Skip to content

Function: cursorPlugin() ​

ts
function cursorPlugin(options?): CursorPlugin;

Defined in: cursor/plugin.ts:236

Create a plugin that shows a glow at the pointer, or replaces the native cursor with an arrow.

Parameters ​

ParameterTypeDescription
optionsCursorPluginOptionsThe display mode, the custom renderer and the selector of ignored elements.

Returns ​

CursorPlugin

The plugin with the name cursor.

Example ​

ts
createWand({ plugins: [cursorPlugin({ mode: 'replace', ignoreSelector: '.no-wand' })] });