Interface HoverProps

Props of the useHover hook.

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

Hierarchy (view full)

Properties

isDisabled? onHoverChange? onHoverEnd? onHoverStart?

Properties

OptionalisDisabled

isDisabled?: boolean

If true then hover events are disabled.

Default

false

OptionalonHoverChange

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

A handler that is called when the hover state changes.

Type declaration

    • (isHovered): void

    • Parameters

      • isHovered: boolean

        true if an element is hovered.

      Returns void

OptionalonHoverEnd

onHoverEnd?: (() => void)

A handler that is called when a hover interaction ends.

OptionalonHoverStart

onHoverStart?: (() => void)

A handler that is called when a hover interaction starts.

Settings

Member Visibility

On This Page

Properties