Installation
Install @uturi/sonification and optional framework peer dependencies.
Install the package
npm install @uturi/sonification
# or
yarn add @uturi/sonification
# or
pnpm add @uturi/sonificationEntry points
| Import | Use when |
|---|---|
@uturi/sonification | Default entry (core API + types) |
@uturi/sonification/core | Core API only, no framework hooks |
@uturi/sonification/react | React useSonifier hook |
@uturi/sonification/vue | Vue useSonifier hook |
@uturi/sonification/svelte | Svelte useSonifier hook |
Prefer a framework-specific import when you are already using that framework:
import { useSonifier } from '@uturi/sonification/react';Peer dependencies
These are optional. Install only what you need:
react:^18.0.0(for React support)vue:^3.0.0(for Vue support)svelte:^3.0.0 || ^4.0.0 || ^5.0.0(for Svelte support)
Requirements
- Node.js: 18.0.0 or higher
- Browser: Web Audio API support (Chrome, Firefox, Safari, Edge)