BlankRenderContext

What a blank-element renderer receives alongside the node.

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

#Fields

datasetsRequired
The document's @data datasets, by id — what a data: #id binding resolves against.
Record<string, ChalkDataset>
dbRequired
The reader's durable store — what the host was given for session+db environments, or one that keeps nothing. Every blank renderer but a question's ignores it; a question keeps its answers here, writing only when the reader acts, never while rendering.
KeyValueStorage
files
Uploaded text files by name, where an ATTACHED dataset's CSV is found: the compiler emits such a dataset as a { src } pointer and does not inline its rows (§2.3). null while the host is still loading them, which a consumer must distinguish from {} — a wait, not an absence.
Record<string, string> | null
resolveAssetUrl
Host asset resolution for relative image sources, when available.
(fileName: string) => string | null
revisionRequired
A tick that changes on every step change and animation frame, so memoised renderers re-render.
number
runtimeRequired
The scene's runtime over its blank-canvas content, for presence and attribute values.
EnvironmentAnimationRuntime
stepRequired
The scene's current step.
number
tasksRequired
What a blank task part — a question — reports where the reader stands through, under taskKeyOf its node.
TaskReporter

Declared in packages/canvas-sdk/src/host/blank-content.tsx:32.

Last updated