# vue-mplayer

> vue music player

Latest version **0.0.2** (published 2020-07-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-mplayer
pnpm add vue-mplayer
yarn add vue-mplayer
bun add vue-mplayer
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-07-22 |
| First published | 2020-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 226.4 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | zxpsuper |
| Maintainers | suporka |
| Keywords | create, vue |

## Links

- npm: https://www.npmjs.com/package/vue-mplayer
- Repository: https://github.com/zxpsuper/vue-mplayer
- Homepage: https://github.com/zxpsuper/vue-mplayer#readme
- Issues: https://github.com/zxpsuper/vue-mplayer/issues
- npm.io page: https://npm.io/package/vue-mplayer

## Dependencies (6)

- [vue](https://npm.io/package/vue.md) ^2.5.17
- [vuex](https://npm.io/package/vuex.md) ^3.0.1
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [vue-router](https://npm.io/package/vue-router.md) ^3.0.1
- [es6-promise](https://npm.io/package/es6-promise.md) ^4.2.5
- [tiny-emitter](https://npm.io/package/tiny-emitter.md) ^2.1.0

## Recent versions

- 0.0.2 (latest) — 2020-07-22
- 0.0.1 — 2020-07-22

## README

# vue-mplayer

## Introduction

> vue-mplayer is a vue component to play music

## Features

-   [x] Beautiful UI
-   [x] Playlist with repeat & shuffle controls
-   [x] Custom theme color
-   [x] Mutex play
-   [x] HLS support
-   [x] Easy props and API
-   [x] Dependency free and light-weight
-   [ ] Lyrics
-   [ ] mini player
-   [ ] music list and play history

By the way, if you want to play m3u8(hls), you should import the hls before. for example:

```html
<script src="https://cdn.jsdelivr.net/npm/hls.js/dist/hls.min.js"></script>
```

## Usage

```
# install
npm install vue-mplayer --sav
```

```js
import MPlayer from 'vue-mplayer'
Vue.component('MPlayer', MPlayer)
```

```html
<MPlayer :playList="playList" theme="black" />
```

## Props

| props      |       desc       |   type |                      value | default |
| :--------- | :--------------: | -----: | -------------------------: | ------: |
| playList   |    music list    |  array |                         -- |      [] |
| theme      |      theme       | string | metal, blue, black, orange |   black |
| textColor  |    text color    | string |                hex or rgba |      '' |
| iconColor  |    icon color    | string |                hex or rgba |      '' |
| background | background color | string |                hex or rgba |      '' |

**if you use the textColor or iconColor or background, it will cover the theme color**

## Methods

`play()` and `pause()` and `togglePlay(bool?)` and `prev()` and `next()`

## Contributing

-   ⇄ Pull requests and ★ Stars are always welcome.
-   For bugs and feature requests, please create an issue.

## License

vue-mplayer is MIT Licensed.

## Questions or advise

If you have some question or advise, you can send me a E-mail(zxpscau@163.com).

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