0.1.1 • Published 4 years ago
@bdt-component-library/description-list v0.1.1
DescriptionList Component
About
This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.
Description
This component wraps DescriptionListItem to enforce proper layout. It displays headings and values in a list format---either horizontally or vertically.
API
| prop | type | required | default | explanation |
|---|---|---|---|---|
| className | string | no | "" | Adds a class to the component |
| children | React node(s) | yes | n/a | The component(s) to receive the DescriptionList layout |
| inline | boolean | no | false | Determines whether the heading and children render horizontally or vertically |