Skip to content
StoryShelf

StoryParameters

Defined in: packages/core/src/capture/adapter.ts:36

Per-story capture parameters from the Storybook index.

Properties

Section titled “Properties”

autoCrop?

Section titled “autoCrop?”

optional autoCrop?: boolean

Defined in: packages/core/src/capture/adapter.ts:43

Force auto-crop (true) or full viewport (false) for this story; undefined uses 60% whitespace rule.

autoCropThreshold?

Section titled “autoCropThreshold?”

optional autoCropThreshold?: number

Defined in: packages/core/src/capture/adapter.ts:45

Whitespace fraction (0..1) above which we crop; default 0.6.

burst?

Section titled “burst?”

optional burst?: number

Defined in: packages/core/src/capture/adapter.ts:54

Burst count for steady capture (1 = single shot, 3 = burst 100ms); default 1.

delay?

Section titled “delay?”

optional delay?: number

Defined in: packages/core/src/capture/adapter.ts:38

diffThreshold?

Section titled “diffThreshold?”

optional diffThreshold?: number

Defined in: packages/core/src/capture/adapter.ts:39

disableSnapshot?

Section titled “disableSnapshot?”

optional disableSnapshot?: boolean

Defined in: packages/core/src/capture/adapter.ts:37

flakyTest?

Section titled “flakyTest?”

optional flakyTest?: boolean

Defined in: packages/core/src/capture/adapter.ts:41

fullPageOnOverflow?

Section titled “fullPageOnOverflow?”

optional fullPageOnOverflow?: boolean

Defined in: packages/core/src/capture/adapter.ts:47

Whether overflow should trigger fullPage; default true.

maxHeight?

Section titled “maxHeight?”

optional maxHeight?: number

Defined in: packages/core/src/capture/adapter.ts:52

maxWidth?

Section titled “maxWidth?”

optional maxWidth?: number

Defined in: packages/core/src/capture/adapter.ts:51

minHeight?

Section titled “minHeight?”

optional minHeight?: number

Defined in: packages/core/src/capture/adapter.ts:50

minWidth?

Section titled “minWidth?”

optional minWidth?: number

Defined in: packages/core/src/capture/adapter.ts:49

Min dimensions for the final PNG (clamp after padding).

modes?

Section titled “modes?”

optional modes?: ModeMap

Defined in: packages/core/src/capture/adapter.ts:60

Named modes: extra captures of this story under different globals/viewports.

pauseAnimationAtEnd?

Section titled “pauseAnimationAtEnd?”

optional pauseAnimationAtEnd?: boolean

Defined in: packages/core/src/capture/adapter.ts:40

viewport?

Section titled “viewport?”

optional viewport?: StoryViewportConfig

Defined in: packages/core/src/capture/adapter.ts:58

Storybook viewport config; adds the story’s default viewport to the project list at capture time.

waitForFonts?

Section titled “waitForFonts?”

optional waitForFonts?: boolean

Defined in: packages/core/src/capture/adapter.ts:56

Whether to wait for fonts.ready before screenshot; default true when burst >1.