> ## Documentation Index
> Fetch the complete documentation index at: https://docs.audx.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> UI sound effects for React and the web, as code you own.

audx is an open-source library of UI sound effects. Pick a theme, add the sounds you need, and call them like functions.

```ts theme={null}
import { click, success, error } from "@/sounds";

click();
```

There are no audio files. Every sound is a few hundred bytes of JSON that the [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API) synthesizes at play time. The CLI writes each sound into your project as a plain TypeScript module, so you own the code and can change it.

## Why audx

> [card] Semantic sounds
>
> 43 sounds named for what they mean, like `click`, `toggle`, `success`, `error` and `notify`, so you pick a sound by intent, not by waveform.

> [card] Swappable themes
>
> Every built-in theme ships the same 43 sounds. Run `audx theme playful` to re-skin your whole app without touching code.

> [card] Code you own
>
> Sounds land in `src/sounds/` as readable source. Commit them, review them and edit them like any other module.

> [card] Tiny and SSR-safe
>
> No audio assets to download. Playing a sound during server rendering, or while muted, does nothing.

## How it works

**1. Initialize**

`npx @litlab/audx init` creates `audx.json`, installs `@litlab/audx` and lets you pick a starter set of sounds.

**2. Add sounds**

`npx @litlab/audx add click success` writes one module per sound, plus an `index.ts` that re-exports them.

**3. Play them**

Import a sound and call it, or pass it to `useSound` in React to respect a mute setting and the user's reduced-motion preference.

## Next steps

> [card] [Quickstart](https://docs.audx.site/quickstart.md)
>
> Add your first sounds in under a minute.

> [card] [Use with React](https://docs.audx.site/guides/react.md)
>
> `SoundProvider`, `useSound` and a sound on/off setting.

> [card] [Themes](https://docs.audx.site/guides/themes.md)
>
> Compare the four built-in themes and switch between them.

> [card] [CLI reference](https://docs.audx.site/reference/cli.md)
>
> Every command and flag.

> [!TIP]
>
> Hear every sound before you install it at [audx.site](https://audx.site), or try them in real components at [audx.site/showcase](https://audx.site/showcase).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.