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

refactor(select): auto scroll selected item to center #3637

Open
wants to merge 4 commits into
base: canary
Choose a base branch
from

Conversation

better-owlet
Copy link

@better-owlet better-owlet commented Aug 12, 2024

Closes #

📝 Description

Auto scroll selected item to center

use scrollIntoView https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView

⛳️ 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):

No

📝 Additional Information

Before:

  • When the mouse is pressed down, the listbox triggers scrolling, causing flickering;
  • Selected item is not absolutely centered and is affected by the expanded animation
iShot_2024-08-12_15.43.14.mp4

After: selected item just scroll into the viewport, not centered

iShot_2024-08-12_15.44.11.mp4

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Introduced automatic scrolling to center the selected item in the dropdown list.
    • Enhanced accessibility and usability for lengthy selection lists.
  • Improvements
    • Simplified listbox scrolling behavior to automatically center the selected item in view.
    • Enhanced code readability and reduced complexity by utilizing built-in functionality.
    • Improved robustness through safe handling of potentially undefined elements.
  • Tests
    • Added type annotations for improved type safety in the test suite for the Select component.

Copy link

changeset-bot bot commented Aug 12, 2024

🦋 Changeset detected

Latest commit: 59261d8

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/select 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 Aug 12, 2024

@better-owlet is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Aug 12, 2024

Walkthrough

The recent updates to the useSelect function in use-select.ts streamline the scrolling behavior of the listbox by utilizing the built-in scrollIntoView method instead of manual calculations. This change improves code readability, reduces complexity, and ensures that the selected item is automatically centered in the view, enhancing the overall robustness and maintainability of the component. Additionally, type safety in tests has been improved.

Changes

Files Change Summary
packages/components/select/src/use-select.ts Simplified scrolling logic in useSelect by using scrollIntoView instead of manual calculations, enhancing readability and reducing complexity.
packages/components/select/__tests__/select.test.tsx Added type annotation to user variable in tests, improving type safety and code clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SelectComponent
    participant Listbox

    User->>SelectComponent: Select an item
    SelectComponent->>Listbox: Update selected item
    Listbox->>Listbox: scrollIntoView(selectedItem)
    Listbox-->>User: Item is now in view
Loading

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.
    • @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 as 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.

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

CodeRabbit Configuration 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.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1973864 and e6cb22f.

Files selected for processing (1)
  • packages/components/select/src/use-select.ts (1 hunks)
Additional comments not posted (1)
packages/components/select/src/use-select.ts (1)

350-350: Simplified scrolling logic with scrollIntoView.

The use of scrollIntoView improves code readability and reduces complexity by leveraging built-in browser functionality. The use of optional chaining ensures robustness.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e6cb22f and 827b5b0.

Files selected for processing (1)
  • .changeset/cold-beans-visit.md (1 hunks)
Additional comments not posted (1)
.changeset/cold-beans-visit.md (1)

1-5: Changeset is well-structured and clear.

The changeset correctly indicates a patch update for the @nextui-org/select package and provides a concise description of the change. This aligns with the PR summary and objectives.

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

please include a before and after video for demonstration

@better-owlet better-owlet changed the title refactor(select): auto scroll selected item to center [WIP]refactor(select): auto scroll selected item to center Aug 12, 2024
@better-owlet better-owlet changed the title [WIP]refactor(select): auto scroll selected item to center refactor(select): auto scroll selected item to center Aug 12, 2024
@wingkwong wingkwong self-assigned this Aug 14, 2024
Copy link

vercel bot commented Aug 15, 2024

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 Aug 15, 2024 4:39am

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

the flickering is still happening in the following case:

  • open select and select last item
  • open select, scroll to the top, click the select by clicking selector button
  • see the flickering
pr3637-comment.webm

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 827b5b0 and 59261d8.

Files selected for processing (3)
  • .changeset/cold-beans-visit.md (1 hunks)
  • packages/components/select/tests/select.test.tsx (1 hunks)
  • packages/components/select/src/use-select.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • .changeset/cold-beans-visit.md
  • packages/components/select/tests/select.test.tsx
Files skipped from review as they are similar to previous changes (1)
  • packages/components/select/src/use-select.ts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants