Home

Awesome

CircleCI branch Codecov branch npm npm

<div align="center"> <img width="200" height="200" src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-11/256/fire.png"> <h1> Ignite-Plugin-Prop-Types </h1> <p>Takes a react component and displays a table with it's prop-types.</p> </div>

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