@lyre/fretboard

2.2.0 • Public • Published

Lyre Fretboard

Create configurable SVG chord charts for stringed instruments.

Installation

npm install @lyre/fretboard

Usage

var Fretboard = require('@lyre/fretboard');

var myFretboard = new Fretboard({
    container: "myContainerId",
    strings: 6,
    frets: 5,
    showFretLabels: true,
    tuning: ['E', 'A', 'D', 'G', 'B', 'e'],

    //F chord
    fingering: [
        {
            string: [1, 6],
            fret: 1,
            finger: 1
        },
        {
            string: 3,
            fret: 2,
            finger: 2
        },
        {
            string: 4,
            fret: 3,
            finger: 4
        },
        {
            string: 5,
            fret: 3,
            finger: 3
        } 
    ]
});

Output

Example code output

Package Sidebar

Install

npm i @lyre/fretboard

Weekly Downloads

0

Version

2.2.0

License

Apache-2.0

Unpacked Size

24.4 kB

Total Files

5

Last publish

Collaborators

  • anthonymassie