react-guitar-sound

A React Hook to play sound with react-guitar.

Usage no npm install needed!

<script type="module">
  import reactGuitarSound from 'https://cdn.skypack.dev/react-guitar-sound';
</script>

README

React-Guitar-Sound · npm version

A React Hook to play sound with react-guitar.

See https://react-guitar.com for a live demo.

For the full documentation go to the root README.

Edit quizzical-dawn-0hzuq

Usage

npm i react-guitar react-guitar-sound react-guitar-tunings

import React, { useMemo } from 'react'
import { render } from 'react-dom'
import Guitar from 'react-guitar'
import { standard } from 'react-guitar-tunings'
import useSound from 'react-guitar-sound'

function SampleGuitarWithSound() {
  const strings = useMemo(() => [0, 1, 2, 2, 0, -1], [])
  const { play, strum } = useSound({ fretting: strings, tuning: standard })

  return <Guitar strings={strings} onPlay={play} />
}

render(<SampleGuitarWithSound />, document.getElementById('root'))

Developing

  • yarn start will watch and rebuild.
  • yarn build will generate the production scripts under the dist folder.