Skip to content

Implement reordering columns using the keyboard in <ColumnsButton> #10870

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

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

Implement reordering columns using the keyboard in <ColumnsButton> #10870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dce0967
Implement reordering columns using the keyboard
djhi Jul 30, 2025
e4989e0
Fix tests
djhi Jul 30, 2025
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
6 changes: 3 additions & 3 deletions packages/ra-ui-materialui/src/list/datatable/ColumnsButton.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ describe('ColumnsButton', () => {
screen
.getByRole('menu')
.querySelectorAll('li:not(.columns-selector-actions)')
).toHaveLength(8); // 7 columns + the filter input li
).toHaveLength(7);
// Typing a filter
fireEvent.change(
screen.getByPlaceholderText('ra.action.search_columns'),
Expand All @@ -43,7 +43,7 @@ describe('ColumnsButton', () => {
screen
.getByRole('menu')
.querySelectorAll('li:not(.columns-selector-actions)')
).toHaveLength(2); // only the column with 'DiA' in its label should remain + the filter input li
).toHaveLength(1);
});
screen.getByLabelText('Téstïng diàcritics');
// Clear the filter
Expand All @@ -53,7 +53,7 @@ describe('ColumnsButton', () => {
screen
.getByRole('menu')
.querySelectorAll('li:not(.columns-selector-actions)')
).toHaveLength(8);
).toHaveLength(7);
});
});
});
216 changes: 172 additions & 44 deletions packages/ra-ui-materialui/src/list/datatable/ColumnsSelector.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,59 +60,187 @@ export const ColumnsSelector = ({ children }: ColumnsSelectorProps) => {

const [columnFilter, setColumnFilter] = React.useState<string>('');

if (!container) return null;

const childrenArray = Children.toArray(children);
const paddedColumnRanks = padRanks(columnRanks ?? [], childrenArray.length);
const shouldDisplaySearchInput = childrenArray.length > 5;

const handleMove = (index1, index2) => {
const colRanks = !columnRanks
? padRanks([], Math.max(index1, index2) + 1)
: Math.max(index1, index2) > columnRanks.length - 1
? padRanks(columnRanks, Math.max(index1, index2) + 1)
: columnRanks;
const index1Pos = colRanks.findIndex(
// eslint-disable-next-line eqeqeq
index => index == index1
);
const index2Pos = colRanks.findIndex(
// eslint-disable-next-line eqeqeq
index => index == index2
);
if (index1Pos === -1 || index2Pos === -1) {
return;
}
let newColumnRanks;
if (index1Pos > index2Pos) {
newColumnRanks = [
...colRanks.slice(0, index2Pos),
colRanks[index1Pos],
...colRanks.slice(index2Pos, index1Pos),
...colRanks.slice(index1Pos + 1),
];
} else {
newColumnRanks = [
...colRanks.slice(0, index1Pos),
...colRanks.slice(index1Pos + 1, index2Pos + 1),
colRanks[index1Pos],
...colRanks.slice(index2Pos + 1),
];
}
setColumnRanks(newColumnRanks);
return index2Pos;
};

const list = React.useRef<HTMLUListElement | null>(null);
const draggedItem = React.useRef<HTMLLIElement | null>(null);
const dropItem = React.useRef<HTMLLIElement | null>(null);

const handleKeyDown = (event: React.KeyboardEvent) => {
// Use setTimeout to let MenuList handle the focus management
setTimeout(() => {
if (document.activeElement?.tagName !== 'LI') {
return;
}

if (event.key === ' ') {
if (!draggedItem.current) {
// Start dragging the currently focused item
draggedItem.current =
document.activeElement as HTMLLIElement;
draggedItem.current.classList.add('drag-active-keyboard');
} else {
if (!dropItem.current) {
return;
}
// Drop the dragged item
draggedItem.current.classList.remove(
'drag-active-keyboard'
);
const itemToFocusIndex = handleMove(
draggedItem.current.dataset.index,
dropItem.current?.dataset.index
);
setTimeout(() => {
// We wait for the DOM to update before focusing
// the item that was moved.
// We use the actual position it was moved to and not the data-index which may not be updated yet
if (itemToFocusIndex && list.current) {
const itemToFocus =
list.current.querySelectorAll('li')[
itemToFocusIndex
];
if (itemToFocus) {
(itemToFocus as HTMLLIElement).focus();
}
}
draggedItem.current = null;
});
}
}
if (!draggedItem.current) {
return;
}
if (event.key === 'ArrowDown') {
// Swap the dragged item with the next one
const nextItem = draggedItem.current.nextElementSibling;
if (nextItem) {
draggedItem.current.parentNode?.insertBefore(
draggedItem.current,
nextItem.nextSibling
);
dropItem.current = nextItem as HTMLLIElement;
draggedItem.current.focus();
} else {
// Start of the list, move the dragged item as the first item
draggedItem.current.parentNode?.insertBefore(
draggedItem.current,
draggedItem.current?.parentNode?.firstChild
);
dropItem.current = draggedItem.current?.parentNode
?.firstChild as HTMLLIElement;
draggedItem.current.focus();
}
} else if (event.key === 'ArrowUp') {
// Swap the dragged item with the previous one
const prevItem = draggedItem.current.previousElementSibling;
if (prevItem) {
draggedItem.current?.parentNode?.insertBefore(
draggedItem.current,
prevItem
);
dropItem.current = prevItem as HTMLLIElement;
draggedItem.current.focus();
} else {
// End of the list, move the dragged item as the last item
draggedItem.current?.parentNode?.appendChild(
draggedItem.current
);
dropItem.current = draggedItem.current?.parentNode
?.lastChild as HTMLLIElement;
draggedItem.current.focus();
}
}
});
};

if (!container) return null;

return createPortal(
<MenuList>
<>
{shouldDisplaySearchInput ? (
<Box component="li" tabIndex={-1}>
<ResettableTextField
hiddenLabel
label=""
value={columnFilter}
onChange={e => {
if (typeof e === 'string') {
setColumnFilter(e);
return;
}
setColumnFilter(e.target.value);
}}
placeholder={translate('ra.action.search_columns', {
_: 'Search columns',
})}
InputProps={{
endAdornment: (
<InputAdornment position="end">
<SearchIcon color="disabled" />
</InputAdornment>
),
}}
resettable
autoFocus
size="small"
sx={{ mb: 1 }}
/>
</Box>
<ResettableTextField
hiddenLabel
label=""
value={columnFilter}
onChange={e => {
if (typeof e === 'string') {
setColumnFilter(e);
return;
}
setColumnFilter(e.target.value);
}}
placeholder={translate('ra.action.search_columns', {
_: 'Search columns',
})}
InputProps={{
endAdornment: (
<InputAdornment position="end">
<SearchIcon color="disabled" />
</InputAdornment>
),
}}
resettable
autoFocus
size="small"
sx={{ my: 1 }}
/>
) : null}
{paddedColumnRanks.map((position, index) => (
<DataTableColumnRankContext.Provider
value={position}
key={index}
>
<DataTableColumnFilterContext.Provider
value={columnFilter}
<MenuList onKeyDown={handleKeyDown} ref={list}>
{paddedColumnRanks.map((position, index) => (
<DataTableColumnRankContext.Provider
value={position}
key={index}
>
{childrenArray[position]}
</DataTableColumnFilterContext.Provider>
</DataTableColumnRankContext.Provider>
))}
<DataTableColumnFilterContext.Provider
value={columnFilter}
key={index}
>
{childrenArray[position]}
</DataTableColumnFilterContext.Provider>
</DataTableColumnRankContext.Provider>
))}
</MenuList>
<Box
component="li"
className="columns-selector-actions"
sx={{ textAlign: 'center', mt: 1 }}
>
Expand All @@ -125,7 +253,7 @@ export const ColumnsSelector = ({ children }: ColumnsSelectorProps) => {
Reset
</Button>
</Box>
</MenuList>,
</>,
container
);
};
Expand Down
7 changes: 7 additions & 0 deletions packages/ra-ui-materialui/src/preferences/FieldToggle.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ export const FieldToggle = (props: FieldToggleProps) => {
onDragEnd={onMove ? handleDragEnd : undefined}
onDragOver={onMove ? handleDragOver : undefined}
data-index={index}
tabIndex={0}
>
<label htmlFor={`switch_${index}`}>
<Switch
Expand Down Expand Up @@ -169,6 +170,12 @@ const Root = styled('li', {
visibility: 'hidden',
},
},
'&.drag-active-keyboard': {
outline: `1px solid ${(theme.vars || theme).palette.action.selected}`,
'& .MuiSwitch-root, & svg': {
visibility: 'hidden',
},
},
}));

declare module '@mui/material/styles' {
Expand Down
Loading