Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
matswainson authored and matswainson committed Jan 22, 2020
0 parents commit 6f6a631
Show file tree
Hide file tree
Showing 29 changed files with 9,302 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"browserslist": [
"defaults"
]
}
5 changes: 5 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": [
"plugin:vue/recommended"
]
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.DS_Store
node_modules/
6 changes: 6 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.browserslistrc
babel.config.json
postcss.config.js
src
webpack.config.js
yarn.lock
3 changes: 3 additions & 0 deletions .storybook/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
stories: ['../src/**/*.stories.[tj]s'],
};
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
![vue-soundcloud-player](http://matswainson.com/wp-content/uploads/2020/01/vue-soundcloud-player.png)

# Vue custom soundcloud player

Custom Soundcloud player supporting single tracks & playlists

### Example

![vue-soundcloud-player-2](http://matswainson.com/wp-content/uploads/2020/01/vue-soundcloud-player-2.png)

```js
<template>
<SoundCloud
track="194881641"
:mini="true"
/>
</template>

<script>
import SoundCloud from 'vue-soundcloud-player';

export default {
...
components: {
SoundCloud
},
...
}
</script>
```

#### Options

| Name | Type | Default | Description |
|-----------|-----------|-------------|-------------|
| track | `string` | - | ID of track |
| playlist | `string` | - | ID of playlist |
| mini | `boolean` | `false` | Small player with inline play button |
| theme | `string` | `dark` | Playlist colours - accepts `dark` or `light` |

Track or playlist IDs can be found from Soundcloud embed player URLs

### Browser Support

* Chrome
* Firefox
* Internet Explorer 9+
* Opera
5 changes: 5 additions & 0 deletions babel.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"presets": [
"vue"
]
}
1 change: 1 addition & 0 deletions dist/index.js

Large diffs are not rendered by default.

45 changes: 45 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "vue-soundcloud-player",
"version": "1.0.0",
"description": "Custom Soundcloud player supporting single tracks & playlists",
"main": "dist/index.js",
"scripts": {
"build": "webpack --config webpack.config --progress --colors -p",
"lint": "eslint 'src/**/*.{js,vue}'",
"storybook": "start-storybook"
},
"repository": {
"type": "git",
"url": "git+https://github.com/matswainson/vue-soundcloud-player.git"
},
"keywords": [
"vue",
"soundcloud",
"player"
],
"author": "Mat Swainson <mat@matswainson.com> (http://matswainson.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/matswainson/vue-soundcloud-player/issues"
},
"homepage": "https://github.com/matswainson/vue-soundcloud-player#readme",
"devDependencies": {
"@babel/core": "^7.8.3",
"@storybook/vue": "^5.3.6",
"babel-loader": "^8.0.6",
"babel-preset-vue": "^2.0.2",
"eslint": "^6.8.0",
"eslint-plugin-vue": "^6.1.2",
"vue-loader": "^15.8.3",
"vue-style-loader": "^4.1.2",
"vue-template-compiler": "^2.6.11",
"webpack-cli": "^3.3.10"
},
"peerDependencies": {
"vue": "^2.6.11"
},
"dependencies": {
"classnames": "^2.2.6",
"vue": "^2.6.11"
}
}
5 changes: 5 additions & 0 deletions postcss.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
plugins: [
require('autoprefixer')
]
}
Loading

0 comments on commit 6f6a631

Please sign in to comment.