API Reference / @gtkx/storybook / index / composeStories

Function: composeStories()

composeStories<TModule>(stories, preview?): ComposedStories<TModule>

Defined in: packages/storybook/src/compose.ts:62

Composes the selected CSF3 exports of a module into native React components. The default export supplies metadata; its includeStories and excludeStories select named exports. Returned keys retain the original export names.

Type Parameters

TModule

TModule extends StoryModule

Parameters

stories

TModule

A story module containing default metadata and named story objects.

preview?

Preview = {}

Shared project annotations, scoped to the returned compositions.

Returns

ComposedStories<TModule>

Composed components keyed by the selected export names.

Throws

If metadata or a selected export is invalid, or a selected story has no renderer.