Documentation
Everything you need to add professional sounds to your web app
Quick Start
Peal will be available soon! We're putting the finishing touches on our sound library.
What's Coming
1. Professional UI Sounds - Carefully crafted sounds for modern web apps
2. Easy Integration - Simple API that works with any framework
3. Lightweight - Tiny footprint, big impact
Stay tuned for the official launch!
3. Use It (1 minute)
import { peal } from './peal';
// In your click handler
button.addEventListener('click', async () => {
peal.click(); // Play click sound
try {
await saveData();
peal.success(); // Play success sound
} catch (err) {
peal.error(); // Play error sound
}
});That's it! You now have professional UI sounds in your app.
CLI Manages Sounds
Add and remove sounds from our curated collection with simple commands
Library Plays Them
Thin wrapper around Howler.js with zero configuration needed
TypeScript Ready
Full TypeScript support with generated types for your sounds
Framework Agnostic
Works with React, Vue, Svelte, or vanilla JavaScript