lyb-pixi-js 1.1.11 → 1.1.13

package/libPixiJs.d.ts

@@ -0,0 +1,163 @@
+import { LibPixiBitText } from "./Components/Base/LibPixiBitText";
+import { LibPixiContainer } from "./Components/Base/LibPixiContainer";
+import { LibPixiParticleMove } from "./Components/Base/LibPixiParticleMove";
+import { LibPixiRectBgColor } from "./Components/Base/LibPixiRectBgColor";
+import { LibPixiSpine } from "./Components/Base/LibPixiSpine";
+import { LibPixiText } from "./Components/Base/LibPixiText";
+import { LibPixiButtonHover } from "./Components/Custom/LibPixiButtonHover";
+import { LibPixiCloseBtn } from "./Components/Custom/LibPixiCloseBtn";
+import { LibPixiDrawer } from "./Components/Custom/LibPixiDrawer";
+import { LibPixiPerforMon } from "./Components/Custom/LibPixiPerforMon";
+import { LibPixiProgress } from "./Components/Custom/LibPixiProgress";
+import { LibPixiScrollContainer } from "./Components/Custom/LibPixiScrollContainer";
+import { LibPixiScrollNum } from "./Components/Custom/LibPixiScrollNum";
+import { LibPixiSlider } from "./Components/Custom/LibPixiSlider";
+import { LibPixiSubAddMinMax } from "./Components/Custom/LibPixiSubAddMinMax";
+import { LibPixiTable } from "./Components/Custom/LibPixiTable";
+import { LibPixiAudio } from "./Utils/LibPixiAudio";
+/** @description 组件 */
+export declare const Components: {
+    Base: {
+        /** @description 自定义位图文本
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiBitText-位图
+         */
+        LibPixiBitText: typeof LibPixiBitText;
+        /** @description 自定义容器大小及背景色
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiContainer-容器
+         */
+        LibPixiContainer: typeof LibPixiContainer;
+        /** @description 利用贝塞尔曲线实现粒子移动
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiParticleMove-粒子容器
+         */
+        LibPixiParticleMove: typeof LibPixiParticleMove;
+        /** @description 自定义矩形背景色
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiRectBgColor-矩形
+         */
+        LibPixiRectBgColor: typeof LibPixiRectBgColor;
+        /** @description 自定义 Spine 动画
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiSpine-动画
+         */
+        LibPixiSpine: typeof LibPixiSpine;
+        /** @description 自定义文本类
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiText-文本
+         */
+        LibPixiText: typeof LibPixiText;
+    };
+    Custom: {
+        /** @description 悬浮切换材质
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiButtonHover-按钮悬浮
+         */
+        LibPixiButtonHover: typeof LibPixiButtonHover;
+        /** @description 右上角关闭按钮，支持悬浮旋转动画
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiCloseBtn-关闭按钮
+         */
+        LibPixiCloseBtn: typeof LibPixiCloseBtn;
+        /** @description 底部弹出抽屉
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiDrawer-抽屉
+         */
+        LibPixiDrawer: typeof LibPixiDrawer;
+        /** @description 监视帧率、Draw Call、Max Draw Call
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiPerforMon-性能监视器
+         */
+        LibPixiPerforMon: typeof LibPixiPerforMon;
+        /** @description 通过裁剪的方式显示进度条
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiProgress-进度条
+         */
+        LibPixiProgress: typeof LibPixiProgress;
+        /** @description 支持鼠标滚轮滚动、鼠标拖动、手指滑动，支持惯性滚动及回弹
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiScrollContainer-滚动容器
+         */
+        LibPixiScrollContainer: typeof LibPixiScrollContainer;
+        /** @description 通过鼠标或手指拖动数字列选择数字
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiScrollNum-数字滑动
+         */
+        LibPixiScrollNum: typeof LibPixiScrollNum;
+        /** @description 类似轮播图，但是不会自动轮播
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiSlider-横向滑动图
+         */
+        LibPixiSlider: typeof LibPixiSlider;
+        /** @description 最小、最大按钮和增减按钮功能及置灰逻辑
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiSubAddMinMax-数字控制器
+         */
+        LibPixiSubAddMinMax: typeof LibPixiSubAddMinMax;
+        /** @description 绘制表格并填充数字
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiTable-数字表格
+         */
+        LibPixiTable: typeof LibPixiTable;
+    };
+};
+/** @description 方法 */
+export declare const Utils: {
+    /** @description 音频播放器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiAudio-音频播放器
+     */
+    LibPixiAudio: typeof LibPixiAudio;
+    /** @description 九宫格图
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiCreateNineGrid-九宫格图
+     */
+    libPixiCreateNineGrid: (params: import("./Utils/LibPixiCreateNineGrid").LibPixiCreateNineGridParams) => import("pixi.js").NineSlicePlane;
+    /** @description 事件注册
+     * @param v 事件容器
+     * @param eventName 事件名称
+     * @param callback 回调函数
+     * @param once 是否只执行一次
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEvent-事件注册
+     */
+    libPixiEvent: (v: import("pixi.js").Container, eventName: keyof import("pixi.js").DisplayObjectEvents, callback: (...args: any) => void, once?: boolean) => void;
+    /** @description 设置可关闭的事件监听，调用自身后不再触发
+     * @param container 事件容器
+     * @param eventName 事件名称
+     * @param callback 事件回调
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEventControlled-可关闭的事件
+     */
+    libPixiEventControlled: (container: import("pixi.js").Container, eventName: keyof import("pixi.js").DisplayObjectEvents, callback: (...args: any) => void) => () => void;
+    /** @description 滤镜
+     * @param filterName 滤镜名称
+     * @param v 滤镜值
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiFilter-滤镜
+     */
+    libPixiFilter: (filterName: import("./Utils/LibPixiFilter").LibPixiSetFilterFilterName, v?: number) => import("pixi.js").ColorMatrixFilter | import("pixi.js").BlurFilter;
+    /** @description 间隔触发
+     * @param callback 回调函数
+     * @param interval 间隔毫秒，或随机范围
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiIntervalTrigger-间隔触发
+     */
+    libPixiIntervalTrigger: (callback: () => void, interval: number | [number, number]) => () => void;
+    /** @description 点击容器外或入口按钮时隐藏
+     * @param container 容器
+     * @param btn 按钮
+     * @param onClose 关闭回调
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiOutsideClick-失焦隐藏
+     */
+    libPixiOutsideClick: (container: import("pixi.js").Container, btn: import("pixi.js").Container, onClose: () => void) => () => void;
+    /** @description 为容器创建并应用一个矩形遮罩，用于隐藏溢出的内容，函数会返回遮罩，可控制是否显示遮罩
+     * @param container 需要设置遮罩裁剪的容器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiOverflowHidden-溢出裁剪
+     */
+    libPixiOverflowHidden: (container: import("pixi.js").Container) => import("pixi.js").Graphics;
+    /** @description 基于 Ticker 和 Promise 的定时器
+     * @param delay 延迟时间
+     * @param callback 延迟后执行的函数
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiPromiseTickerTimeout-TickerPromise定时器
+     */
+    libPixiPromiseTickerTimeout: (delay?: number, callback?: () => void) => Promise<void>;
+    /** @description 元素超过指定宽度就缩放
+     * @param scaleContainer 需要缩放的元素
+     * @param maxWidth 最大宽度
+     * @param maxHeight 最大高度
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiScaleContainer-超出缩放
+     */
+    libPixiScaleContainer: (scaleContainer: import("pixi.js").Container | import("pixi.js").Sprite | import("pixi.js").Text, maxWidth: number, maxHeight?: number) => void;
+    /** @description 阴影
+     * @param container 需要添加阴影的元素
+     * @param config 配置项
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiShadow-阴影
+     */
+    libPixiShadow: (container: import("pixi.js").Container, config?: import("./Utils/LibPixiShadow").LibPixiShadowShadowConfig) => void;
+    /** @description 基于 Ticker 的定时器
+     * @param callback 延迟后执行的函数
+     * @param delay 延迟时间
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiTickerTimeout-Ticker定时器
+     */
+    libPixiTickerTimeout: (callback: () => void, delay?: number) => () => void;
+};

