@component-controls/react-docgen-info

Table of contents

• Overview
• Installation
• API
  • 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

• 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	RectDocgenOptions resolver: function ( ast* [string]: unknown parser* 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