vaul

https://github.com/emilkowalski/vaul/assets/36730035/fdf8c5e8-ade8-433b-8bb0-4ce10e722516

Vaul is an unstyled drawer component for React that can be used as a Dialog replacement on tablet and mobile devices. You can read about why and how it was built here.

Usage

To start using the library, install it in your project:,

npm install vaul

Use the drawer in your app.

import { Drawer } from 'vaul';

function MyComponent() {
  return (
    <Drawer.Root>
      <Drawer.Trigger>Open</Drawer.Trigger>
      <Drawer.Portal>
        <Drawer.Content>
          <p>Content</p>
        </Drawer.Content>
        <Drawer.Overlay />
      </Drawer.Portal>
    </Drawer.Root>
  );
}

Examples

Play around with the examples on codesandbox:

• With scaled background
• Without scaled background
• With snap points
• Scrollable with inputs
• Drawer from right instead of bottom
• Nested drawers
• Non-dismissible
• Non-draggable element

API Reference

Root

Contains all parts of a dialog. Use shouldScaleBackground to enable background scaling, it requires an element with [data-vaul-drawer-wrapper] data attribute to scale its background. Can be controlled with the value and onOpenChange props. Can be opened by default via the open prop.

Additional props:

closeThreshold: Number between 0 and 1 that determines when the drawer should be closed. Example: threshold of 0.5 would close the drawer if the user swiped for 50% of the height of the drawer or more.

scrollLockTimeout: Duration for which the drawer is not draggable after scrolling content inside of the drawer. Defaults to 500ms.

snapPoints: Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up. Should go from least visible. Example [0.2, 0.5, 0.8]. You can also use px values, which doesn't take screen height into account.

fadeFromIndex: Index of a snapPoint from which the overlay fade should be applied. Defaults to the last snap point.

modal: When false it allows to interact with elements outside of the drawer without closing it. Defaults to true.

direction: Direction of the drawer. Can be top or bottom, left, right. Defaults to bottom.

repositionInputs: When true Vaul will reposition inputs rather than scroll then into view if the keyboard is in the way. Setting it to false will fall back to the default browser behavior.

noBodyStyles: When true the body doesn't get any styles assigned from Vaul.

setBackgroundColorOnScale: When false we don't change body's background color when the drawer is open. true by default.

defaultOpen: Opened by default, still reacts to open state changes.

[data-vaul-no-drag]: When interacting with an element with this data attribute, the drawer won't be dragged.

Controlled Drawer

Drawer can be controlled programmatically by providing the open prop. If you want to react to open state changes from within the Drawer use the onOpenChange prop, this will allow you to provide your own open state while still closing the drawer when the escape key is pressed for example.

const [open, setOpen] = React.useState(false);

// ...

<Drawer.Root open={open} onOpenChange={setOpen}>
  // ...
</Drawer.Root>

Trigger

The button that opens the dialog. Props.

Content

Content that should be rendered in the drawer. Props.

Overlay

A layer that covers the inert portion of the view when the dialog is open. Props.

Title

An accessible title to be announced when the dialog is opened. Props.

Description

An optional accessible description to be announced when the dialog is opened. Props.

Close

The button that closes the dialog. Props.

Portal

Portals your drawer into the body.