Function: injectCursors()
@roomful/angular / injectCursors
Function: injectCursors()
Section titled “Function: injectCursors()”injectCursors<
TCursor,TPresence>(options?):InjectCursorsResult<TCursor>
Defined in: angular/src/index.ts:793
Subscribes to cursor snapshots and returns mounting helpers.
Must be called in an injection context. Angular has no React-style callback
ref, so mount the engine on an element from afterNextRender or
ngAfterViewInit by calling InjectCursorsResult.mount.
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”InjectCursorsResult<TCursor>
The cursor snapshot signal and mounting helpers.