# react-sampler

> react-sampler allows you to easily launch sound samples from key events

Latest version **1.0.2** (published 2020-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-sampler
pnpm add react-sampler
yarn add react-sampler
bun add react-sampler
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-02-12 |
| First published | 2015-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Rui Ramos |
| Maintainers | ruiramos |
| Keywords | react, react-component |

## Links

- npm: https://www.npmjs.com/package/react-sampler
- Repository: https://github.com/ruiramos/react-sampler
- Issues: https://github.com/ruiramos/react-sampler/issues
- npm.io page: https://npm.io/package/react-sampler

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-02-12
- 1.0.1 — 2020-02-12
- 1.0.0 — 2020-02-12
- 0.1.3 — 2016-05-03
- 0.2.0 — 2015-08-31
- 0.1.2 — 2015-04-04
- 0.1.1 — 2015-04-04
- 0.1.0 — 2015-04-04

## README

react-sampler
==============

Developing an invoicing app using React?

Oh great, another project management solution?!

Think your TodoMVC could use a little... flare?

___React Sampler might just be what you need!___

Easily assign sound samples to keyboard keys and make your apps fun again!
Delight your users with sounds for every occasion, from a victory Horn to a desperate Gun Shot!

Sound files from [freesound.org](http://freesound.org/)

## Demo
Check the [GitHub page](http://ruiramos.github.io/react-sampler) or the examples folder (there's a README there as well).

As seen live on [great.dj](http://great.dj/)!

## Usage

Install through NPM

```
  npm install react-sampler --save
```

Then include it on all your React apps like so:

```javascript
var Sampler = require('react-sampler');

var samples = [{
  file: '/path/to/file.mp3',
  key: 'h'
  startAt: 0 // in seconds, defaults to 0 (begging of the file)
},{
  ...
}]

<Sampler samples={samples} onLaunchSample={this.handleSampleLaunch} />
```

## Contributing

I'm using [Babel](https://github.com/babel/babel) to create the transpiled file from the .jsx source, and browserify/watchify to create the distribution build, so installing these might be a good start!


## License

[MIT License](http://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/react-sampler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
