# react-soundcloud-widget

> react.js powered SoundCloud player component

Latest version **2.0.4** (published 2015-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-soundcloud-widget
pnpm add react-soundcloud-widget
yarn add react-soundcloud-widget
bun add react-soundcloud-widget
```

## 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 | 2.0.4 |
| Published | 2015-11-22 |
| First published | 2014-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Author | troy betz |
| Maintainers | troybetz |
| Keywords | soundcloud, player, widget, react, react-component |

## Links

- npm: https://www.npmjs.com/package/react-soundcloud-widget
- Repository: https://github.com/troybetz/react-soundcloud-widget
- Issues: https://github.com/troybetz/react-soundcloud-widget/issues
- npm.io page: https://npm.io/package/react-soundcloud-widget

## Dependencies (1)

- [load-script](https://npm.io/package/load-script.md) ^1.0.0

## 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

- 2.0.4 (latest) — 2015-11-22
- 2.0.3 — 2015-10-23
- 2.0.2 — 2015-09-29
- 2.0.1 — 2015-03-30
- 2.0.0 — 2015-03-26
- 1.1.1 — 2015-03-12
- 1.1.0 — 2014-12-16
- 1.0.2 — 2014-12-04
- 1.0.1 — 2014-11-06
- 1.0.0 — 2014-11-04

## README

# react-soundcloud-widget [![Build Status](https://travis-ci.org/troybetz/react-soundcloud-widget.svg?branch=master)](https://travis-ci.org/troybetz/react-soundcloud-widget)

Simple [React](http://facebook.github.io/react) component acting as a thin
layer over the [SoundCloud HTML5 Widget](https://developers.soundcloud.com/docs/api/html5-widget).

## Features

- url playback
- customizable widget options
- playback event bindings
- lazy API loading

## Installation

```shell
$ npm install react-soundcloud-widget
```

## Usage

```js
<SoundCloud
  url={string}         // required
  id={string}          // defaults -> 'react-sc-widget'
  opts={object}        // defaults -> './lib/default-options'
  onPlay={func}        // defaults -> noop
  onPause={func}       // defaults -> noop
  onEnd={func}         // defaults -> noop
/>
```

## Example

```js
class Example extends Component {
  onPlay() {
    console.log('playing');
  }

  render() {
    return (
      <SoundCloud
        url={'https://soundcloud.com/sylvanesso/coffee'}
        onPlay={this.onPlay}
      />
    );
  }
}

```

### Widget options

Boolean toggles passed via `props.opts`

| Parameter | Purpose | Default|
| --------|-------------|------|
| `auto_play` | Start playing the widget after it’s loaded | `true` |
| `visual` | Display widget in [visual mode](https://soundcheck.soundcloud.com/music/our-new-visual-player/). | `false` |
| `buying` | Show/hide buy buttons | `true` |
| `liking` | Show/hide like buttons | `true` |
| `download` | Show/hide download buttons | `true` |
| `sharing` | Show/hide share buttons/dialogues | `true` |
| `show_artwork` | Show/hide artwork | `true` |
| `show_comments` | Show/hide comments | `true` |
| `show_playcount` | Show/hide number of sound plays | `true` |
| `show_user` | Show/hide the uploader name | `true` |
| `show_reposts` | Show/hide reposts | `false` |
| `hide_related` | Show/hide related tracks | `false` |

## Warning

Changing `props.url` currently adds an entry to `window.history`, breaking the back button (or at least adding another click to it).

You can see this in action at http://troybetz.com/react-soundcloud-widget/, change the url using the button and try navigating back.

This is outside my control for now, the widget used internally is served up and managed by SoundCloud. Super bummer.

## Caveat

Programmatic control of the widget as outlined in the [API docs](https://developers.soundcloud.com/docs/api/html5-widget) isn't included. Luckily, the API loads alongside the widget, so taking control is as easy as:

```js
var widget = SC.Widget('react-sc-player');
// do stuff
```

The component itself uses `SC.Widget.load`, `SC.Widget.bind` and `SC.Widget.unbind` internally. Using those methods outside the component may cause problems.

# License

  MIT

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