fix(dropdown): focus behaviour on press / enter keydown #2970

wingkwong · 2024-05-09T09:57:25Z

📝 Description

As the doc stated, when keydown (press /enter) on the trigger, the first menu item should be focused. This PR is to cover this missing behaviour.

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

New Features
- Improved keyboard accessibility in dropdown menus: now focuses on the first item when opened with Space or Enter keys.
- Added @nextui-org/test-utils as a dependency for the dropdown component.

linear · 2024-05-09T09:57:28Z

ENG-726 [BUG] - DropdownItem not getting focused properly and 'Enter' | 'Space' not selecting the item.

vercel · 2024-05-09T09:57:28Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nextui-docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 19, 2024 2:12pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 19, 2024 2:12pm

changeset-bot · 2024-05-09T09:57:29Z

🦋 Changeset detected

Latest commit: 6549a0b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@nextui-org/dropdown	Patch
@nextui-org/menu	Patch
@nextui-org/react	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2024-05-09T09:57:32Z

Walkthrough

The recent changes aim to improve the behavior of the @nextui-org/dropdown package by ensuring that the first item in the dropdown receives focus automatically when opened using the Space or Enter keys. These enhancements are designed to enhance accessibility and improve user interaction with keyboard inputs.

Changes

File Path	Change Summary
`.changeset/heavy-kangaroos-stare.md`	Introduces a patch to focus on the first dropdown item when the Space or Enter key is pressed.
`packages/components/dropdown/__tests__/dropdown.test.tsx`	Adds test cases for keyboard interactions focusing on the first dropdown item using Enter and Space keys.
`packages/components/dropdown/package.json`	Adds `@nextui-org/test-utils` as a dependency in the `package.json` file for the dropdown component.
`packages/components/dropdown/src/use-dropdown.ts`	Adds `autoFocus: "first"` property to `MenuProps` in the `useDropdown` function for auto-focusing.
`packages/components/menu/src/use-menu.ts`	Updates the usage of props in the `useMenu` function to include `userMenuProps` alongside `otherProps`.

Assessment against linked issues

