Active theme set to LightDarkLight high contrastDark high contrast and saved in preferences.
Copied to clipboard.
Error submitting your feedback! Please try again.
We’re hiring frontend developers! View open positions.

NavigationReady

Navigation is used to display the primary navigation in the sidebar of an application. Navigation includes a list of links that users use to move between sections of the application.

Edit in CodePen
Open in new window
Edit in CodePen
Open in new window
View RTL
<nord-navigation style="max-inline-size: 250px">
<nord-button slot="header" expand variant="switch">
<span slot="start" aria-hidden="true" class="n-clinic-icon">B</span>
Bath Clinic
</nord-button>
<nord-nav-group heading="Workspace">
<nord-nav-item active icon="navigation-dashboard">Dashboard</nord-nav-item>
<nord-nav-item icon="navigation-payments">Payments</nord-nav-item>
<nord-nav-item icon="navigation-reports">Reports</nord-nav-item>
<nord-nav-item icon="navigation-settings">Settings</nord-nav-item>
</nord-nav-group>
</nord-navigation>

Slots

Slot nameDescription
Default slotThe main section of the sidebar, for holding nav components.
headerThe top section of the sidebar.
footerThe bottom section of the sidebar.

Usage #

This section includes guidelines for designers and developers about the usage of this component in different contexts.

Do #

  • Use for primary navigation items that perform an action when clicked. Each action should navigate to a URL or trigger another action like a modal overlay.
  • Group navigation items into navigation groups based on related categories.
  • Use group headings to clarify the category of a section.
  • Use icons for all top level navigation items.

Don’t #

  • Don’t place a <nav> element inside the navigation component, as it already contains one internally.

Content guidelines #

When writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):

My tasks
My Tasks

Avoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:

Change theme
Change the theme

Avoid ending item labels in punctuation:

Switch user
Switch user.

Use as few words as possible to describe each item label:

Payments
Payments in your clinic

Avoid all caps for item labels and group titles:

Dashboard
DASHBOARD

Integration

For integration guidelines, please see Web Components documentation. This documentation explains how to implement and use Nord Web Components across different technologies such as Vue.js, React, or Vanilla JavaScript.

Integration Guidelines

Localization

Nord provides a lightweight solution for localizing its components. Not all components need localizing, as for the most part snippets of text are set per instance. For full localization guidelines, please see Localization documentation.

Localization Guidelines

Troubleshooting

If you experience any issues while using Nord Web Components, please head over to the Support page for more guidelines and ways to contact us.


Was this page helpful?

YesNo
Send feedback

We use this feedback to improve our documentation.