zds-pickers 4.1.4 → 4.1.6
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 +17 -3
- package/dist/index.cjs.js +9 -9
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.js +1525 -1465
- package/dist/index.es.js.map +1 -1
- package/dist/other/OctavePlayer.js +6 -8
- package/dist/other/SoundFontProvider.js +78 -65
- package/dist/other/pianoTypes.js +1 -0
- package/dist/pickers/KeyPicker.js +20 -2
- package/dist/types/other/OctavePlayer.d.ts +5 -33
- package/dist/types/other/pianoTypes.d.ts +40 -0
- package/dist/types/pickers/KeyPicker.d.ts +3 -2
- package/dist/types/pickers/PianoPicker.d.ts +2 -9
- package/package.json +13 -17
package/README.md
CHANGED
|
@@ -27,9 +27,11 @@ The library is organized into several key areas:
|
|
|
27
27
|
## Quick Start
|
|
28
28
|
|
|
29
29
|
```bash
|
|
30
|
-
npm install zds-pickers
|
|
30
|
+
npm install zds-pickers react-select
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
+
Peer dependencies (`react`, `react-dom`, `react-select`, `classnames`, `zds-mappings`) must be installed in the host app. `react-select` was moved out of the package bundle in 4.1.x — add it explicitly if you use `Select`-based pickers.
|
|
34
|
+
|
|
33
35
|
```tsx
|
|
34
36
|
import { PianoPicker, KnobPicker, NotePicker } from 'zds-pickers'
|
|
35
37
|
|
|
@@ -69,7 +71,7 @@ Run `npm run sb` to access the interactive component playground with:
|
|
|
69
71
|
**🎵 Music & Audio**
|
|
70
72
|
- `PianoPicker` - Full piano keyboard with soundfont integration
|
|
71
73
|
- `OctavePlayer` - Single octave piano interface
|
|
72
|
-
- `KeyPicker` - Octave-based
|
|
74
|
+
- `KeyPicker` - Octave-based MIDI note selection with highlighted key state
|
|
73
75
|
|
|
74
76
|
**🎛️ Controls**
|
|
75
77
|
- `KnobPicker` - Draggable knob with label and value display
|
|
@@ -141,10 +143,22 @@ The library builds to both CommonJS and ES modules:
|
|
|
141
143
|
- `dist/index.es.js` - ES module build
|
|
142
144
|
- `dist/types/` - TypeScript definitions
|
|
143
145
|
|
|
146
|
+
## Peer dependencies
|
|
147
|
+
|
|
148
|
+
Install these in your application (they are not bundled with `zds-pickers`):
|
|
149
|
+
|
|
150
|
+
| Package | Version |
|
|
151
|
+
|---------|---------|
|
|
152
|
+
| `react` | >=18.0.0 |
|
|
153
|
+
| `react-dom` | >=18.0.0 |
|
|
154
|
+
| `react-select` | >=5.10.0 |
|
|
155
|
+
| `classnames` | >=2.5.1 |
|
|
156
|
+
| `zds-mappings` | 1.4.9 |
|
|
157
|
+
|
|
144
158
|
## Dependencies
|
|
145
159
|
|
|
146
160
|
### Core Dependencies
|
|
147
|
-
- **React 18+** - Component framework
|
|
161
|
+
- **React 18+** - Component framework (peer)
|
|
148
162
|
- **TypeScript** - Type safety
|
|
149
163
|
- **D3.js** - Drag interactions and scaling
|
|
150
164
|
- **soundfont-player** - Audio playback
|