diff --git a/README.md b/README.md index 28eb14b..dbb2e83 100644 --- a/README.md +++ b/README.md @@ -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). \ No newline at end of file