PropShop
PropShop provides an holistic view of all defined PropTypes in your project.
https://github.com/PaulieScanlon/gatsby-plugin-prop-shop
file | name | type | required | defaultValue | description |
---|---|---|---|---|---|
DefaultValue | |||||
DefaultValue | defaultValue |
| false | - | The default value of the prop from react-docgen |
Donut | |||||
Donut | percent |
| true | - | The percent to drive the donut chart |
Donut | donutSize |
| false | 42 | The size of the donut |
Filters | |||||
Filters | noPropsFilter |
| false | - | Parent noPropsFilter state value |
Filters | setNoPropsFilter |
| false | - | Sets parent noPropsFilter state value |
Header | |||||
- | - | - | - | - | |
Icon | |||||
Icon | iconPath |
| true | - | Material Icon svg path |
Icon | iconSize |
| false | 22 | The default px value for the width and height |
Icon | iconFill |
| false | 'currentColor' | The default fill css value |
Intro | |||||
- | - | - | - | - | |
Logo | |||||
Logo | logoSize |
| false | 64 | The size of the logo |
Main | |||||
- | - | - | - | - | |
PropTable | |||||
PropTable | searchTerm |
| true | - | Parent searchTerm state value |
PropTable | isTableExpanded |
| true | - | Parent isTableExpanded state value |
PropTable | propData |
| true | - | The result of GraphQL allComponentMetaData query + applied filter |
PropTable | filterOptions |
| true | - | Array of filter-able values taken from GraphQL query |
PropType | |||||
PropType | type |
| false | - | The type value of the prop from react-docgen |
Required | |||||
Required | required |
| false | - | The required value of the prop from react-docgen |
Search | |||||
Search | searchTerm |
| true | - | Parent searchTerm state value |
Search | setSearchTerm |
| true | - | Sets parent searchTerm state value |
Search | clearSearchTerm |
| true | - | Clear parent searchTerm state value |
Search | searchFilter |
| true | - | Parent searchFilter state value |
Search | setSearchFilter |
| true | - | Sets parent searchFilter state value |
Search | filterOptions |
| true | - | Array of filter-able values taken from GraphQL query |
ShowMore | |||||
ShowMore | isTableExpanded |
| false | - | Parent isTableExpanded state value |
ShowMore | setIsTableExpanded |
| false | - | Sets parent setIsTableExpanded state value |
StatPanel | |||||
StatPanel | text |
| true | - | The text to display |
StatPanel | value |
| true | - | The number to display |
StatPanel | total |
| true | - | The total to display |
StatPanel | percent |
| true | - | The percent to drive the donut chart |
TableContainer | |||||
TableContainer | children |
| false | - | React children |
TableContainer | rest |
| false | - | Rest object |
TableWrapper | |||||
TableWrapper | children |
| false | - | React children |
Table | |||||
Table | children |
| false | - | React children |
Thead | |||||
Thead | children |
| false | - | React children |
Tbody | |||||
Tbody | children |
| false | - | React children |
Tr | |||||
Tr | children |
| false | - | React children |
Tr | rest |
| false | - | Rest object |
Th | |||||
Th | children |
| false | - | React children |
Th | rest |
| false | - | Rest object |
Td | |||||
Td | children |
| false | - | React children |
Td | rest |
| false | - | Rest object |