fix(docs): fix the selected state of the top navigation bar

[QFifteen]

Description

• 修复顶部导航栏的选中状态
• 新增顶部导航栏选中样式-底部边框，参阅 Vue官方文档

Before:

---

After:

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Enhanced navigation structure with improved active state highlighting for documentation and guide items in both English and Chinese versions.
  • Introduced new CSS styles for the top navigation bar to provide better visual feedback for active navigation links.

• Bug Fixes

  • Resolved issues with navigation item highlighting to ensure correct items are displayed as active based on user location.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1b0be29

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

[coderabbitai]

Walkthrough

The changes involve updates to the navigation configuration in both English and Chinese documentation files, enhancing the routing logic by adding activeMatch properties to various navigation items. Additionally, new CSS styles are introduced to improve the visual feedback of the active state in the navigation bar.

Changes

Files	Change Summary
docs/.vitepress/config/en.mts, docs/.vitepress/config/zh.mts	Added activeMatch properties to navigation items for "Doc", "Guide", and "Components" in both English and Chinese configurations to improve route matching.
docs/.vitepress/theme/styles/base.css	Introduced new CSS styles for active navigation links and groups, enhancing visual feedback with border-bottom styles.

Suggested labels

bug

🐰 In the nav, we hop and play,
With active paths to guide our way.
In styles so bright, we find our cheer,
A clearer route, oh what a year!
So let us dance, with links so fine,
A joyful path, forever shine! ✨

---

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.

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

docs/.vitepress/theme/styles/base.css (2)

13-15: LGTM! Consider adding an English translation to the comment.

The selectors are appropriately targeting the navigation bar elements. Good job on including a comment to explain the purpose of these styles.

Consider adding an English translation to the comment for better accessibility to non-Chinese speaking developers. For example:

/* 顶部导航栏选中项样式 (Top navigation bar selected item style) */

---

16-22: LGTM! Consider adding a transition for smoother state changes.

The CSS rules effectively implement the desired visual feedback for active navigation items. The use of a transparent border for inactive items and changing only the border color for active items is a good approach to prevent layout shifts.

To enhance the user experience, consider adding a smooth transition effect for the border color change. This can be achieved by adding a transition property to the base styles:

 .VPNavBarMenuLink,
 .VPNavBarMenuGroup {
   border-bottom: 1px solid transparent;
+  transition: border-color 0.3s ease;
 }

This will create a subtle animation when the navigation items become active or inactive, potentially improving the overall feel of the interface.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 79c87c9 and 1b0be29.

Files selected for processing (3)

• docs/.vitepress/config/en.mts (1 hunks)
• docs/.vitepress/config/zh.mts (1 hunks)
• docs/.vitepress/theme/styles/base.css (1 hunks)

Additional comments not posted (5)

docs/.vitepress/theme/styles/base.css (1)

12-22: Overall, these changes effectively address the PR objectives.

The added CSS rules successfully implement the visual feedback for the selected state of the top navigation bar. The approach used is clean and efficient, preventing layout shifts and likely matching the theme's brand color.

A few minor suggestions have been made to further enhance the code:

1. Adding an English translation to the comment for better accessibility.
2. Implementing a smooth transition effect for a more polished user experience.

These changes align well with the PR's goal of fixing the selected state of the top navigation bar and should improve the overall user interface.

docs/.vitepress/config/zh.mts (4)

179-181: LGTM: Improved navigation highlighting for Documentation section

The addition of the activeMatch property for the "文档" (Documentation) navigation item is a good improvement. It ensures that this item remains highlighted when users are viewing either the guide or components sections, which enhances the user experience by providing clear visual feedback about their current location in the documentation.

---

183-186: LGTM: Enhanced navigation highlighting for Guide section

The addition of the activeMatch property for the "指南" (Guide) navigation sub-item is a good improvement. It ensures that this item is correctly highlighted when users are specifically viewing the guide section. This change provides more granular control over the navigation highlighting, improving the overall user experience.

---

188-191: LGTM: Completed navigation highlighting improvements

The addition of the activeMatch property for the "组件" (Components) navigation sub-item completes the set of improvements to the navigation highlighting. This change, along with the previous two, ensures that each section of the documentation (主文档, 指南, and 组件) is correctly highlighted in the navigation bar based on the user's current location.

These changes collectively address the PR objective of fixing the selected state of the top navigation bar. They provide a more intuitive and responsive navigation experience for users of the Chinese version of the documentation.

---

179-191: Summary: Navigation highlighting improvements successfully implemented

The changes made to the Chinese documentation configuration file (docs/.vitepress/config/zh.mts) successfully address the PR objective of fixing the selected state of the top navigation bar. The addition of activeMatch properties to the main documentation item and its sub-items (Guide and Components) ensures accurate highlighting based on the user's current location within the documentation.

These improvements enhance the user experience by providing clear visual feedback about the current section being viewed. The implementation is consistent and uses correct regex patterns for URL matching.

Next steps:

1. Ensure that similar changes are applied to the English version of the configuration file (if not already done).
2. Consider adding a test case to verify the correct highlighting of navigation items based on different URL paths.
3. Update the documentation to reflect these changes in the navigation behavior, if necessary.

Great work on improving the navigation experience!