use()

use(plugin: CursorPlugin)

Decorate the Cursor singleton with extensible interactions. Plugins can hook into cursor hooks like hover styling (ThemePlugin), path logging (LoggingPlugin), click effects (RipplePlugin), and auditory feedback (ClickSoundPlugin).

You can mount your own custom classes extending CursorPlugin natively.

Use Cases

• Enabling analytics: Connecting a custom plugin that sends cursor click timestamps to your Mixpanel or Google Analytics.
• A/B Testing UI visual feedback: Injecting different ripple colors dynamically to test which visual converts better.

Example

import { Cursor, RipplePlugin } from '@cursor.js/core';

const cursor = new Cursor()
  .use(new RipplePlugin({ color: '#ff0000', size: 100 }))
  .click('.my-div');

removePlugin(name: string)

Removes a registered plugin logically cleaning trailing event handlers it may have set.

cursor.removePlugin('RipplePlugin'); // Drops interaction trace cleanup bounds.