Packages@robojs/sync
SyncCursorsProps<ClientData>
Interface: SyncCursorsProps<ClientData>
Props for SyncCursors component.
Type Parameters
| Type Parameter | Default type |
|---|---|
ClientData | unknown |
Properties
| Property | Type | Description |
|---|---|---|
colorFn? | (clientId: string) => string | Color function to generate cursor color from client ID |
defaultCursorStyle? | CSSProperties | Default style for cursor wrapper |
labelKey? | keyof ClientData | (client) => string | Key to use for label from client data, or function to extract label |
renderCursor? | (cursor: RemoteCursor<ClientData>) => ReactNode | Custom cursor renderer |
roomKey | (null | string)[] | Room key for cursor synchronization |
showLabels? | boolean | Show user labels next to cursors (default: true) |
throttle? | number | Milliseconds between cursor updates (default: 16) |
zIndex? | number | Z-index for cursor container (default: 9999) |