useSceneSession

Re-renders the caller whenever anything writes to a scene's session slot: its footer's open state, or where the reader has put its parameters.

@internote/canvas-sdk/reactHook
On this page
import { useSceneSession } from '@internote/canvas-sdk/react';

It returns nothing. The values are read back through ctx.footer and ctx.parameters, which are views over the same slot. A surface that only needs the parameters uses useSceneParameters, which returns them.

#Signature

(session: EnvironmentSessionState<unknown>): void

#Parameters

session
The scene's session slot, as a host holds it.

Declared in packages/canvas-sdk/src/react/use-scene-session.ts:34.

Last updated