The v-navigation-drawer component is what your users will utilize to navigate through the application. The navigation-drawer is pre-configured to work with or without vue-router right out the box. For the purpose of display, some examples are wrapped in a v-card element. Within your application you will generally place the v-navigation-drawer as a direct child of v-app.

Usage

The navigation drawer is primarily used to house links to the pages in your application. Using null as the starting value for its v-model will initialize the drawer as closed on mobile and as open on desktop. It is common to pair drawers with the v-list component using the nav property.

API

v-navigation-drawer

Examples

Colored drawer

Navigation drawers can be customized to fit any application's design. Here we apply a custom background color and an appended content area using the append slot.

Permanent floating drawer

By default, a navigation drawer has a 1px right border that separates it from content. In this example we want to detach the drawer from the left side and let it float on its own. The floating property removes the right border (or left if using right).

Avatars

When setting up drawer lists you will typically pair the nav prop with dense. This will lower the font-size of the list items and reduce the vertical space that they take up.

Mini

When using the mini-variant prop, the drawer will shrink (default 80px) and hide everything inside of v-list except the first element. In this example we use the .sync modifier that allows us to tie the expanding/contracting of the drawer programmatically.

Temporary

A temporary drawer sits above its application and uses a scrim (overlay) to darken the background. This drawer behavior is mimicked by default when on mobile. Clicking outside of the drawer will cause it to close.

Dark theme

The v-navigation-drawer also supports the dark variant.

Combined drawers

In this example we define a custom width to accommodate our nested drawer. Using v-layout we ensure that the drawer and list stack horizontally next to each other.

Nested lists

Using the v-list-group component you can create up to 2 levels in depth using the sub-group prop. For more information on v-list, navigate here.

Right positioned

Navigation drawers can also be positioned on the right side of your application (or an element). This is also useful for creating a side-sheet with auxillary information that may not have any navigation links. When using RTL you must explicitly define right for your drawer.

Backgrounds

Apply a custom background to your drawer. If you need to customize v-img's properties you can use the scoped img scoped slot.

Bottom drawer

Using the bottom prop, we are able to relocate our drawer on mobile devices to come from the bottom of the screen. This is an alternative style and only activates once the mobile-break-point is met.

Expand on hover

Places the component in mini-variant mode and expands once hovered. Does not alter the content area. Width can be controlled with the mini-variant-width property.

Edit this page | language on Github