@wavesurfer/react

@wavesurfer/react

A React component and hook for wavesurfer.js.

It makes it easy to use wavesurfer from React. All of the familiar wavesurfer options become React props.

You can subscribe to various wavesurfer events also via props. Just prepend an event name with on, e.g. ready -> onReady. Each event callback receives a wavesurfer instance as the first argument.

Installation

With yarn:

yarn add wavesurfer.js @wavesurfer/react

With npm:

npm install wavesurfer.js @wavesurfer/react

Usage

As a component:

import WavesurferPlayer from '@wavesurfer/react'

const App = () => {
  const [wavesurfer, setWavesurfer] = useState(null)
  const [isPlaying, setIsPlaying] = useState(false)

  const onReady = (ws) => {
    setWavesurfer(ws)
    setIsPlaying(false)
  }

  const onPlayPause = () => {
    wavesurfer && wavesurfer.playPause()
  }

  return (
    <>
      <WavesurferPlayer
        height={100}
        waveColor="violet"
        url="/my-server/audio.wav"
        onReady={onReady}
        onPlay={() => setIsPlaying(true)}
        onPause={() => setIsPlaying(false)}
      />

      <button onClick={onPlayPause}>
        {isPlaying ? 'Pause' : 'Play'}
      </button>
    </>
  )
}

Alternatively, as a hook:

import { useRef } from 'react'
import { useWavesurfer } from '@wavesurfer/react'

const App = () => {
  const containerRef = useRef(null)

  const { wavesurfer, isReady, isPlaying, currentTime } = useWavesurfer({
    container: containerRef,
    url: '/my-server/audio.ogg',
    waveColor: 'purple',
    height: 100,
  })

  const onPlayPause = () => {
    wavesurfer && wavesurfer.playPause()
  }

  return (
    <>
      <div ref={containerRef} />

      <button onClick={onPlayPause}>
        {isPlaying ? 'Pause' : 'Play'}
      </button>
    </>
  )
}

Using plugins

Wavesurfer plugins can be passed in the plugins option.

Important: The plugins array must be memoized using useMemo or defined outside the component. This is because wavesurfer.js mutates plugin instances during initialization, and passing a new array on every render will cause errors.

Basic example with a single plugin

import { useMemo } from 'react'
import WavesurferPlayer from '@wavesurfer/react'
import Timeline from 'wavesurfer.js/dist/plugins/timeline.esm.js'

const App = () => {
  const plugins = useMemo(() => {
    return [
      Timeline.create({
        container: '#timeline',
      }),
    ]
  }, [])

  return (
    <>
      <WavesurferPlayer
        height={100}
        waveColor="violet"
        url="/audio.wav"
        plugins={plugins}
      />
      <div id="timeline" />
    </>
  )
}

Example with multiple plugins

import { useMemo } from 'react'
import WavesurferPlayer from '@wavesurfer/react'
import Timeline from 'wavesurfer.js/dist/plugins/timeline.esm.js'
import Regions from 'wavesurfer.js/dist/plugins/regions.esm.js'

const App = () => {
  const plugins = useMemo(() => {
    return [
      Timeline.create({
        container: '#timeline',
      }),
      Regions.create(),
    ]
  }, [])

  return (
    <>
      <WavesurferPlayer
        height={100}
        waveColor="violet"
        url="/audio.wav"
        plugins={plugins}
      />
      <div id="timeline" />
    </>
  )
}

Alternative: Define plugins outside the component

If your plugins don't depend on component props or state, you can define them outside:

import WavesurferPlayer from '@wavesurfer/react'
import Timeline from 'wavesurfer.js/dist/plugins/timeline.esm.js'

// Define plugins outside the component
const plugins = [
  Timeline.create({
    container: '#timeline',
  }),
]

const App = () => {
  return (
    <>
      <WavesurferPlayer
        height={100}
        waveColor="violet"
        url="/audio.wav"
        plugins={plugins}
      />
      <div id="timeline" />
    </>
  )
}

Docs

https://wavesurfer.xyz