Skip to content
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

Fix preferenceKey definition in <SelectColumnsButton> #8479

Closed
wants to merge 3 commits into from
Closed

Fix preferenceKey definition in <SelectColumnsButton> #8479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71750cb
Fix types on <SelectColumnsButton> / fix user defined preferenceKey d…
antoinefricker Dec 7, 2022
b438ae9
Update stories to show <SelectColumnsButton> and <InspectorButton> wo…
antoinefricker Dec 7, 2022
c9770a0
Fix test
antoinefricker Dec 7, 2022
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
75 changes: 41 additions & 34 deletions packages/ra-ui-materialui/src/list/datagrid/DatagridConfigurable.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { Inspector, InspectorButton } from '../../preferences';
import { TextField } from '../../field';
import { EditButton } from '../../button';
import { createTheme, ThemeProvider } from '@mui/material/styles';
import { SelectColumnsButton } from './SelectColumnsButton';

export default { title: 'ra-ui-materialui/list/DatagridConfigurable' };

Expand Down Expand Up @@ -96,38 +97,44 @@ export const Omit = () => (
);

export const PreferenceKey = () => (
<PreferencesEditorContextProvider>
<MemoryRouter>
<Inspector />
<Box display="flex" justifyContent="flex-end">
<InspectorButton />
</Box>
<Box p={2} display="flex" justifyContent="space-between">
<DatagridConfigurable
resource="books3"
data={data}
sort={{ field: 'title', order: 'ASC' }}
bulkActionButtons={false}
preferenceKey="pref1"
>
<TextField source="id" />
<TextField source="title" label="Original title" />
<TextField source="author" />
<TextField source="year" />
</DatagridConfigurable>
<DatagridConfigurable
resource="books3"
data={data}
sort={{ field: 'title', order: 'ASC' }}
bulkActionButtons={false}
preferenceKey="pref2"
>
<TextField source="id" />
<TextField source="title" label="Original title" />
<TextField source="author" />
<TextField source="year" />
</DatagridConfigurable>
</Box>
</MemoryRouter>
</PreferencesEditorContextProvider>
<ThemeProvider theme={theme}>
<PreferencesEditorContextProvider>
<MemoryRouter>
<Inspector />
<Box display="flex" justifyContent="space-around">
<SelectColumnsButton
resource="books3"
preferenceKey="pref1"
/>
<InspectorButton color="primary" />
</Box>
<Box p={2} display="flex" justifyContent="space-between">
<DatagridConfigurable
resource="books3"
data={data}
sort={{ field: 'title', order: 'ASC' }}
bulkActionButtons={false}
preferenceKey="pref1"
>
<TextField source="id" />
<TextField source="title" label="Original title" />
<TextField source="author" />
<TextField source="year" />
</DatagridConfigurable>
<DatagridConfigurable
resource="books3"
data={data}
sort={{ field: 'title', order: 'ASC' }}
bulkActionButtons={false}
preferenceKey="pref2"
>
<TextField source="id" />
<TextField source="title" label="Original title" />
<TextField source="author" />
<TextField source="year" />
</DatagridConfigurable>
</Box>
</MemoryRouter>
</PreferencesEditorContextProvider>
</ThemeProvider>
);
31 changes: 23 additions & 8 deletions packages/ra-ui-materialui/src/list/datagrid/SelectColumnsButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,22 @@ import { styled } from '@mui/material/styles';
* </List>
* );
*/
export const SelectColumnsButton = props => {
export const SelectColumnsButton = (props: SelectColumnsButtonProps) => {
const { preferenceKey } = props;

const resource = useResourceContext(props);
const preferenceKey =
props.preferenceKey || `preferences.${resource}.datagrid`;
const finalPreferenceKey = preferenceKey || `${resource}.datagrid`;

const [anchorEl, setAnchorEl] = React.useState(null);
const [availableColumns, setAvailableColumns] = useStore<
ConfigurableDatagridColumn[]
>(`${preferenceKey}.availableColumns`, []);
const [omit] = useStore<string[]>(`${preferenceKey}.omit`, []);
>(`preferences.${finalPreferenceKey}.availableColumns`, []);
const [omit] = useStore<string[]>(
`preferences.${finalPreferenceKey}.omit`,
[]
);
const [columns, setColumns] = useStore<string[]>(
`${preferenceKey}.columns`,
`preferences.${finalPreferenceKey}.columns`,
availableColumns
.filter(column => !omit?.includes(column.source))
.map(column => column.index)
Expand Down Expand Up @@ -130,6 +135,7 @@ export const SelectColumnsButton = props => {
color="primary"
onClick={handleClick}
size="large"
{...sanitizeRestProps(props)}
>
<ViewWeekIcon />
</IconButton>
Expand All @@ -139,6 +145,7 @@ export const SelectColumnsButton = props => {
size="small"
onClick={handleClick}
startIcon={<ViewWeekIcon />}
{...sanitizeRestProps(props)}
>
{title}
</StyledButton>
Expand Down Expand Up @@ -184,6 +191,14 @@ const StyledButton = styled(Button, {
},
});

export interface SelectColumnsButtonProps {
preferenceKey: string;
const sanitizeRestProps = ({
resource = null,
preferenceKey = null,
...rest
}) => rest;

export interface SelectColumnsButtonProps
extends React.HtmlHTMLAttributes<HTMLDivElement> {
resource?: string;
preferenceKey?: string;
}