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.

Nav ItemReady

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

Edit in CodePen
Open in new window
Edit in CodePen
Open in new window
Edit in CodePen
Open in new window
Edit in CodePen
Open in new window
Edit in CodePen
Open in new window
View RTL
<nord-nav-group style="max-inline-size: 220px">
<nord-nav-item href="#">Dashboard</nord-nav-item>
</nord-nav-group>

Properties

PropertyAttributeDescriptionTypeDefault
activeactive

Used for indicating the current page. This gives a prominent background to the nav item, and marks the item as the current page for assistive technology.

booleanfalse
iconicon

The name of an icon from Nordicons to display for the nav item.

string | undefinedundefined
hrefhref

The url the nav item should link to. Note: this is not used if you have nested navigation using the "subnav" slot.

string | undefinedundefined
badgebadge

Allows you to add a notification badge with a number next to the nav item.

string | undefinedundefined
openopen

When the nav items contains a subnav, controls whether the section is expanded or not. Note: this is only used if you have nested navigation using the "subnav" slot.

booleanfalse

Events

EventDescriptionType
toggle

Dispatched whenever a nav item's state changes between open and closed.

NordEvent

Slots

Slot nameDescription
Default slotThe default slot used for the nav item's text.
subnavUsed for nesting navigation. When used the nav-item becomes a button to collapse the subnav, rather than a link.

Methods

Method nameParametersDescription
focus(options?: FocusOptions) => voidoptions: An object which controls aspects of the focusing process.
Programmatically move focus to the component.
blur() => voidN/AProgrammatically remove focus from the component.
click() => voidN/AProgrammatically simulates a click on the component.

Usage #

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

Do #

  • 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 use navigation item outside of navigation group and navigation components.

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.