Skip to content

Docs/clarify api differences #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
antonycaporossi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs/clarify api differences #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3dbfbdb
docs: clarify API differences from original Vaul
antonycaporossi Jan 7, 2026
6039498
docs: clarify API differences from original Vaul
antonycaporossi Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ function MyDrawerComponent() {

[Here are additional examples](https://vaul-base.vercel.app/examples) demonstrating the component in use.

## Documentation
### Documentation and API Differences from Vaul

You can use original [Vaul documentation](https://vaul.emilkowal.ski/getting-started) for more information.

Since vaul-base uses Base UI internally (instead of Radix UI), the following components are re-exported directly from [Base UI's Dialog](https://base-ui.com/react/components/dialog) and follow Base UI's Dialog API conventions:

- `Drawer.Trigger`
- `Drawer.Close`
- `Drawer.Title`
- `Drawer.Description`


> **Note:** Base UI uses `render` prop instead of Radix's `asChild` for composition.


For more details on Base UI's Dialog, see the [Base UI Dialog component](https://base-ui.com/react/components/dialog).