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

fix: header-mixed layout side-menu active #5265

Merged
merged 2 commits into from
Dec 30, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 30, 2024

Description

修复水平双列模式下的双列菜单中的一级菜单在点击时没有激活的问题。

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

Release Notes

  • Preferences

    • Updated default sidebar configuration to disable extra collapse functionality
  • Layout Improvements

    • Enhanced menu handling logic for mixed header and sidebar menus
    • Simplified active menu path determination
    • Improved menu selection and interaction mechanisms
  • Performance

    • Streamlined menu management functions
    • Increased flexibility in menu configuration

Copy link

changeset-bot bot commented Dec 30, 2024

⚠️ No Changeset found

Latest commit: 50b2524

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

Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • packages/@core/preferences/__tests__/__snapshots__/config.test.ts.snap is excluded by !**/*.snap

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request introduces modifications to the sidebar and menu handling across multiple files in the layout and preferences system. The changes primarily focus on refining the menu management logic, specifically altering the default sidebar preferences, updating the extra menu functionality, and simplifying the mixed menu handling. The modifications aim to provide more flexible menu configuration and improve the interaction between different menu components.

Changes

File Change Summary
packages/@core/preferences/src/config.ts Changed extraCollapse in sidebar configuration from true to false
packages/effects/layouts/src/basic/layout.vue Updated useExtraMenu call with mixHeaderMenus, simplified active-path prop
packages/effects/layouts/src/basic/menu/use-extra-menu.ts Added optional useRootMenus parameter, introduced parentLevel computed property
packages/effects/layouts/src/basic/menu/use-mixed-menu.ts Removed mixedSidebarActive computed property

Sequence Diagram

sequenceDiagram
    participant Layout as Layout Component
    participant ExtraMenu as useExtraMenu
    participant AccessStore as Access Store
    
    Layout->>ExtraMenu: Call with mixHeaderMenus
    ExtraMenu->>AccessStore: Retrieve menus
    ExtraMenu-->>Layout: Return extraActiveMenu, extraMenus
    Layout->>Layout: Update active menu path
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

🐰 Menus dancing, sidebar light
Collapsing rules now take flight
Flexibility springs anew
With CodeRabbit's coding brew
Menu magic, clear and bright! 🍃


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

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
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: 0

🧹 Nitpick comments (2)
packages/effects/layouts/src/basic/menu/use-extra-menu.ts (2)

35-35: Accurate Extraction of extraActiveMenu

Referencing menu.parents?.[parentLevel.value] ensures correct active menu tracking in mixed layouts. Be sure to test with parentless root menus to avoid undefined references.


74-74: Excess Blank Line

Minor nitpick: This lone blank line might not be necessary, but leaving it is stylistically acceptable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ff8d5ca and 53a8d10.

📒 Files selected for processing (4)
  • packages/@core/preferences/src/config.ts (1 hunks)
  • packages/effects/layouts/src/basic/layout.vue (2 hunks)
  • packages/effects/layouts/src/basic/menu/use-extra-menu.ts (6 hunks)
  • packages/effects/layouts/src/basic/menu/use-mixed-menu.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/effects/layouts/src/basic/menu/use-mixed-menu.ts
🔇 Additional comments (14)
packages/@core/preferences/src/config.ts (1)

74-74: No Extra Collapsing by Default

Setting extraCollapse to false ensures that the sidebar won’t have additional collapsible behavior by default. Validate with UI tests to ensure this matches user expectations for the default layout.

packages/effects/layouts/src/basic/menu/use-extra-menu.ts (11)

3-3: Ensure Dependency Imports are Used Properly

The addition of ComputedRef is valid, but confirm that you remove any unused imports to keep the file clean.


12-12: Increased Flexibility in useExtraMenu

Accepting useRootMenus as an optional parameter is a neat approach to allow external menu definitions, improving reusability.


16-16: Fallback Logic for Menus

Using useRootMenus?.value ?? accessStore.accessMenus ensures a robust fallback. Double-check that useRootMenus properly resolves before usage to prevent runtime errors.


25-27: Dynamic Parent Level Computation

Good job introducing parentLevel based on the layout preference. Verify that all calling code accounts for both header-mixed-nav and other modes to prevent unexpected results.


60-60: Consistent Setting of Active Menu

Reusing menu.parents?.[parentLevel.value] ?? menu.path maintains consistency across layouts. Great move for preventing logic divergence.


75-78: Enhanced Readability with findRootMenuByPath

Locating menus by path simplifies understanding the active and root menus. Ensure thorough tests for complex nested menu structures.


79-79: Setting extraActiveMenu to Fallback

Defaulting to rootMenuPath or findMenu?.path covers edge cases for root-level items, which is crucial for robust menu highlighting.


80-80: Populating extraMenus with Root Menu Children

Setting extraMenus to rootMenu?.children ?? [] ensures the side extra menu displays all relevant subitems. Validate that empty arrays behave correctly in the UI.


87-87: Consistent Menu Highlighting on Hover

Using menu.parents?.[parentLevel.value] ?? menu.path again grants consistency in highlight logic for hovered items. Check ephemeral states quickly in QA cycles.


97-97: Invoking findRootMenuByPath with parentLevel

This helps adapt root menu lookups dynamically. Make sure the path detection logic is accurate, especially with nested or unusual route structures.


99-102: Storing and Restoring Submenus

Storing the path in defaultSubMap and updating extraRootMenus, extraActiveMenu, and extraMenus collectively ensures the UI remains in sync. Good job centralizing these updates.

packages/effects/layouts/src/basic/layout.vue (2)

110-119: Optional Parameter Usage in useExtraMenu

Passing mixHeaderMenus to useExtraMenu elegantly extends the menu source. Confirm that all relevant computed and reactive data in mixHeaderMenus is stable before passing it in to avoid race conditions.


277-277: Unified active-path Prop

Replacing the conditional expression with :active-path="extraActiveMenu" simplifies the logic and extinguishes potential branching inconsistencies between mixed nav states. Well done.

@mynetfan mynetfan merged commit 2eb7fed into vbenjs:main Dec 30, 2024
13 checks passed
@mynetfan mynetfan deleted the fix/header-mixed-active branch December 30, 2024 07:24
little-alei pushed a commit to little-alei/vue-vben-admin that referenced this pull request Jan 6, 2025
* fix: header-mixed layout side-menu active

* fix: config test
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