New

Drawer

PreviousNext

A drawer component for React.

Radix UIBase UI
"use client"

import * as React from "react"

About

Drawer is built on top of Vaul by emilkowalski.

Installation

pnpm dlx shadcn@latest add drawer

Usage

import {
  Drawer,
  DrawerClose,
  DrawerContent,
  DrawerDescription,
  DrawerFooter,
  DrawerHeader,
  DrawerTitle,
  DrawerTrigger,
} from "@/components/ui/drawer"
<Drawer>
  <DrawerTrigger>Open</DrawerTrigger>
  <DrawerContent>
    <DrawerHeader>
      <DrawerTitle>Are you absolutely sure?</DrawerTitle>
      <DrawerDescription>This action cannot be undone.</DrawerDescription>
    </DrawerHeader>
    <DrawerFooter>
      <Button>Submit</Button>
      <DrawerClose>
        <Button variant="outline">Cancel</Button>
      </DrawerClose>
    </DrawerFooter>
  </DrawerContent>
</Drawer>

Composition

Use the following composition to build a Drawer:

Drawer
├── DrawerTrigger
└── DrawerContent
    ├── DrawerHeader
    │   ├── DrawerTitle
    │   └── DrawerDescription
    └── DrawerFooter

Examples

Scrollable Content

Keep actions visible while the content scrolls.

import { Button } from "@/components/ui/button"
import {
  Drawer,

Sides

Use the direction prop to set the side of the drawer. Available options are top, right, bottom, and left.

import { Button } from "@/components/ui/button"
import {
  Drawer,

Responsive Dialog

You can combine the Dialog and Drawer components to create a responsive dialog. This renders a Dialog component on desktop and a Drawer on mobile.

"use client"

import * as React from "react"

RTL

To enable RTL support in DWL Components, see the RTL configuration guide.

"use client"

import * as React from "react"

API Reference

See the Vaul documentation for the full API reference.