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

Jump to bottom

Fix broken referenceKey prop on SelectColumnsButton #8432

Merged
merged 2 commits into from
Dec 8, 2022
Merged

Fix broken referenceKey prop on SelectColumnsButton #8432

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e232817
Fix #8431
wcoppens Nov 29, 2022
9eb83c6
Add TS typing from #8479
wcoppens Dec 8, 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
12 changes: 11 additions & 1 deletion packages/ra-ui-materialui/src/list/datagrid/SelectColumnsButton.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as React from 'react';
import { render, screen } from '@testing-library/react';
import expect from 'expect';

import { Basic } from './SelectColumnsButton.stories';
import { Basic, WithPreferenceKey } from './SelectColumnsButton.stories';

describe('<SelectColumnsButton>', () => {
it('should render a datagrid with configurable columns', async () => {
Expand All @@ -14,4 +14,14 @@ describe('<SelectColumnsButton>', () => {
screen.getByLabelText('Year').click();
expect(screen.queryByText('1869')).not.toBeNull();
});

it('should render a datagrid with columns using the given preference key', async () => {
WiXSL marked this conversation as resolved.
Show resolved Hide resolved
render(<WithPreferenceKey />);
screen.getByText('Columns').click();
expect(screen.queryByText('1869')).not.toBeNull();
screen.getByLabelText('Year').click();
expect(screen.queryByText('1869')).toBeNull();
screen.getByLabelText('Year').click();
expect(screen.queryByText('1869')).not.toBeNull();
});
});
25 changes: 25 additions & 0 deletions packages/ra-ui-materialui/src/list/datagrid/SelectColumnsButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,28 @@ export const Basic = () => (
</PreferencesEditorContextProvider>
</ThemeProvider>
);

export const WithPreferenceKey = () => (
<ThemeProvider theme={theme}>
<PreferencesEditorContextProvider>
<MemoryRouter>
<Box p={2}>
<Box textAlign="right">
<SelectColumnsButton preferenceKey="just-a-key.to_test_with" />
</Box>
<DatagridConfigurable
preferenceKey="just-a-key.to_test_with"
data={data}
sort={{ field: 'title', order: 'ASC' }}
bulkActionButtons={false}
>
<TextField source="id" />
<TextField source="title" label="Original title" />
<TextField source="author" />
<TextField source="year" />
</DatagridConfigurable>
</Box>
</MemoryRouter>
</PreferencesEditorContextProvider>
</ThemeProvider>
);
18 changes: 11 additions & 7 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 @@ -40,15 +40,19 @@ import { styled } from '@mui/material/styles';
*/
export const SelectColumnsButton = props => {
const resource = useResourceContext(props);
const preferenceKey =
props.preferenceKey || `preferences.${resource}.datagrid`;
const finalPreferenceKey = props.preferenceKey || `${resource}.datagrid`;

const [anchorEl, setAnchorEl] = React.useState(null);
const [availableColumns, setAvailableColumns] = useStore<
ConfigurableDatagridColumn[]
>(`${preferenceKey}.availableColumns`, []);
const [omit] = useStore<string[]>(`${preferenceKey}.omit`, []);
const [availableColumns, setAvailableColumns] = useStore<ConfigurableDatagridColumn[]>(
`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