@polyv/vue-components 1.2.3 → 1.4.0

package/vue3/src/hooks/interactive/use-fullscreen/index.d.ts

@@ -1,29 +1,30 @@
-import { MaybeElement } from '../../../vue-utils';
-import { Ref } from 'vue';
-export interface FullscreenFieldData {
-    /** 浏览器是否支持全屏模式的 api 字段 */
-    enabledField: 'fullscreenEnabled';
-    /** 获取浏览器正在全屏的 dom 节点 api 字段 */
-    elementField: 'fullscreenElement';
-    /** 浏览器全屏的 api 字段 */
-    requestApiField: 'requestFullscreen';
-    /** 浏览器退出全屏的 api 字段 */
-    exitApiField: 'exitFullscreen';
-    /** 浏览器全屏状态改变事件 */
-    fullscreenChangeEvent: 'fullscreenchange';
+import { ResponsiveElement } from '../../../vue-utils';
+import { ComputedRef, Ref } from 'vue';
+import { UseAutoListenOptions, UseAutoListenFn } from '../../tools/use-auto-listen';
+export type GetFullscreenTarget = () => ResponsiveElement;
+export interface UseFullscreenOptions extends UseAutoListenOptions {
+    /** 全屏状态改变回调 */
+    onFullscreenChange?: (isFullscreen: boolean) => void;
+}
+export interface UseFullscreenReturn extends UseAutoListenFn {
+    /** 是否全屏 */
+    isFullscreen: Ref<boolean>;
+    /** 是否当前元素全屏 */
+    isCurrentFullscreen: Ref<boolean>;
+    /** 是否支持浏览器全屏 */
+    supportFullscreen: ComputedRef<boolean>;
+    /** 获取全屏中的元素 */
+    getFullscreenElement: () => Element | undefined;
+    /** 进入全屏 */
+    requestFullscreen: () => Promise<void>;
+    /** 退出全屏 */
+    exitFullscreen: () => Promise<void>;
+    /** 切换全屏状态 */
+    toggleFullscreen: () => Promise<void>;
 }
-export type GetFullscreenElement = () => MaybeElement;
 /**
  * 系统全屏
+ * @param target 目标元素
+ * @param options 选项
  */
-export declare const useFullscreen: (elementRef?: MaybeElement | GetFullscreenElement, options?: {
-    /** 强制禁用全屏 */
-    forceDisabled?: boolean;
-    onFullscreenChange?: (isFullscreen: boolean) => void;
-}) => {
-    isFullscreen: Ref<boolean>;
-    supportFullscreen: import('vue').ComputedRef<boolean>;
-    requestFullscreen: () => void;
-    exitFullscreen: () => void;
-    toggleFullscreen: () => void;
-};
+export declare function useFullscreen(target?: ResponsiveElement | GetFullscreenTarget, options?: UseFullscreenOptions): UseFullscreenReturn;

package/vue3/src/hooks/interactive/use-fullscreen/types.d.ts

@@ -0,0 +1,19 @@
+export interface FullscreenFieldData {
+    /** 浏览器是否支持全屏模式的 api 字段 */
+    enabledField: 'fullscreenEnabled';
+    /** 获取浏览器正在全屏的 dom 节点 api 字段 */
+    elementField: 'fullscreenElement';
+    /** 浏览器全屏的 api 字段 */
+    requestApiField: 'requestFullscreen';
+    /** 浏览器退出全屏的 api 字段 */
+    exitApiField: 'exitFullscreen';
+    /** 浏览器全屏状态改变事件 */
+    fullscreenChangeEvent: 'fullscreenchange';
+}
+export declare const fullscreenApis: {
+    enabledField: string;
+    elementField: string;
+    requestApiField: string;
+    exitApiField: string;
+    fullscreenChangeEvent: string;
+}[];

package/vue3/src/hooks/interactive/use-hover/index.d.ts

@@ -1,8 +1,20 @@
 import { ResponsiveElement } from '../../../vue-utils';
+import { Ref } from 'vue';
+export interface UseHoverOptions {
+    /**
+     * 悬停时添加的类名
+     * @default false
+     */
+    hoverClass?: string | boolean;
+}
+export interface UseHoverReturn {
+    /**
+     * 是否悬停
+     */
+    isHover: Ref<boolean>;
+}
 /**
- * 悬浮事件 hook
+ * 悬停
  * @param target 响应式节点
  */
-export declare const useHover: (target: ResponsiveElement) => {
-    isHover: import('vue').Ref<boolean>;
-};
+export declare function useHover(target: ResponsiveElement, options?: UseHoverOptions): UseHoverReturn;

package/vue3/src/hooks/interactive/use-hover-visible/index.d.ts

@@ -1,4 +1,5 @@
 import { ResponsiveElement } from '../../../vue-utils';
+import { Ref } from 'vue';
 export interface UseHoverVisibleOptions {
     /**
      * 目标节点
@@ -8,20 +9,36 @@ export interface UseHoverVisibleOptions {
      * 自动展示
      * @default true
      */
-    autoHover?: boolean;
+    defaultVisible?: boolean;
     /**
      * 自动关闭时长，单位：ms
      * @default 3000
      */
     timeout?: number;
 }
-/**
- * 悬浮可见处理
- */
-export declare const useHoverVisible: (hookOptions?: UseHoverVisibleOptions) => {
-    visible: import('vue').Ref<boolean>;
+export interface UseHoverVisibleReturn {
+    /**
+     * 是否可见
+     */
+    visible: Ref<boolean>;
+    /**
+     * 显示
+     */
     show: () => void;
+    /**
+     * 强制显示
+     */
     forceShow: () => void;
+    /**
+     * 隐藏
+     */
     hide: () => void;
+    /**
+     * 开始自动隐藏
+     */
     startAutoHide: () => void;
-};
+}
+/**
+ * 悬浮可见处理
+ */
+export declare function useHoverVisible(hookOptions?: UseHoverVisibleOptions): UseHoverVisibleReturn;

package/vue3/src/hooks/interactive/use-outside/common.d.ts

@@ -0,0 +1,9 @@
+import { OutsideTargets, OutsideTargetsFunction } from './types';
+/** 获取用于比较的 dom 节点列表 */
+export declare function getCompareElements(targets: OutsideTargets | OutsideTargetsFunction): HTMLElement[];
+/**
+ * 检查事件目标是否在目标节点内
+ * @param eventTarget 事件目标
+ * @param targets 目标节点
+ */
+export declare function checkIsInTargets(eventTarget: HTMLElement, targets: OutsideTargets | OutsideTargetsFunction): boolean;

package/vue3/src/hooks/interactive/use-outside/index.d.ts

@@ -1,24 +1,3 @@
-import { Ref } from 'vue';
-export type OutsideTargetType = Ref | Element | string;
-export type OutsideTargets = OutsideTargetType | OutsideTargetType[];
-export type OutsideTargetsFunction = () => OutsideTargets;
-export type OutsideCallback = (options: {
-    listenOutSideEvent: () => void;
-    removeOutSideEvent: () => void;
-}) => unknown;
-/**
- * 点击节点外部事件 hook
- * @param targets 响应式节点数组或获取方法
- * @param callback 回调方法
- * @param autoListen 自动监听，默认：true
- */
-export declare const useClickOutside: (targets: OutsideTargets | OutsideTargetsFunction, callback: OutsideCallback, autoListen?: boolean) => {
-    listenOutSideEvent: () => void;
-    removeOutSideEvent: () => void;
-    listenClickOutSide: () => void;
-    removeListenClickOutSide: () => void;
-};
-export declare const useMouseMoveOutside: (targets: OutsideTargets | OutsideTargetsFunction, callback: OutsideCallback, autoListen?: boolean) => {
-    listenOutSideEvent: () => void;
-    removeOutSideEvent: () => void;
-};
+export * from './use-click-outside';
+export * from './use-mouse-outside';
+export * from './types';

package/vue3/src/hooks/interactive/use-outside/types.d.ts

@@ -0,0 +1,18 @@
+import { Ref } from 'vue';
+export type OutsideTargetType = Ref | Element | string;
+export type OutsideTargets = OutsideTargetType | OutsideTargetType[];
+export type OutsideTargetsFunction = () => OutsideTargets;
+export type OutsideCallback = (options: {
+    listenOutSideEvent: () => void;
+    removeOutSideEvent: () => void;
+}) => unknown;
+export interface OutsideReturn {
+    /**
+     * 监听事件
+     */
+    listenOutSideEvent: () => void;
+    /**
+     * 取消监听事件
+     */
+    removeOutSideEvent: () => void;
+}

package/vue3/src/hooks/interactive/use-outside/use-click-outside.d.ts

@@ -0,0 +1,8 @@
+import { OutsideCallback, OutsideReturn, OutsideTargets, OutsideTargetsFunction } from './types';
+/**
+ * 点击节点外部事件 hook
+ * @param targets 响应式节点数组或获取方法
+ * @param callback 回调方法
+ * @param autoListen 自动监听，默认：true
+ */
+export declare function useClickOutside(targets: OutsideTargets | OutsideTargetsFunction, callback: OutsideCallback, autoListen?: boolean): OutsideReturn;

package/vue3/src/hooks/interactive/use-outside/use-mouse-outside.d.ts

@@ -0,0 +1,2 @@
+import { OutsideCallback, OutsideReturn, OutsideTargets, OutsideTargetsFunction } from './types';
+export declare function useMouseOutside(targets: OutsideTargets | OutsideTargetsFunction, callback: OutsideCallback, autoListen?: boolean): OutsideReturn;

package/vue3/src/hooks/interactive/use-press-hold/index.d.ts

@@ -1,5 +1,10 @@
 import { ResponsiveElement } from '../../../vue-utils';
 export interface UsePressHoldOptions {
+    /**
+     * 是否支持按住
+     * @default true
+     */
+    canHold?: boolean;
     /**
      * 按住间隔时间，单位：毫秒
      * @default 100

package/vue3/src/hooks/interactive/use-screen-orientation/index.d.ts

@@ -1,3 +1,5 @@
+import { UseAutoListenFn, UseAutoListenOptions } from '../../tools/use-auto-listen';
+import { ComputedRef, Ref } from 'vue';
 /**
  * 屏幕旋转模式
  * @description 不使用 portrait 和 landscape 是不想和业务名称重合
@@ -8,18 +10,17 @@ export declare enum ScreenOrientationMode {
     /** 屏幕横向 */
     Horizontal = "Horizontal"
 }
+export interface UseScreenOrientationOptions extends UseAutoListenOptions {
+}
+export interface UseScreenOrientationReturn extends UseAutoListenFn {
+    /** 屏幕旋转模式 */
+    screenOrientationMode: Ref<ScreenOrientationMode>;
+    /** 当前屏幕方向是否为纵向 */
+    isVerticalScreenOrientation: ComputedRef<boolean>;
+    /** 当前屏幕方向是否为横向 */
+    isHorizontalScreenOrientation: ComputedRef<boolean>;
+}
 /**
- * 屏幕旋转
+ * 屏幕方向
  */
-export declare const useScreenOrientation: (params?: {
-    /** 自动监听事件，默认：true */
-    autoListen?: boolean;
-    /** 自动监听回调 */
-    autoListenCb?: (screenOrientationMode: ScreenOrientationMode) => void;
-}) => {
-    screenOrientationMode: import('vue').Ref<ScreenOrientationMode>;
-    isVerticalScreenOrientation: import('vue').ComputedRef<boolean>;
-    isHorizontalScreenOrientation: import('vue').ComputedRef<boolean>;
-    listenOrientationEvent: () => void;
-    updateScreenOrientationModeManually: () => void;
-};
+export declare function useScreenOrientation(callback?: (screenOrientationMode: ScreenOrientationMode) => unknown, options?: UseScreenOrientationOptions): UseScreenOrientationReturn;

package/vue3/src/hooks/interactive/use-scroll/index.d.ts

@@ -3,18 +3,48 @@ import { Ref } from 'vue';
  * 滚动方向
  */
 export type ScrollDirection = 'horizontal' | 'vertical';
-/**
- * 滚动
- */
-export declare const useScroll: (options?: {
-    scrollRef?: Ref<HTMLDivElement | undefined>;
-    /** 滚动到下一页回调 */
+export interface UseScrollOptions {
+    /**
+     * 滚动容器
+     */
+    scrollRef?: Ref<HTMLElement | undefined>;
+    /**
+     * 滚动到下一页回调
+     */
     nextCallback?: () => unknown;
-    /** 滚动方向，默认：vertical */
+    /**
+     * 滚动方向
+     * @default 'vertical'
+     */
     direction?: ScrollDirection;
-}) => {
-    scrollRef: Ref<HTMLDivElement | undefined>;
-    onScroll: import('lodash-es/debounce').DebouncedFunc<(event: Event) => void>;
-    getScrollElement: () => HTMLDivElement | undefined;
+}
+export interface UseScrollReturn {
+    /**
+     * 滚动容器
+     */
+    scrollRef: Ref<HTMLElement | undefined>;
+    /**
+     * 滚到最顶部
+     */
+    scrollToTop: () => void;
+    /**
+     * 滚到最底部
+     */
+    scrollToBottom: () => void;
+    /**
+     * 是否靠近底部
+     */
+    isNearBottom: () => boolean;
+    /**
+     * 是否存在垂直滚动条
+     */
     hasVerticalScrollbar: () => Promise<boolean | undefined>;
-};
+    /**
+     * 是否存在水平滚动条
+     */
+    hasHorizontalScrollbar: () => Promise<boolean | undefined>;
+}
+/**
+ * 滚动
+ */
+export declare function useScroll(options?: UseScrollOptions): UseScrollReturn;

package/vue3/src/hooks/interactive/use-sound-effect/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * 提示音播放
  */
-export declare const useSoundEffect: () => {
+export declare function useSoundEffect(): {
     playSoundEffect: () => Promise<void>;
 };

package/vue3/src/hooks/pagination/use-scroll-pagintaion/index.d.ts

@@ -5,7 +5,7 @@ export interface ScrollPaginationHookOptions<I = unknown> extends PaginationHook
     /**
      * 滚动容器
      */
-    scrollRef?: Ref<HTMLDivElement | undefined>;
+    scrollRef?: Ref<HTMLElement | undefined>;
     /**
      * 滚动方向
      * @default 'vertical'
@@ -16,7 +16,7 @@ export interface ScrollPaginationHookReturn<I = unknown> extends PageinationHook
     /**
      * 滚动容器
      */
-    scrollRef: Ref<HTMLDivElement | undefined>;
+    scrollRef: Ref<HTMLElement | undefined>;
     /**
      * 是否为空
      */

package/vue3/src/hooks/state/create-global-store/index.d.ts

@@ -0,0 +1,6 @@
+export type GlobalStoreSetup<SS> = () => SS;
+export interface GlobalStoreDefinition<Id extends string, SS> {
+    (): SS;
+    $id: Id;
+}
+export declare function createGlobalStore<Id extends string, SS>(id: Id, storeSetup: GlobalStoreSetup<SS>): GlobalStoreDefinition<Id, SS>;

package/vue3/src/hooks/tools/use-event-bus/index.d.ts

@@ -1,10 +1,18 @@
 import { EventEmitter } from '@polyv/utils/es/event';
 import { UseAutoListenFn, UseAutoListenOptions } from '../use-auto-listen';
+declare module '../../business/use-config-provider' {
+    interface ConfigProviderInjectData {
+        /**
+         * 获取事件订阅器
+         */
+        getEmitter?: () => PwcEventEmitter;
+    }
+}
 type PwcMittEvents = {
     [key: string]: any;
 };
 export type PwcEventEmitter = EventEmitter<PwcMittEvents>;
-export declare function createEmitter(): PwcEventEmitter;
+export declare function createEmitter(id?: string): PwcEventEmitter;
 /**
  * 获取事件订阅器
  */
@@ -22,4 +30,13 @@ export interface UseEventBusListenerReturn extends UseAutoListenFn {
  * @param options 选项
  */
 export declare function useEventBusListener(event: string, callback: (...arg: any[]) => unknown, options?: UseEventBusListenerOptions): UseEventBusListenerReturn;
+/**
+ * 生成事件对象
+ * @param prefix 前缀
+ * @param eventObj 事件对象
+ * @returns 生成的事件对象
+ */
+export declare function generateEventObject<Prefix extends string, E extends Record<string, string> = {}>(prefix: Prefix, eventObj: E): {
+    readonly [key in keyof E]: `${Prefix}.${E[key]}`;
+};
 export {};

package/vue3/src/hooks/tools/use-queue/index.d.ts

@@ -0,0 +1,29 @@
+import { Ref } from 'vue';
+export interface QueueItem<T = unknown> {
+    data: T;
+}
+export interface UseQueueOptions<T = unknown> {
+    /**
+     * 队列最大长度，不传则不限制
+     */
+    maxLength?: number;
+    /**
+     * 出队回调
+     */
+    onDequeue?: (item: QueueItem<T>) => void;
+}
+export interface UseQueueReturn<T = unknown> {
+    /**
+     * 队列
+     */
+    queue: Ref<QueueItem<T>[]>;
+    /**
+     * 插入队列
+     */
+    push: (data: T) => void;
+    /**
+     * 出队
+     */
+    pop: () => QueueItem<T> | undefined;
+}
+export declare function useQueue<T = unknown>(options?: UseQueueOptions<T>): UseQueueReturn<T>;

package/vue3/src/hooks/tools/use-task-queue/index.d.ts

@@ -0,0 +1,33 @@
+import { Ref } from 'vue';
+export interface UseTaskQueueOptions {
+    /**
+     * 队列最大长度，不传则不限制
+     */
+    maxLength?: number;
+    /**
+     * 最大同时执行任务数
+     * @default 1
+     */
+    maxConcurrent?: number;
+}
+export type TaskFunction = () => Promise<void>;
+export interface UseTaskQueueReturn {
+    /**
+     * 插入任务
+     * @param task 任务函数
+     */
+    pushTask: (task: TaskFunction) => void;
+    /**
+     * 队列长度
+     */
+    queueLength: Ref<number>;
+    /**
+     * 正在执行的任务数
+     */
+    runningCount: Ref<number>;
+    /**
+     * 清空队列
+     */
+    clearQueue: () => void;
+}
+export declare function useTaskQueue(options?: UseTaskQueueOptions): UseTaskQueueReturn;

package/vue3/src/hooks/vue/use-model-value/index.d.ts

@@ -8,6 +8,7 @@ type MVProps = {
  */
 export declare const useModelValue: <P extends MVProps>(props: P) => {
     modelValue: import('vue').ComputedRef<P["v-model-key"]>;
+    getModelValue: () => P["v-model-key"];
     updateModelValue: (value: P[typeof PropUtils.modelValueKey]) => void;
 };
 export {};

package/vue3/src/index.d.ts

@@ -4,3 +4,4 @@ export * from './plugins/exports';
 export * from './lang/exports';
 export * from './interface';
 export * from './vue-utils';
+export { VueCompatible } from './vue-utils/version-compatible/vue3';

package/vue3/src/lang/common/en.json.d.ts

@@ -10,7 +10,8 @@ declare const _default: {
     "copyLinkSuccess": "Link copy success, you can paste it in the browser to download",
     "tips": "Tips",
     "success": "Success",
-    "empty": "Empty"
+    "empty": "Empty",
+    "comma": ", "
   }
 }
 ;

package/vue3/src/lang/common/ja.json.d.ts

@@ -10,7 +10,8 @@ declare const _default: {
     "copyLinkSuccess": "リンクをコピーしました。ブラウザに貼り付けてダウンロードしてください",
     "tips": "ヒント",
     "success": "成功",
-    "empty": "空"
+    "empty": "空",
+    "comma": "，"
   }
 };
 

package/vue3/src/lang/common/ko.json.d.ts

@@ -10,7 +10,8 @@ declare const _default: {
     "copyLinkSuccess": "링크 복사 성공, 브라우저에 붙여넣기하여 다운로드",
     "tips": "팁",
     "success": "성공",
-    "empty": "비어있음"
+    "empty": "비어있음",
+    "comma": "，"
   }
 };
 

package/vue3/src/lang/common/ru.json.d.ts

@@ -10,7 +10,8 @@ declare const _default: {
     "copyLinkSuccess": "Ссылка скопирована успешно, можно перейти в браузер и вставить для загрузки",
     "tips": "Подсказка",
     "success": "Успешно",
-    "empty": "Пусто"
+    "empty": "Пусто",
+    "comma": ", "
   }
 };
 

