Skip to content

techies23/react-chords

 
 

Repository files navigation

React library for easily generate string instruments SVG chord diagrams based on @tombatossals/react-chords

This is direct fork of @tombatossals/react-chords which fixes some console errors, support with latest version react and supports typescript.

Installation

With NPM

npm install @techies23/react-chords

With Yarn

yarn add @techies23/react-chords

Usage

import React from "react";
import ReactDOM from "react-dom";

import Chord from "@tombatossals/react-chords/lib/Chord";

const MyChord = () => {
  const chord = {
    frets: [1, 3, 3, 2, 1, 1],
    fingers: [1, 3, 4, 2, 1, 1],
    barres: [1],
    capo: false,
  };
  const instrument = {
    strings: 6,
    fretsOnChord: 4,
    name: "Guitar",
    keys: [],
    tunings: {
      standard: ["E", "A", "D", "G", "B", "E"],
    },
  };
  const lite = false; // defaults to false if omitted
  return <Chord chord={chord} instrument={instrument} lite={lite} />;
};

ReactDOM.render(<MyChord />, document.getElementById("root"));

About

React library for easily generate guitar/ukulele SVG chords

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.3%
  • JavaScript 7.7%