@storybook/html/dist/index.d.ts

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

import { AnnotatedStoryFn, ArgTypes, Args, Args as Args$1, ArgsStoryFn, ComponentAnnotations, DecoratorFunction, LoaderFunction, NamedOrDefaultProjectAnnotations, NormalizedProjectAnnotations, Parameters, ProjectAnnotations, StoryAnnotations, StoryContext as StoryContext$1, StrictArgs, StrictArgs as StrictArgs$1, WebRenderer } from "storybook/internal/types";

//#region code/renderers/html/.dts-emit/code/renderers/html/src/types.d.ts
type StoryFnHtmlReturnType = string | Node;
interface HtmlRenderer extends WebRenderer {
  component: string | HTMLElement | ArgsStoryFn<HtmlRenderer>;
  storyResult: StoryFnHtmlReturnType;
}
//#endregion
//#region code/renderers/html/.dts-emit/code/renderers/html/src/public-types.d.ts
/**
 * Metadata to configure the stories for a component.
 *
 * @see [Default export](https://storybook.js.org/docs/api/csf#default-export)
 */
type Meta<TArgs = Args$1> = ComponentAnnotations<HtmlRenderer, 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$1> = AnnotatedStoryFn<HtmlRenderer, 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$1> = StoryAnnotations<HtmlRenderer, TArgs>;
type Decorator<TArgs = StrictArgs$1> = DecoratorFunction<HtmlRenderer, TArgs>;
type Loader<TArgs = StrictArgs$1> = LoaderFunction<HtmlRenderer, TArgs>;
type StoryContext<TArgs = StrictArgs$1> = StoryContext$1<HtmlRenderer, TArgs>;
type Preview = ProjectAnnotations<HtmlRenderer>;
//#endregion
//#region code/renderers/html/.dts-emit/code/renderers/html/src/portable-stories.d.ts
/**
 * 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<HtmlRenderer>;
//#endregion
export { type ArgTypes, type Args, Decorator, type HtmlRenderer, Loader, Meta, type Parameters, Preview, StoryContext, StoryFn, StoryObj, type StrictArgs, setProjectAnnotations };