fix: userDropdown triggered unnecessary while overlay shown

[mynetfan]

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

• Refactor
  • Enhanced hover detection behavior for interactive elements, ensuring more accurate and responsive pointer events.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c56b2cf

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 modify the useHoverToggle function in use-hover-toggle.ts by replacing the useMouseInElement hook with useElementHover. The variable tracking outside states is renamed to better reflect its new purpose of monitoring hover states. The logic now checks if all elements are not hovered instead of whether they are outside, and a new computed property (eleRef) is added for validation and typing of the element reference. The delay function and watcher remain unchanged, while the overall control flow is adjusted to focus on hover events.

Changes

File Path	Change Summary
packages/.../src/use-hover-toggle.ts	Replaced useMouseInElement with useElementHover; renamed isOutsides to isHovers; updated isOutsideAll logic; added computed property eleRef.

Sequence Diagram(s)

sequenceDiagram
    participant Component
    participant useHoverToggle
    participant useElementHover
    participant Watcher

    Component->>useHoverToggle: Call useHoverToggle(ref, delay)
    useHoverToggle->>useElementHover: Initialize hover tracking
    useElementHover-->>useHoverToggle: Return hover state
    useHoverToggle->>useHoverToggle: Compute isHovers via hover state updates
    useHoverToggle->>Watcher: Watch for hover state changes
    Watcher->>useHoverToggle: Trigger setValueDelay on change

Loading

Possibly related PRs

• fix: sidebar header height #5183: Addresses hover-related behavior in the layout sidebar component, connecting with changes to handle hover states.
• feat: user-dropdown support hover trigger #5143: Enhances the UserDropdown component which utilizes the useHoverToggle hook for managing hover interactions.

Suggested labels

bug

Suggested reviewers

• anncwb
• vince292007

Poem

Oh, I’m the rabbit dancing through the code,
A hop and a skip on a brand-new road.
Hover replaced the old “mouse out” tale,
In every computed line, I set sail.
Bugs now fade like shadows in the night,
Celebrating change with pure delight!
🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/effects/hooks/src/use-hover-toggle.ts

Oops! Something went wrong! :(

ESLint: 9.19.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

---

📜 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 e7b0097 and c56b2cf.

📒 Files selected for processing (1)

• packages/effects/hooks/src/use-hover-toggle.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Lint (windows-latest)
• GitHub Check: Test (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: post-update (windows-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (5)

packages/effects/hooks/src/use-hover-toggle.ts (5)

5-5: LGTM! Good choice of hooks.

The switch to useElementHover is a more appropriate choice for handling hover states, as it provides a cleaner and more focused API compared to useMouseInElement.

Also applies to: 9-9

---

21-21: LGTM! Clear and descriptive variable naming.

The rename from isOutsides to isHovers better reflects the array's purpose of storing hover states.

---

26-29: LGTM! Robust element reference handling.

The computed property provides proper type checking and validation, handling both direct Element references and Vue component references safely.

---

30-31: LGTM! Clean hover state management.

The use of useElementHover provides a more direct and reliable way to track hover states, which should help prevent the dropdown from being triggered unnecessarily.

---

33-33: Verify behavior with multiple elements.

The logic for checking if all elements are not hovered looks correct. However, please verify the behavior when:

1. Multiple dropdowns are present
2. Rapidly moving between elements
3. Hovering over overlapping elements

To help verify these scenarios, you can add test cases like:

describe('useHoverToggle', () => {
  it('handles multiple elements correctly', async () => {
    const el1 = document.createElement('div')
    const el2 = document.createElement('div')
    const [value] = useHoverToggle([el1, el2])
    
    // Simulate hover on first element
    await fireEvent.mouseEnter(el1)
    expect(value.value).toBe(true)
    
    // Simulate hover on second element while first is still hovered
    await fireEvent.mouseEnter(el2)
    expect(value.value).toBe(true)
    
    // Simulate mouse leave from both elements
    await fireEvent.mouseLeave(el1)
    await fireEvent.mouseLeave(el2)
    expect(value.value).toBe(false)
  })
})

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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