fix(site): fix scroll bugs

[shenjunjian]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features

  • Enhanced scrolling behavior for improved user experience.
  • Updated layout for better responsiveness across different screen sizes.

• Bug Fixes

  • Adjusted layout structure to ensure consistent visibility and functionality of components.

• Documentation

  • Improved clarity in the layout and component interactions for users.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the components.vue and layout.vue files. In components.vue, the template structure and JavaScript logic have been updated, particularly affecting scrolling behavior and layout adjustments. The layout.vue file has seen updates to its template and style sections to improve responsiveness and maintain the existing functionality. Both files have undergone structural changes without altering any exported or public entity declarations.

Changes

File Path	Change Summary
examples/sites/src/views/components/components.vue	Modified template structure, removed position: sticky from docs-header, adjusted scrolling logic with a fixed offset of 52 pixels, and streamlined the loadPage function.
examples/sites/src/views/layout/layout.vue	Updated template structure with overflow: hidden auto;, ensured responsive design with media queries, and retained existing menu interaction logic.

Possibly related PRs

• feat(docs): the official website adds API anchor function #2366: Enhances routing and state management functionalities in components.vue, aligning with the main PR's updates.
• docs: fix demo anchor position not correct #2391: Addresses issues with demo anchor positions, directly related to scrolling behavior changes in components.vue.
• fix(site): fix Popper layers separate when scrolling through document #2502: Focuses on fixing Popper layer separation during scrolling, connecting to the main PR's updates to scrolling logic.

Suggested labels

bug

Suggested reviewers

• zzcr

🐇 In the meadow, where rabbits play,
Changes to components brighten the day.
Scrolling fixed, and layouts refined,
A hop, a skip, all perfectly aligned!
With every click, the menus respond,
A joyful dance, of which we're so fond! 🌼

---

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 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.

[github-actions]

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

examples/sites/src/views/layout/layout.vue (1)

343-346: LGTM! The scroll fixes look good.

The changes properly address scroll issues by:

• Using flex-grow: 1 to fill available space
• Enabling vertical scrolling with overflow: hidden auto
• Setting explicit dimensions with width: 100% and height: calc(100vh - 60px)

Consider adding a fallback for browsers that don't support calc():

 #doc-layout {
   display: flex;
   flex-direction: column;
   flex-grow: 1;
   overflow: hidden auto;
   width: 100%;
+  height: 100vh; /* Fallback for browsers that don't support calc() */
   height: calc(100vh - 60px);
 }

examples/sites/src/views/components/components.vue (2)

487-492: LGTM! Consider extracting the magic number.

The scroll offset logic correctly compensates for the tab-title height. However, the hardcoded value of 52 pixels could be moved to a constant for better maintainability.

+const TAB_TITLE_HEIGHT = 52;
+
 document.getElementById('doc-layout-scoller').scrollTo({
-  top: scrollTarget.offsetTop + 52,
+  top: scrollTarget.offsetTop + TAB_TITLE_HEIGHT,
   left: 0,
   behavior: 'smooth'
 })

---

20-20: Fix typo in scroll container id.

The id "doc-layout-scoller" contains a typo (should be "scroller"). While it works as is since it's used consistently, consider fixing it for better code clarity.

-<div class="docs-content" id="doc-layout-scoller">
+<div class="docs-content" id="doc-layout-scroller">

-document.getElementById('doc-layout-scoller').scrollTo({
+document.getElementById('doc-layout-scroller').scrollTo({

Also applies to: 489-489

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b611d79 and c67df0d.

📒 Files selected for processing (2)

• examples/sites/src/views/components/components.vue (2 hunks)
• examples/sites/src/views/layout/layout.vue (1 hunks)

🔇 Additional comments (1)

examples/sites/src/views/components/components.vue (1)

487-492: LGTM! Scroll styles are well-implemented.

The scroll-related styles are properly implemented with:

• Correct overflow handling
• Smooth transitions
• Proper z-index management