@applemusic-like-lyrics/core 0.0.11 → 0.0.12

package/dist/lyric-player/index.d.ts

@@ -5,7 +5,28 @@
  */
 import type { Disposable, HasElement, LyricLine } from "../interfaces";
 import { SpringParams } from "../utils/spring";
-export declare class LyricLineClickedEvent extends MouseEvent {
+import { LyricLineEl } from "./lyric-line";
+/**
+ * 歌词行鼠标相关事件，可以获取到歌词行的索引和歌词行元素
+ */
+export declare class LyricLineMouseEvent extends MouseEvent {
+    /**
+     * 歌词行索引
+     */
+    readonly lineIndex: number;
+    /**
+     * 歌词行元素
+     */
+    readonly line: LyricLineEl;
+    constructor(
+    /**
+     * 歌词行索引
+     */
+    lineIndex: number, 
+    /**
+     * 歌词行元素
+     */
+    line: LyricLineEl, event: MouseEvent);
 }
 /**
  * 歌词播放组件，本框架的核心组件
@@ -19,6 +40,7 @@ export declare class LyricPlayer extends EventTarget implements HasElement, Disp
     private processedLines;
     private lyricLinesEl;
     private lyricLinesSize;
+    private lyricLinesIndexes;
     private hotLines;
     private bufferedLines;
     private scrollToIndex;
@@ -26,12 +48,15 @@ export declare class LyricPlayer extends EventTarget implements HasElement, Disp
     private scrolledHandler;
     private isScrolled;
     private invokedByScrollEvent;
+    private padding;
     private scrollOffset;
+    private hidePassedLines;
     private resizeObserver;
     private posXSpringParams;
     private posYSpringParams;
     private scaleSpringParams;
     private enableBlur;
+    private enableScale;
     private interludeDots;
     private interludeDotsSize;
     private bottomLine;
@@ -43,7 +68,7 @@ export declare class LyricPlayer extends EventTarget implements HasElement, Disp
     private isNonDynamic;
     readonly size: [number, number];
     readonly innerSize: [number, number];
-    readonly pos: [number, number];
+    private readonly onLineClickedHandler;
     _getIsNonDynamic(): boolean;
     /**
      * 设置是否使用物理弹簧算法实现歌词动画效果，默认启用
@@ -58,6 +83,20 @@ export declare class LyricPlayer extends EventTarget implements HasElement, Disp
      * @returns 是否启用物理弹簧
      */
     getEnableSpring(): boolean;
+    /**
+     * 是否启用歌词行缩放效果，默认启用
+     *
+     * 如果启用，非选中的歌词行会轻微缩小以凸显当前播放歌词行效果
+     *
+     * 此效果对性能影响微乎其微，推荐启用
+     * @param enable 是否启用歌词行缩放效果
+     */
+    setEnableScale(enable?: boolean): void;
+    /**
+     * 获取当前是否启用了歌词行缩放效果
+     * @returns 是否启用歌词行缩放效果
+     */
+    getEnableScale(): boolean;
     readonly style: import("jss").StyleSheet<"lyricPlayer" | "lyricLine" | "@media (max-width: 1024px)" | "lyricDuetLine" | "lyricBgLine" | "lyricMainLine" | "lyricSubLine" | "disableSpring" | "interludeDots" | "@supports (mix-blend-mode: plus-lighter)" | "tmpDisableTransition">;
     private onPageShow;
     constructor();
@@ -76,6 +115,11 @@ export declare class LyricPlayer extends EventTarget implements HasElement, Disp
      * 这个只允许内部调用
      */
     rebuildStyle(): void;
+    /**
+     * 设置是否隐藏已经播放过的歌词行，默认不隐藏
+     * @param hide 是否隐藏已经播放过的歌词行，默认不隐藏
+     */
+    setHidePassedLines(hide: boolean): void;
     /**
      * 设置是否启用歌词行的模糊效果
      * @param enable 是否启用
@@ -86,6 +130,12 @@ export declare class LyricPlayer extends EventTarget implements HasElement, Disp
      * @param lines 歌词数组
      */
     setLyricLines(lines: LyricLine[]): void;
+    /**
+     * 重置用户滚动状态
+     *
+     * 请在用户完成滚动点击跳转歌词时调用本事件再调用 `calcLayout` 以正确滚动到目标位置
+     */
+    resetScroll(): void;
     /**
      * 重新布局定位歌词行的位置，调用完成后再逐帧调用 `update`
      * 函数即可让歌词通过动画移动到目标位置。

package/dist/lyric-player/lyric-line.d.ts

@@ -2,7 +2,16 @@ import { LyricPlayer } from ".";
 import { Disposable, HasElement, LyricLine, LyricWord } from "../interfaces";
 import { Spring } from "../utils/spring";
 export declare function shouldEmphasize(word: LyricWord): boolean;
-export declare class LyricLineEl implements HasElement, Disposable {
+export declare class RawLyricLineMouseEvent extends MouseEvent {
+    readonly line: LyricLineEl;
+    constructor(line: LyricLineEl, event: MouseEvent);
+}
+type MouseEventMap = {
+    [evt in keyof HTMLElementEventMap]: HTMLElementEventMap[evt] extends MouseEvent ? evt : never;
+};
+type MouseEventTypes = MouseEventMap[keyof MouseEventMap];
+type MouseEventListener = (this: LyricLineEl, ev: RawLyricLineMouseEvent) => void;
+export declare class LyricLineEl extends EventTarget implements HasElement, Disposable {
     private lyricPlayer;
     private lyricLine;
     private element;
@@ -19,6 +28,10 @@ export declare class LyricLineEl implements HasElement, Disposable {
         scale: Spring;
     };
     constructor(lyricPlayer: LyricPlayer, lyricLine?: LyricLine);
+    private listenersMap;
+    private readonly onMouseEvent;
+    addEventListener(type: MouseEventTypes, callback: MouseEventListener | null, options?: boolean | AddEventListenerOptions | undefined): void;
+    removeEventListener(type: MouseEventTypes, callback: MouseEventListener | null, options?: boolean | EventListenerOptions | undefined): void;
     private isEnabled;
     enable(): void;
     measureSize(): [number, number];
@@ -40,3 +53,4 @@ export declare class LyricLineEl implements HasElement, Disposable {
     get isInSight(): boolean;
     dispose(): void;
 }
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@applemusic-like-lyrics/core",
   "packageManager": "yarn@3.6.1",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "AMLL 的纯 JS 核心组件框架，包括歌词显示组件和背景组件等其它可以复用的组件",
   "repository": {
     "url": "https://github.com/Steve-xmh/applemusic-like-lyrics.git",
@@ -15,6 +15,7 @@
   "scripts": {
     "build:docs": "typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts",
     "build": "vite build",
+    "build:dev": "vite build",
     "fmt": "rome format --write ./src",
     "dev": "vite dev"
   },
@@ -34,11 +35,11 @@
     "lil-gui": "^0.18.2",
     "rome": "^12.1.3",
     "stats.js": "^0.17.0",
-    "typedoc": "^0.24.8",
-    "typedoc-plugin-markdown": "^3.15.3",
-    "typescript": "^5.1.6",
-    "vite": "^4.4.7",
-    "vite-plugin-dts": "^3.3.1",
+    "typedoc": "^0.25.2",
+    "typedoc-plugin-markdown": "^3.16.0",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.11",
+    "vite-plugin-dts": "^3.6.0",
     "vite-plugin-top-level-await": "^1.3.1",
     "vite-plugin-wasm": "^3.2.2"
   },
@@ -47,9 +48,13 @@
     "@pixi/core": "*",
     "@pixi/display": "*",
     "@pixi/filter-blur": "*",
+    "@pixi/filter-bulge-pinch": "*",
     "@pixi/filter-color-matrix": "*",
     "@pixi/sprite": "*",
     "jss": "*",
     "jss-preset-default": "*"
+  },
+  "dependencies": {
+    "node-vibrant": "^3.2.1-alpha.1"
   }
 }