Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

@vaadin/app-layout

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vaadin/app-layout

vaadin-app-layout


Version published
Maintainers
14
Created

@vaadin/app-layout

A web component for building common application layouts.

Documentation + Live Demo ↗

npm version Discord

<vaadin-app-layout>
  <vaadin-drawer-toggle slot="navbar touch-optimized"></vaadin-drawer-toggle>
  <h3 slot="navbar touch-optimized">Application Name</h3>
  <vaadin-tabs orientation="vertical" slot="drawer">
    <vaadin-tab>
      <a href="/profile">
        <vaadin-icon icon="lumo:user"></vaadin-icon>
        Profile
      </a>
    </vaadin-tab>
    <vaadin-tab>
      <a href="/contact">
        <vaadin-icon icon="lumo:phone"></vaadin-icon>
        Contact
      </a>
    </vaadin-tab>
  </vaadin-tabs>
  <div>Page content</div>
</vaadin-app-layout>

Screenshot of vaadin-app-layout

Screenshot of vaadin-app-layout on mobile

Installation

Install the component:

npm i @vaadin/app-layout

Once installed, import the components in your application:

import '@vaadin/app-layout';
import '@vaadin/app-layout/vaadin-drawer-toggle.js';

Themes

Vaadin components come with two built-in themes, Lumo and Material. The main entrypoint of the package uses the Lumo theme.

To use the Material theme, import the components from the theme/material folder:

import '@vaadin/app-layout/theme/material/vaadin-app-layout.js';
import '@vaadin/app-layout/theme/material/vaadin-drawer-toggle.js';

You can also import the Lumo version of the components explicitly:

import '@vaadin/app-layout/theme/lumo/vaadin-app-layout.js';
import '@vaadin/app-layout/theme/lumo/vaadin-drawer-toggle.js';

Finally, you can import the un-themed components from the src folder to get a minimal starting point:

import '@vaadin/app-layout/src/vaadin-app-layout.js';
import '@vaadin/app-layout/src/vaadin-drawer-toggle.js';

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.

FAQs

Package last updated on 13 May 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts