Interface: UsePointerResult
@roomful/react / UsePointerResult
Interface: UsePointerResult
Section titled “Interface: UsePointerResult”Defined in: react/src/index.ts:245
Describes the return value of usePointer.
Properties
Section titled “Properties”activate()
Section titled “activate()”activate: () =>
void
Defined in: react/src/index.ts:259
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:
PointerBeam[]
Defined in: react/src/index.ts:254
Exposes remote peers’ pointer beams only.
deactivate()
Section titled “deactivate()”deactivate: () =>
void
Defined in: react/src/index.ts:264
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:
RefCallback<HTMLElement>
Defined in: react/src/index.ts:249
Callback ref that mounts the pointer engine on a container element.
render()
Section titled “render()”render: (
options?) =>Unsubscribe
Defined in: react/src/index.ts:270
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.