Skip to contentDisplay
On this page
UnderlineNav v2
Use an underlined nav to allow tab like navigation with overflow behaviour in your UI.
On this page
import {UnderlineNav} from '@primer/react/drafts'
Examples
Simple
With Icons
Overflow Behaviour
When overflow occurs, the component first hides icons if present to optimize for space and show as many items as possible. (Only for fine pointer devices)
Items Without Icons
Display More Menu
If there is still overflow, the component will behave depending on the pointer.
Loading state for counters
Props
UnderlineNav
| Name | Type | Default | Description |
|---|---|---|---|
| aria-label | string | A unique name for the rendered 'nav' landmark. It will also be used to label the arrow buttons that control the scroll behaviour on coarse pointer devices. (I.e. 'Scroll ${aria-label} left/right') | |
| loadingCounters | boolean | false | Whether all of the counters are in loading state |
| afterSelect | (event) => void | The handler that gets called when a nav link child is selected | |
| sx | SystemStyleObject | Style overrides to apply to the component. See also overriding styles. |
UnderlineNav.Item
| Name | Type | Default | Description |
|---|---|---|---|
| icon | Component | The leading icon comes before item label | |
| selected | boolean | Whether the link is selected | |
| onSelect | (event) => void | The handler that gets called when a nav link is selected | |
| as | string | Component | a | What kind of component needs to be rendered |
| sx | SystemStyleObject | Style overrides to apply to the component. See also overriding styles. |
Status
Alpha
- Component props are documented on primer.style/react.
- Component does not have any unnecessary third-party dependencies.
- Component can adapt to different themes.
- Component can adapt to different screen sizes.
- Component has 100% test coverage.
Beta
- Component is used in a production application.
- Common usage examples are documented on primer.style/react.
- Common usage examples are documented in storybook stories.
- Component has been reviewed by a systems designer and any resulting issues have been addressed.
- Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.
Stable
- Component API has been stable with no breaking changes for at least one month.
- Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
- Component has corresponding design guidelines documented in the interface guidelines.
- Component has corresponding Figma component in the Primer Web library.
Edit this page on GitHub
2 contributors
Last edited by broccolinisoup on October 11, 2022