# @component-controls/react-docgen-info

> Component controls react-docgen props info loader

Latest version **4.0.3** (published 2022-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @component-controls/react-docgen-info
pnpm add @component-controls/react-docgen-info
yarn add @component-controls/react-docgen-info
bun add @component-controls/react-docgen-info
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2022-01-14 |
| First published | 2020-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 48.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 82 |
| Maintainers | atanasster |

## Links

- npm: https://www.npmjs.com/package/@component-controls/react-docgen-info
- Repository: https://github.com/ccontrols/component-controls
- Issues: https://github.com/ccontrols/component-controls/issues
- npm.io page: https://npm.io/package/@component-controls/react-docgen-info

## Dependencies (2)

- [react-docgen](https://npm.io/package/react-docgen.md) ^5.4.0
- [@component-controls/core](https://npm.io/package/@component-controls/core.md) ^4.0.3

## Recent versions

- 4.0.3 (latest) — 2022-01-14
- 3.14.6 — 2021-05-20
- 3.14.5 — 2021-05-19
- 3.14.2 — 2021-05-18
- 3.14.0 — 2021-05-17
- 3.13.0 — 2021-05-17
- 3.12.0 — 2021-05-13
- 3.11.4 — 2021-05-11
- 3.11.0 — 2021-05-10
- 3.10.3 — 2021-05-09
- 3.10.2 — 2021-05-09
- 3.10.0 — 2021-05-08
- 3.9.0 — 2021-04-30
- 3.8.2 — 2021-04-30
- 3.8.0 — 2021-04-29
- … 99 more at https://npm.io/package/@component-controls/react-docgen-info/versions

## README

# Table of contents

-   [Overview](#overview)
-   [Installation](#installation)
-   [API](#api)
    -   [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

-   Uses [react-docgen](https://github.com/reactjs/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:

```bash
$ npm install @component-controls/react-docgen-info --save-dev
```

# API

<api-readme />

<!-- START-API-README -->

## 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](https://github.com/ccontrols/component-controls/tree/master/props-info/react-docgen/src/index.ts#L15)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Description                                            |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| `options` | <details><summary>`RectDocgenOptions`</summary><blockquote>`resolver`: **function** (<br /><details><summary>`ast`\*</summary><blockquote>\[`string`]: `unknown`</blockquote></details><details><summary>`parser`\*</summary><blockquote>`parse`\*: </blockquote></details>) => `NodePath` \| `NodePath`\[]<br />`handlers`: `HandlerType`\[]<br /><details><summary>`options`</summary><blockquote>`filename`: `string`<br />`cwd`: `string`<br />`babelrc`: `boolean`<br />`babelrcRoots`: `boolean`<br />`root`: `boolean`<br />`rootMode`: `boolean`<br />`configFile`: `boolean`<br />`envName`: `boolean`<br />`parserOptions`: ParserOptions</blockquote></details></blockquote></details> | configuration options                                  |
| `returns` | PropsInfoExtractorFunction                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | a callable function of type PropsInfoExtractorFunction |

<!-- END-API-README -->

---
_Source: https://npm.io/package/@component-controls/react-docgen-info · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._