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(@vben-core/menu-ui): fix horizontal layout top menu language switching issue(#4724) #4777

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

13982720426
Copy link
Contributor

@13982720426 13982720426 commented Oct 31, 2024

…ching issue(#4724)

Description

复现步骤:

  1. 水平布局
  2. 顶部菜单 中文或者英文菜单结尾出现更多时切换中英文
    image

原因:
image
sliceIndex.value变化时,defaultSlots未及时更新,拿到的是旧插槽

解决:
因为getSlot计算属性是依赖sliceIndex.value变化时更新,所以在更新getSlot时,重新执行slots.default?.()拿到新插槽内容

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 dynamic rendering of menu items based on the menu's state, particularly in collapsed mode.
    • Improved slot handling for better display of default and additional menu items.
  • Bug Fixes

    • Refined logic for determining menu display mode, ensuring accurate popup behavior.
  • Documentation

    • Updated descriptions for computed properties to reflect the latest changes in functionality.

Copy link

changeset-bot bot commented Oct 31, 2024

⚠️ No Changeset found

Latest commit: 8709608

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 Oct 31, 2024

Walkthrough

The changes in the menu.vue component involve enhancements to slot handling and menu item visibility computation. A new computed property, getSlot, is introduced to manage default slots and their organization into slotDefault and slotMore. The isMenuPopup computed property is updated to encapsulate logic related to the menu's mode and collapse state. Overall, these modifications refine the component's interaction with slots and improve the dynamic rendering of menu items without introducing new methods or significantly altering existing functionality.

Changes

File Change Summary
packages/@core/ui-kit/menu-ui/src/components/menu.vue - Added computed property: getSlot
- Updated defaultSlots to be defined within getSlot
- Encapsulated logic for menu popup in isMenuPopup

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

In the menu where options play,
Slots now dance in a brand new way.
With getSlot to guide their flight,
Collapsed or open, they shine so bright!
A rabbit's cheer for changes made,
In the UI's heart, new paths are laid! 🐇✨


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

🧹 Outside diff range and nitpick comments (1)
packages/@core/ui-kit/menu-ui/src/components/menu.vue (1)

75-77: Translate comment to English for consistency.

The Chinese comment "更新插槽内容" should be translated to English.

-  // 更新插槽内容
+  // Update slot content
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 353e8be and 8709608.

📒 Files selected for processing (1)
  • packages/@core/ui-kit/menu-ui/src/components/menu.vue (1 hunks)
🔇 Additional comments (2)
packages/@core/ui-kit/menu-ui/src/components/menu.vue (2)

Line range hint 75-91: Implementation successfully fixes the language switching issue.

The computed property getSlot correctly handles the menu items by:

  1. Updating slot content when sliceIndex changes
  2. Properly splitting items between default view and more menu
  3. Maintaining reactivity for language switching

Line range hint 75-91: Verify slot cleanup and edge cases.

Please ensure:

  1. Slots are properly cleaned up when components are destroyed
  2. The solution handles edge cases like:
    • Empty slots
    • Rapid language switching
    • Dynamic content updates
✅ Verification successful

Let me gather more specific information about the menu component's implementation and test coverage.


Let me check the component's implementation for any potential memory leaks or cleanup patterns.


Based on the analysis of the code, I can now provide the final response:

Slot handling implementation is safe and properly managed

The implementation is well-designed and handles cleanup appropriately:

  1. Slot content is managed through Vue's reactive system using computed properties, which automatically handle cleanup
  2. The component properly handles resize cleanup through resizeStopper?.() when mode changes
  3. Edge cases are properly handled:
    • Empty slots: slots.default?.() ?? []
    • Dynamic updates: Handled through Vue's reactivity
    • Content switching: Managed via sliceIndex computed value

The concerns raised in the review comment are already addressed by the existing implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for memory leak prevention patterns in component lifecycle hooks
ast-grep --pattern 'onBeforeUnmount($$$)' || ast-grep --pattern 'onUnmounted($$$)'

# Look for existing test cases covering edge cases
rg -l "test|spec|describe.*menu.*language" -g "*.{spec,test}.{ts,js,vue}"

Length of output: 2903


Script:

#!/bin/bash
# Check for slot-related cleanup in the menu component
rg -A 5 "slots?.default|originalSlot|slotMore" packages/@core/ui-kit/menu-ui/src/components/menu.vue

# Look for menu component tests
fd -g "*menu*.{spec,test}.{ts,js,vue}" packages/@core/ui-kit/menu-ui/

# Check for watch cleanup patterns
ast-grep --pattern 'watch($$$, {
  $$$
  immediate: $_
})'

Length of output: 29217


Script:

#!/bin/bash
# Check the menu component's implementation for computed properties and cleanup
rg -A 10 "computed|watch" packages/@core/ui-kit/menu-ui/src/components/menu.vue

# Look for slot handling and cleanup patterns
ast-grep --pattern 'const $_ = computed(() => {
  $$$
  const $_ = slots.default?.()
  $$$
})'

Length of output: 2555

@anncwb anncwb merged commit f78cc31 into vbenjs:main Oct 31, 2024
15 checks passed
GavinLucky pushed a commit to GavinLucky/vue-vben-admin that referenced this pull request Nov 4, 2024
@coderabbitai coderabbitai bot mentioned this pull request Nov 7, 2024
3 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 17, 2024
16 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Dec 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants