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

feat(autocomplete): automatically focus first non-disabled item #2186

Merged
merged 3 commits into from
Oct 1, 2024

Conversation

juliesaia
Copy link
Contributor

@juliesaia juliesaia commented Dec 31, 2023

📝 Description

Automatically focus the first selectable item in <Autocomplete />

⛳️ Current behavior (updates)

Autocomplete doesn't really work as an autocomplete because you have to hover/click/press an arrow key to focus and element.

🚀 New behavior

This PR makes the first non-disabled item automatically focus any time the item list changes.

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

Not really, honestly feels like more of a bug fix but I still called it a feature

📝 Additional Information

1ed594b4-13cd-4dc5-95d9-7597a32f39a8

Summary by CodeRabbit

  • New Features

    • Enhanced autocomplete functionality to automatically focus on the first non-disabled item when rendered.
  • Bug Fixes

    • Improved handling of key events to maintain expected behavior during user interactions.

Copy link

changeset-bot bot commented Dec 31, 2023

🦋 Changeset detected

Latest commit: 1bb0a62

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

This PR includes changesets to release 2 packages
Name Type
@nextui-org/autocomplete 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

Copy link

vercel bot commented Dec 31, 2023

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 31, 2023 8:32am

Copy link

vercel bot commented Dec 31, 2023

@juliesaia is attempting to deploy a commit to the NextUI Team on Vercel.

A member of the Team first needs to authorize it.

@jsonMartin
Copy link

Nice, I'd really like this feature implemented! I wrote my own logic to handle this in an app I'm working on, but it's cumbersome and it would be really great to have this working out of the box.

Any updates on getting this merged?

@gumgumalan
Copy link

How do I implement this locally? Thanks.

@jsonMartin
Copy link

How do I implement this locally? Thanks.

Hi @gumgumalan , since this feature isn't baked in, I personally created a hook to watch for every time the Autocomplete is opened and then manually invoke focus on the DOM element to achieve this. Here's an example:

// AutoFocus on the NextUI search input when the modal opens
useEffect(() => {
  if (!isOpen) return

  setTimeout(() => {
    const element: HTMLElement | null = document.querySelector(*ADD DOM REF HERE*)
    if (!element) console.warn('Not available for autofocus')
    else element?.focus()
  }, 10)
}, [isOpen, label])

@wingkwong wingkwong changed the base branch from main to canary April 28, 2024 14:56
@daniel-esserweb
Copy link

daniel-esserweb commented Jul 8, 2024

I think this could be and awesome feature @wingkwong

@wingkwong wingkwong added this to the v2.5.0 milestone Sep 8, 2024
@wingkwong wingkwong self-assigned this Sep 8, 2024
Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce functionality in the useAutocomplete function to automatically focus on the first non-disabled item in the autocomplete suggestions when rendered. This is accomplished by iterating through the items and setting the focused key accordingly, while preserving the existing logic for syncing the input value with the selected item. Additionally, minor adjustments were made to the handling of the inputProps.onKeyDown event to maintain default behavior.

Changes

Files Change Summary
packages/components/autocomplete/src/use-autocomplete.ts Added logic to focus on the first non-disabled item in the autocomplete list upon rendering; adjusted inputProps.onKeyDown handling.

Possibly related PRs

Suggested reviewers

  • jrgarciadev: Suggested reviewer for the changes made in the use-autocomplete.ts file.

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@wingkwong wingkwong requested review from wingkwong and removed request for jrgarciadev October 1, 2024 08:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/components/autocomplete/src/use-autocomplete.ts (1)

320-328: LGTM! Consider a minor optimization.

The implementation correctly focuses on the first non-disabled item when the collection or disabled keys change. This aligns well with the PR objective of automatically focusing the first selectable item.

Consider using state.collection.getFirstKey() with a predicate function to simplify the logic:

- let key = state.collection.getFirstKey();
- 
- while (key && state.disabledKeys.has(key)) {
-   key = state.collection.getKeyAfter(key);
- }
+ let key = state.collection.getFirstKey(key => !state.disabledKeys.has(key));

state.selectionManager.setFocusedKey(key);

This approach is more declarative and potentially more efficient, as it leverages the collection's internal structure to find the first non-disabled key in a single pass.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a4ab020 and 98bb6fb.

📒 Files selected for processing (1)
  • packages/components/autocomplete/src/use-autocomplete.ts (1 hunks)

@wingkwong wingkwong merged commit 557f10f into nextui-org:canary Oct 1, 2024
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants