Breadcrumb Item
<wa-breadcrumb-item>
Breadcrumb Items are used inside breadcrumbs to represent different links.
This component must be used as a child of <wa-breadcrumb>. Please see the Breadcrumb docs to see examples of this component in action.
Importing
Jump to heading
Autoloading components via projects is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.
Let your project code do the work! Sign up for free to use a project with your very own CDN — it's the fastest and easiest way to use Web Awesome.
To manually import this component from NPM, use the following code.
import '@awesome.me/webawesome/dist/components/breadcrumb-item/breadcrumb-item.js';
To manually import this component from React, use the following code.
import WaBreadcrumbItem from '@awesome.me/webawesome/dist/react/breadcrumb-item';
Slots
Jump to heading
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The breadcrumb item's label. |
end
|
An element, such as <wa-icon>, placed after the label. |
separator
|
The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on <wa-breadcrumb> instead. |
start
|
An element, such as <wa-icon>, placed before the label. |
Attributes & Properties
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
styles |
||
customStates |
Methods for setting and checking custom states.
Type
objectDefault
{ /** Adds or removes the specified custom state. / set: (customState: string, active: boolean) => { if (!Boolean(this.internals?.states)) return; try { if (active) { this.internals.states.add(customState); } else { this.internals.states.delete(customState); } } catch (e) { if (String(e).includes("must start with '--'")) { / eslint-disable-next-line / console.error('Your browser implements an outdated version of CustomStateSet. Consider using a polyfill'); } else { throw e; } } }, /* Determines whether or not the element currently has the specified state. */ has: (customState: string) => { if (!Boolean(this.internals?.states)) return false; try { return this.internals.states.has(customState); } catch { return false; } }, } |
||
hrefhref |
Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered
internally. When unset, a button will be rendered instead.
Type
string | undefined |
||
relrel |
The
rel attribute to use on the link. Only used when href is set.Type
stringDefault
'noreferrer noopener' |
||
targettarget |
Tells the browser where to open the link. Only used when
href is set.Type
'_blank' | '_parent' | '_self' | '_top' | undefined |
Methods
Jump to heading
Learn more about methods.
| Name | Description | Arguments |
|---|---|---|
relayNativeEvent() |
Given a native event, this function cancels it and dispatches it again from the host element using the desired event options. |
event: Event,
eventOptions: EventInit
|
CSS parts
Jump to heading
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
end |
The container that wraps the end slot. |
::part(end)
|
label |
The breadcrumb item's label. |
::part(label)
|
separator |
The container that wraps the separator. |
::part(separator)
|
start |
The container that wraps the start slot. |
::part(start)
|