package/vue3/src/lang/common/zh-CN.json.d.ts

@@ -10,7 +10,8 @@ declare const _default: {
     "copyLinkSuccess": "链接复制成功，可去浏览器粘贴下载",
     "tips": "提示",
     "success": "成功",
-    "empty": "暂无内容"
+    "empty": "暂无内容",
+    "comma": "，"
   }
 }
 ;

package/vue3/src/lang/common/zh-TW.json.d.ts

@@ -10,7 +10,8 @@ declare const _default: {
     "copyLinkSuccess": "連結複製成功，可去瀏覽器貼上下載",
     "tips": "提示",
     "success": "成功",
-    "empty": "暫無內容"
+    "empty": "暫無內容",
+    "comma": "，"
   }
 };
 

package/vue3/src/lang/hook.d.ts

@@ -1,6 +1,14 @@
 import { CommonLangs } from './common';
 import { I18nConfig, I18nLangs, NestedKeys } from './types';
 import { UniversalParams } from '../interface';
+declare module '../hooks/business/use-config-provider' {
+    interface ConfigProviderInjectData {
+        /**
+         * 当前语言
+         */
+        globalLang?: I18nLangs | (() => I18nLangs);
+    }
+}
 type LangData<C extends Record<string, unknown>> = C & CommonLangs;
 export declare function createI18n<C extends Record<string, unknown> = {}>(config?: I18nConfig<C>): {
     useI18n: () => {

package/vue3/src/lang/internal/en.json.d.ts

@@ -16,6 +16,14 @@ declare const _default: {
     "error2": "Please enter the correct phone number",
     "submitText": "Agree to submit"
   },
+  "messageBox": {
+    "confirm": "Confirm",
+    "cancel": "Cancel",
+    "delete": "Delete",
+    "clear": "Clear",
+    "submit": "Submit",
+    "known": "I know"
+  },
   "areaPicker": {
     "province": "Province",
     "city": "City",
@@ -39,6 +47,62 @@ declare const _default: {
     "viewExportRecords": "You can view your export records here",
     "gotIt": "Got it",
     "empty": "Empty"
+  },
+  "imageUpload": {
+    "error1": "Unsupported file type",
+    "error2": "Do not upload empty files",
+    "error3": "Image size must not exceed {size}MB",
+    "error4": "Image size must not be less than {size}KB",
+    "error5": "Image is damaged, please upload it again",
+    "error6": "Image contains violent elements, please upload it again",
+    "uploading": "Uploading...",
+    "clickUpload": "Click to upload image",
+    "replace": "Replace",
+    "delete": "Delete",
+    "defaultPlaceholder1": "Supported file formats: {types}",
+    "defaultPlaceholder2": "File size must not exceed {size}"
+  },
+  "datePicker": {
+    "headerText": "{year} year {month} month",
+    "monday": "Mon",
+    "tuesday": "Tue",
+    "wednesday": "Wed",
+    "thursday": "Thu",
+    "friday": "Fri",
+    "saturday": "Sat",
+    "sunday": "Sun",
+    "current": "Now",
+    "datePlaceholder1": "Select date",
+    "datePlaceholder2": "Select date and time",
+    "startPlaceholder": "Start date",
+    "endPlaceholder": "End date",
+    "today": "Today",
+    "yesterday": "Yesterday",
+    "tomorrow": "Tomorrow",
+    "30-minutes-later": "30 minutes later",
+    "1-hour-later": "1 hour later",
+    "last-7-days": "Last 7 days",
+    "last-30-days": "Last 30 days",
+    "last-90-days": "Last 90 days",
+    "last-180-days": "Last 180 days",
+    "last-360-days": "Last 360 days"
+  },
+  "select": {
+    "searchPlaceholder": "Search keywords",
+    "empty": "No options"
+  },
+  "table": {
+    "operation": "Operation",
+    "tags": "Tags",
+    "index": "Index",
+    "single": "Select",
+    "allCount": "Total {count}"
+  },
+  "pagination": {
+    "totalItems": "Total {count}",
+    "totalPages": "Total {count} pages",
+    "size": "{size}/page",
+    "goto": "Go to"
   }
 };