Nav ToggleReady
Nav toggle is meant for hiding and showing the primary navigation. This component is used internally in the Layout component, but can also be used separate to further customize the behavior.
<nord-nav-toggle></nord-nav-toggle>Methods
| Method name | Parameters | Description |
|---|---|---|
focus(options?: FocusOptions) => void | options: An object which controls aspects of the focusing process. | Programmatically move focus to the component. |
blur() => void | N/A | Programmatically remove focus from the component. |
click() => void | N/A | Programmatically simulates a click on the component. |
Localization
This component requires localization in a multi-lingual application. The following keys are required when registering a translation:
| Key | Description |
|---|---|
label | Accessible label for the nav toggle button. |
For full localization guidelines, please see Localization documentation.
Dependencies
This component is internally dependent on the following components:
Button
Buttons are used for interface actions. Primary style should be used only once per section for main call-to-action, while other styles can appear more frequently.
Icon
Icons are used to provide additional meaning or in places where text label doesn’t fit. Icon component allows you to display an icon from the Nordicons library.
Visually Hidden
Visually hidden is used when an element needs to be available to assistive technologies like screen readers, but be otherwise hidden.
Usage
This section includes guidelines for designers and developers about the usage of this component in different contexts.
Do
- Use a tooltip with the toggle that’s labelled as
Toggle navigation. - We recommend setting a keyboard shortcut that toggles the navigation.
Don’t
- Don’t use as a generic button or toggle. Use the Button component instead.
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.
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.