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

Enable scroll restoration #148

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

Conversation

VinSpee
Copy link

@VinSpee VinSpee commented Dec 9, 2024

This PR enables scroll restoration for the app, using next.js's experimental scrollRestoration feature, which overrides the default browser behavior of restoring the scroll position to the last saved position.

The scenario is this:

  1. User navigates to a page with a scrollable content.
  2. User scrolls down to the bottom of the page.
  3. User navigates to another page.
  4. User navigates back to the previous page.
  5. Result
  • Expected behavior: The scroll position is restored to the last saved position, which is the bottom of the page.
  • Actual behavior: The scroll position is restored to the top of the page.

This is my first contribution to this repo, let me know if I'm missing anything!

Thanks for your great work.

Summary by CodeRabbit

  • New Features
    • Introduced experimental scroll restoration feature for improved navigation experience.

This PR enables scroll restoration for the app, using next.js's experimental `scrollRestoration` feature,
which overrides the default browser behavior of restoring the scroll position to the last saved position.

The scenario is this:

1. User navigates to a page with a scrollable content.
2. User scrolls down to the bottom of the page.
3. User navigates to another page.
4. User navigates back to the previous page.
5. Result
  - Expected behavior: The scroll position is restored to the last saved position, which is the bottom of the page.
  - Actual behavior: The scroll position is restored to the top of the page.
Copy link

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request involve modifications to the next.config.js file, specifically introducing an experimental feature for scroll restoration. This is achieved by adding an experimental object with a scrollRestoration property set to true. Additionally, the remotePatterns array has been restructured, although the overall configuration structure remains unchanged, preserving existing properties like output, images, reactStrictMode, and publicRuntimeConfig.

Changes

File Change Summary
next.config.js Added experimental object with scrollRestoration: true. Reformatted remotePatterns array.

Poem

In the land of code where rabbits hop,
A scroll restoration feature takes the top!
With patterns restructured, neat and bright,
Our config shines, oh what a sight!
Hopping along, we cheer with glee,
For smoother scrolling, just wait and see! 🐇✨


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.

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

@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)
next.config.js (1)

10-57: LGTM: Well-structured remote patterns with secure configuration

The remote patterns are well-organized and properly secured with HTTPS. However, the empty port specification is redundant for HTTPS URLs.

Consider removing the empty port specifications to reduce config verbosity:

 {
   protocol: 'https',
   hostname: 'image.tmdb.org',
-  port: '',
   pathname: '/**',
 },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4ccbb64 and a687968.

📒 Files selected for processing (1)
  • next.config.js (1 hunks)
🔇 Additional comments (1)
next.config.js (1)

3-5: Verify experimental feature stability

While the implementation correctly enables scroll restoration, please note that this is using an experimental Next.js feature which may have stability implications or break in future versions.

Let's check the Next.js version and documentation:

Consider:

  1. Adding a comment explaining why this experimental feature is needed
  2. Creating a tracking issue to monitor the feature's stability status in future Next.js releases
✅ Verification successful

Experimental scroll restoration feature is appropriate for Next.js 13.4

The scroll restoration feature is a stable experimental feature in Next.js 13.4.x, and its usage here is appropriate. The implementation is clean and follows the official configuration pattern. Since this is the only experimental feature enabled and it addresses a specific UX need, the potential stability risks are contained.

  • The feature is enabled in a standard way through the experimental config object
  • Using Next.js version 13.4.19 where this feature is well-documented
  • No other experimental features are enabled, minimizing potential stability issues
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check Next.js version and whether this feature is still experimental
cat package.json | jq '.dependencies.next, .devDependencies.next'

# Look for any existing experimental features
rg -l "experimental.*scrollRestoration" 

Length of output: 125


Script:

#!/bin/bash
# Let's check if there are any existing experimental features in next.config.js
cat next.config.js

# Let's also check if there are any documented issues or discussions about this feature
rg -i "scroll.*restoration" README.md CHANGELOG.md

Length of output: 1672

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.

1 participant