Files
directus/docs/reference/app/components/v-drawer.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

2.4 KiB

Drawer

A more robust dialog that is rendered at the side and provides more space than a usual dialog. Can be helpful for relational or nested data.

<v-drawer v-model="isOpen">
	<div>This text will show up in the drawer</div>
</v-drawer>

Reference

Props

Prop Description Default Type
title* The title of the drawer String
subtitle The subtitle of the drawer null String
active Can be used with v-model to open or close the drawer undefined Boolean
persistent Disallow closing the drawer by clicking out of it false Boolean
icon An icon for the drawer 'box' String
sidebar-label A label for the sidebar i18n.t('sidebar') String

Events

Event Description Value
cancel When escape is pressed or the drawer gets canceled in other ways
toggle When the drawer gets opened or closed boolean

Slots

Slot Description Data
activator Elements placed inside here can activate the drawer on
sidebar Display components to the side of the drawer like tabs
subtitle Add a custom subtitle
actions:prepend Prepend actions to the drawer
actions Add actions to the top right corner
header:append Append your elements to the header
default Where the content of the drawer goes

CSS Variables

Variable Default
--v-drawer-max-width 856px