storybook-addon-react-docgen

  • Version 1.2.44
  • Published
  • 60.3 kB
  • 4 dependencies
  • MIT license

Install

npm i storybook-addon-react-docgen
yarn add storybook-addon-react-docgen
pnpm add storybook-addon-react-docgen

Overview

A storybook addon to display react docgen info.

Index

Variables

Functions

Variables

variable Story

const Story: {
({ styles, ...props }: StoryProps): JSX.Element;
defaultProps: {
PropTable: (
props: Pick<
PropTableProps,
| 'maxPropArrayLength'
| 'maxPropObjectKeys'
| 'maxPropStringLength'
| 'maxPropsIntoLine'
| 'excludedPropTypes'
| 'type'
>
) => JSX.Element | null;
excludedPropTypes: never[];
};
};

    Functions

    function withPropsTable

    withPropsTable: (options: DocgenTableOptions) => any;

      Package Files (2)

      Dependencies (4)

      Dev Dependencies (32)

      Peer Dependencies (4)

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/storybook-addon-react-docgen.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/storybook-addon-react-docgen)
      • HTML
        <a href="https://www.jsdocs.io/package/storybook-addon-react-docgen"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>