Interface ToolCursorOptions

Options for toolCursor.

interface ToolCursorOptions {
    color?: string;
    fallback?: string;
    halo?: string;
    hotspot?: readonly [number, number];
    size?: number;
}

Properties

color? fallback? halo? hotspot? size?

Properties

Optionalcolor

color?: string

Glyph colour. Default white.

Optionalfallback

fallback?: string

The keyword after the image, for a browser that will not take it. Default crosshair.

Optionalhalo

halo?: string

Halo colour. Default: black under a light color, white under a dark one, judged from a hex colour. A non-hex color gets a black halo unless this is set.

Optionalhotspot

hotspot?: readonly [number, number]

The pointer's active pixel, from the image's top-left. Default: the centre.

Optionalsize

size?: number

Cursor image size in CSS pixels. Default 20. Browsers reject images over 128.

Settings

Member Visibility

On This Page

Properties