Interface ICursorHoverElementProps

Options for Cursor.attachHover.

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 (also receives sticky transforms when sticky is on)

Optionalemitter

emitter?: null | Element

Element that emits hover events. Defaults to element.

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 for mouseenter before treating as hovered, in milliseconds.

Default

16

Optionalpadding

padding?: string | number

Extra padding added to cursor width/height on hover. 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

Move the hovered element with the pointer (sticky parallax).

Default

false

OptionalstickyAmplitude

stickyAmplitude?:
    | TCursorHoverElementStickyAmplitude
    | TCursorHoverElementStickyAmplitudeObject

Max sticky offset. Number, CSS length, 'auto' (element size), or per-axis object.

Default

'auto'

OptionalstickyFriction

stickyFriction?: number

Pull-back friction while hovering. Higher values resist pointer offset more. Applied continuously toward the element's origin during hover.

Default

0

OptionalstickyLerp

stickyLerp?: number

Lerp factor for sticky motion. Defaults to the cursor lerp.

Default

this.props.lerp

Optionaltype

type?: string

Cursor type id to activate on hover (see Cursor.attachCursor)

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