@bdt-component-library/description-list-item
v0.1.1
Published
DescriptionListItem component
Downloads
5
Readme
DescriptionListItem 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 renders a heading and text in a list format. It is intended to be wrapped by the DescriptionList component.
- https://zeroheight.com/990ea04ab/p/000580-lists/t/4538f1
API
| prop | type | required | default | explanation | |-----------|--------|----------|---------|--------------| | children | React node | yes | n/a | The information that renders under the heading | | className | string | no | "" | Adds a class to the component | | inline | boolean | no | false | Determines whether the heading and children render horizontally or vertically | | heading | string | yes | n/a | The bold text that renders above the children |
