Interface ICursorStaticProps

interface ICursorStaticProps {
    __staticProp?: true;
    append?: boolean;
    behavior?: "path" | "default";
    container?: Element | Window;
    hideNative?: boolean;
    transformModifier?: (coords: ICursorFullCoords) => string;
}

Hierarchy (View Summary)

Properties

__staticProp? append? behavior? container? hideNative? transformModifier?

Properties

Optional__staticProp

__staticProp?: true

Optionalappend

append?: boolean

Appends the custom cursor to the container. Use false if you need only cursor logic and interactions.

Default

true

Optionalbehavior

behavior?: "path" | "default"

Cursor behavior

Default

'default'

Optionalcontainer

container?: Element | Window

The container where the custom cursor is active. Use window for full-window activation.

Default

window

OptionalhideNative

hideNative?: boolean

Hides the native cursor if set to true.

Default

false

OptionaltransformModifier

transformModifier?: (coords: ICursorFullCoords) => string

Modifier for the cursor transform.

Default

(coords) => translate(${coords.x}px, ${coords.y}px)

Settings

Member Visibility

On This Page

Properties