https://github.com/hipstersmoothie/ignite-plugin-prop-types

Takes a react component and displays a table with it's prop-types.
https://github.com/hipstersmoothie/ignite-plugin-prop-types

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hipstersmoothie/ignite-plugin-prop-types
• Owner: hipstersmoothie
• License: apache-2.0
• Created: 2018-07-08T07:31:30.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-11T17:22:01.000Z (almost 7 years ago)
• Last Synced: 2024-10-29T08:43:05.754Z (6 months ago)
• Language: JavaScript
• Homepage: https://github.com/intuit/Ignite
• Size: 119 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CircleCI branch](https://img.shields.io/circleci/project/github/hipstersmoothie/ignite-plugin-prop-types/master.svg?style=for-the-badge)](https://circleci.com/gh/hipstersmoothie/workflows/ignite-plugin-prop-types/tree/master) [![Codecov branch](https://img.shields.io/codecov/c/github/hipstersmoothie/ignite-plugin-prop-types/master.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/ignite-plugin-prop-types/branch/master) [![npm](https://img.shields.io/npm/v/ignite-plugin-prop-types.svg?style=for-the-badge)](https://www.npmjs.com/package/ignite-plugin-prop-types) [![npm](https://img.shields.io/npm/dt/ignite-plugin-prop-types.svg?style=for-the-badge)](https://www.npmjs.com/package/ignite-plugin-prop-types)



  

  


    Ignite-Plugin-Prop-Types

  

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



## Usage

Install the plugin:

```bash

yarn add ignite-plugin-prop-types

```

Add it to your `.igniterc` or `package.json`:

```json

{

  "plugins": [

    ["PropTypes", "ignite-plugin-prop-types"],

    ["OtherComponentWithPropTypes", "/path/to/component"]

  ]

}

```

Use in your documentation:

```markdown

# OtherComponentWithPropTypes Documentation Page

Description of component.

```

Result:

![Example Output Image](example.png)