Is this page helpful?

Type: CursorChange#

CursorChange: object

Payload passed to the onCursor callback.

  • Supported cursor (the SDK applied it): streamCursor is the StreamCursorType that was applied and kitCursorName is the name Kit sent, for reference.

  • Any other cursor name: only kitCursorName is present. The SDK applied nothing, so your handler must set the cursor.

Type declaration#

cursor?#

optional cursor: CursorType

The cursor the SDK applied, when it is one of the six CursorType cursors. Absent for GRAB, GRABBING and ORBIT, which are only in streamCursor.

Deprecated#

Removed in v7.0. Use streamCursor, which covers every cursor.

kitCursorName#

kitCursorName: string

The cursor name exactly as Kit sent it (for example ‘Arrow’, ‘Grab_open’, or a custom name).

streamCursor?#

optional streamCursor: StreamCursorType

The cursor the SDK applied. Absent when the SDK applied nothing.