Quick Start

A quick guide to getting started with Base UI Vue.

Install the library

Install Base UI Vue using a package manager.

npm

$ npm install base-ui-vue

pnpm

$ pnpm add base-ui-vue

yarn

$ yarn add base-ui-vue

bun

$ bun add base-ui-vue

All components are included in a single package. Base UI Vue is tree-shakable, so your app bundle will contain only the components that you actually use.

Assemble a component

Start with a component page such as Button, Accordion, or Form, then compose its parts and apply your own styles.

If you need renderless or advanced composition, continue with:

• useRender
• mergeProps
• DirectionProvider
• CSPProvider

Next steps

This walkthrough outlines the basics of putting together a Base UI Vue component. Browse the rest of the documentation to see what components are available in the library and how to use them.

• Read Accessibility
• Browse the Components
• Check GitHub Releases for updates
• Use the Handbook for cross-cutting patterns

Working with LLMs

For those of you working with LLMs, each docs page has a "View as Markdown" link at the top, which can be shared with AI chat assistants to help them understand Base UI Vue concepts and component APIs.

Additionally, there is an "llms.txt" link in the "Handbook" section of the navigation sidebar, which you can feed to AI chat assistants to help them navigate the docs.