isStill

Returns whether an environment should draw itself still.

@internote/canvas-sdkFunction
On this page
import { isStill } from '@internote/canvas-sdk';

Two things ask for it. The host, when what it draws is a picture rather than something read — an exported figure, shot at one moment, where a clock caught mid-tick or dots caught mid-flow would be a different picture every time. And the reader, who asked the system for reduced motion. Either way the environment draws the state things have settled in, and starts nothing that moves by itself.

#Signature

(ctx?: Pick<EnvironmentContext, "still"> | null): boolean

#Parameters

ctx
The environment's context; without one, only the reader's preference is read.

Declared in packages/canvas-sdk/src/environment/still.ts:25.

Last updated