> Note
> This repository is a port of the original Vaul library by Emil Kowalski, migrated from radix-ui to base-ui.

Purpose

The primary goal of this repository is to provide a base-ui equivalent of Vaul while preserving the original API and behavior as closely as possible.

This port intentionally minimizes changes in order to:

- Reduce migration friction for existing Vaul users
- Keep parity with the upstream project
- Establish a stable baseline before introducing enhancements or divergence

Quick start

$3

``bash
npm install base-vaul


or

pnpm add base-vaul

or

yarn add base-vaul
`

$3

`tsx
import { Drawer } from 'base-vaul';

export function Example() {
return (

Open drawer




Drawer title
Drawer description



);
}
`

The API mirrors the original Vaul implementation as closely as possible, with the main differences coming from the underlying base-ui primitives.

Differences from the original Vaul

$3

Since base-ui does not support asChild, components that relied on this pattern in radix-ui now expose a render prop instead.

Original (Radix / Vaul):

`tsx

Open drawer

`

This port (Base UI):

`tsx
Open drawer} />
``

Roadmap

Planned next steps include:

- Writing proper documentation (usage, API, and migration notes)
- Solidifying the project structure with a well-defined monorepo setup
- Upgrading development dependencies and expanding test coverage
- Ongoing maintenance, bug fixes, and alignment with upstream changes where relevant