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(DatagridConfigurable): better detect and handle columns changes #10157

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(DatagridConfigurable): better detect and handle columns changes #10157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
feaab16
fix(DatagridConfigurable): better detect and handle columns changes
Aug 26, 2024
41c4d36
fix prettier issues
slax57 Aug 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
81 changes: 76 additions & 5 deletions packages/ra-ui-materialui/src/list/datagrid/DatagridConfigurable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import * as React from 'react';
import {
useResourceContext,
usePreference,
useResourceContext,
useStore,
useTranslate,
} from 'ra-core';
import * as React from 'react';

import { Configurable } from '../../preferences';
import { Datagrid, DatagridProps } from './Datagrid';
Expand Down Expand Up @@ -50,6 +50,11 @@ export const DatagridConfigurable = ({
ConfigurableDatagridColumn[]
>(`preferences.${finalPreferenceKey}.availableColumns`, []);

const [columns, setColumns] = useStore<string[]>(
`preferences.${finalPreferenceKey}.columns`,
[]
);

// eslint-disable-next-line @typescript-eslint/no-unused-vars
const [_, setOmit] = useStore<string[] | undefined>(
`preferences.${finalPreferenceKey}.omit`,
Expand All @@ -58,7 +63,7 @@ export const DatagridConfigurable = ({

React.useEffect(() => {
// first render, or the preference have been cleared
const columns = React.Children.toArray(props.children)
const newAvailableColumns = React.Children.toArray(props.children)
.filter(child => React.isValidElement(child))
.map((child: React.ReactElement, index) => ({
index: String(index),
Expand All @@ -75,8 +80,74 @@ export const DatagridConfigurable = ({
_: `Unlabeled column #%{column}`,
}),
}));
if (columns.length !== availableColumns.length) {
setAvailableColumns(columns);
const hasChanged = newAvailableColumns.some(column => {
const availableColumn = availableColumns.find(
availableColumn =>
(!!availableColumn.source &&
availableColumn.source === column?.source) ||
(!!availableColumn.label &&
availableColumn.label === column?.label)
);
return !availableColumn || availableColumn.index !== column.index;
});
if (hasChanged) {
// first we need to update the columns indexes to match the new availableColumns so we keep the same order
const newColumnsSortedAsOldColumns = columns.flatMap(column => {
const oldColumn = availableColumns.find(
availableColumn => availableColumn.index === column
);
const newColumn = newAvailableColumns.find(
availableColumn =>
(!!availableColumn.source &&
availableColumn.source === oldColumn?.source) ||
(!!availableColumn.label &&
availableColumn.label === oldColumn?.label)
);
return newColumn?.index ? [newColumn.index] : [];
});
setColumns([
// we add the old columns in the same order as before
...newColumnsSortedAsOldColumns,
// then we add at the new columns which are not omited
...newAvailableColumns
.filter(
c =>
!availableColumns.some(
ac =>
(!!ac.source && ac.source === c.source) ||
(!!ac.label && ac.label === c.label)
) && !omit?.includes(c.source as string)
)
.map(c => c.index),
]);

// Then we update the available columns to include the new columns while keeping the same order as before
const newAvailableColumnsSortedAsBefore = [
// First the existing columns, in the same order
...(availableColumns
.map(oldAvailableColumn =>
newAvailableColumns.find(
c =>
(!!c.source &&
c.source === oldAvailableColumn.source) ||
(!!c.label &&
c.label === oldAvailableColumn.label)
)
)
.filter(c => !!c) as ConfigurableDatagridColumn[]), // Remove undefined columns
// Then the new columns
...newAvailableColumns.filter(
c =>
!availableColumns.some(
oldAvailableColumn =>
(!!oldAvailableColumn.source &&
oldAvailableColumn.source === c.source) ||
(!!oldAvailableColumn.label &&
oldAvailableColumn.label === c.label)
)
),
];
setAvailableColumns(newAvailableColumnsSortedAsBefore);
setOmit(omit);
}
}, [availableColumns]); // eslint-disable-line react-hooks/exhaustive-deps
Expand Down
Loading