@component-controls/react-docgen-info
v4.0.3
Published
Component controls react-docgen props info loader
Downloads
148
Readme
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-devAPI
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 | RectDocgenOptionsresolver: function (ast*[string]: unknownparser*parse*: ) => NodePath | NodePath[]handlers: HandlerType[]optionsfilename: stringcwd: stringbabelrc: booleanbabelrcRoots: booleanroot: booleanrootMode: booleanconfigFile: booleanenvName: booleanparserOptions: ParserOptions | configuration options |
| returns | PropsInfoExtractorFunction | a callable function of type PropsInfoExtractorFunction |
