Lab

Installation

Set audio/ui up by hand in your framework, as the prompt of Get Started does for you.

The prompt of the Get Started page does this for you. Here is what it sets up by hand, in your framework.

Prerequisites

audio/ui is built on React 19 and Tailwind CSS v4. Set up both first, with shadcn/ui: the shadcn/ui installation guide covers the environment.

Install a primitive

Copy a styled component with the shadcn CLI. @audio-ui is in shadcn's registry directory, so there is nothing to configure:

pnpm dlx shadcn@latest add @audio-ui/knob

Or, without the styles, copy the headless primitive and style it yourself:

pnpm dlx shadcn@latest add @audio-ui/knob-react

The same works for every item of the Docs, including the block-* blocks and demos you install with @audio-ui/…. You can also install by manual copy, for full control.

Without the CLI

Each item is a JSON file at its address, and the CLI only reads it: you can do the same by hand. Open the address of the item (for the knob in Vue, https://www.audio-ui.dev/r/styles/base-nova/knob-vue.json), write each entry of files to its path under components/audio-ui/ with its content, and install the packages its dependencies lists. An agent can do this for you: the prompt of Get Started says how.

Use it

Import it from where it landed, through your components alias:

import { Knob } from "@/components/audio-ui/knob";

The page of each component has its parts, its options and an example in your framework: Knob is the first to open.

The package a primitive needs

Primitives import from @audio-ui/core (and some components from @audio-ui/engine: pitch, MIDI, musical time, analysis). Installing one adds the package to your package.json if it is not there, with no version pinned: the version is yours to choose.

The CLI leaves a version you already have. If an older @audio-ui/core is installed and a component needs a subpath it did not have yet, your build says it cannot resolve @audio-ui/engine/time (or /pitch, /midi, /analysis). Update the package:

pnpm add @audio-ui/core@latest

If your package manager still resolves the old version, bypass its cache: with Bun, add --no-cache.

Styling

Components are styled with a design token system defined by CSS variables and implemented with Tailwind CSS, following the same conventions as shadcn/ui so they're fully customizable. See the Styling guide for details.

Continue with First Component to add a knob to your app.

Built by Ouest Labs, the source code is available on GitHub.
RSS