react-modern-audio-player 0.0.3 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 LYH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,53 +1,297 @@
-# deploy on 0.0.3 for test 
+<p align="center">
+<img width="20%" src="https://user-images.githubusercontent.com/70849655/180391190-2b268d23-c9f3-4e95-9fce-090897842c04.png" alt="rm-audio-player" />
+<h1 align="center">React Modern Audio Player</h1>
+</p>
 
-## Override Style
 
-### Icon Imgs
-use icon module - `react-icons`
-- pass by props `iconImgs`
+<p align="center">
+  <a href="https://www.npmjs.com/package/react-modern-audio-player">
+    <img src="https://img.shields.io/npm/v/react-modern-audio-player" alt="Version">
+  </a>
+  <a href="https://www.npmjs.com/package/react-modern-audio-player">
+    <img src="https://img.shields.io/npm/dt/react-modern-audio-player" alt="Download">
+  </a>
+  <a href="https://bundlephobia.com/package/react-modern-audio-player@0.0.3">
+    <img src="https://badgen.net/bundlephobia/minzip/react-modern-audio-player" alt="Download">
+  </a>
+</p>
 
-### ID
-- rs-audio-player-audio 
+# ****Flexible and Customizable UI****
+## This can offer waveform by `wavesurfer.js`
+<img width="100%" src="https://user-images.githubusercontent.com/70849655/180435472-f043dbb4-54df-43e0-bc5c-67492510e817.png" alt="">
 
-### classnames
-- playlist classnames
-  - play-list-trigger-container
-  - sortable-play-list-content-container (root)
-    - sortable-list
-      - list-item-root
-        - list-item-container
-          - album-cover-wrapper
-          - album-info-wrapper
-      - list-item-root dragstart
-      - list-item-root dragover
+## This can offer various UI and you can also customize each component position
+> Full View
+> <img width="100%" src="https://user-images.githubusercontent.com/70849655/180435489-263fae23-f066-4a37-a524-58918eb40b0c.png" alt="">
 
-- interface classnames
-  - interface-container
-    - interface-grid
+> Position Change
+> <img width="110%" src="https://user-images.githubusercontent.com/70849655/180435493-2c2e08c5-b67b-4ab7-aded-5a0403d42050.png" alt="">
+
+
+> Particular View
+> </br>
+><img width="50%" margin='10px' src="https://user-images.githubusercontent.com/70849655/180435497-0f839cd1-e1fd-400f-a013-82ba441ca79b.png" alt="">
+><img width="20%" margin='10px' src="https://user-images.githubusercontent.com/70849655/180435479-4f056620-f850-4d21-ab23-24efc4300d68.png" alt="">
+> </br>
+><img width="20%" margin='10px' src="https://user-images.githubusercontent.com/70849655/180435484-3331b7cb-1555-4ffb-a36c-a5343f72c8c3.png" alt="">
+> <img width="50%" margin='10px' src="https://user-images.githubusercontent.com/70849655/180435486-2402ba80-7121-410c-9a06-9a737be72ec2.png" alt="">
+
+
+# ****Installation****
+
+```tsx
+npm install --save react-modern-audio-player
+```
+
+# ****Quick Start****
+
+```tsx
+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
+
+```tsx
+interface AudioPlayerProps {
+  playList: PlayList;
+  audioInitialState?: AudioInitialState;
+  activeUI?: ActiveUI;
+  customIcons?: CustomIcons;
+  coverImgsCss?: CoverImgsCss;
+  placement?: {
+    player?: PlayerPlacement;
+    playList?: PlayListPlacement;
+    interface?: InterfacePlacement;
+  };
+}
+```
+
+Prop | Type | Default 
+--- | --- | --- 
+`playList` | [PlayList](#playlist) | [ ] 
+`audioInitialState` | [AudioInitialState](#audioinitialstate) | isPlaying: false </br>repeatType: "ALL" </br>volume: 1 
+`activeUI` | [ActiveUI](#activeui) | playButton : true
+`customIcons` | [CustomIcons](#customicons) | undefined 
+`coverImgsCss` | [CoverImgsCss](#coverimgscss) | undefined 
+`placement` | [Placement](#placement) | playListPlacement : "bottom" </br>interfacePlacement :[DefaultInterfacePlacement](#default-interface-placement)
+
+## PlayList
+
+```tsx
+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
+
+```tsx
+type AudioInitialState = Omit<
+  React.AudioHTMLAttributes<HTMLAudioElement>,
+  "autoPlay"
+> & {
+	isPlaying?: boolean;
+  repeatType?: RepeatType;
+  volume?: number;
+  currentTime?: number;
+  duration?: number;
+  curPlayId: number;
+};
+```
+
+## activeUI
+
+```tsx
+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
+
+```tsx
+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
+
+```tsx
+interface CoverImgsCss {
+  artwork?: React.CSSProperties;
+  listThumbnail?: React.CSSProperties;
+}
+```
+
+## placement
+
+```tsx
+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
+```tsx
+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
-- --rs-audio-player-volume-fill
-- --rs-audio-player-volume-track
-- --rs-audio-player-volume-thumb
-- --rs-audio-player-volume-background
-- --rs-audio-player-volume-panel-background
-- --rs-audio-player-volume-panel-border
-- --rs-audio-player-track-current-time-color
-- --rs-audio-player-track-duration-color
-- --rs-audio-player-progress-color
-- --rs-audio-player-selected-list-item-background
-
-## UI Placement
-
-## flexible and customable UI
-it can offer variant UI and you can also place each component easily
-`Volume Tooltip` is wrapped with `tooltip` of `react-spectrum`
-
-### Theme mode
-it apply color-theme from `system-theme` 
-and you can customize color-theme from `css-variable` of `theme-default` of `react-spectrum`  
-
-### grid item custom area
-progress = 2-4
-playBtn = 2-4
-repeatBtn = row1-4 / 2 / row1-4 / 10
+
+```tsx
+--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****
+```tsx
+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>
+  );
+}
+```