Table of contents
Overview
Extract props info from react components. Although the latest version of react-docgen
does support typescript, the typescript support still lags and is not recommended for use
- Uses react-docgen
Installation
This package is usually installed as part of the @component-controls package, but you can also install it standalone to extract props info from react components:
$ npm install @component-controls/react-docgen-info --save-dev
API
run
function
run API to generate react-docgen props information tables.
defined in @component-controls/react-docgen-info/props-info/react-docgen/src/index.ts
parameters
Name | Type | Description |
---|---|---|
options |
|
configuration options |
returns |
PropsInfoExtractorFunction | a callable function of type PropsInfoExtractorFunction |