@vaadin/side-nav

@vaadin/side-nav

A web component for navigation menus.

Documentation + Live Demo

<vaadin-side-nav collapsible>
  <span slot="label">Main menu</span>

  <vaadin-side-nav-item path="/dashboard">
    <vaadin-icon icon="vaadin:chart" slot="prefix"></vaadin-icon>
    Dashboard
    <vaadin-badge slot="suffix" number="2" theme="number-only">new items</vaadin-badge>
  </vaadin-side-nav-item>

  <vaadin-side-nav-item>
    <vaadin-icon icon="vaadin:folder-open" slot="prefix"></vaadin-icon>
    Parent

    <vaadin-side-nav-item path="/child1" slot="children"> Child 1 </vaadin-side-nav-item>

    <vaadin-side-nav-item path="/child2" slot="children"> Child 2 </vaadin-side-nav-item>
  </vaadin-side-nav-item>
</vaadin-side-nav>

Installation

Install the component:

npm i @vaadin/side-nav

Once installed, import the component in your application:

import '@vaadin/side-nav';

Contributing

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.

License

Apache License 2.0

Vaadin collects usage statistics at development time to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.