Skip to content

Allow <Title> to be non configurable #9836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slax57 merged 10 commits into from
Jun 28, 2024
Merged

Allow <Title> to be non configurable #9836

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a37e67b
Allow <Title /> to be nonConfigurable
markyao6275 May 8, 2024
20956b0
Add storybook example
markyao6275 May 8, 2024
9ca18e4
address some feedback
markyao6275 May 11, 2024
50c6767
fix NonConfigurable storybook
markyao6275 May 18, 2024
687639f
remove nonConfigurable prop and fix story
markyao6275 May 23, 2024
9944fb2
Remove useless fragment
djhi May 23, 2024
33df92a
add preferenceKey default + check for undefined
markyao6275 May 23, 2024
14f7256
check if preferenceKey is strictly equal to false
markyao6275 May 30, 2024
1f9a116
remove unused lines
markyao6275 Jun 13, 2024
7f73bfb
add configurable story, add documentation, pass on props
markyao6275 Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/ra-ui-materialui/src/layout/PageTitle.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
import * as React from 'react';
import { useRecordContext, useTranslate, usePreference } from 'ra-core';
import { useTranslate } from 'ra-core';

export const PageTitle = ({ title, defaultTitle, className, ...rest }: any) => {
const [titleFromPreferences] = usePreference();
const translate = useTranslate();
const record = useRecordContext();

return titleFromPreferences ? (
<span className={className} {...rest}>
{translate(titleFromPreferences, {
...record,
_: titleFromPreferences,
})}
</span>
) : (
return (
<span className={className}>
{!title ? (
<span {...rest}>{defaultTitle}</span>
Expand Down
26 changes: 24 additions & 2 deletions packages/ra-ui-materialui/src/layout/PageTitleConfigurable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import * as React from 'react';
import { useLocation } from 'react-router-dom';
import { usePreferenceInput } from 'ra-core';
import {
usePreferenceInput,
usePreference,
useRecordContext,
useTranslate,
} from 'ra-core';
import { TextField } from '@mui/material';

import { Configurable } from '../preferences';
Expand Down Expand Up @@ -34,7 +39,24 @@ export const PageTitleConfigurable = ({ preferenceKey, ...props }) => {
},
}}
>
<PageTitle {...props} />
<PageTitleConfigurableInner {...props} />
</Configurable>
);
};

const PageTitleConfigurableInner = props => {
const [titleFromPreferences] = usePreference();
const translate = useTranslate();
const record = useRecordContext();

return titleFromPreferences ? (
<span className={props.className}>
{translate(titleFromPreferences, {
...record,
_: titleFromPreferences,
})}
</span>
) : (
<PageTitle {...props} />
);
};
24 changes: 12 additions & 12 deletions packages/ra-ui-materialui/src/layout/Title.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { ReactElement } from 'react';
import { createPortal } from 'react-dom';
import { RaRecord, TitleComponent, warning } from 'ra-core';

import { PageTitle } from './PageTitle';
import { PageTitleConfigurable } from './PageTitleConfigurable';

export const Title = (props: TitleProps) => {
Expand Down Expand Up @@ -31,19 +32,18 @@ export const Title = (props: TitleProps) => {

warning(!defaultTitle && !title, 'Missing title prop in <Title> element');

return (
<>
{createPortal(
<PageTitleConfigurable
title={title}
defaultTitle={defaultTitle}
preferenceKey={preferenceKey}
{...rest}
/>,
container
)}
</>
const pageTitle = preferenceKey ? (
<PageTitleConfigurable
title={title}
defaultTitle={defaultTitle}
preferenceKey={preferenceKey}
{...rest}
/>
) : (
<PageTitle title={title} defaultTitle={defaultTitle} {...rest} />
);

return <>{createPortal(pageTitle, container)}</>;
};

export interface TitleProps {
Expand Down
20 changes: 18 additions & 2 deletions packages/ra-ui-materialui/src/layout/TitlePortal.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import * as React from 'react';
import { TestMemoryRouter } from 'ra-core';
import { PreferencesEditorContextProvider } from 'ra-core';
import { PreferencesEditorContextProvider, TestMemoryRouter } from 'ra-core';

import { TitlePortal } from './TitlePortal';
import { Title } from './Title';
import { InspectorButton } from '../preferences/InspectorButton';
import { Inspector } from '../preferences/Inspector';
import { Configurable } from '../preferences/Configurable';
import { PageTitleEditor } from './PageTitleConfigurable';

export default {
title: 'ra-ui-materialui/layout/TitlePortal',
Expand Down Expand Up @@ -35,3 +38,16 @@ export const Sx = () => (
</PreferencesEditorContextProvider>
</TestMemoryRouter>
);

export const NonConfigurable = () => (
<TestMemoryRouter>
<PreferencesEditorContextProvider>
<Inspector />
<InspectorButton />
<>
<TitlePortal variant="body1" />
<Title title="Hello, world" preferenceKey={undefined} />
</>
</PreferencesEditorContextProvider>
</TestMemoryRouter>
);