0.2.3 • Published 4 years ago
@bdt-component-library/breadcrumb v0.2.3
Breadcrumb 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
API
| prop | type | required | default | explanation |
|---|---|---|---|---|
| children | React node | yes | n/a | The components to render as breadcrumbs |
| className | string | no | n/a | Adds an optional classname to the component |
| separator | any | no | ">" | Changes the separator used between breadcrumbs (implicitly inherits Breadcrumbs' separator) |
| last | boolean | no | false | Deterimines if Breadcrumb is last and is a separator should be used (implicitly set by Breadcrumbs container) |
| url | string | yes | n/a | The URL to pass to the Link component for the Breadcrumb |
| isTruncated | boolean | no | false | Changes styles to use truncation |