/** @jsx jsx */
import { jsx } from '@emotion/react'
import { useRef, Fragment, useMemo, ReactElement, useState } from 'react'
import useLayoutEffect from './hooks/layoutEffect'
import range from 'lodash.range'
import uniqueId from 'lodash.uniqueid'
import { set } from './util/arrays'
import classNames from 'classnames'
import { get, fromMidiSharps } from '@tonaljs/note'
import { fromSemitones } from '@tonaljs/interval'
import spanishTheme, { Theme } from './util/theme'
import getStyles from './styles'
import color from 'color'
import { getKey } from 'keyboard-key'
export { spanishTheme, Theme }
export function getRenderFingerSpn(tuning: number[]) {
return (string: number, fret: number) => {
const { letter, acc, oct } = get(fromMidiSharps(tuning[string] + fret))
return (
{letter}
{acc === '#' ? '♯' : acc === 'b' ? '♭' : ''}
{oct}
)
}
}
const mod = (n: number, m: number) => (m + (n % m)) % m
export function getRenderFingerRelative(tuning: number[], root: number) {
return (string: number, fret: number) => (
{range(12).map(fromSemitones)[mod(tuning[string] + fret - root, 12)]}
)
}
function Frets(props: {
className?: string
currentFret?: number
frets: {
from: number
amount: number
}
children?: (fret: number) => ReactElement | ReactElement[] | null
onMouseEnter?: () => void
}) {
const { from, amount } = props.frets
return (
{props.currentFret !== undefined && (
{props.children?.(-1)}
)}
{range(from, from + amount + 1).map((fret) => (
{props.children?.(fret)}
))}
)
}
export default function Guitar(props: {
id?: string
className?: string
strings?: number[]
frets?: {
from: number
amount: number
}
lefty?: boolean
center?: boolean
renderFinger?: (string: number, fret: number) => JSX.Element
theme?: Theme
playOnHover?: boolean
onChange?: (strings: number[]) => void
onPlay?: (string: number) => void
}) {
const {
strings = [],
frets = { from: 0, amount: 22 },
lefty = false,
center = false,
renderFinger,
theme = spanishTheme,
playOnHover,
} = props
const id = useMemo(() => props.id || uniqueId('guitar-'), [props.id])
const styles = useMemo(() => getStyles(theme), [theme])
const ref = useRef(null as HTMLDivElement | null)
const focusString = (string: number, fret: number = strings[string]) =>
ref.current
?.querySelector?.(
`input[name="${id}-string-${string}"][value="${fret}"]`
)
?.focus()
const releaseString = (string: number) =>
pressString(string, strings[string] === 0 ? -1 : 0)
const pressString = (string: number, fret: number) => {
focusString(string, fret)
props.onChange?.(set(strings, string, fret))
}
const getNavigationDelta = (e: KeyboardEvent) => {
switch (getKey(e)) {
case 'ArrowDown':
return { x: 0, y: 1 }
case 'ArrowUp':
return { x: 0, y: -1 }
case 'ArrowRight':
return { x: lefty ? -1 : 1, y: 0 }
case 'ArrowLeft':
return { x: lefty ? 1 : -1, y: 0 }
default:
return null
}
}
useLayoutEffect(() => {
const fretsNode = ref.current
if (center && fretsNode) {
const children = fretsNode.querySelectorAll('.fret')
const pressedFrets = strings.filter((fret) => fret > 0)
const minFret = Math.min.apply(Math, pressedFrets)
const maxFret = Math.max.apply(Math, pressedFrets)
const toFret = minFret + Math.floor((maxFret - minFret) / 2)
const fretNode = children[toFret] as HTMLElement | undefined
if (fretNode) {
fretsNode.scrollLeft =
fretNode.offsetLeft -
fretsNode.offsetWidth / 2 +
fretNode.offsetWidth / 2
}
}
}, [ref, strings, center, lefty])
const [focusedString, setFocusedString] = useState(0)
return (
{
const delta = getNavigationDelta(e.nativeEvent)
if (delta) {
const string = mod(focusedString + delta.y, strings.length)
const fret = strings[string] + delta.x
pressString(
string,
fret > frets.from + frets.amount
? -1
: fret < -1
? frets.from + frets.amount
: fret
)
e.preventDefault()
}
}}
>
This is a guitar with {strings.length} strings and {frets.amount} frets,
starting from {frets.from}. Its theme describes it as:{' '}
{theme.description}.
{props.onChange && (
Once you focus on a string you will be able to navigate strings and
frets using the arrow keys.
)}
{props.onPlay && (
When a specific string is focused you can play it by pressing 'p'.
)}
Current fretting: {strings.join(', ')}.
{theme.fret.marker
? (fret) => (
{theme.fret.marker?.(fret)}
)
: undefined}
{strings.map((currentFret, string) => (
String {string + 1}.{' '}
{currentFret === -1 && 'This string is muted.'}
playOnHover && props.onPlay?.(string)}
>
{(fret) => (
Fret {fret} {fret === -1 && '(Mute)'}.
{fret >= 0 && (
)}
{
props.onChange?.(set(strings, string, fret))
e.target.focus()
}}
onClick={() =>
fret === currentFret && releaseString(string)
}
onKeyDown={(e) => {
switch (e.keyCode) {
case 80:
props.onPlay?.(string)
break
case 13:
releaseString(string)
e.preventDefault()
}
}}
onFocus={() => setFocusedString(string)}
/>
{renderFinger?.(string, fret === -1 ? 0 : fret)}
)}
))}
{(fret) =>
fret !== 0 ? {fret} : null
}
)
}