Interface: UsePointerResult
@roomful/vue / UsePointerResult
Interface: UsePointerResult
Section titled “Interface: UsePointerResult”Defined in: vue/src/index.ts:232
Describes the return value of usePointer.
Properties
Section titled “Properties”activate()
Section titled “activate()”activate: () =>
void
Defined in: vue/src/index.ts:261
Starts broadcasting the local pointer beam to all peers.
Starts broadcasting this peer’s pointer beam. While active, pointer movement over the mounted element is broadcast to peers.
Returns
Section titled “Returns”void
Nothing.
beams:
ReadonlyRef<PointerBeam[]>
Defined in: vue/src/index.ts:241
Exposes remote peers’ pointer beams only.
deactivate()
Section titled “deactivate()”deactivate: () =>
void
Defined in: vue/src/index.ts:266
Stops broadcasting the local pointer beam so peers drop it.
Stops broadcasting and announces an inactive beam so peers drop it (the laser disappears).
Returns
Section titled “Returns”void
Nothing.
ref:
ShallowRef<HTMLElement|null>
Defined in: vue/src/index.ts:236
Holds the mounted pointer host element.
render()
Section titled “render()”render: (
options?) =>Unsubscribe
Defined in: vue/src/index.ts:272
Renders the built-in pointer overlay over a container, returning a cleanup function.
Renders a built-in, zero-config DOM overlay that draws every remote active beam over the container, updating as beams change. This is a convenience layer; apps that draw their own pointers can ignore it and use PointerEngine.subscribe instead.
Parameters
Section titled “Parameters”options?
Section titled “options?”PointerRenderOptions
The overlay container and style.
Returns
Section titled “Returns”Unsubscribe
A cleanup function that removes the overlay.
Methods
Section titled “Methods”mount()
Section titled “mount()”mount(
element):void
Defined in: vue/src/index.ts:249
Mounts pointer tracking on a container 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:256
Unmounts pointer tracking.
Returns
Section titled “Returns”void
Nothing.