2021-09-25 16:51:32 +08:00
---
category: Components
type: Feedback
title: Drawer
cover: https://gw.alipayobjects.com/zos/alicdn/7z8NJQhFb/Drawer.svg
---
A panel which slides in from the edge of the screen.
## When To Use
A Drawer is a panel that is typically overlaid on top of a page and slides in from the side. It contains a set of information or actions. Since the user can interact with the Drawer without leaving the current page, tasks can be achieved more efficiently within the same context.
- Use a Form to create or edit a set of information.
- Processing subtasks. When subtasks are too heavy for a Popover and we still want to keep the subtasks in the context of the main task, Drawer comes very handy.
- When the same Form is needed in multiple places.
## API
2021-10-03 13:30:50 +08:00
| Props | Description | Type | Default | Version |
2021-09-25 16:51:32 +08:00
| --- | --- | --- | --- | --- |
2021-10-07 22:13:56 +08:00
| autofocus | Whether Drawer should get focused after open | boolean | true | 3.0.0 |
2021-10-03 13:30:50 +08:00
| bodyStyle | Style of the drawer content part | CSSProperties | - | |
| class | The class name of the container of the Drawer dialog | string | - | |
2022-03-12 09:56:32 +08:00
| closable | Whether a close (x) button is visible on top left of the Drawer dialog or not | boolean | true | |
2021-10-03 13:30:50 +08:00
| closeIcon | Custom close icon | VNode \| slot | < CloseOutlined /> | 3.0.0 |
2021-10-08 10:11:20 +08:00
| contentWrapperStyle | Style of the drawer wrapper of content part | CSSProperties | - | 3.0.0 |
2021-10-03 13:30:50 +08:00
| destroyOnClose | Whether to unmount child components on closing drawer or not | boolean | false | |
2021-09-25 16:51:32 +08:00
| drawerStyle | Style of the popup layer element | object | - | |
2021-10-03 13:30:50 +08:00
| extra | Extra actions area at corner | VNode \| slot | - | 3.0.0 |
| footer | The footer for Drawer | VNode \| slot | - | 3.0.0 |
| footerStyle | Style of the drawer footer part | CSSProperties | - | 3.0.0 |
| forceRender | Prerender Drawer component forcely | boolean | false | 3.0.0 |
| getContainer | Return the mounted node for Drawer | HTMLElement \| `() => HTMLElement` \| Selectors | 'body' | |
| headerStyle | Style of the drawer header part | CSSProperties | - | 3.0.0 |
| height | Placement is `top` or `bottom` , height of the Drawer dialog | string \| number | 378 | |
| keyboard | Whether support press esc to close | boolean | true | |
| mask | Whether to show mask or not | Boolean | true | |
| maskClosable | Clicking on the mask (area outside the Drawer) to close the Drawer or not | boolean | true | |
| maskStyle | Style for Drawer's mask element | CSSProperties | {} | |
| placement | The placement of the Drawer | 'top' \| 'right' \| 'bottom' \| 'left' | 'right' | |
2021-10-08 10:11:20 +08:00
| push | Nested drawers push behavior | boolean \| {distance: string \| number} | { distance: 180 } | 3.0.0 |
2021-10-03 13:30:50 +08:00
| size | presetted size of drawer, default `378px` and large `736px` | `default` \| `large` | `default` | 3.0.0 |
| style | Style of wrapper element which contains mask compare to drawerStyle | CSSProperties | - | |
| title | The title for Drawer | string \| slot | - | |
| visible(v-model) | Whether the Drawer dialog is visible or not | boolean | - | |
| width | Width of the Drawer dialog | string \| number | 378 | |
| zIndex | The `z-index` of the Drawer | Number | 1000 | |
2021-09-25 16:51:32 +08:00
2021-10-07 22:13:56 +08:00
## Events
2021-09-25 16:51:32 +08:00
| Name | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
2021-10-03 13:30:50 +08:00
| afterVisibleChange | Callback after the animation ends when switching drawers. | function(visible) | - | |
2021-09-25 16:51:32 +08:00
| close | Specify a callback that will be called when a user clicks mask, close button or Cancel button. | function(e) | - | |
