Drawer

A slide-in panel that overlays the main content.

Dependencies

Source Code

import { cn } from "@/lib/utils";
import {
  Modal,
  ModalClose,
  ModalContent,
  ModalDescription,
  ModalTitle,
  ModalTrigger,
} from "@/components/modal";
 
type DrawerProps = React.ComponentProps<typeof Modal>;
 
const Drawer = (props: DrawerProps) => {
  return <Modal {...props} />;
};
 
type DrawerContentProps = React.ComponentProps<typeof ModalContent>;
 
const DrawerContent = ({
  className,
  children,
  ...props
}: DrawerContentProps) => {
  return (
    <ModalContent
      className={cn(
        "[--drawer-p:--spacing(4)]",
        "bg-background-high border-border mx-auto flex w-full max-w-screen flex-col !overflow-x-hidden overflow-y-auto border p-(--drawer-p) *:shrink-0",
        "has-[[data-drawer-actions]:last-child]:pb-0 has-[[data-modal-focus-catcher]:first-child+[data-drawer-header],[data-drawer-header]:first-child]:pt-0",
        "backdrop:bg-black/20 backdrop:backdrop-blur-sm not-data-[status=open]:backdrop:opacity-0",
        // desktop
        "md:mr-0 md:h-full md:max-h-screen md:w-full md:max-w-128 md:not-data-[status=open]:translate-x-full",
        // mobile
        "min-h-[50svh] max-md:mb-0 max-md:max-h-[calc(100svh-(--spacing(16)))] max-md:w-full max-md:rounded-t-xl max-md:not-data-[status=open]:translate-y-full",
        // animation props
        "ease-emphasized-decelerate not-data-[status=open]:ease-emphasized-accelerate transition-transform",
        "backdrop:transition-opacity backdrop:ease-in-out",
        "motion-reduce:transition-none motion-reduce:backdrop:transition-none",
        "duration-400 not-data-[status=open]:duration-250 not-data-[status=open]:backdrop:delay-150 not-data-[status=open]:backdrop:duration-200",
        className
      )}
      {...props}
    >
      {children}
    </ModalContent>
  );
};
 
const DrawerTrigger = ModalTrigger;
 
const DrawerClose = ModalClose;
 
const DrawerTitle = ({
  children,
  className,
  ...props
}: React.ComponentProps<typeof ModalTitle>) => {
  return (
    <ModalTitle className={cn("font-semibold", className)} {...props}>
      {children}
    </ModalTitle>
  );
};
 
const DrawerDescription = ({
  children,
  className,
  ...props
}: React.ComponentProps<typeof ModalDescription>) => {
  return (
    <ModalDescription className={cn("pb-2", className)} {...props}>
      {children}
    </ModalDescription>
  );
};
 
const DrawerBleed = ({
  className,
  ...props
}: React.ComponentPropsWithRef<"div">) => {
  return <div className={cn("-mx-(--drawer-p)", className)} {...props} />;
};
 
const DrawerHeader = ({
  className,
  children,
  ...props
}: React.ComponentPropsWithRef<"div">) => {
  return (
    <DrawerBleed
      className={cn(
        "bg-background border-border sticky top-0 z-10 mb-(--drawer-p) border-b p-(--drawer-p)",
        className
      )}
      {...props}
      data-drawer-header=""
    >
      {children}
    </DrawerBleed>
  );
};
 
const DrawerActions = ({
  className,
  children,
  ...props
}: React.ComponentPropsWithRef<"div">) => {
  return (
    <DrawerBleed
      className={cn(
        "bg-background border-border sticky bottom-0 mt-auto flex gap-2 border-t p-(--drawer-p)",
        className
      )}
      {...props}
      data-drawer-actions=""
    >
      {children}
    </DrawerBleed>
  );
};
 
export {
  Drawer,
  DrawerContent,
  DrawerTrigger,
  DrawerClose,
  DrawerTitle,
  DrawerDescription,
  DrawerBleed,
  DrawerHeader,
  DrawerActions,
};

Features

  • Modal Overlay: Creates an accessible modal dialog with backdrop
  • Focus Management: Automatically traps focus within the dialog
  • Flexible Positioning: Center or top alignment options
  • Controlled & Uncontrolled: Supports both controlled and uncontrolled modes
  • Customizable Actions: Built-in support for common dialog actions

Anatomy

<Drawer>
  <DrawerTrigger />
  <DrawerContent>
    <DrawerHeader>
      <DrawerTitle />
    </DrawerHeader>
    <DrawerDescription />
    <DrawerActions>
      <DrawerClose />
    </DrawerActions>
  </DrawerContent>
</Drawer>

API Reference

Drawer

Extends the Modal component.

DrawerContent

Extends the ModalContent component.

DrawerTrigger

Extends the ModalTrigger component.

DrawerClose

Extends the ModalClose component.

DrawerTitle

Extends the ModalTitle component.

DrawerDescription

Extends the ModalDescription component.

DrawerHeader

Extends the div element.

DrawerActions

Extends the div element.

Examples

Simple

Tall Content

Controlled

Best Practices

  1. Content Structure:

    • Always include a clear title that describes the purpose
    • Keep content concise and focused
    • Use appropriate action labels (avoid "OK/Cancel")
  2. Performance:

    • Lazy load dialog content if needed
    • Consider using dynamic imports for heavy content
    • Clean up resources when dialog closes