@bdt-component-library/ordered-list

Ordered List component

Usage no npm install needed!

<script type="module">
  import bdtComponentLibraryOrderedList from 'https://cdn.skypack.dev/@bdt-component-library/ordered-list';
</script>

README

OrderedList 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 ordered lists according to style guide conventions.

API

prop type required default explanation
listClassName string no n/a Adds an optional classname to the list
children React node yes n/a The inner content of the list
numberIcons boolean no n/a Changes list style for use with icons
inline boolean no false Changes list style for use with elements like icons
noTopMargin boolean no false Removes top spacing
noBottomMargin boolean no false Removes bottom spacing