VerbHandler

Handles a vocabulary element's step anchor firing, given the invocation and the environment's context.

@internote/canvas-sdkType
On this page
import { VerbHandler } from '@internote/canvas-sdk';

Only step anchors dispatch verbs; time anchors do not. A handler is called with phase: 'enter' when the element's in: or at: anchor names the step entered, and with phase: 'exit' when its out: anchor does.

#Signature

(invocation: VerbInvocation, ctx: Ctx) => void

#Example

verbs: {
    caption: ({ phase }, ctx) => ctx.storage.session.update((s) => ({ ...s, shown: phase === 'enter' })),
},

Declared in packages/canvas-sdk/src/animation/EnvironmentAnimationRuntime.ts:80.

Last updated