Function: useCursors()
@roomful/react / useCursors
Function: useCursors()
Section titled “Function: useCursors()”useCursors<
TCursor,TPresence>(options?):UseCursorsResult<TCursor>
Defined in: react/src/index.ts:388
Subscribes to cursor snapshots and returns mounting helpers.
Type Parameters
Section titled “Type Parameters”TCursor
Section titled “TCursor”TCursor extends CursorData = CursorData
The custom cursor payload shape.
TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Parameters
Section titled “Parameters”options?
Section titled “options?”CursorOptions
Optional cursor tracking configuration.
Returns
Section titled “Returns”UseCursorsResult<TCursor>
The cursor snapshot and mounting helpers.