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

Update dependency array on setPage #2942

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

jesuzon
Copy link

@jesuzon jesuzon commented May 4, 2024

Changes:
Add the onChange function to the dependency array of the setPage callback to ensure it always reflects the latest state.

Impact:
This fix ensures that the pagination component accurately reflects the current state when triggering onChange.

Closes #

📝 Description

This fixes an issue where search parameters were not updated correctly when changing pages in the pagination component. The root cause was the missing onChange dependency in the setPage callback function, which prevented the correct state from being passed on page changes.

⛳️ Current behavior (updates)

Currently, state is memoized during onChange after page changes, meaning that writing onChange handlers do not always contain current state. This was causing issues with hooks such as useSearchParams, where the search params would not be fully up-to-date

🚀 New behavior

Adding onChange to the callback dependencies ensures state is refreshed.

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

Should not break anything.

📝 Additional Information

Summary by CodeRabbit

  • Refactor
    • Improved the responsiveness of the pagination feature by ensuring changes are effectively tracked and updated.

This fixes an issue where search parameters were not updated correctly when changing pages in the pagination component. The root cause was the missing onChange dependency in the setPage callback function, which prevented the correct state from being passed on page changes.

Changes:
Add the onChange function to the dependency array of the setPage callback to ensure it always reflects the latest state.

Impact:
This fix ensures that the pagination component accurately reflects the current state when triggering onChange.
@jesuzon jesuzon requested a review from jrgarciadev as a code owner May 4, 2024 10:31
Copy link

changeset-bot bot commented May 4, 2024

⚠️ No Changeset found

Latest commit: d17a98d

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 May 4, 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 May 4, 2024 10:33am

Copy link

vercel bot commented May 4, 2024

@jesuzon 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 May 4, 2024

Walkthrough

The update in the usePagination function involves a modification to the useEffect hook's dependency array, specifically adding the onChange function. This change ensures that the effect re-runs whenever onChange is updated, potentially improving the responsiveness and accuracy of pagination behavior.

Changes

File Change Summary
.../use-pagination/src/index.ts Updated dependency array in useEffect to include onChange.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between f28b1e9 and d17a98d.
Files selected for processing (1)
  • packages/hooks/use-pagination/src/index.ts (1 hunks)
Additional comments not posted (1)
packages/hooks/use-pagination/src/index.ts (1)

85-85: Dependency array updated to include onChange.


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.

@jesuzon
Copy link
Author

jesuzon commented May 4, 2024

Fix to this open bug issue: #2417

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.

why not onChangeActivePage?

@jesuzon
Copy link
Author

jesuzon commented May 4, 2024

why not onChangeActivePage?

I supposed they are equivalent in this context, one calls the other anyway - I have tested and that works as well.

@wingkwong
Copy link
Member

@jesuzon setPage doesn't depend on onChange. I could set the active page without triggering onChange.

@jesuzon
Copy link
Author

jesuzon commented May 5, 2024

@jesuzon setPage doesn't depend on onChange. I could set the active page without triggering onChange.

Changing the active page the intended documented way (using setPage rather than changing the internal state directly using setActivePage which you technically can’t do directly I think) triggers an onChange by calling onChangeActivePage:

const onChangeActivePage = (newPage: number) => { setActivePage(newPage); onChange && onChange(newPage); };

Do you want me to make a different commit adding onChangeActivePage instead of onChange? Either way, it should fix the issue I tagged above

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.

None yet

2 participants