Breadcrumbs

readyNot reviewed for a11y

This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

Description

Use Breadcrumbs to display page hierarchy.

Known issues

Responsiveness

Breadcrumbs is not optimized for responsive designs.

Breadcrumbs renders a list of links within a nav element and has an implicit landmark role of navigation. By default, the component labels the nav element with "Breadcrumbs" which helps distinguish the type of navigation. Additionally, the component will always render the last link, which should represent the current page, with an aria-current="page" attribute.

For more information on the breadcrumbs pattern implemented by this component, see WAI-ARIA 1.1 Breadcrumb.

Arguments

Name	Required	Description
system_arguments		`Hash` System arguments

Slots

`items`

Name	Required	Description
href		`String` The URL to link to.
system_arguments		`Hash` System arguments

This component is part of Primer::Beta::Breadcrumbs and should not be used as a standalone component.

`selected`

Returns the value of attribute selected.

`selected=(value)`

Sets the attribute selected

Name	Required	Description
value		the value to set the attribute selected to.

`href`

Returns the value of attribute href.

`href=(value)`

Sets the attribute href

Name	Required	Description
value		the value to set the attribute href to.