@component-controls/react-docgen-info

Component controls react-docgen props info loader

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@component-controls/react-docgen-info
71114.0.39 months ago2 years agoMinified + gzip package size for @component-controls/react-docgen-info in KB

Readme

Table of contents
-   [run](#run)
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
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 | RectDocgenOptions
resolver: function (
ast\
\[string
: unknownparser\
parse\:
) => NodePath \| NodePath\
handlers: HandlerType\
options
filename: string
cwd: string
babelrc: boolean
babelrcRoots: boolean
root: boolean
rootMode: boolean
configFile: boolean
envName: boolean
parserOptions: ParserOptions
| configuration options | | returns | PropsInfoExtractorFunction | a callable function of type PropsInfoExtractorFunction |