react-modern-audio-player

React Modern Audio Player

Flexible and Customizable UI

This can offer waveform by wavesurfer.js

This can offer various UI and you can also customize each component position

Full View

Position Change

Particular View

Installation

npm install --save react-modern-audio-player

Quick Start

import AudioPlayer from 'react-modern-audio-player';

const playList = [
  {
    name: 'name',
    writer: 'write',
    img: 'image.jpg',
    src: 'audio.mp3',
    id: 1,
    index: 0,
  },
]
function Player (){
	return (
		<AudioPlayer playList={playList} />
	)
}

Props

interface AudioPlayerProps {
  playList: PlayList;
  audioInitialState?: AudioInitialState;
  activeUI?: ActiveUI;
  customIcons?: CustomIcons;
  coverImgsCss?: CoverImgsCss;
  placement?: {
    player?: PlayerPlacement;
    playList?: PlayListPlacement;
    interface?: InterfacePlacement;
  };
}

Prop	Type	Default
playList	PlayList	[ ]
audioInitialState	AudioInitialState	isPlaying: false repeatType: "ALL" volume: 1
activeUI	ActiveUI	playButton : true
customIcons	CustomIcons	undefined
coverImgsCss	CoverImgsCss	undefined
placement	Placement	playListPlacement : "bottom" interfacePlacement :DefaultInterfacePlacement

PlayList

type PlayList = Array<AudioData>;
type AudioData = {
  src: string;
  id: number;
  index: number;
  name?: string | ReactNode;
  writer?: string | ReactNode;
  img?: string;
  description?: string | ReactNode;
  customTrackInfo?: string | ReactNode;
};

audioInitialState

type AudioInitialState = Omit<
  React.AudioHTMLAttributes<HTMLAudioElement>,
  "autoPlay"
> & {
	isPlaying?: boolean;
  repeatType?: RepeatType;
  volume?: number;
  currentTime?: number;
  duration?: number;
  curPlayId: number;
};

activeUI

type ActiveUI = {
  all: boolean;
  playButton: boolean;
  playList: PlayListUI;
  prevNnext: boolean;
  volume: boolean;
  repeatType: boolean;
  trackTime: TrackTimeUI;
  trackInfo: boolean;
  artwork: boolean;
  progress: ProgressUI;
};
type TrackTimeUI = "separation-mode" | "unification-mode" | false;
type ProgressUI = "waveform" | "bar" | false;
type PlayListUI = "sortable" | "unSortable" | false;

customIcons

type CustomIcons = {
  play: ReactNode;
  pause: ReactNode;
  prev: ReactNode;
  next: ReactNode;
  repeatOne: ReactNode;
  repeatAll: ReactNode;
  repeatNone: ReactNode;
  repeatShuffle: ReactNode;
  volumeFull: ReactNode;
  volumeHalf: ReactNode;
  volumeMuted: ReactNode;
  playList: ReactNode;
};

coverImgsCss

interface CoverImgsCss {
  artwork?: React.CSSProperties;
  listThumbnail?: React.CSSProperties;
}

placement

type PlayerPlacement =
  | "bottom"
  | "top"
  | "bottom-left"
  | "bottom-right"
  | "top-left"
  | "top-right";

type PlayListPlacement = "bottom" | "top";

type InterfacePlacement = {
  templateArea: InterfaceGridTemplateArea;
  itemCustomArea?: InterfaceGridItemArea;
};

type InterfaceGridTemplateArea = Record<InterfacePlacementKey,InterfacePlacementValue>
type InterfacePlacementKey =
  | Exclude<keyof ActiveUI, "all" | "prevNnext" | "trackTime">
  | "trackTimeCurrent"
  | "trackTimeDuration";
type InterfacePlacementValue = "row1-1" | "row1-2" | "row1-3" | "row1-4" | ... more ... | "row9-9";

type InterfaceGridItemArea = Partial<Record<InterfacePlacementKey, string>>;
	/** example
    * check grid item MDN
	* progress : 2-4
	* repeatBtn : row1-4 / 2 / row1-4 / 10
	*/

Default interface placement

const defaultInterfacePlacement = {
  templateArea: {
    artwork: "row1-1",
    trackInfo: "row1-2",
    trackTimeCurrent: "row1-3",
    trackTimeDuration: "row1-4",
    progress: "row1-5",
    repeatType: "row1-6",
    volume: "row1-7",
    playButton: "row1-8",
    playList: "row1-9",
  },
};

Override Style

Theme mode ( dark-mode )

it apply dark-mode depending on system-theme
you can customize color-theme by css-variable of react-spectrum theme-default

ID & Classnames

root ID

• rm-audio-player

root ClassName

• rm-audio-player-provider

color variables

--rm-audio-player-volume-background: #ccc;
--rm-audio-player-volume-panel-background: #f2f2f2;
--rm-audio-player-volume-panel-border: #ccc;
--rm-audio-player-volume-thumb: #e5e5e5;
--rm-audio-player-volume-fill: rgba(0, 0, 0, 0.5);
--rm-audio-player-volume-track: #ababab;
--rm-audio-player-track-current-time: #0072F5;
--rm-audio-player-track-duration: #8c8c8c;
--rm-audio-player-progress-bar: #0072F5;
--rm-audio-player-progress-bar-background: #D1D1D1;
--rm-audio-player-waveform-cursor: var(--spectrum-alias-text-color);
--rm-audio-player-waveform-background: var(--rm-audio-player-progress-bar-background);
--rm-audio-player-waveform-bar: var(--rm-audio-player-progress-bar);
--rm-audio-player-sortable-list-button-active: #0072F5;
--rm-audio-player-selected-list-item-background: var(--spectrum-alias-border-color);

// ...spectrim theme palette and so on... //

Example

function App() {
  return (
    <div>
      <AudioPlayer
        playList={playList}
        audioInitialState={{
          muted: true,
          volume: 0.2,
          curPlayId: 1,
        }}
        placement={{
          interface: {
            templateArea: {
              trackTimeDuration: "row1-5",
              progress: "row1-4",
              playButton: "row1-6",
              repeatType: "row1-7",
              volume: "row1-8",
            },
          },
          player: "bottom-left",
        }}
        activeUI={{
          all: true,
          trackTime: "separation-mode",
          progress: "waveform",
        }}
      />
    </div>
  );
}