StringTune/Docs

API Reference

CursorState

Internal model for raw and smoothed cursor position, step values, and cursor velocity.

CursorState

CursorState holds raw and smoothed pointer motion data.

Public status

CursorState lives in src/states and is mainly runtime reference. Most integrations should read it through exported StringData.

Important fields

  • targetX
  • targetY
  • smoothedX
  • smoothedY
  • stepX
  • stepY
  • velocityX
  • velocityY

What it is for

This state powers:

  • cursor smoothing
  • pointer-reactive modules
  • motion derived from cursor velocity

Practical note

If a custom interaction module needs runtime cursor state rather than raw DOM events, data.cursor is the branch to inspect.