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(docs): error in select all table doc #2717

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

Conversation

kuri-sun
Copy link
Member

@kuri-sun kuri-sun commented Apr 15, 2024

Closes #2313

📝 Description

When I select all in the table with 100 data(10 rows per page), go to the next page and uncheck one of the rows.
It says "9 items are selected", however, it should say "99" not "9".

⛳️ Current behavior (updates)

prev.mov

🚀 New behavior

Here is the new behavior!✌️ I would like you to let me know that this behavior meets the requirements. Thank you! 😄

  • By selecting all rows initially and then allowing the user to deselect specific rows.
new.mov

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Enhanced multi-page selection management in the Table component, allowing for page-specific selections.
    • Added functions for bulk selection updates and checks on selection states across pages.

@kuri-sun kuri-sun added the 🐛 Type: Bug Something isn't working label Apr 15, 2024
@kuri-sun kuri-sun self-assigned this Apr 15, 2024
Copy link

changeset-bot bot commented Apr 15, 2024

⚠️ No Changeset found

Latest commit: ec8b4d2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link

vercel bot commented Apr 15, 2024

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 Apr 15, 2024 1:11pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview Apr 15, 2024 1:11pm

Copy link
Contributor

coderabbitai bot commented Apr 15, 2024

Walkthrough

The update primarily revises the selectedKeys management within the Page component of the NextUI Table. It shifts from a singular set to an object that holds selections specific to each page, enhancing how selections are maintained when navigating through pagination. This adjustment also includes new functionalities for bulk selection updates and a refined method to check if all rows are unselected.

Changes

File Path Change Summary
apps/docs/app/.../table/use-case/page.tsx Updated selectedKeys to use page-specific objects; added bulk selection functions.

Assessment against linked issues

Objective Addressed Explanation
Bug fix for selecting all across pages (#2313)

Poem

🐇✨
In the fields of code, where tables lay,
A clever rabbit found a better way.
With keys in hand, and pages turned,
No row unchecked, no stone unturned.
Celebrate the fix, hip hip hooray! 🎉
🐇✨


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between abf532b and ec8b4d2.
Files selected for processing (1)
  • apps/docs/app/examples/table/use-case/page.tsx (5 hunks)
Additional comments not posted (4)
apps/docs/app/examples/table/use-case/page.tsx (4)

263-263: Initialization of selectedKeys using an object to track selections per page is a good approach to solve the issue with cross-page selection.


318-320: Ensure that selectedKeysInCurrentPage correctly handles cases where no keys are selected on the current page by initializing with an empty set.


412-436: The bulkUpdateSelectedKeys function correctly updates all pages to the new selection state. The isUnselectAllRows function correctly identifies when all rows are unselected. Both functions are well-implemented for managing selections across multiple pages.


438-452: The onSelectionChange function handles updates to the selection state based on user interactions. It correctly uses the bulkUpdateSelectedKeys and isUnselectAllRows functions to manage the state. Ensure thorough testing to confirm that selections are correctly updated across pages.


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.

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: 1

@kuri-sun kuri-sun changed the title Docs/components/error in select all table doc fix(docs): error in select all table doc Apr 15, 2024
@kuri-sun kuri-sun requested a review from wingkwong April 21, 2024 14:11
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.

Here's the case you may take a look.

  1. select all and see 20 of 20 selected (which is ok)
  2. type fisher in "Search by name ..." input to filter
  3. you will see 20 of 1 selected
image
  1. unselect all, it shows 15 of 1 selected
image

@kuri-sun
Copy link
Member Author

Here's the case you may take a look.

  1. select all and see 20 of 20 selected (which is ok)
  2. type fisher in "Search by name ..." input to filter
  3. you will see 20 of 1 selected
image 4. unselect all, it shows `15 of 1 selected` image

That was really good catch, thanks, Marcus. I will fix that later today!

@wingkwong wingkwong changed the base branch from main to canary April 28, 2024 14:50
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.

[BUG] - error in selecting all
2 participants