API Reference / @gtkx/storybook / index / composeStory

Variable: composeStory

const composeStory: <TArgs>(story, meta, preview?, exportName?) => ComposedStory<TArgs>

Defined in: compose.d.ts:14

Composes a CSF3 story into a native React component with resolved defaults and decorators. Compose outside render to preserve component identity. Rendering props override the composed args. This function does not create an application, window, or Storybook preview lifecycle.

Type Parameters

TArgs

TArgs extends object

Parameters

story

StoryAnnotations<NoInfer<TArgs>>

The named story's annotations.

meta

ComponentMeta<TArgs>

The module's default component metadata.

preview?

Preview

Shared project annotations, scoped to this composition.

exportName?

string

Export name used for the story identifier and default display name.

Returns

ComposedStory<TArgs>

A renderable component exposing its composed annotations.

Throws

If an annotation is not an object or no component or render function is available.