HostToolbarState

Everything an embedder needs to draw the host toolbar.

@internote/canvas-sdk/hostInterface
On this page
import { HostToolbarState } from '@internote/canvas-sdk/host';

#Fields

advanceRequired
Moves to the next step.
() => void
backRequired
Moves to the previous step.
() => void
itemsRequired
Every environment's items in the scene, with the reserved slots already resolved: the identity labels, the scene's one view group, then each environment's own items, ids namespaced by environment.
ToolbarItem[]
playbackRequired
The playback control's state; null when the current step has nothing to play.
HostPlaybackState | null
presentingRequired
Whether the scene is being presented.
boolean
stepRequired
The scene's current step.
number
stepCountRequired
How many steps the scene has.
number
taskRequired
Where the reader stands on the scene's tasks together, or null when it is not a task scene.
correctincorrectpartialincomplete
togglePresentRequired
Enters or leaves presentation.
() => void

Declared in packages/canvas-sdk/src/host/host-state.ts:54.

Last updated