- Selector
- bp-breadcrumbs
Interfaces
You can import the following interfaces from epsilon-blueprint to properly type your inputs.
| Input | Type | Notes |
|---|---|---|
| BreadcrumbInterface | interface | Interface for typing a crumbs object. See crumbs. |
Inputs
Crumbs
The crumbs Input is an array of objects typed as BreadcrumbInterface[]. It is the only Input on the bp-breadcrumbs component. The keys and expected values are listed below.
| Input | Type | Description | Notes |
|---|---|---|---|
| text | string | The text used for the crumb's text. | Required for all crumbs. |
| bpRouterLink | string | The crumb's routerLink value. | Either bpRouterLink or href is required for all but the last crumb. If neither are provided, the breadcrumb will be a button. Invalid for the last crumb. |
| href | string | The crumb's href value. | Either bpRouterLink or href is required for all but the last crumb. If neither are provided, the breadcrumb will be a button. Invalid for the last crumb. |
| target | string | The crumb's target value. | Invalid for the last crumb. |
| bpID | string | The value for the breadcrumb's id attribute. | Ids must only be used once per page. Ids should be camelCase, e.g.: #myId. See identifiers. |
Outputs
| Output | Type | Description |
|---|---|---|
| clickCrumb | BreadcrumbInterface | When neither bpRouterLink or href is provided in a breadcrumb, the breadcrumb acts as a button. When clicked the breadcrumb object is emitted. |
Identifiers
| ID | Description |
|---|---|
bpID | The unique identifier for the breadcrumbs component. |
bpID + 'Crumb' + i | The unique identifier for each crumb. |