Objective	Addressed	Explanation
DropdownItem not getting focused properly when Dropdown opens with Space or Enter (Issue #2863)	✅
'Enter' or 'Space' not selecting the item after focusing on DropdownItem (Issue #2863)	❓	The changes address the focus issue, but it's unclear if the selection functionality is explicitly added.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 633f9d2 and 9c70e92.

Files selected for processing (3)

.changeset/heavy-kangaroos-stare.md (1 hunks)
packages/components/dropdown/tests/dropdown.test.tsx (1 hunks)
packages/components/dropdown/src/use-dropdown.ts (1 hunks)

Files skipped from review due to trivial changes (1)

.changeset/heavy-kangaroos-stare.md

Additional comments not posted (2)

packages/components/dropdown/src/use-dropdown.ts (1)

147-147: Ensure the autoFocus property is correctly implemented and tested.

This change correctly implements the autoFocus: "first" property to enhance keyboard accessibility by focusing the first item when the dropdown is activated. It's crucial to ensure that this behavior is covered by unit tests to prevent regressions in future updates.

packages/components/dropdown/__tests__/dropdown.test.tsx (1)

542-622: New test cases for keyboard interactions are comprehensive and well-structured.

The new test cases effectively simulate user interactions with the keyboard (Enter and Space keys) and verify that the first item is focused as expected. This aligns well with the changes made in the use-dropdown.ts file and ensures that the new functionality behaves as intended.

packages/components/dropdown/src/use-dropdown.ts

… autoFocus

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9c70e92 and 2de66ad.

Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !pnpm-lock.yaml

Files selected for processing (3)

packages/components/dropdown/tests/dropdown.test.tsx (2 hunks)
packages/components/dropdown/package.json (1 hunks)
packages/components/dropdown/src/use-dropdown.ts (2 hunks)

Files skipped from review due to trivial changes (2)

packages/components/dropdown/tests/dropdown.test.tsx
packages/components/dropdown/package.json

Files skipped from review as they are similar to previous changes (1)

packages/components/dropdown/src/use-dropdown.ts

…ove from getListProps

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2de66ad and 6549a0b.

Files selected for processing (3)

.changeset/heavy-kangaroos-stare.md (1 hunks)
packages/components/dropdown/src/use-dropdown.ts (1 hunks)
packages/components/menu/src/use-menu.ts (2 hunks)

Files skipped from review due to trivial changes (1)

packages/components/dropdown/src/use-dropdown.ts

Files skipped from review as they are similar to previous changes (1)

.changeset/heavy-kangaroos-stare.md

Additional comments not posted (2)

packages/components/menu/src/use-menu.ts (2)

122-122: Ensure proper merging of userMenuProps with otherProps.

The integration of userMenuProps into the state generation through useTreeState is correctly implemented. This change should allow for more flexible configuration of the menu component, aligning with the PR's objectives to enhance keyboard interaction.

126-126: Validate the extended use of userMenuProps in ARIA menu props.

The extension of userMenuProps into the ARIA menu props generation via useAriaMenu is correctly done. This ensures that any user-defined properties are considered in the ARIA attributes, which is crucial for accessibility and custom behavior.

jrgarciadev

🚀

wingkwong added 3 commits May 9, 2024 17:00

fix(dropdown): set focus on the first item

f74a31b

feat(dropdown): add keyboard interactions tests

0816f6b

feat(changeset): add changeset

9c70e92

wingkwong requested a review from jrgarciadev as a code owner May 9, 2024 09:57

coderabbitai bot reviewed May 9, 2024

View reviewed changes

vercel bot deployed to Preview – nextui-docs-v2 May 9, 2024 10:00 View deployment

vercel bot deployed to Preview – nextui-storybook-v2 May 9, 2024 10:00 View deployment

wingkwong assigned jrgarciadev May 9, 2024

jrgarciadev requested changes May 13, 2024

View reviewed changes

packages/components/dropdown/src/use-dropdown.ts Outdated Show resolved Hide resolved

wingkwong added this to the v2.3.7 milestone May 14, 2024

wingkwong added 4 commits May 14, 2024 13:07

Merge branch 'canary' into fix/eng-726

cf58138

fix(dropdown): use fireEvent.keyDown instead

1311c25

chore(deps): add @nextui-org/test-utils to dropdown

0bf8da5

refactor(dropdown): pass onKeyDown to menu trigger and don't hardcode…

2de66ad

… autoFocus

vercel bot deployed to Preview – nextui-storybook-v2 May 15, 2024 16:19 View deployment

vercel bot deployed to Preview – nextui-docs-v2 May 15, 2024 16:19 View deployment

coderabbitai bot reviewed May 15, 2024

View reviewed changes

wingkwong requested a review from jrgarciadev May 15, 2024 16:22

wingkwong added 3 commits May 19, 2024 22:08

chore(dropdown): remove autoFocus

4ea7624

fix(menu): pass userMenuProps to useTreeState and useAriaMenu and rem…

ea4f63b

…ove from getListProps

chore(changeset): add menu package

6549a0b

vercel bot deployed to Preview – nextui-docs-v2 May 19, 2024 14:11 View deployment

vercel bot deployed to Preview – nextui-storybook-v2 May 19, 2024 14:12 View deployment

coderabbitai bot reviewed May 19, 2024

View reviewed changes

jrgarciadev approved these changes May 19, 2024

View reviewed changes

jrgarciadev merged commit 7df2c71 into canary May 19, 2024
8 checks passed

jrgarciadev deleted the fix/eng-726 branch May 19, 2024 19:40

github-actions bot mentioned this pull request May 19, 2024

ci(changesets): 📦 version packages #2903

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(dropdown): focus behaviour on press / enter keydown #2970

fix(dropdown): focus behaviour on press / enter keydown #2970

wingkwong commented May 9, 2024 •

edited by coderabbitai bot

linear bot commented May 9, 2024

vercel bot commented May 9, 2024 •

edited

changeset-bot bot commented May 9, 2024 •

edited

coderabbitai bot commented May 9, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

jrgarciadev left a comment

fix(dropdown): focus behaviour on press / enter keydown #2970

fix(dropdown): focus behaviour on press / enter keydown #2970

Conversation

wingkwong commented May 9, 2024 • edited by coderabbitai bot

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

linear bot commented May 9, 2024

vercel bot commented May 9, 2024 • edited

changeset-bot bot commented May 9, 2024 • edited

🦋 Changeset detected

coderabbitai bot commented May 9, 2024 • edited

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

jrgarciadev left a comment

Choose a reason for hiding this comment

wingkwong commented May 9, 2024 •

edited by coderabbitai bot

vercel bot commented May 9, 2024 •

edited

changeset-bot bot commented May 9, 2024 •

edited

coderabbitai bot commented May 9, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)