Skip to content

dalechyn/react-soundcloud-embedded

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-soundcloud-embedded

npm npm bundle size

🎵 Fork of Embedded SoundCloud widget, now with TypeScript typings.

Installation

npm install react-soundcloud-embedded

or

yarn add react-soundcloud-embedded

Usage

import ReactSoundcloud from 'react-soundcloud-embedded';

Simple usage:

import React, { FC } from 'react'
import ReactDOM from 'react-dom'
import ReactSoundCloud from 'react-soundcloud-embedded'
import MyTrackURL from './somewhere'

const Page = (): FC => (
  <div>
    <label>My SoundCloud:</label>
    <ReactSoundCloud url={MyTrackURL} />
  </div>
)

ReactDOM.render(<Page />, document.getElementById('root'))

Props

  • width (String) - widget width, default: 100%
  • height (String) - widget height, default: 450px
  • url (String) - URL to track, default: https://api.soundcloud.com/tracks/210785280,
  • autoPlay (Boolean) - auto play track, default: false,
  • hideRelated (Boolean) - hide related, default: false,
  • showComments (Boolean) - show comments, default: true,
  • showUser (Boolean) - show users, default: true,
  • showReposts (Boolean) - show reposts, default: false,
  • visual (Boolean) - true for background image, default: true,
  • color (String) - play button color, default: ff5500

About

Embedded SoundCloud for your React Application

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%