@component-controls/react-docgen-typescript-info
v4.0.3
Published
Component controls react-docgen-typescript props info loader
Readme
Table of contents
Overview
Extract props info from react typescript components:
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 typescript components
$ npm install @component-controls/react-docgen-typescript-info --save-devAPI
run
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[]) => ComponentDocexpression: ts.SymboldisplayName*: stringfilePath*: stringdescription*: stringprops*[string]: Tmethods*: Method[]tags[string]: TpropFilter: StaticPropFilter | PropFiltercomponentNameResolver: function (exp*: Symbolsource*: SourceFile) => string | undefined | null | falseshouldExtractLiteralValuesFromEnum: booleanshouldRemoveUndefinedFromOptional: booleanshouldExtractValuesFromUnion: booleanskipChildrenPropWithoutDoc: booleansavePropValueAsString: booleanshouldIncludePropTagMap: booleanshouldIncludeExpression: booleancustomComponentTypes: string[] | configuration options |
| returns | PropsInfoExtractorFunction | a callable function of type PropsInfoExtractorFunction |
