fretboard-diagram
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Fretboard Diagram

A simple tool for creating fretboard diagrams.

Install

npm install --save fretboard-diagram

Usage

import { FretboardDiagram } from 'fretboard-diagram'

const AmChord = [
  { string: 5, fret: 3 },
  { string: 3, fret: 2, color: "limegreen" },
  { string: 1, fret: 0, color: "salmon" }
];

const div = document.createElement('div');
div.setAttribute("id", "diagram-id");
document.body.appendChild(div);

const diagram = new FretboardDiagram({
  id: "diagram-id",
  dots: AmChord,
  label: "A min",
  showFretNums: true,
  showStringNames: true,
  onClick: (dot, fd) => {
    console.log(`you clicked string: ${dot.string}, fret: ${dot.fret}`);
  }
});

Readme

Keywords

none

Package Sidebar

Install

npm i fretboard-diagram

Weekly Downloads

3

Version

1.0.0

License

GPL-3.0

Unpacked Size

123 kB

Total Files

14

Last publish

Collaborators

  • zazzerino