React component to render a table view for the props metadata of another react component.
npm install terra-props-table
React component to render a table view for the props metadata of another react component.
- Getting Started
- Documentation
- LICENSE
- Install from npmjs: npm install terra-props-table
This component requires the following peer dependencies be installed in your app for the component to properly function.
| Peer Dependency | Version |
|-|-|
| react | ^16.8.5 |
| react-dom | ^16.8.5 |
props-table src/Status.jsx --out-dir ./docs
js
const propTypes = {
/**
* Child node. Component to display next to the status indicator.
*/
children: PropTypes.node.isRequired,
/**
* The color of the status indicator. Accepts a CSS color value.
*/
color: PropTypes.string,
};const Status = ({ color, children }) => {
return (
{children}
);
};Status.propTypes = propTypes;
`The status react component (above) will generate the markdown table (below).
| Prop Name | Type | Is Required | Default Value | Description |
|-|-|-|-|-|
| children|
| required| | Child node. Component to display next to the status indicator.|
| color| string`| optional| | The color of the status indicator. Accepts a CSS color value.|Copyright 2017 - 2019 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.