ignite-plugin-prop-types

1.0.1 • Public • Published

CircleCI branch Codecov branch

Ignite-Plugin-Prop-Types

Takes a react component and displays a table with it's prop-types.

Usage

Install the plugin:

yarn add ignite-plugin-prop-types

Add it to your .igniterc or package.json:

{
  "plugins": [
    ["PropTypes", "ignite-plugin-prop-types"],
    ["OtherComponentWithPropTypes", "/path/to/component"]
  ]
}

Use in your documentation:

OtherComponentWithPropTypes Documentation Page
 
Description of component.
 
<PropTypes component='OtherComponentWithPropTypes' />

Result:

Example Output Image

Readme

Keywords

none

Package Sidebar

Install

npm i ignite-plugin-prop-types

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

285 kB

Total Files

8

Last publish

Collaborators

  • alisowski