React Hookers - v6.3.0
    Preparing search index...

    Interface HoverProps

    Props of the useHover hook.

    interface HoverProps {
        isDisabled?: boolean;
        onHoverChange?: (isHovered: boolean) => void;
        onHoverEnd?: () => void;
        onHoverStart?: () => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    isDisabled?: boolean

    If true then hover events are disabled.

    false
    
    onHoverChange?: (isHovered: boolean) => void

    A handler that is called when the hover state changes.

    Type declaration

      • (isHovered: boolean): void
      • Parameters

        • isHovered: boolean

          true if an element is hovered.

        Returns void

    onHoverEnd?: () => void

    A handler that is called when a hover interaction ends.

    onHoverStart?: () => void

    A handler that is called when a hover interaction starts.