Skip to main content

Function: createTestEngine()

createTestEngine<T>(canvasElement, partDefinitions, _option?): TestEngine<T>

Defined in: storybook/src/createTestEngine.ts:18

Create a test engine over a story's canvas, for use inside a Storybook play function.

Framework-agnostic: works for any renderer whose story commits to real DOM (React, Vue, …) — see StorybookInteractor.

Type Parameters​

T​

T extends ScenePart

Parameters​

canvasElement​

HTMLElement

The story's canvas element, from the play context

partDefinitions​

T

The scene part definitions

_option?​

ITestEngineOption

Reserved for future use; accepted for entry-point symmetry with the other adapters and currently ignored.

Returns​

TestEngine<T>

The test engine