Variable cursorsConst

cursors: {
    default: string | CursorDescriptor;
    "default-down": string | CursorDescriptor;
    grab: string | CursorDescriptor;
    "grab-down": string | CursorDescriptor;
    pointer: string | CursorDescriptor;
    "pointer-down": string | CursorDescriptor;
    text: string | CursorDescriptor;
    "text-down": string | CursorDescriptor;
} = ...

Configure custom cursor images to use when interacting with the application.

Type declaration

Example: Configuring a cursor with a hotspot in the default top-left.

Object.assign(CONFIG.cursors, {
  default: "icons/cursors/default.avif",
  "default-down": "icons/cursors/default-down.avif"
});

Example: Configuring a cursor with a hotspot in the center.

Object.assign(CONFIG.cursors, {
  default: { url: "icons/cursors/target.avif", x: 16, y: 16 },
  "default-down": { url: "icons/cursors/target-down.avif", x: 16, y: 16 }
});

Settings

Member Visibility