[NMP v3] 文档镜像 旧的 [NMP v2] 已不再维护使用访问旧文档打开原始文档

NeteaseMiniPlayer v3

NeteaseMiniPlayer v3

基于 NeteaseCloudMusicApi 的轻量级可插入式音乐播放器 UI 组件库

NMPv3

面向公开网页、博客、CMS 和普通 WordPress 场景，默认一个 JavaScript 文件即可嵌入

NMPv3+

面向二次开发和高级集成，提供插件、皮肤、自定义音乐源、自定义歌词和自定义构建

Apache-2.0Web ComponentVitePress DocsjsDelivrunpkg

按场景接入

HTML / 静态站点适合 GitHub Pages、Hugo、Hexo、Jekyll 和普通静态页面 PHP / WordPress Basic适合服务端模板、短代码渲染和 API 代理注入 React适合 JSX 类型声明、客户端组件和 Vite React 项目 Vue 3适合单文件组件、compilerOptions 和组合式项目 Next.js适合 App Router、客户端边界和动态导入 Nuxt适合 client plugin、SSR 安全加载和页面组件 Astro适合 Astro 页面、组件插槽和静态输出 Svelte适合浏览器端动态导入和自定义元素类型扩展

项目定位

NeteaseMiniPlayer v3 是一个面向开源社区维护的网页播放器项目。仓库从 v3 开始拆分为两条产品线：

NMPv3：轻量播放器。默认只面向网易云音乐，浏览器部署只需要一个 nmpv3.min.js
NMPv3+：高级扩展框架。面向插件、皮肤、自定义来源、自定义歌词、宿主页面联动和框架适配

两条产品线在同一个仓库维护，但功能边界分开。普通嵌入优先使用 NMPv3，需要扩展能力时再使用 NMPv3+。

推荐入口

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>

如果项目已经使用 npm：

bash

npm install netease-mini-player-v3
pnpm add netease-mini-player-v3

ts

import "netease-mini-player-v3/auto";

下一步