Component controls react-docgen-typescript props info loader
npm install @component-controls/react-docgen-typescript-info- Overview
- Installation
- API
- run
Extract props info from react typescript components:
- Uses react-docgen-typescript
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 typescript components
``bash`
$ npm install @component-controls/react-docgen-typescript-info --save-dev
function
run API to generate react-docgen-typescript props information tables.
_defined in @component-controls/react-docgen-typescript-info/props-info/react-docgen-typescript/src/index.ts_
parameters
| Name | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
| options | typetransformProps: function (props\: ComponentDoc\[]ComponentDoc
) => expression: ts.SymboldisplayName\: stringfilePath\: stringdescription\: stringprops\string\[
]: Tmethods\: Method\[]tagsstring\[
]: TpropFilter: StaticPropFilter \| PropFiltercomponentNameResolver: function (exp\: Symbolsource\: SourceFilestring
) => \| undefined \| null \| falseshouldExtractLiteralValuesFromEnum: booleanshouldRemoveUndefinedFromOptional: booleanshouldExtractValuesFromUnion: booleanskipChildrenPropWithoutDoc: booleansavePropValueAsString: booleanshouldIncludePropTagMap: booleanshouldIncludeExpression: booleancustomComponentTypes: string\[] | configuration options |returns` | PropsInfoExtractorFunction | a callable function of type PropsInfoExtractorFunction |
|