@bdt-component-library/chip

Chip component

Usage no npm install needed!

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

README

Chip 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 chips according to style guide conventions.

API

prop type required default explanation
children React node yes n/a The text to display inside the chip
className string no n/a Adds an optional classname to the component
small boolean no undefined Determines if the chip is the small variation
variant enum("default", "success", "error", "warning", "dark", "light") no "default" Changes the variation style of the chip