Skip to content

NeteaseMiniPlayer v3

A lightweight embeddable music player UI component library built on NeteaseCloudMusicApi

Apache-2.0Web ComponentVitePress DocsjsDelivrunpkg

Project Scope

NeteaseMiniPlayer v3 is maintained as an open-source web player project. Starting from v3, the repository has two product lines:

  • NMPv3: the lightweight player for NetEase Cloud Music. Browser usage only needs nmpv3.min.js
  • NMPv3+: the advanced framework for plugins, skins, custom sources, custom lyrics, host integration, framework adapters, and custom builds

Use NMPv3 for normal embedding. Use NMPv3+ only when an integration needs advanced extension points.

Recommended Entry

html
<script src="https://cdn.jsdelivr.net/npm/netease-mini-player-v3@3.0.1/dist/nmpv3.min.js"></script>

<nmp-player
  playlist-id="14273792576"
  theme="auto"
  layout="compact"
></nmp-player>

For npm-based projects:

bash
npm install netease-mini-player-v3
pnpm add netease-mini-player-v3
ts
import "netease-mini-player-v3/auto";

Next Steps