useHover
Commons
stable
Tracks whether the host element is hovered via mouseenter/mouseleave events. Supports forced-on (hover=true) and IHoverState config objects for per-axis style overrides. Pairs with useColorEffect for theme-aware hover surfaces.
API
Signature
Signature TypeScript complète extraite du fichier du composable.
Interfaces consommées
IHoverProps
IHoverState
API
Paramètres
Paramètres d'entrée acceptés par ce composable.
- propsrequisIHoverProps
- Component props. Reads `props.hover` — accepts undefined/false (event-driven), true (forced on), or an IHoverState config object.
- namestringgetCurrentInstanceName()
- Component name prefix for the `{name}--hovered` class.
API
Valeurs de retour
Propriétés et méthodes exposées par l'objet retourné par le composable.
- isHover
- True when the element is hovered (event-driven) or when forced via `hover=true` / `{ enabled: true }`.
- hoverState
- The IHoverState config object when the consumer passed one, undefined otherwise. Consumed by useStateEffect.
- hoverClasses
- Includes `{name}--hovered` when isHover is true.
- onMouseenter
- Bind to `@mouseenter` on the root element to activate event-driven hover tracking.
- onMouseleave
- Bind to `@mouseleave` on the root element to deactivate hover tracking.
Usage
Exemples
Extraits de code prêts à coller.
Component with hover color effect
Forced hover (story / test)