Skip to content

Fixed layout shift issue when Search popup appears #22539

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Fixed layout shift issue when Search popup appears #22539

wants to merge 6 commits into from

Conversation

xudongcc
Copy link

@xudongcc xudongcc commented Mar 18, 2025 •
edited
Loading

Fix #22538
Reference #21895

Got some code for us? Awesome 🎊!

Please include a description of your change & check your PR against this list, thanks!

  • There's a clear use-case for this code change, explained below
  • Commit message has a short title & references relevant issues
  • The build will pass (run yarn test:all and yarn lint)

We appreciate your contribution!

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 18, 2025 •
edited
Loading

Walkthrough

The pull request introduces changes within the App component of the application. A new state variable, scrollbarWidth, is added and initialized to 0. During the component mounting phase, the getScrollbarWidth() method is executed to dynamically calculate the browser scrollbar width by temporarily creating and measuring a div element. In the componentDidUpdate lifecycle method, when the popup display state changes, the code updates the body's margin-right property by adding or subtracting the computed scrollbarWidth. This update ensures that any potential layout shift, which may occur when the popup is shown or hidden and the scrollbar is toggled, is mitigated. The changes strictly involve the calculation of the scrollbar width and the corresponding adjustment of the layout margin.

Assessment against linked issues

Objective Addressed Explanation
Prevent layout shift when the search popup opens with scrollbar visible (#22538) ✅

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 388c860 and 40aeb06.

📒 Files selected for processing (1)
  • apps/sodo-search/src/App.js (3 hunks)
🔇 Additional comments (5)
apps/sodo-search/src/App.js (5)

28-29: State initialization for scrollbar width is implemented correctly.

Adding the scrollbarWidth state property is the first step in addressing the layout shift issue. This will store the browser's scrollbar width, which can vary between browsers and operating systems.

36-37: Appropriate scrollbar width calculation at component mount.

Calculating the scrollbar width during component mounting ensures it's available before the popup is shown. The implementation correctly sets this value in the component state.

49-53: Good implementation for preventing layout shift when the popup opens.

This code properly:

  1. Stores the current body margin before modifying it
  2. Adds the scrollbar width to the margin only when necessary (when content is taller than viewport)
  3. Uses calc() to preserve any existing margin values

This approach effectively prevents the layout shift when the scrollbar disappears as the popup opens.

57-61: Proper margin restoration when the popup closes.

The implementation correctly handles different scenarios:

  1. When there was no margin or margin was 0px, it removes the margin property entirely
  2. Otherwise, it restores the exact previous margin value

This ensures the layout returns to its original state when the popup is closed.

106-121: Well-implemented scrollbar width calculation method.

The getScrollbarWidth method correctly:

  1. Creates a temporary div with a forced scrollbar
  2. Calculates the width difference between offsetWidth and clientWidth
  3. Cleans up by removing the temporary element

I note that the previously identified issue with redundant DOM operations has been fixed.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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.
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed Mar 18, 2025
View reviewed changes
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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6183be and e31ecef.

📒 Files selected for processing (1)
  • apps/sodo-search/src/App.js (3 hunks)
🔇 Additional comments (4)
apps/sodo-search/src/App.js (4)

28-29: State variable addition looks good.

Adding the scrollbarWidth state variable to track the browser's scrollbar width is a good approach for addressing the layout shift issue.

36-38: Proper initialization in componentDidMount.

Good implementation of scrollbar width calculation during component initialization. This ensures the value is available before the popup is first displayed.

49-54: Good implementation for opening popup.

Storing the current margin-right value and then adding the scrollbar width when the popup opens is a solid approach to prevent layout shift. The conditional check ensures that the margin is only adjusted when there's a scrollbar width to account for.

57-61: Good implementation for closing popup.

The conditional handling for different margin scenarios when closing the popup is well implemented. It correctly handles cases where the original margin was 0px or empty, ensuring the DOM returns to its original state.

@xudongcc xudongcc changed the title Fixed layout shift issue when Search popup appears Daft: Fixed layout shift issue when Search popup appears Mar 18, 2025
@xudongcc xudongcc changed the title Daft: Fixed layout shift issue when Search popup appears Fixed layout shift issue when Search popup appears Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

When the search popup window opens and the browser scrollbar is visible, it causes layout shift.
1 participant
@xudongcc