Skip to content
On this page
SubNav
- Alpha
- Review pending by accessibility team
On this page
Use the SubNav component for navigation on a dashboard-type interface with another set of navigation components above it. This helps distinguish navigation hierarchy.
To use SubNav with react-router or
react-router-dom, pass
as={NavLink} and omit the selected prop.
This ensures that the NavLink gets activeClassName='selected'
Attention: Make sure to properly label your SubNav with an aria-label to provide context about the type of navigation contained in SubNav.
Default example
SubNav with search example
SubNav with filtered search example
Component props
SubNav
| Name | Type | Default | Description |
|---|---|---|---|
| actions | Node | Place another element, such as a button, to the opposite side of the navigation items. | |
| align | String | Use right to have navigation items aligned right. | |
| full | Boolean | Used to make navigation fill the width of the container. | |
| aria-label | String | Used to set the aria-label on the top level <nav> element. | |
| sx | SystemStyleObject | {} | Style to be applied to the component |
SubNav.Link
| Name | Type | Default | Description |
|---|---|---|---|
| as | String | sets the HTML tag for the component | |
| href | String | URL to be used for the Link | |
| selected | Boolean | Used to style the link as selected or unselected | |
| sx | SystemStyleObject | {} | Style to be applied to the component |
SubNav.Links
| Name | Type | Default | Description |
|---|---|---|---|
| sx | SystemStyleObject | {} | Style to be applied to the component |
Edit this page on GitHub
5 contributors
Last edited by mperrotti on May 5, 2022