npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@magicdidac/chord-display

v1.1.3

Published

Package to display guitar chords on react

Downloads

12

Readme

@magicdidac/chord-display

A React library to easily generate guitar SVG chords display.

Install

With npm

npm i @magicdidac/chord-display

With yarn

yarn add @magicdidac/chord-display

Examples

Here are some examples of what the chords would look like.

chords-screenshot

How to use it

import { ChordDisplay, getChordByName } from '@magicdidac/chord-display'

const MyChord = () => {

  return (
    <ChordDisplay
      chord={getChordByName('C')}
      {/* chord={Chords.C} */}
    />
  )
}

To use the preset chords in the package you can obtain them in two different ways:

  1. using the getChordByName function, where you will pass the name of the chord you want.
  2. Using the Chords object, where the preset chords in the package are located.

Alternatively, you can generate your own chord by generating an object that follows the structure of the following example:

{
  name: 'A',
  frets: [-1, 0, 2, 2, 2, 0]
}
  • -1 means that this string is not played
  • 0 means that the string is played in the air
  • the rest of the numbers are the fret

If you need to make a capo the chord would look like this:

{
  name: 'F',
  barre: 1,
  frets: [0, 2, 2, 1, 0, 0]
}
  • the number in the barre property is the fret where the capo is desired
  • 0 means to play the string in the air (where the capo is located)

Note: it is recommended to use the Chord interface included in the package if you use typescript