@storybook/addon-docs/dist/index.d.ts

Storybook Docs: Document UI components automatically with stories and MDX

import { n as DocsContainerProps, o as TocParameters } from "./chunk-CQxGUEmv.js";
import React$1, { ComponentType } from "react";
import { Args, DocsContextProps, DocsRenderFunction, ModuleExport, ModuleExports, PreparedStory, Renderer } from "storybook/internal/types";
import { ThemeVars } from "storybook/theming";

//#region code/addons/docs/.dts-emit/code/addons/docs/src/types.d.ts
type StoryBlockParameters = {
  /** Whether a story's play function runs when shown in docs page */autoplay?: boolean;
  /**
   * Set a minimum height (note for an iframe this is the actual height) when rendering a story in
   * an iframe or inline. This overrides `parameters.docs.story.iframeHeight` for iframes.
   */
  height?: string; /** IFrame configuration */
  iframeHeight?: string;
  /**
   * Whether the story is rendered inline (in the same browser frame as the other docs content) or
   * in an iframe
   */
  inline?: boolean; /** Specifies the CSF file to which the story is associated */
  meta: ModuleExports;
  /**
   * Specifies which story is rendered by the Story block. If no `of` is defined and the MDX file is
   * attached, the primary (first) story will be rendered.
   */
  of: ModuleExport;
};
type StoriesBlockParameters = {
  /**
   * Custom filter function for determining which stories to include in a <Stories> block
   */
  filter?: <TRenderer extends Renderer = Renderer, TArgs = Args>(Story: PreparedStory<TRenderer>, Context: ReturnType<DocsContextProps['getStoryContext']>) => boolean;
};
type ControlsBlockParameters = {
  /** Exclude specific properties from the Controls panel */exclude?: string[] | RegExp; /** Exclude only specific properties in the Controls panel */
  include?: string[] | RegExp; /** Controls sorting order */
  sort?: 'none' | 'alpha' | 'requiredFirst';
};
type ArgTypesBlockParameters = {
  /** Exclude specific arg types from the args table */exclude?: string[] | RegExp; /** Exclude only specific arg types from the args table */
  include?: string[] | RegExp;
  /**
   * Specifies which story to get the arg types from. If a CSF file exports is provided, it will use
   * the primary (first) story in the file.
   */
  of: ModuleExport | ModuleExports;
  /**
   * Controls arg types order
   *
   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes#sort
   */
  sort?: 'none' | 'alpha' | 'requiredFirst';
};
type CanvasBlockParameters = {
  /**
   * Provides any additional custom actions to show in the bottom right corner. These are simple
   * buttons that do anything you specify in the onClick function.
   */
  additionalActions?: {
    ariaLabel?: string;
    className?: string;
    disabled?: boolean;
    onClick: () => void;
    title: string | React.JSX.Element;
  }[]; /** Provide HTML class(es) to the preview element, for custom styling. */
  className?: string;
  /**
   * Specify how the canvas should layout the story.
   *
   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#layout
   */
  layout?: 'centered' | 'fullscreen' | 'padded'; /** Specifies which story is rendered */
  of: ModuleExport; /** Show story source code */
  sourceState?: 'hidden' | 'shown' | 'none';
  /**
   * Story configuration
   *
   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#story
   */
  story?: StoryBlockParameters; /** Disable story source code */
  withSource?: 'open' | 'closed' | 'none'; /** Whether to render a toolbar containing tools to interact with the story. */
  withToolbar?: 'open' | 'closed' | 'none';
};
type DescriptionBlockParameters = {
  /** Component description */component?: string; /** Story description */
  story?: string;
};
type SourceBlockParameters = {
  /** The source code to be rendered. Will be inferred if not passed */code?: string; /** Whether to render the code in dark mode */
  dark?: boolean; /** Determines if decorators are rendered in the source code snippet. */
  excludeDecorators?: boolean;
  /**
   * The formatting used on source code. Both true and 'dedent' have the same effect of removing any
   * extraneous indentation. Supports all valid prettier parser names.
   */
  format?: boolean | 'dedent' | string; /** Source code language */
  language?: 'bash' | 'css' | 'graphql' | 'html' | 'json' | 'jsextra' | 'jsx' | 'md' | 'text' | 'tsx' | 'typescript' | 'yml';
  /**
   * Specifies which story is rendered by the Source block. If no of is defined and the MDX file is
   * attached, the primary (first) story will be rendered.
   */
  of: ModuleExport; /** Source code transformations */
  transform?: (code: string, storyContext: any) => string | Promise<string>;
  /**
   * Specifies how the source code is rendered.
   *
   * @default 'auto'
   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#type
   */
  type?: 'auto' | 'code' | 'dynamic';
};
interface DocsParameters {
  /**
   * Docs configuration
   *
   * @see https://storybook.js.org/docs/writing-docs
   */
  docs?: {
    /**
     * The subtitle displayed when shown in docs page
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes
     */
    argTypes?: ArgTypesBlockParameters;
    /**
     * Canvas configuration when shown in docs page
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas
     */
    canvas?: Partial<CanvasBlockParameters>;
    /**
     * Enable the Code panel.
     *
     * @see https://storybook.js.org/docs/writing-docs/code-panel
     */
    codePanel?: boolean;
    /**
     * Controls block configuration
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls
     */
    controls?: ControlsBlockParameters;
    /**
     * Customize the Docs Container
     *
     * @see https://storybook.js.org/docs/writing-docs/autodocs#customize-the-docs-container
     */
    container?: ComponentType<DocsContainerProps>;
    /**
     * Component/story description when shown in docs page
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-description#writing-descriptions
     */
    description?: DescriptionBlockParameters; /** Remove the addon panel and disable the addon's behavior */
    disable?: boolean;
    /**
     * Replace the default documentation template used by Storybook with your own
     *
     * @see https://storybook.js.org/docs/writing-docs/autodocs#write-a-custom-template
     */
    page?: ComponentType;
    /**
     * Source code configuration when shown in docs page
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source
     */
    source?: Partial<SourceBlockParameters>;
    /**
     * Story block configuration
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-story
     */
    story?: Partial<StoryBlockParameters>;
    /**
     * Stories block configuration
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-stories
     */
    stories?: Partial<StoriesBlockParameters>;
    /**
     * The subtitle displayed when shown in docs page
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-subtitle
     */
    subtitle?: string;
    /**
     * The BCP-47 language tag applied to Storybook-rendered docs prose (descriptions, titles,
     * ArgTypes description cells, free MDX prose).
     *
     * Storybook's own chrome stays English regardless. Inherited project → meta (page-level) or
     * project → meta → story (per-story prose).
     *
     * @default 'en'
     */
    lang?: string;
    /**
     * Override the default theme
     *
     * @see https://storybook.js.org/docs/writing-docs/autodocs#override-the-default-theme
     */
    theme?: ThemeVars;
    /**
     * The title displayed when shown in docs page
     *
     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-title
     */
    title?: string;
    /**
     * Configure the table of contents
     *
     * @see https://storybook.js.org/docs/writing-docs/autodocs#configure-the-table-of-contents
     */
    toc?: true | TocParameters;
  };
}
interface DocsTypes {
  parameters: DocsParameters;
}
//#endregion
//#region code/addons/docs/.dts-emit/code/addons/docs/src/DocsRenderer.d.ts
declare class DocsRenderer<TRenderer extends Renderer> {
  render: DocsRenderFunction<TRenderer>;
  unmount: (element: HTMLElement) => void;
  constructor();
}
//#endregion
//#region code/addons/docs/.dts-emit/code/addons/docs/src/index.d.ts
declare module 'mdx/types' {
  namespace JSX {
    type Element = React$1.JSX.Element;
    type ElementClass = React$1.JSX.ElementClass;
    type IntrinsicElements = React$1.JSX.IntrinsicElements;
  }
}
declare function _default(): import("storybook/internal/csf").PreviewAddon<DocsTypes>;
//#endregion
export { DocsRenderer, type DocsTypes, _default as default };