Vaul

An unstyled drawer component for React.

ModalHeadless componentsReactGesture - Touch
emilkowalski/vaulvaul.emilkowal.ski

README

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. It uses Radix's Dialog primitive under the hood and is inspired by this tweet.

Usage


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

  1. ```bash
  2. npm install vaul
  3. ```

Use the drawer in your app.

  1. ```jsx
  2. import { Drawer } from 'vaul';

  4. function MyComponent() {
  5.   return (
  6.     <Drawer.Root>
  7.       <Drawer.Trigger>Open</Drawer.Trigger>
  8.       <Drawer.Portal>
  9.         <Drawer.Content>
  10.           <p>Content</p>
  11.         </Drawer.Content>
  12.         <Drawer.Overlay />
  13.       </Drawer.Portal>
  14.     </Drawer.Root>
  15.   );
  16. }
  17. ```

Examples


Play around with the examples on codesandbox:

- With scaled background
- Without scaled background
- With snap points
- Scrollable with inputs
- Nested drawers
- Non-dismissible

API Reference


Root


Contains all parts of a dialog. Use shouldScaleBackground to enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.
Can be controlled with the value and onOpenChange props. Can be opened by default via defaultOpen 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 falseit allows to interact with elements outside of the drawer without closing it. Defaults totrue.

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.