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 useMenuItem onAction regression #6807

Merged
merged 2 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions packages/@react-aria/menu/src/useMenuItem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ export function useMenuItem<T>(props: AriaMenuItemProps, state: TreeState<T>, re

if (item?.props?.onAction) {
item.props.onAction();
} else if (props.onAction) {
props.onAction(key);
}

if (data.onAction) {
Expand Down
77 changes: 77 additions & 0 deletions packages/@react-aria/menu/test/useMenu.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright 2020 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

import {AriaMenuProps, useMenu, useMenuItem} from '../';
import {Item} from '@react-stately/collections';
import {pointerMap, render} from '@react-spectrum/test-utils-internal';
import React from 'react';
import userEvent from '@testing-library/user-event';
import {useTreeState} from '@react-stately/tree';

function Menu<T extends object>(props: AriaMenuProps<T> & {onSelect: () => void}) {
// Create menu state based on the incoming props
let state = useTreeState(props);

// Get props for the menu element
let ref = React.useRef(null);
let {menuProps} = useMenu(props, state, ref);

return (
<ul {...menuProps} ref={ref}>
{[...state.collection].map((item) => (
<MenuItem key={item.key} item={item} state={state} onAction={props.onSelect} />
))}
</ul>
);
}

function MenuItem({item, state, onAction}) {
// Get props for the menu item element
let ref = React.useRef(null);
let {menuItemProps, isSelected} = useMenuItem(
{key: item.key, onAction},
state,
ref
);

return (
<li {...menuItemProps} ref={ref}>
{item.rendered}
{isSelected && <span aria-hidden="true">βœ…</span>}
</li>
);
}

describe('useMenuTrigger', function () {
let user;
beforeAll(() => {
user = userEvent.setup({delay: null, pointerMap});
jest.useFakeTimers();
});

afterEach(() => {
});

it('calls an onAction passed directly to useMenuItem', async () => {
let onSelect = jest.fn();
let {getAllByRole} = render(
<Menu onSelect={onSelect} aria-label={'test menu'}>
Copy link
Member

Choose a reason for hiding this comment

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

Ah interesting, so this is a route where the user passes their onAction equivalent at the menu level but routes it directly to the useMenuItem hook. I think when you and I discussed this previously that I had made an erroneous assumption that it would always be passed to the Menu or the Item as onAction directly whoops

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, all good, I didn't really understand until I saw an example as well.

<Item key="1">One</Item>
<Item key="2">Two</Item>
<Item key="3">Three</Item>
</Menu>
);
let items = getAllByRole('menuitem');
await user.click(items[0]);
expect(onSelect).toHaveBeenCalledTimes(1);
});
});