https://github.com/emilkowalski/vaul

A drawer component for React.
https://github.com/emilkowalski/vaul

dialog drawer react

Last synced: about 14 hours ago
JSON representation

A drawer component for React.

• Host: GitHub
• URL: https://github.com/emilkowalski/vaul
• Owner: emilkowalski
• License: mit
• Created: 2023-07-16T11:24:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-14T00:57:07.000Z (17 days ago)
• Last Synced: 2024-12-23T15:05:10.668Z (8 days ago)
• Topics: dialog, drawer, react
• Language: TypeScript
• Homepage: https://vaul.emilkowal.ski
• Size: 1.11 MB
• Stars: 6,618
• Watchers: 12
• Forks: 219
• Open Issues: 67
• Metadata Files:
  • Readme: README.md
  • Funding: FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-shadcn-ui - Vaul - A drawer component for React. (Components)
• awesome-shadcn-ui - Vaul - A drawer component for React. (Components)

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. You can read about why and how it was built [here](https://emilkowal.ski/ui/building-a-drawer-component).

## Usage

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

```bash

npm install vaul

```

Use the drawer in your app.

```jsx

import { Drawer } from 'vaul';

function MyComponent() {

  return (

    

      Open

      

        

          Title

        

        

      

    

  );

}

```

## Documentation

Find the full API reference and examples in the [documentation](https://vaul.emilkowal.ski/getting-started).