miguelgargallo / vaul Goto Github PK

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.

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>
  );
}

Play around with the examples on codesandbox:

• With scaled background
• Without scaled background
• Scrollable with inputs

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.

The button that opens the dialog. Props.

Content that should be rendered in the drawer. Props.

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

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

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

The button that closes the dialog. Props.

Portals your drawer into the body.