From 3dbfbdb74fb0c914a7c20de5ce7d1377c96b1fcc Mon Sep 17 00:00:00 2001 From: Antony Caporossi Date: Wed, 7 Jan 2026 16:42:31 +0100 Subject: [PATCH 1/2] docs: clarify API differences from original Vaul --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 28eb14b..afc3d3f 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,17 @@ function MyDrawerComponent() { [Here are additional examples](https://vaul-base.vercel.app/examples) demonstrating the component in use. -## Documentation +### 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). \ No newline at end of file From 6039498d27697358e172029f28ac139a696cad1e Mon Sep 17 00:00:00 2001 From: Antony Caporossi Date: Wed, 7 Jan 2026 16:44:49 +0100 Subject: [PATCH 2/2] docs: clarify API differences from original Vaul --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index afc3d3f..dbb2e83 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,9 @@ function MyDrawerComponent() { [Here are additional examples](https://vaul-base.vercel.app/examples) demonstrating the component in use. -### API Differences from Vaul +### 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: