Interface: UseCursorsResult\<TCursor\>
@roomful/vue / UseCursorsResult
Interface: UseCursorsResult<TCursor>
Section titled “Interface: UseCursorsResult<TCursor>”Defined in: vue/src/index.ts:142
Describes the return value of useCursors.
Type Parameters
Section titled “Type Parameters”TCursor
Section titled “TCursor”TCursor extends CursorData = CursorData
The custom cursor payload shape.
Properties
Section titled “Properties”cursors
Section titled “cursors”cursors:
ReadonlyRef<CursorPosition<TCursor>[]>
Defined in: vue/src/index.ts:151
Exposes the latest cursor positions.
ref:
ShallowRef<HTMLElement|null>
Defined in: vue/src/index.ts:146
Holds the mounted cursor host element.
Methods
Section titled “Methods”mount()
Section titled “mount()”mount(
element):void
Defined in: vue/src/index.ts:159
Mounts cursor tracking on an element.
Parameters
Section titled “Parameters”element
Section titled “element”HTMLElement
The element to observe.
Returns
Section titled “Returns”void
Nothing.
unmount()
Section titled “unmount()”unmount():
void
Defined in: vue/src/index.ts:166
Unmounts cursor tracking.
Returns
Section titled “Returns”void
Nothing.