README.md

July 8, 2018 ยท View on GitHub

CircleCI branch Codecov branch npm npm

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