@minikeys/react 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.cjs +1603 -0
- package/dist/index.d.cts +78 -0
- package/dist/index.d.ts +78 -0
- package/dist/index.js +1513 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# MiniKeys React
|
|
2
|
+
|
|
3
|
+
<!-- TODO add badges from CD -->
|
|
4
|
+
|
|
5
|
+
React components for [MiniKeys](https://github.com/liampuk/minikeys) - a tiny javascript library that plays the piano. [Try it out here!](https://liamp.uk/minikeys)
|
|
6
|
+
|
|
7
|
+
Look through the components in [Storybook](https://liamp.uk/minikeys-react)
|
|
8
|
+
|
|
9
|
+
## Components
|
|
10
|
+
|
|
11
|
+
MiniKeys React provides 2 components, a Piano and a Keyboard
|
|
12
|
+
|
|
13
|
+
### Piano
|
|
14
|
+
|
|
15
|
+
The piano shows up to a full piano keyboard, with the range of notes that are currently playable by the keyboard, and active playing notes.
|
|
16
|
+
|
|
17
|
+
<img width="1033" height="282" alt="image" src="https://github.com/user-attachments/assets/624918e9-ee76-4840-af05-44b7e498c2ce" />
|
|
18
|
+
|
|
19
|
+
### Keyboard
|
|
20
|
+
|
|
21
|
+
The keyboard shows a representation of your computer keyboard, along with custom modifier keys (sustain, transpose etc.) and active playing notes.
|
|
22
|
+
|
|
23
|
+
<img width="1253" height="370" alt="image" src="https://github.com/user-attachments/assets/e339909c-9eec-4999-b902-db53f5354755" />
|
|
24
|
+
|
|
25
|
+
Full documentation is coming soon! For now, have a look through the [Storybook](https://liamp.uk/minikeys-react) to see what props are available.
|