Class CursorHoverElement

Hover target for Cursor.attachHover: size/snap/sticky and enter/leave.

Hierarchy

  • Destroyable
    • CursorHoverElement

Constructors

constructor

Accessors

element emitter hasStickyFriction height isDestroyed isInterpolated padding snap sticky stickyFriction stickyLerp type width

Methods

_destroy destroy getDimensions onDestroy render

Constructors

constructor

Accessors

element

  • get element(): Element

    Returns Element

emitter

  • get emitter(): Element

    Returns Element

hasStickyFriction

  • get hasStickyFriction(): boolean

    Returns boolean

height

  • get height(): null | number | "auto"

    Returns null | number | "auto"

isDestroyed

  • get isDestroyed(): boolean

    Indicates whether the instance has been destroyed.

    After destruction, destroy is a no-op.

    Returns boolean

isInterpolated

  • get isInterpolated(): boolean

    Returns boolean

padding

  • get padding(): number

    Returns number

snap

  • get snap(): boolean

    Returns boolean

sticky

  • get sticky(): boolean

    Returns boolean

stickyFriction

  • get stickyFriction(): number

    Returns number

stickyLerp

  • get stickyLerp(): undefined | number

    Returns undefined | number

type

  • get type(): undefined | string

    Returns undefined | string

width

  • get width(): null | number | "auto"

    Returns null | number | "auto"

Methods

Protected_destroy

  • _destroy(): void

    Subclass hook for internal cleanup.

    Called at the start of destroy, before registered onDestroy actions run.

    Returns void

destroy

  • destroy(): void

    Destroys the instance and runs all registered cleanup actions.

    Safe to call multiple times; subsequent calls are ignored.

    Execution order:

    1. _destroy
    2. all onDestroy callbacks, in registration order
    3. isDestroyed is set to true

    Returns void

getDimensions

  • getDimensions(): {
        height: undefined
        | number;
        padding: number;
        width: undefined | number;
        x: undefined | number;
        y: undefined | number;
    }

    Returns {
        height: undefined | number;
        padding: number;
        width: undefined | number;
        x: undefined | number;
        y: undefined | number;
    }

onDestroy

  • onDestroy(action: () => void): void

    Registers a function to run when the instance is destroyed.

    If the instance is already destroyed, action runs immediately.

    Parameters

    • action: () => void

      Cleanup function (for example remove listeners or DOM classes).

    Returns void

render

  • render(getLerp: (source?: number) => number): void

    Parameters

    • getLerp: (source?: number) => number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods