@dschoon/react-waves
Advanced tools
Comparing version 2.0.0 to 3.0.0
{ | ||
"name": "@dschoon/react-waves", | ||
"version": "2.0.0", | ||
"version": "3.0.0", | ||
"description": "React component wrapper for wavesurfer.js", | ||
@@ -5,0 +5,0 @@ "author": "dschoon", |
# ReactWaves | ||
React component wrapper for [Wavesurfer v2](http://wavesurfer-js.org) | ||
React component wrapper for [Wavesurfer.js](http://wavesurfer-js.org) | ||
[![NPM](https://img.shields.io/npm/v/@dschoon/react-waves.svg)](https://www.npmjs.com/package/@dschoon/react-waves) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![CircleCI](https://circleci.com/gh/dschoon/react-waves.svg?style=svg)](https://circleci.com/gh/dschoon/react-waves) | ||
#### Background | ||
This component was originally based off of the work done in [react-wavesurfer](https://github.com/mspae/react-wavesurfer) by [@mspae](https://github.com/mspae) (and [others]((https://github.com/mspae/react-wavesurfer/graphs/contributors))). After wavesurfer-js released version 2, and the react-wavesurfer projected became unmaintained, I decided that it was safer to start my own version that I had better control over. | ||
Welcome! This component is still a work in progress, and is heavily based off the previous work done in [react-wavesurfer](https://github.com/mspae/react-wavesurfer) by [@mspae](https://github.com/mspae) (and [others]((https://github.com/mspae/react-wavesurfer/graphs/contributors))). After wavesurfer-js released version 2, and the react-wavesurfer projected became unmaintained, I decided that it was safer to start my own version that I had better control over. | ||
#### Version 3 | ||
To align this component nicer with the base [wavesurfer.js](https://github.com/katspaugh/wavesurfer.js) project, I've decided to skip version 2 and go straight to version 3. | ||
#### Issues | ||
Please report any [issues](https://github.com/dschoon/react-waves/issues) you encounter and I will try my best to get them fixed. | ||
@@ -15,2 +19,3 @@ | ||
## Examples | ||
![ReactWaves](example/public/react-waves.jpg) | ||
@@ -23,4 +28,6 @@ | ||
- **[Regions Plugin Example](https://github.com/dschoon/react-waves/blob/master/example/src/components/RegionsExample.js)** | ||
- **[Timeline Example](https://github.com/dschoon/react-waves/blob/master/example/src/components/TimelineExample.js)** | ||
- **[Large File Example](https://github.com/dschoon/react-waves/blob/master/example/src/components/LargeFilePeaksExample.js)** | ||
- **[Generate PCM Data Example](https://github.com/dschoon/react-waves/blob/master/example/src/components/GetPeaksExample.js)** | ||
- **[Spectrogram Example](https://github.com/dschoon/react-waves/blob/master/example/src/components/SpectrogramExample.js)** | ||
@@ -35,4 +42,8 @@ Here's an example of the personal project where I'm using this code: | ||
```bash | ||
npm install --save @dschoon/react-waves | ||
npm install @dschoon/react-waves | ||
``` | ||
or | ||
```bash | ||
yarn add @dschoon/react-waves | ||
``` | ||
@@ -156,3 +167,5 @@ ## Basic Example | ||
xhr: PropTypes.object, | ||
}) | ||
}), | ||
spectrogramOptions: PropTypes.object, | ||
timelineOptions: PropTypes.object, | ||
} | ||
@@ -165,1 +178,3 @@ | ||
MIT © [Dan Schoonmaker](https://danielschoonmaker.com) [(github)](https://github.com/dschoon) | ||
_Last Updated: November 10th, 2019_ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
1622178
176
2