0.10.1 • Published 4 years ago
@bdt-component-library/unordered-list v0.10.1
UnorderedList 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
Handles display of unordered lists according to style guide conventions. Can be used for many generic kinds of lists, including input controls.
API
| prop | type | required | default | explanation |
|---|---|---|---|---|
| className | string | no | n/a | Adds an optional classname to the list |
| children | React node | yes | n/a | The inner content of the list |
| variant | enum("unstyled", "icon") | no | "unstyled" | Changes list style for use with elements like icons |
| inline | boolean | no | false | Changes list style to inline |
| inlineWithSeparators | boolean | no | false | Changes list style to inline with elements like icons, overrides inline |
| noTopMargin | boolean | no | false | Removes top spacing |
| noBottomMargin | boolean | no | false | Removes bottom spacing |
| spacing | enum(0, 1, 2, 3, 4) | no | 1 | Determines the spacing between children passed into the UnorderedList component (0 means no spacing) |