File size: 2,640 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
---
title: Drawer
description:
Used to render a content that slides in from the side of the screen.
links:
source: components/drawer
storybook: components-drawer--basic
recipe: drawer
ark: https://ark-ui.com/react/docs/components/dialog
---
<ExampleTabs name="drawer-basic" />
## Usage
```tsx
import { Drawer } from "@chakra-ui/react"
```
```tsx
<Drawer.Root>
<Drawer.Backdrop />
<Drawer.Trigger />
<Drawer.Positioner>
<Drawer.Content>
<Drawer.CloseTrigger />
<Drawer.Header>
<Drawer.Title />
</Drawer.Header>
<Drawer.Body />
<Drawer.Footer />
</Drawer.Content>
</Drawer.Positioner>
</Drawer.Root>
```
## Examples
### Controlled
Use the `open` and `onOpenChange` props to control the drawer component.
<ExampleTabs name="drawer-controlled" />
### Sizes
Use the `size` prop to change the size of the drawer component.
<ExampleTabs name="drawer-with-sizes" />
### Context
Use the `DrawerContext` component to access the drawer state and methods from
outside the drawer.
<ExampleTabs name="drawer-with-context" />
### Offset
Pass the `offset` prop to the `DrawerContent` to change the offset of the drawer
component.
<ExampleTabs name="drawer-with-offset" />
### Placement
Use the `placement` prop to change the placement of the drawer component.
<ExampleTabs name="drawer-with-placement" />
### Initial Focus
Use the `initialFocusEl` prop to set the initial focus of the drawer component.
<ExampleTabs name="drawer-with-initial-focus" />
### Custom Container
Here's an example of how to render the drawer component in a custom container.
Consider setting `closeOnInteractOutside` to `false` to prevent the drawer from
closing when interacting outside the drawer.
<ExampleTabs name="drawer-with-custom-container" />
### Header Actions
Here's an example of rendering actions in the header of the drawer component.
<ExampleTabs name="drawer-with-header-actions" />
### Drawer with conditional variants
Here is an example of how to change variants based on the different breakpoints.
This example uses the `mdDown` breakpoint to change the drawer's placement on
smaller screens. This approach is recommended because both conditions are
translated into CSS media queries, which helps avoid base style merging issues.
If you really want to use the base condition instead, you’ll also need to define
corresponding sizes.
For example:
`<Drawer.Root placement={{ base: "bottom", md: "end" }} size={{ base: "xs", md: "md" }}>`
<ExampleTabs name="drawer-with-conditional-variants" />
## Props
### Root
<PropTable component="Drawer" part="Root" />
|