@bdt-component-library/button-group

ButtonGroup component

Usage no npm install needed!

<script type="module">
  import bdtComponentLibraryButtonGroup from 'https://cdn.skypack.dev/@bdt-component-library/button-group';
</script>

README

ButtonGroup 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 button groups according to style guide conventions (infers conventions from the structured list component).

API

prop type required default explanation
children React node yes n/a The components to group inside the button group
className string no n/a Adds an optional classname to the component
inline boolean no false Determines if button group displays in inline or block
spacing enum(1, 2, 3, 4) no 1 Determines the spacing between children passed into the ButtonGroup component
wrap enum("wrap", "no-wrap") no "wrap" Determines if flex-wrap attribute is applied