Gochord-viewer NPM

Demo

GoChord Viewer

A JavaScript frontend library for parsing and formatting ChordPro songs with chord diagrams.

Inspired by: https://github.com/buzcarter/UkeGeeks with the following changes:

Adaptation for Guitar
Upgraded to ES6
Allows to send the chordpro songText instead of preload it in the document
Import Themes class (it allows modify the viewer alone instead of the whole body)
Beautify chord diagrams
Chord diagrams on right side
Bugs fixes
Use webpack (bundle and minify) to optimize performance (Mode Production)
Use webpack to allow debug (Mode Development)

Overview

Reads marked-up music (lyrics + chords) extracting all of the chords used. Generates chord diagrams using HTML5 <canvas> and rewrites the music with standard HTML wrapping the chords.

Part of goChord

Usage

GoChord Viewer is on npm, to install run:

$ npm i gochord-viewer

Load with require():

var GoChordViewer = require("gochord-viewer");

or import (es6, typescript):

import * as GoChordViewer from "gochord-viewer";

And call the Main class:

GoChordViewer.Main.init(false);
GoChordViewer.Main.run(chordSheet);

Demo

Clone
Install dependencies:

$ npm i

Run in mode dev :

$ npm run start

It should open a browser and navigate to http://localhost:8080/ showing a song example.

Make changes (e.g. Change the songText input or theme in demo/sample.js)
Changes are deployed on browser directly!

If you want a new version: Bundle files with webpack (the output will be in dist folder):

$ npm run build

ChordPro format: Lyrics and Chords

Essentially, it looks like this:

    {title: Praise Adonai}
    {artist: Paul Baloche}

    {sot}
    E|-----2---2-----|-------3-3---
    B|---3---3---3---|-----0-------
    G|-2-------------|---0---------
    D|---------------|---0---------
    A|---------------|-2-----------
    E|---------------|-------------
    {eot}

    [Am]Who is like [F]Him,
    The Lion and the [C]Lamb
    Seated on the [G]throne    [E7]
    [Am]Mountains bow [F]down
    Every ocean [C]roars
    To the Lord of [G]hosts

    {start_of_chorus}
    [F]Praise Ado[Am]nai
    From the [G]rising of the sun
    'Till the [Dm7]end of every [F]day[G]
    [F]Praise Ado[Am]nai
    All the [G]nations of the earth
    All the [Dm7] Angels and the [F]Saints
    [G]Sing [Bbsus2]praise
    {end_of_chorus}