UNPKG

@storybook/preact

Version:

Storybook Preact renderer: Develop, document, and test UI components in isolation

51 lines (47 loc) 2.31 kB
import { Args, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations, StrictArgs, DecoratorFunction, LoaderFunction, StoryContext as StoryContext$1, ProjectAnnotations, NamedOrDefaultProjectAnnotations, NormalizedProjectAnnotations } from 'storybook/internal/types'; export { ArgTypes, Args, Parameters, StrictArgs } from 'storybook/internal/types'; import { P as PreactRenderer } from './types-57f4f889.js'; import 'preact'; /** * Metadata to configure the stories for a component. * * @see [Default export](https://storybook.js.org/docs/api/csf#default-export) */ type Meta<TArgs = Args> = ComponentAnnotations<PreactRenderer, TArgs>; /** * Story function that represents a CSFv2 component example. * * @see [Named Story exports](https://storybook.js.org/docs/api/csf#named-story-exports) */ type StoryFn<TArgs = Args> = AnnotatedStoryFn<PreactRenderer, TArgs>; /** * Story object that represents a CSFv3 component example. * * @see [Named Story exports](https://storybook.js.org/docs/api/csf#named-story-exports) */ type StoryObj<TArgs = Args> = StoryAnnotations<PreactRenderer, TArgs>; type Decorator<TArgs = StrictArgs> = DecoratorFunction<PreactRenderer, TArgs>; type Loader<TArgs = StrictArgs> = LoaderFunction<PreactRenderer, TArgs>; type StoryContext<TArgs = StrictArgs> = StoryContext$1<PreactRenderer, TArgs>; type Preview = ProjectAnnotations<PreactRenderer>; /** * Function that sets the globalConfig of your storybook. The global config is the preview module of * your .storybook folder. * * It should be run a single time, so that your global config (e.g. decorators) is applied to your * stories when using `composeStories` or `composeStory`. * * Example: * * ```jsx * // setup-file.js * import { setProjectAnnotations } from '@storybook/preact'; * import projectAnnotations from './.storybook/preview'; * * setProjectAnnotations(projectAnnotations); * ``` * * @param projectAnnotations - E.g. (import projectAnnotations from '../.storybook/preview') */ declare function setProjectAnnotations(projectAnnotations: NamedOrDefaultProjectAnnotations<any> | NamedOrDefaultProjectAnnotations<any>[]): NormalizedProjectAnnotations<PreactRenderer>; export { Decorator, Loader, Meta, PreactRenderer, Preview, StoryContext, StoryFn, StoryObj, setProjectAnnotations };