Underline nav
The UnderlineNav is used to display navigation.
On this page
v0.14.0AlphaNot reviewed for accessibility
Description
Use UnderlineNav
to style navigation links with a minimal
underlined selected state, typically placed at the top
of the page.
For panel navigation, use UnderlinePanels instead.
Accessibility
- By default,
UnderlineNav
renders links within a<nav>
element.<nav>
has an implicit landmark role ofnavigation
which should be reserved for main links. For all other set of links, set tag to:div
. - See
Primer::Alpha::Navigation::Tab
for additional accessibility considerations.
Arguments
Name | Default | Description |
---|---|---|
tag |
| Symbol One of |
label | N/A | String Sets an |
align |
| Symbol One of |
body_arguments |
| Hash System arguments for the body wrapper. |
system_arguments | N/A | Hash |
Examples
Slots
tabs
Use the tabs to list page links.
Name | Default | Description |
---|---|---|
selected | N/A | Boolean Whether the tab is selected. |
system_arguments | N/A | Hash |
actions
Use actions for a call to action.
Name | Default | Description |
---|---|---|
tag |
| Symbol One of |
system_arguments | N/A | Hash |