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.

Open in new window

View RTL

<nord-navigation style="max-inline-size: 250px">
  <nord-dropdown slot="header" expand>
    <nord-button slot="toggle" expand>
      <nord-avatar slot="start" variant="square">B</nord-avatar>
      Bath Clinic
    </nord-button>
    <nord-dropdown-group heading="laura.williams@nordhealth.com">
      <nord-dropdown-item>
        <nord-avatar slot="start" size="s" variant="square">B</nord-avatar>
        Bath Clinic
        <nord-icon slot="end" name="interface-checked"></nord-icon>
      </nord-dropdown-item>
      <nord-dropdown-item>
        <nord-avatar slot="start" size="s" variant="square" style="--n-avatar-color: var(--n-color-status-success)">
          O
        </nord-avatar>
        Ocean Beach Clinic
      </nord-dropdown-item>
    </nord-dropdown-group>
    <nord-dropdown-group>
      <nord-dropdown-item>Add another clinic</nord-dropdown-item>
      <nord-dropdown-item>Customize style</nord-dropdown-item>
    </nord-dropdown-group>
    <nord-dropdown-item>Sign out from all clinics</nord-dropdown-item>
  </nord-dropdown>
  <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>

<nord-navigation style="max-inline-size: 250px">
  <nord-dropdown slot="header" expand>
    <nord-button slot="toggle" expand>
      <nord-avatar slot="start" name="Bath Clinic" variant="square">B</nord-avatar>
      Bath Clinic
    </nord-button>
    <nord-dropdown-group heading="laura.williams@nordhealth.com">
      <nord-dropdown-item>
        <nord-avatar slot="start" name="Bath Clinic" size="s" variant="square">B</nord-avatar>
        Bath Clinic
        <nord-icon slot="end" name="interface-checked"></nord-icon>
      </nord-dropdown-item>
      <nord-dropdown-item>
        <nord-avatar
          slot="start"
          name="Ocean Beach Clinic"
          size="s"
          variant="square"
          style="--n-avatar-color: var(--n-color-status-success)"
        >
          O
        </nord-avatar>
        Ocean Beach Clinic
      </nord-dropdown-item>
      <nord-dropdown-item>
        <nord-avatar
          slot="start"
          name="Park Animal Hospital"
          size="s"
          variant="square"
          style="--n-avatar-color: var(--n-color-status-highlight)"
        >
          P
        </nord-avatar>
        Park Animal Hospital
      </nord-dropdown-item>
      <nord-dropdown-item>
        <nord-avatar
          slot="start"
          name="Balboa Pet Hospital"
          size="s"
          variant="square"
          style="--n-avatar-color: var(--n-color-status-danger)"
        >
          B
        </nord-avatar>
        Balboa Pet Hospital
      </nord-dropdown-item>
    </nord-dropdown-group>
    <nord-dropdown-group>
      <nord-dropdown-item>Add another clinic</nord-dropdown-item>
      <nord-dropdown-item>Customize style</nord-dropdown-item>
    </nord-dropdown-group>
    <nord-dropdown-item>Sign out from all clinics</nord-dropdown-item>
  </nord-dropdown>
  <nord-nav-group>
    <nord-nav-item aria-describedby="search" icon="navigation-search">Search</nord-nav-item>
    <nord-tooltip id="search" position="inline-end">
      Search
      <nord-icon slot="shortcut" name="keyboard-option" label="Option key"></nord-icon>
      <span slot="shortcut">S</span>
    </nord-tooltip>
    <nord-nav-item icon="navigation-notifications" aria-describedby="notifications" badge="12">
      Notifications
    </nord-nav-item>
    <nord-tooltip id="notifications" position="inline-end">
      Notifications
      <nord-icon slot="shortcut" name="keyboard-option" label="Option key"></nord-icon>
      <span slot="shortcut">N</span>
    </nord-tooltip>
    <nord-nav-item icon="navigation-tasks" aria-describedby="tasks">My tasks</nord-nav-item>
    <nord-tooltip id="tasks" position="inline-end">
      My tasks
      <nord-icon slot="shortcut" name="keyboard-option" label="Option key"></nord-icon>
      <span slot="shortcut">M</span>
    </nord-tooltip>
  </nord-nav-group>
  <nord-nav-group heading="Workspace">
    <nord-nav-item href="#" icon="navigation-dashboard">Dashboard</nord-nav-item>
    <nord-nav-item icon="navigation-payments">
      Payments
      <nord-nav-group slot="subnav">
        <nord-nav-item href="#" active>All transactions</nord-nav-item>
        <nord-nav-item href="#">Payments</nord-nav-item>
        <nord-nav-item href="#">Disputes</nord-nav-item>
      </nord-nav-group>
    </nord-nav-item>
    <nord-nav-item icon="navigation-reports">
      Reports
      <nord-nav-group slot="subnav">
        <nord-nav-item href="#">Payments</nord-nav-item>
        <nord-nav-item href="#">Disputes</nord-nav-item>
        <nord-nav-item href="#">Payouts</nord-nav-item>
      </nord-nav-group>
    </nord-nav-item>
    <nord-nav-item href="#" icon="navigation-settings">Settings</nord-nav-item>
  </nord-nav-group>
  <nord-dropdown expand slot="footer">
    <nord-button slot="toggle" expand>
      <nord-avatar slot="start" aria-hidden="true" name="Laura Williams"></nord-avatar>
      Laura Williams
    </nord-button>
    <nord-dropdown-group>
      <nord-dropdown-item href="#">View profile</nord-dropdown-item>
      <nord-dropdown-item>Settings</nord-dropdown-item>
    </nord-dropdown-group>
    <nord-dropdown-group>
      <nord-dropdown-item>
        Show keyboard shortcuts
        <div slot="end" class="n-color-text-weaker n-font-size-xs">Cmd+K</div>
      </nord-dropdown-item>
      <nord-dropdown-item>Help & Support</nord-dropdown-item>
      <nord-dropdown-item>API</nord-dropdown-item>
    </nord-dropdown-group>
    <nord-dropdown-item>
      Sign out
      <nord-icon slot="end" name="interface-logout"></nord-icon>
    </nord-dropdown-item>
  </nord-dropdown>
</nord-navigation>

<script>
  const navigation = document.querySelector("nord-navigation")

  // for demo purposes, activate nav items on click.
  // in most cases you should instead integrate with your chosen router
  navigation.addEventListener("click", e => {
    if (e.target.matches("nord-nav-item") && e.target.href) {
      e.target.active = true
      e.preventDefault()
    }
  })
</script>

Slots

Slot name	Description
Default slot	The main section of the sidebar, for holding nav components.
`header`	The top section of the sidebar.
`footer`	The bottom section of the sidebar.

CSS Properties

CSS Custom Properties provide more fine grain control over component presentation.

Property	Description	Default
`--n-navigation-background-color`	Controls the background color of the navigation element.	`var(--n-color-nav-surface)`

Dependencies

This component is internally dependent on the following components:

Nav Item
Navigation item populates sidebar navigation with links. Every item should be placed inside a navigation group.

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

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.