package/libPixiJs.js

@@ -0,0 +1,174 @@
+import { LibPixiBitText } from "./Components/Base/LibPixiBitText";
+import { LibPixiContainer } from "./Components/Base/LibPixiContainer";
+import { LibPixiParticleMove } from "./Components/Base/LibPixiParticleMove";
+import { LibPixiRectBgColor } from "./Components/Base/LibPixiRectBgColor";
+import { LibPixiSpine } from "./Components/Base/LibPixiSpine";
+import { LibPixiText } from "./Components/Base/LibPixiText";
+import { LibPixiButtonHover } from "./Components/Custom/LibPixiButtonHover";
+import { LibPixiCloseBtn } from "./Components/Custom/LibPixiCloseBtn";
+import { LibPixiDrawer } from "./Components/Custom/LibPixiDrawer";
+import { LibPixiPerforMon } from "./Components/Custom/LibPixiPerforMon";
+import { LibPixiProgress } from "./Components/Custom/LibPixiProgress";
+import { LibPixiScrollContainer } from "./Components/Custom/LibPixiScrollContainer";
+import { LibPixiScrollNum } from "./Components/Custom/LibPixiScrollNum";
+import { LibPixiSlider } from "./Components/Custom/LibPixiSlider";
+import { LibPixiSubAddMinMax } from "./Components/Custom/LibPixiSubAddMinMax";
+import { LibPixiTable } from "./Components/Custom/LibPixiTable";
+import { LibPixiAudio } from "./Utils/LibPixiAudio";
+import { libPixiCreateNineGrid } from "./Utils/LibPixiCreateNineGrid";
+import { libPixiEvent } from "./Utils/LibPixiEvent";
+import { libPixiEventControlled } from "./Utils/LibPixiEventControlled";
+import { libPixiIntervalTrigger } from "./Utils/LibPixiIntervalTrigger";
+import { libPixiOutsideClick } from "./Utils/LibPixiOutsideClick";
+import { libPixiOverflowHidden } from "./Utils/LibPixiOverflowHidden";
+import { libPixiPromiseTickerTimeout } from "./Utils/LibPixiPromiseTickerTimeout";
+import { libPixiScaleContainer } from "./Utils/LibPixiScaleContainer";
+import { libPixiFilter } from "./Utils/LibPixiFilter";
+import { libPixiShadow } from "./Utils/LibPixiShadow";
+import { libPixiTickerTimeout } from "./Utils/LibPixiTickerTimeout";
+/** @description 组件 */
+export const Components = {
+    Base: {
+        /** @description 自定义位图文本
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiBitText-位图
+         */
+        LibPixiBitText,
+        /** @description 自定义容器大小及背景色
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiContainer-容器
+         */
+        LibPixiContainer,
+        /** @description 利用贝塞尔曲线实现粒子移动
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiParticleMove-粒子容器
+         */
+        LibPixiParticleMove,
+        /** @description 自定义矩形背景色
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiRectBgColor-矩形
+         */
+        LibPixiRectBgColor,
+        /** @description 自定义 Spine 动画
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiSpine-动画
+         */
+        LibPixiSpine,
+        /** @description 自定义文本类
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiText-文本
+         */
+        LibPixiText,
+    },
+    Custom: {
+        /** @description 悬浮切换材质
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiButtonHover-按钮悬浮
+         */
+        LibPixiButtonHover,
+        /** @description 右上角关闭按钮，支持悬浮旋转动画
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiCloseBtn-关闭按钮
+         */
+        LibPixiCloseBtn,
+        /** @description 底部弹出抽屉
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiDrawer-抽屉
+         */
+        LibPixiDrawer,
+        /** @description 监视帧率、Draw Call、Max Draw Call
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiPerforMon-性能监视器
+         */
+        LibPixiPerforMon,
+        /** @description 通过裁剪的方式显示进度条
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiProgress-进度条
+         */
+        LibPixiProgress,
+        /** @description 支持鼠标滚轮滚动、鼠标拖动、手指滑动，支持惯性滚动及回弹
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiScrollContainer-滚动容器
+         */
+        LibPixiScrollContainer,
+        /** @description 通过鼠标或手指拖动数字列选择数字
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiScrollNum-数字滑动
+         */
+        LibPixiScrollNum,
+        /** @description 类似轮播图，但是不会自动轮播
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiSlider-横向滑动图
+         */
+        LibPixiSlider,
+        /** @description 最小、最大按钮和增减按钮功能及置灰逻辑
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiSubAddMinMax-数字控制器
+         */
+        LibPixiSubAddMinMax,
+        /** @description 绘制表格并填充数字
+         * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiTable-数字表格
+         */
+        LibPixiTable,
+    },
+};
+/** @description 方法 */
+export const Utils = {
+    /** @description 音频播放器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiAudio-音频播放器
+     */
+    LibPixiAudio,
+    /** @description 九宫格图
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiCreateNineGrid-九宫格图
+     */
+    libPixiCreateNineGrid,
+    /** @description 事件注册
+     * @param v 事件容器
+     * @param eventName 事件名称
+     * @param callback 回调函数
+     * @param once 是否只执行一次
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEvent-事件注册
+     */
+    libPixiEvent,
+    /** @description 设置可关闭的事件监听，调用自身后不再触发
+     * @param container 事件容器
+     * @param eventName 事件名称
+     * @param callback 事件回调
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEventControlled-可关闭的事件
+     */
+    libPixiEventControlled,
+    /** @description 滤镜
+     * @param filterName 滤镜名称
+     * @param v 滤镜值
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiFilter-滤镜
+     */
+    libPixiFilter,
+    /** @description 间隔触发
+     * @param callback 回调函数
+     * @param interval 间隔毫秒，或随机范围
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiIntervalTrigger-间隔触发
+     */
+    libPixiIntervalTrigger,
+    /** @description 点击容器外或入口按钮时隐藏
+     * @param container 容器
+     * @param btn 按钮
+     * @param onClose 关闭回调
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiOutsideClick-失焦隐藏
+     */
+    libPixiOutsideClick,
+    /** @description 为容器创建并应用一个矩形遮罩，用于隐藏溢出的内容，函数会返回遮罩，可控制是否显示遮罩
+     * @param container 需要设置遮罩裁剪的容器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiOverflowHidden-溢出裁剪
+     */
+    libPixiOverflowHidden,
+    /** @description 基于 Ticker 和 Promise 的定时器
+     * @param delay 延迟时间
+     * @param callback 延迟后执行的函数
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiPromiseTickerTimeout-TickerPromise定时器
+     */
+    libPixiPromiseTickerTimeout,
+    /** @description 元素超过指定宽度就缩放
+     * @param scaleContainer 需要缩放的元素
+     * @param maxWidth 最大宽度
+     * @param maxHeight 最大高度
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiScaleContainer-超出缩放
+     */
+    libPixiScaleContainer,
+    /** @description 阴影
+     * @param container 需要添加阴影的元素
+     * @param config 配置项
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiShadow-阴影
+     */
+    libPixiShadow,
+    /** @description 基于 Ticker 的定时器
+     * @param callback 延迟后执行的函数
+     * @param delay 延迟时间
+     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiTickerTimeout-Ticker定时器
+     */
+    libPixiTickerTimeout,
+};