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

openmusic-piano-keyboard

v1.0.0

Published

a piano keyboard component to input notes with touch or mouse devices

Downloads

3

Readme

openmusic-piano-keyboard

A piano keyboard component

Install with NPM

** YOU NEED SUPPORT FOR WEB COMPONENTS IN YOUR BROWSER BECAUSE WE'RE NOT SHIMMING ANYTHING IN **

Firefox: go to about:config, find dom.webcomponents.enabled and set it to true.

Chrome: maybe nothing to do?

Installation

Grab Piano-Keyboard.js and Piano-Keyboard.css from the repo or do npm install openmusic-piano-keyboard.

Usage

If not using any package manager

Include Piano-Keyboard.js and Piano-Keyboard.css before you use the component. It will be registered automatically as openmusic-piano-keyboard so you can run document.createElement('openmusic-piano-keyboard') or have <openmusic-piano-keyboard> elements in your HTML source.

E.g.:

<link rel="stylesheet" href="Piano-Keyboard.css">
<script src="Piano-Keyboard.js" defer></script>

If using npm

You need to load the module and then register it--it is not automatically registered!

require('openmusic-piano-keyboard').register('openmusic-piano-keyboard');

But you could even register it with other name. Up to you.

Remember to load the css file too or the component will be unstyled.

API

<openmusic-piano-keyboard octaves="2"></openmusic-piano-keyboard>

Attributes

octaves

Attribute for selecting how many octaves to render. Can be 1 or 2.

Events

Events are DOM events, additional data is in the detail field of each event.

noteon

detail: index containing the index of the pressed key (either by mouse or keyboard)

E.g.

keyboard.addEventListener('noteon', function(e) {
	console.log('note on on key index: ', e.detail.index);
});

noteoff

detail: index containing the index of the released key (either by mouse or keyboard)

E.g.

keyboard.addEventListener('noteoff', function(e) {
	console.log('note off on key index: ', e.detail.index);
});

Demo

Have a look at the demo file in index.html for a usage example.