Takes a react component and displays a table with it's prop-types.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
__tests__
src
.gitignore
LICENSE
README.md
example.png
package.json
yarn.lock

README.md

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