feat(hooks): support separate enter/leave delays in useHoverToggle

[broBinChen]

Description

Enhanced the useHoverToggle hook to support independent delay configurations for mouse enter and leave events, while maintaining full backward compatibility with existing implementations.

Key Changes

• Separate Delay Configuration: Added support for configuring different delays for mouse enter and leave events through a new HoverDelayOptions interface
• Enhanced User Experience: Default behavior now provides immediate enter response (0ms) and delayed leave response (500ms) for better interaction patterns
• Improved Timer Management: Replaced single timer with separate enterTimer and leaveTimer for better control and prevention of timing conflicts
• Full Backward Compatibility: All existing usage patterns continue to work without any code changes

New Interface

interface HoverDelayOptions {
  /** Mouse enter delay time, defaults to 0 (immediate response) */
  enterDelay?: (() => number) | number;
  /** Mouse leave delay time, defaults to 500ms */
  leaveDelay?: (() => number) | number;
}

Usage Examples

Existing usage (fully compatible):

const [isHover] = useHoverToggle(elementRef, 500);

New enhanced usage:

const [isHover] = useHoverToggle(elementRef, {
  enterDelay: 0,      // Immediate enter
  leaveDelay: 800     // 800ms leave delay
});

Benefits

• Better UX: Immediate enter response improves interaction responsiveness
• Flexible Configuration: Support for static numbers, dynamic functions, and object configurations
• Type Safety: Full TypeScript support with comprehensive type definitions
• Performance: Independent timers prevent interference between enter/leave events

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
  • Added support for configuring separate delays for mouse enter and leave events when toggling hover state.
  • Users can now specify custom enter and leave delays for hover interactions, allowing for more precise control over hover behavior.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 50a927f

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 useHoverToggle hook was updated to support separate, configurable delays for mouse enter and leave events by introducing the HoverDelayOptions interface. The hook now accepts either a single delay value, a function, or an options object, providing more granular control over hover state timing. Timers and cleanup logic were adjusted accordingly.

Changes

File(s)	Change Summary
packages/effects/hooks/src/use-hover-toggle.ts	Refactored to support separate enter/leave delays via HoverDelayOptions; updated function signature; added timer management and input normalization logic.

Poem

A hop and a pause, then away I go,
Now my hover can linger, or swiftly flow.
Enter and leave, each with their own say,
Timers in tandem, no overlap in play.
With every delay, my code feels just right—
Hopping through changes, from morning to night! 🐇✨

---

📜 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 ea776aa and 38e6c2f.

📒 Files selected for processing (1)

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

🧰 Additional context used

🧬 Code Graph Analysis (1)

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

packages/@core/base/shared/src/utils/inference.ts (1)

• isFunction (156-156)

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

• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)

🔇 Additional comments (9)

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

11-16: Well-designed interface with proper TypeScript typing.

The HoverDelayOptions interface is well-structured with optional properties supporting both static values and dynamic functions. The Chinese comments provide clear documentation for the intended usage.

---

18-19: Good default values with clear semantic meaning.

The default constants are well-chosen: 0ms for enter delay provides immediate responsiveness, while 500ms for leave delay prevents accidental state changes. The naming and comments clearly convey the purpose.

---

24-24: JSDoc documentation accurately reflects the new functionality.

The parameter description has been updated to accurately describe the enhanced delay parameter that now supports both single values and configuration objects.

---

29-29: Function signature maintains backward compatibility while adding new features.

The union type correctly supports the existing API (number/function) while adding the new HoverDelayOptions interface. The default value preserves the original behavior.

---

31-39: Excellent backward compatibility implementation.

The normalization logic elegantly handles all input types while maintaining full backward compatibility. The type checking with isFunction utility and object spread syntax ensures user-provided values take precedence over defaults.

---

43-44: Proper TypeScript typing for timer management.

The separate timer refs are correctly typed with ReturnType<typeof setTimeout> and properly initialized as undefined, following Vue 3 best practices.

---

56-65: Clean timer management with proper cleanup.

The clearTimers helper function properly clears both timers and resets the refs to undefined, preventing memory leaks and ensuring clean state management.

---

68-96: Robust delay handling with proper race condition prevention.

The refactored setValueDelay function correctly:

• Clears existing timers to prevent race conditions
• Handles both enter and leave scenarios with appropriate delays
• Supports immediate execution for zero/negative delays
• Properly evaluates function-based delays
• Manages timer cleanup within the timeout callbacks

The implementation prevents timer conflicts and ensures predictable behavior.

---

117-117: Proper cleanup on component unmount.

Using the clearTimers helper ensures both timers are properly cleaned up when the component unmounts, preventing memory leaks.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.