# audx

> Documentation for audx, the open-source UI sound effects library for React, Next.js and the web: 43 semantic interaction sounds in 4 themes, synthesized with the Web Audio API and installed as code you own.

- [UI sound effects for React and the web](https://docs.audx.site/index.md): Open-source UI sound effects for React, Next.js and any web app: 43 interaction sounds in 4 themes, synthesized with Web Audio and installed as code you own.
- [Quickstart: add UI sounds to your app](https://docs.audx.site/quickstart.md): Add click, success, error and notification sounds to a React, Next.js or JavaScript app in under a minute with one CLI command: npx @litlab/audx init.
- [Add sound effects to a React app](https://docs.audx.site/guides/react.md): Play UI sound effects from React components with the useSound hook, add a mute and volume setting with SoundProvider, and respect prefers-reduced-motion.
- [Add sound effects to a Next.js app](https://docs.audx.site/guides/nextjs.md): Add UI sound effects to a Next.js App Router or Pages Router app with audx: set up, play sounds from client components, and add a mute setting.
- [Use audx with Vue, Svelte or vanilla JavaScript](https://docs.audx.site/guides/frameworks.md): audx sounds are plain functions, so they work in Vue, Nuxt, Svelte, SvelteKit, Astro, Solid, Angular and plain JavaScript. Set up, play sounds, and add mute.
- [UI sound themes: change every sound with one command](https://docs.audx.site/guides/themes.md): Pick a sound theme (minimal, playful, mechanical or retro) and switch the personality of every UI sound in your app with one command, without touching code.
- [Create a custom UI sound theme](https://docs.audx.site/guides/custom-themes.md): Fork a built-in audx theme into a JSON file, tune it to your brand, share it by URL, and apply it to every sound in your app.
- [Design UI sounds with the Web Audio API](https://docs.audx.site/guides/designing-sounds.md): Build your own UI sounds in code with defineSound: oscillators, noise, samples, envelopes, filters, effects and layers, rendered live with the Web Audio API.
- [UI sound design best practices](https://docs.audx.site/guides/best-practices.md): When to add sound to a user interface, which sound fits each interaction, and how to keep UI sounds subtle, consistent and accessible.
- [Configure audx with audx.json](https://docs.audx.site/guides/configuration.md): Configure the audx CLI with audx.json: where sound files go, which theme and registry to use, and how audx runs in CI and scripts.
- [Migrate from use-sound to audx](https://docs.audx.site/guides/migrate-from-use-sound.md): Move a React app from the use-sound hook to audx: map each option, keep your existing audio files or switch to synthesized sounds, and add a global mute.
- [audx CLI reference](https://docs.audx.site/reference/cli.md): Every audx CLI command, flag and alias: init, add, remove, list, theme, update and create.
- [UI sound catalog: click, toggle, success, error and 39 more](https://docs.audx.site/reference/sounds.md): The 43 semantic UI sounds every audx theme ships, from click, hover and toggle to success, error, notify and loading, and when to use each one.
- [Core API reference (@litlab/audx)](https://docs.audx.site/reference/core-api.md): API reference for @litlab/audx: defineSound, play options, sequences, global mute and volume, patches, offline WAV rendering, analysis and 3D audio.
- [React API reference: useSound, SoundProvider and hooks](https://docs.audx.site/reference/react-api.md): API reference for @litlab/audx/react: SoundProvider, useSound, useSequence, usePatch, useAnalyser and useListener.
- [Sound definition JSON reference](https://docs.audx.site/reference/sound-definition.md): Every field of the JSON format that describes an audx sound: sources, envelopes, filters, LFOs, effects, layers and 3D panning.

## Optional

- [Browse sounds](https://audx.site)
- [Showcase](https://audx.site/showcase)
- [Changelog](https://audx.site/changelog)


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