Interface: UseViewportResult
@roomful/react / UseViewportResult
Interface: UseViewportResult
Section titled “Interface: UseViewportResult”Defined in: react/src/index.ts:200
Describes the return value of useViewport.
Properties
Section titled “Properties”broadcast()
Section titled “broadcast()”broadcast: () =>
void
Defined in: react/src/index.ts:214
Starts streaming the local viewport to all peers.
Starts streaming the local viewport to all peers.
Returns
Section titled “Returns”void
Nothing.
follow()
Section titled “follow()”follow: (
peerId) =>void
Defined in: react/src/index.ts:234
Follows a specific peer’s viewport.
Follows a specific peer’s viewport, applying their scroll position to the mounted element as their viewport changes. Zoom is exposed in state for the app to apply.
Parameters
Section titled “Parameters”peerId
Section titled “peerId”string
The peer whose viewport to follow.
Returns
Section titled “Returns”void
Nothing.
present()
Section titled “present()”present: () =>
void
Defined in: react/src/index.ts:224
Enters present mode, forcing peers to follow the local viewport.
Enters present mode: broadcasts the local viewport and signals peers to follow it until ViewportEngine.stopPresenting is called.
Returns
Section titled “Returns”void
Nothing.
ref:
RefCallback<HTMLElement>
Defined in: react/src/index.ts:204
Callback ref that mounts the viewport engine on a scrollable container.
states
Section titled “states”states:
ViewportState[]
Defined in: react/src/index.ts:209
Exposes remote peer viewport states only.
stopBroadcast()
Section titled “stopBroadcast()”stopBroadcast: () =>
void
Defined in: react/src/index.ts:219
Stops streaming the local viewport.
Stops streaming the local viewport.
Returns
Section titled “Returns”void
Nothing.
stopPresenting()
Section titled “stopPresenting()”stopPresenting: () =>
void
Defined in: react/src/index.ts:229
Leaves present mode and releases following peers.
Leaves present mode and releases peers that were following.
Returns
Section titled “Returns”void
Nothing.
unfollow()
Section titled “unfollow()”unfollow: () =>
void
Defined in: react/src/index.ts:239
Stops following any peer and resumes independent scrolling.
Stops following any peer and resumes independent scrolling.
Returns
Section titled “Returns”void
Nothing.