Skip to content

Basic Usage

Song and playlist

html
<nmp-player song-id="1901371647"></nmp-player>
<nmp-player playlist-id="14273792576"></nmp-player>

Use one source per player when possible.

Theme

html
<nmp-player theme="auto"></nmp-player>
<nmp-player theme="light"></nmp-player>
<nmp-player theme="dark"></nmp-player>

Layout

html
<nmp-player layout="compact"></nmp-player>
<nmp-player layout="mini"></nmp-player>
<nmp-player layout="dock"></nmp-player>
LayoutUse case
compactDefault embedded player
miniNarrow article or embed area
dockFloating page-level player

Advanced card and cover layouts belong to NMPv3+.

Common attributes

AttributeValueDescription
song-idstringNetEase song ID
playlist-idstringNetEase playlist ID
themeauto, light, darkTheme
layoutcompact, mini, dockLayout
embed-modearticle, pageEmbed mode
positionstatic or corner positionsPlayer position
volume0 to 1Initial volume
lyrictrue, falseShow lyrics
playlisttrue, falseShow playlist control
api-base-urlURLAPI proxy

CSS variables

css
nmp-player {
  --nmpv3-accent: #ff6b35;
  --nmpv3-radius: 16px;
  --nmpv3-bg: rgba(255, 255, 255, 0.92);
  --nmpv3-text: #222;
  --nmpv3-idle-opacity: 0.72;
}

Use NMPv3+ when you need full skin packages.

Events

txt
nmpv3:ready
nmpv3:play
nmpv3:pause
nmpv3:songchange
nmpv3:playlistchange
nmpv3:error
js
document.addEventListener("nmpv3:songchange", (event) => {
  console.log(event.detail);
});