0.2.3 • Published 3 years ago
@bdt-component-library/callout v0.2.3
Callout 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 is used to call out special information with multiple pieces of metadata, and is often used in multiples. By default, a headline appears, and other information and calls to action can be added.
API
| prop | type | required | default | explanation |
|---|---|---|---|---|
| className | string | no | "" | Adds a custom className |
| headline | string | yes | "" | The largest bit of content |
| secondary | string | no | "" | The copy under the headline |
| buttonElement | React.ReactElement | no | undefined | The Button component that appears on the right side of the component |
| chipElement | React.ReactElement | no | undefined | The Chip component that appears next to the headline |
| iconName | string | no | "" | The isometric icon that appears before the headline |