fix(use-pagination): controlled page after delay

[wingkwong]

Closes #4522

📝 Description

If a user sets page = 0 initially, awaiting for API to respond the value. In this case, after page returned by API got updated. The cursor hasn't moved to the corresponding item.

The reason is by default activePage is 1 based page or initialPage. In this case, API responds 1 which is same as activePage, hence it won't trigger scrollTo. This PR is to add page to dependency array to trigger scrollTo.

⛳️ Current behavior (updates)

see the video from the issue

🚀 New behavior

pr4536-demo.webm

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

No

📝 Additional Information

Summary by CodeRabbit

• Dependencies
  • Updated @nextui-org/pagination to a patch version
• Improvements
  • Enhanced pagination scrolling behavior to better respond to page changes
• Bug Fixes
  • Improved page scrolling functionality for more accurate page navigation

[linear]

ENG-1846 [BUG] - Pagination controlled page number does not update when setting total after delay

[changeset-bot]

🦋 Changeset detected

Latest commit: 3cb4e3c

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/pagination	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

[vercel]

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	Jan 12, 2025 3:59am
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 12, 2025 3:59am

[coderabbitai]

Walkthrough

This pull request addresses a pagination bug related to page updates when total items change after a delay. The changes involve adding the page prop to the dependency array in the usePagination hook's useEffect, ensuring that scrolling behavior correctly responds to page changes. A changeset entry was also added to track the dependency update for @nextui-org/pagination.

Changes

File	Change Summary
.changeset/stale-days-sniff.md	Added patch version for @nextui-org/pagination dependency
packages/components/pagination/src/use-pagination.ts	Added page to useEffect dependency array for scrolling functionality

Assessment against linked issues

Objective	Addressed	Explanation
Pagination page not updating with delayed total [#4522]	✅

Possibly related PRs

• Update dependency array on setPage useCallback hook #3029: Updates to usePagination hook dependency array
• fix(pagination): missing animation in pagination #3144: Pagination component animation improvements
• fix(pagination): cursor position when hidden on init #4222: usePagination function cursor positioning modifications

Suggested labels

🐛 Type: Bug

Suggested reviewers

• jrgarciadev

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eada8cb and 3cb4e3c.

📒 Files selected for processing (2)

• .changeset/stale-days-sniff.md (1 hunks)
• packages/components/pagination/src/use-pagination.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .changeset/stale-days-sniff.md

🔇 Additional comments (2)

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

Line range hint 290-309: Robust implementation with proper safeguards!

The effect implementation is well-designed with:

• Visibility checks to prevent incorrect scroll offsets
• Proper animation state management
• Clean timer handling

---

301-301: LGTM! Adding page to dependencies fixes the cursor movement issue.

The addition of page to the dependency array ensures that the scroll effect re-runs when the page value is updated by the API, fixing the issue where the cursor wasn't moving when the API returned a matching page value.

A few considerations to verify:

1. The effect runs with the correct timing relative to API updates
2. No unnecessary re-renders occur due to the additional dependency

✅ Verification successful

✅ The page dependency addition is safe and necessary

The implementation correctly handles scroll behavior when the page changes, with proper safeguards:

• Only scrolls when the pagination is visible
• Includes animation skip logic to prevent visual glitches
• No conflicting scroll behaviors or potential infinite loops

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential infinite loops or unnecessary re-renders
# Look for other useEffects that might conflict with this one

rg -B 5 -A 5 'useEffect.*page.*scrollTo'

Length of output: 42

---

Script:

#!/bin/bash
# Find useEffect declarations in the pagination component
ast-grep --pattern 'useEffect(() => {
  $$$
})'

# Also search for scrollTo-related code
rg -B 3 -A 3 'scrollTo'

Length of output: 10725

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.