setState()

setState(newState: Record<string, any>)

The cursor engine maintains an internal untyped dictionary (accessible via .state). Invoking setState merges keys incrementally while optionally alerting registered plugins of changes.

If newState provides size, it will directly alter the Ghost Cursor size property synchronously.

Use Cases

• Changing visual themes dynamically: Swapping to a dark-mode theme pointer for specific steps of an interaction.
• Adjusting user speed in real-time: Setting cursor speed to slow down when giving detailed explanations, then resetting to normal speed.

Example

const cursor = new Cursor();

cursor
  .hover('.submit-btn')
  .setState({ ripple: { color: 'rebeccapurple' }, size: 2 })
  .click('.submit-btn')
  .setState({ size: 1 });