RE

React Docgen Typescript Plugin

@storybook/react-docgen-typescript-plugin

A webpack plugin to inject react typescript docgen information.

Utilities
react
docgen
typescript
webpack
plugin
@storybook/react-docgen-typescript-plugin
Utilities
javascript
npm
frontend
Stars
546
Weekly
3.3M
Open issues
7
Bundle
~25 kB

Installation

npm install @storybook/react-docgen-typescript-plugin

Code example

import { useDocgenTypescriptPlugin } from "@storybook/react-docgen-typescript-plugin";

export function Example() {
  const value = useDocgenTypescriptPlugin();
  return <p>{String(value)}</p>;
}

Pros & cons

Pros

  • Actively maintained by Andrew Lisowski
  • 3.3M weekly downloads. Battle tested
  • First-class TypeScript definitions
  • MIT licensed

Considerations

  • Adds roughly ~25 kB to your bundle
  • Needs client-only rendering in SSR frameworks
  • Not supported in React Native
  • 7 open issues on GitHub

FAQs

Alternatives & similar libraries