Interface ICursorHoverElementProps

Information about the currently hovered element affecting cursor behavior.

interface ICursorHoverElementProps {
    element: Element;
    emitter?: null | Element;
    height?: null | number | string & {} | "auto";
    hoverDebounce?: number;
    padding?: string | number;
    snap?: boolean;
    sticky?: boolean;
    stickyAmplitude?:
        | TCursorHoverElementStickyAmplitude
        | TCursorHoverElementStickyAmplitudeObject;
    stickyFriction?: number;
    stickyLerp?: number;
    type?: string;
    width?: null
    | number
    | string & {}
    | "auto";
}

Properties

element emitter? height? hoverDebounce? padding? snap? sticky? stickyAmplitude? stickyFriction? stickyLerp? type? width?

Properties

element

element: Element

Hoverable DOM element

Optionalemitter

emitter?: null | Element

Hover events emitter. If not provided, the element itself will be used

Default

null

Optionalheight

height?: null | number | string & {} | "auto"

Target cursor height on hover. Supports css units like px, rem, vw, vh, svh.

Default

null

OptionalhoverDebounce

hoverDebounce?: number

Debounce time for hover events, in milliseconds

Default

16

Optionalpadding

padding?: string | number

Padding applied around the cursor. Supports css units like px, rem, vw, vh, svh.

Default

0

Optionalsnap

snap?: boolean

Snap cursor to the element center. Does not work with behavior: "path".

Default

false

Optionalsticky

sticky?: boolean

Enable sticky behavior for the hovered element.

Default

false

OptionalstickyAmplitude

stickyAmplitude?:
    | TCursorHoverElementStickyAmplitude
    | TCursorHoverElementStickyAmplitudeObject

Sticky animation amplitude. Supports css units like px, rem, vw, vh, svh.

Default

'auto'

OptionalstickyFriction

stickyFriction?: number

Friction factor for smooth sticky animation. Friction is applied during hover and will tend the element to its original position. The higher value the more resistance is applied.

Default

0

OptionalstickyLerp

stickyLerp?: number

Linear interpolation factor for smooth sticky animation.

Default

this.props.lerp

Optionaltype

type?: string

Cursor type to activate on hover

Optionalwidth

width?: null | number | string & {} | "auto"

Target cursor width on hover. Supports css units like px, rem, vw, vh, svh.

Default

null

Settings

Member Visibility

On This Page

Properties