FooterAccess

The scene's footer as an environment sees it: whether its panel is open, and the ability to ask for it.

@internote/canvas-sdkInterface
On this page
import { FooterAccess } from '@internote/canvas-sdk';

There is one footer per scene and one open state with it, however many environments the scene holds, so this object is shared: an environment that opens it opens the one the reader is looking at. An environment asks rather than sets. A run starting is a reason to show the console, which is open(), not a claim about where the chevron stands.

#Fields

closeRequired
Folds the panel away.
void
isOpenRequired
Whether the panel is open. Open by default, since a reader who cannot see the controls will not look for them.
boolean
openRequired
Asks for the panel, as when a run starts or there is an error to show.
void

Declared in packages/canvas-sdk/src/environment/types.ts:32.

Last updated