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.

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 List Filter Menu is not accessible #6967

Merged
merged 3 commits into from
Dec 15, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
3 changes: 2 additions & 1 deletion packages/ra-ui-materialui/src/list/filter/FilterButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,13 @@ const FilterButton = (props: FilterButtonProps): JSX.Element => {
anchorEl={anchorEl.current}
onClose={handleRequestClose}
>
{hiddenFilters.map((filterElement: JSX.Element) => (
{hiddenFilters.map((filterElement: JSX.Element, index) => (
<FilterButtonMenuItem
key={filterElement.props.source}
filter={filterElement}
resource={resource}
onShow={handleShow}
autoFocus={index === 0}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get why this is necessary to fix the keyboard navigation. Can you explain?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't get it to work otherwise, I'm forcing the focus on the first menu item, do you have a suggestion with aria attributes?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No but I fail to find a difference between our code and the MUI v4 demos for the menu

Copy link
Contributor Author

@WiXSL WiXSL Dec 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No but I fail to find a difference between our code and the MUI v4 demos for the menu

What I've noticed is that they don't have a forwardRef MenuItem inside a Menu in their examples.
The keyboard navigation works out of the box without this, but of course, we need it because of the use of FilterButtonMenuItem.

For example, this works (without the use of FilterButtonMenuItem):

// FilterButton.jsx
...
<Menu
    open={open}
    anchorEl={anchorEl.current}
    onClose={handleRequestClose}
>
    {hiddenFilters.map((filterElement: JSX.Element, index) => (
        <MenuItem
            key={filterElement.props.source}
            data-key={filterElement.props.source}
            data-default-value={filterElement.props.defaultValue}
            onClick={() =>
                handleShow({
                    source: filterElement.props.source,
                    defaultValue: filterElement.props.defaultValue,
                })
            }
        >
            <FieldTitle
                label={filterElement.props.label}
                source={filterElement.props.source}
                resource={resource}
            />
        </MenuItem>
    ))}
</Menu>
...

Of course, it would be a BC.
Now, why does it work when not using a forwardRef ?, I don't know.

/>
))}
</Menu>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { FieldTitle, useResourceContext } from 'ra-core';

export const FilterButtonMenuItem = forwardRef<any, FilterButtonMenuItemProps>(
(props, ref) => {
const { filter, onShow } = props;
const { filter, onShow, autoFocus } = props;
const resource = useResourceContext(props);
const handleShow = useCallback(() => {
onShow({
Expand All @@ -22,6 +22,7 @@ export const FilterButtonMenuItem = forwardRef<any, FilterButtonMenuItemProps>(
data-default-value={filter.props.defaultValue}
key={filter.props.source}
onClick={handleShow}
autoFocus={autoFocus}
ref={ref}
>
<FieldTitle
Expand All @@ -38,10 +39,12 @@ FilterButtonMenuItem.propTypes = {
filter: PropTypes.element.isRequired,
onShow: PropTypes.func.isRequired,
resource: PropTypes.string,
autoFocus: PropTypes.bool,
};

export interface FilterButtonMenuItemProps {
filter: JSX.Element;
onShow: (params: { source: string; defaultValue: any }) => void;
resource: string;
autoFocus: boolean;
}