@polyv/vue-components 1.1.1 → 1.2.0

package/vue2/src/hooks/tools/use-auto-listen/index.d.ts

@@ -0,0 +1,30 @@
+export interface UseAutoListenOptions {
+    /**
+     * 是否在 `onMounted` 时自动监听
+     *
+     * @default true
+     */
+    autoListen?: boolean;
+    /**
+     * 是否在 `onBeforeUnmount` 时自动移除
+     *
+     * @default true
+     */
+    autoRemove?: boolean;
+}
+export interface UseAutoListenFn {
+    /**
+     * 监听事件
+     */
+    listenEvent: () => void;
+    /**
+     * 移除事件
+     */
+    removeEvent: () => void;
+}
+/**
+ * 在 `onMounted` 时自动监听，在 `onBeforeUnmount` 时自动移除
+ * @param fns 监听和移除事件的函数
+ * @param options 选项
+ */
+export declare function useAutoListen(fns: UseAutoListenFn, options?: UseAutoListenOptions): void;

package/vue2/src/hooks/tools/use-browser/index.d.ts

@@ -0,0 +1,38 @@
+export interface UseBrowserReturn {
+    /**
+     * 是否为 MAC
+     */
+    isMac: boolean;
+    /**
+     * 是否为移动端
+     */
+    isMobile: boolean;
+    /**
+     * 是否为微信内置浏览器（非企业微信）
+     */
+    isWeixin: boolean;
+    /**
+     * 是否为企业微信内置浏览器
+     */
+    isWorkWeixin: boolean;
+    /**
+     * 是否被 iframe
+     */
+    isIframe: boolean;
+    /**
+     * 是否为桌面端 iPad
+     */
+    isDesktopIPad: boolean;
+    /**
+     * 是否 IE
+     */
+    isIE: boolean;
+    /**
+     * 是否为低版本 IE
+     */
+    isLowerIE: boolean;
+}
+/**
+ * 浏览器识别
+ */
+export declare const useBrowser: () => UseBrowserReturn;

package/vue2/src/hooks/tools/use-clipboard/index.d.ts

@@ -0,0 +1,4 @@
+export declare const useClipboard: () => {
+    copyText: (text: string) => Promise<unknown>;
+    toastCopySuccess: () => void;
+};

package/vue2/src/hooks/tools/use-count-down/index.d.ts

@@ -0,0 +1,60 @@
+import { MaybeResponsive } from '../../../vue-utils';
+import { IRemaining as CountDownSurplusData } from '@polyv/utils/es/countdown';
+import { ComputedRef, Ref } from 'vue';
+export interface UseCountDownOptions {
+    /**
+     * 总秒数，单位秒
+     */
+    second?: MaybeResponsive<number | undefined>;
+    /**
+     * 结束的时间戳
+     */
+    endTimestamp?: MaybeResponsive<number | undefined>;
+    /**
+     * 自动开始倒计时
+     * @default false
+     */
+    autoStart?: boolean;
+    /**
+     * 倒计时剩余时间改变回调
+     */
+    onCountDownChange?: (surplusData: CountDownSurplusData) => void;
+    /**
+     * 倒计时结束回调
+     */
+    onCountDownFinish?: () => void;
+}
+export interface UseCountDownReturn {
+    /**
+     * 剩余时间
+     */
+    surplusTime: Ref<CountDownSurplusData>;
+    /**
+     * 剩余秒数
+     */
+    surplusSecond: ComputedRef<number>;
+    /**
+     * 重置剩余时间并销毁倒计时
+     */
+    resetSurplus: () => void;
+    /**
+     * 开始倒计时，如果传入 options，则根据 options 更新倒计时。
+     */
+    startCountDown: (options?: UseCountDownOptions) => void;
+    /**
+     * 暂停倒计时，如果再次调用 startCountDown，则继续未完成的倒计时。
+     */
+    pauseCountDown: () => void;
+    /**
+     * 停止倒计时，如果再次调用 startCountDown，则重新开始倒计时。
+     */
+    stopCountDown: () => void;
+    /**
+     * 销毁倒计时
+     */
+    destroyCountDown: () => void;
+}
+/**
+ * 倒计时
+ */
+export declare function useCountDown(options?: UseCountDownOptions): UseCountDownReturn;

package/vue2/src/hooks/tools/use-download/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 下载文件相关
+ */
+export declare const useDownload: () => {
+    downloadFileUrl: (fileUrl: string, fileName?: string) => Promise<void>;
+};

package/{src → vue2/src}/hooks/tools/use-event-bus/index.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from '@polyv/utils/es/event';
+import { UseAutoListenFn, UseAutoListenOptions } from '../use-auto-listen';
 type PwcMittEvents = {
     [key: string]: any;
 };
@@ -10,10 +11,15 @@ export declare function createEmitter(): PwcEventEmitter;
 export declare const useEventBusEmitter: () => {
     getEmitter: () => PwcEventEmitter;
 };
+export interface UseEventBusListenerOptions extends UseAutoListenOptions {
+}
+export interface UseEventBusListenerReturn extends UseAutoListenFn {
+}
 /**
  * 设置 eventBus 监听
  * @param event appEvents 中的事件
  * @param callback 回调
+ * @param options 选项
  */
-export declare const useEventBusListener: (event: string, callback: (...arg: any[]) => unknown) => void;
+export declare function useEventBusListener(event: string, callback: (...arg: any[]) => unknown, options?: UseEventBusListenerOptions): UseEventBusListenerReturn;
 export {};

package/vue2/src/hooks/tools/use-event-listener/index.d.ts

@@ -0,0 +1,40 @@
+import { MaybeResponsive } from '../../../vue-utils';
+import { UseAutoListenFn } from '../use-auto-listen';
+export interface UseEventListenerReturn extends UseAutoListenFn {
+}
+export type WindowEventName = keyof WindowEventMap;
+export type DocumentEventName = keyof DocumentEventMap;
+export type HTMLElementEventName = keyof HTMLElementEventMap;
+export type EventListenerCallback<E = Event> = (evt: E) => unknown;
+/**
+ * 在挂载时使用 addEventListener 进行注册，并在卸载时自动调用removeEventListener进行移除
+ * @param target
+ * @param event
+ * @param listener
+ * @param options
+ */
+export declare function useEventListener<E extends WindowEventName>(target: Window, event: E, listener: EventListenerCallback<WindowEventMap[E]>, options?: boolean | AddEventListenerOptions): UseEventListenerReturn;
+/**
+ * 在挂载时使用 addEventListener 进行注册，并在卸载时自动调用removeEventListener进行移除
+ * @param target
+ * @param event
+ * @param listener
+ * @param options
+ */
+export declare function useEventListener<E extends DocumentEventName>(target: Document, event: E, listener: EventListenerCallback<DocumentEventMap[E]>, options?: boolean | AddEventListenerOptions): UseEventListenerReturn;
+/**
+ * 在挂载时使用 addEventListener 进行注册，并在卸载时自动调用removeEventListener进行移除
+ * @param target
+ * @param event
+ * @param listener
+ * @param options
+ */
+export declare function useEventListener<E extends HTMLElementEventName>(target: MaybeResponsive<HTMLElement | undefined>, event: E, listener: EventListenerCallback<HTMLElementEventMap[E]>, options?: boolean | AddEventListenerOptions): UseEventListenerReturn;
+/**
+ * 在挂载时使用 addEventListener 进行注册，并在卸载时自动调用removeEventListener进行移除
+ * @param target
+ * @param event
+ * @param listener
+ * @param options
+ */
+export declare function useEventListener<E = Event>(target: MaybeResponsive<EventTarget | string | undefined>, event: string, listener: EventListenerCallback<E>, options?: boolean | AddEventListenerOptions): UseEventListenerReturn;

package/vue2/src/hooks/tools/use-request-animation-frame/index.d.ts

@@ -0,0 +1,5 @@
+export declare const useRequestAnimationFrame: (callback: () => unknown) => {
+    startAnimationFrame: () => void;
+    stopAnimationFrame: () => void;
+    hasAnimationFrame: () => boolean;
+};

package/vue2/src/hooks/tools/use-scroll-lock/index.d.ts

@@ -0,0 +1,21 @@
+import { MaybeElement, ResponsiveRef } from '../../../vue-utils';
+export interface UseScrollLockOptions {
+    /**
+     * 是否锁定滚动条
+     */
+    lockedRef?: ResponsiveRef<boolean>;
+    /**
+     * 需要锁定滚动条的节点
+     *
+     * @default document.body
+     */
+    lockTarget?: MaybeElement;
+}
+/**
+ * 锁定节点滚动
+ */
+export declare function useScrollLock(options?: UseScrollLockOptions): {
+    lockedRef: import('vue').Ref<boolean>;
+    lockScroll: () => void;
+    unlockScroll: () => void;
+};

package/vue2/src/hooks/tools/use-set-interval/index.d.ts

@@ -0,0 +1,20 @@
+export interface UseSetIntervalReturn {
+    /**
+     * 开始定时器
+     */
+    startInterval: () => void;
+    /**
+     * 关闭定时器
+     */
+    closeInterval: () => void;
+    /**
+     * 是否存在定时器
+     */
+    hasInterval: () => boolean;
+}
+/**
+ * 设置定时器
+ * @param callback 回调函数
+ * @param time 时间
+ */
+export declare function useSetInterval(callback: () => unknown, time: number): UseSetIntervalReturn;

package/vue2/src/hooks/tools/use-set-timeout/index.d.ts

@@ -0,0 +1,20 @@
+export interface UseSetTimeoutReturn {
+    /**
+     * 开始定时器
+     */
+    startTimeout: () => void;
+    /**
+     * 关闭定时器
+     */
+    closeTimeout: () => void;
+    /**
+     * 是否存在定时器
+     */
+    hasTimeout: () => boolean;
+}
+/**
+ * 设置定时器
+ * @param callback 回调函数
+ * @param time 时间
+ */
+export declare function useSetTimeout(callback: () => unknown, time: number): UseSetTimeoutReturn;

package/{src → vue2/src}/hooks/tools/use-simple-visible/index.d.ts

@@ -14,22 +14,18 @@ export interface UseSimpleVisibleOptions {
     autoCloseTime?: number;
     /**
      * 显示时回调
-     * @propType () => void
      */
     showCallback?: () => void;
     /**
      * 隐藏时回调
-     * @propType () => void
      */
     hideCallback?: () => void;
     /**
      * 隐藏延迟回调
-     * @propType () => void
      */
     hideDelayCallback?: () => void;
     /**
      * 更新回调
-     * @propType (visible: boolean) => void
      */
     changeCallback?: (visible: boolean) => void;
 }

package/vue2/src/hooks/tools/use-target-event-emitter/index.d.ts

@@ -0,0 +1,15 @@
+import { EventEmitter, EventHandler, EventRelationsType, EventType } from '@polyv/utils/es/event';
+import { UseAutoListenFn, UseAutoListenOptions } from '../use-auto-listen';
+export type TargetEventListeners<R extends EventRelationsType, E extends EventType> = {
+    [event in E]?: EventHandler<R, event>;
+};
+export interface UseTargetEventEmitterOptions extends UseAutoListenOptions {
+}
+export interface UseTargetEventEmitterReturn extends UseAutoListenFn {
+}
+/**
+ * EventEmitter 监听器
+ * @param eventEmitter 事件监听器
+ * @param listeners 监听列表
+ */
+export declare function useTargetEventEmitter<R extends EventRelationsType, E extends EventType>(eventEmitter: EventEmitter<R, E>, listeners: TargetEventListeners<R, E>, options?: UseTargetEventEmitterOptions): UseTargetEventEmitterReturn;

package/vue2/src/hooks/tools/use-window-resize-listener/index.d.ts

@@ -0,0 +1,32 @@
+import { Ref } from 'vue';
+import { UseAutoListenFn, UseAutoListenOptions } from '../use-auto-listen';
+export interface UseWindowResizeListenerOptions extends UseAutoListenOptions {
+    /**
+     * 在 `onMounted` 时立即执行回调
+     *
+     * @default false
+     */
+    immediate?: boolean;
+    /**
+     * 防抖时间
+     *
+     * @default 0
+     */
+    debounceTime?: number;
+}
+export interface UseWindowResizeListenerReturn extends UseAutoListenFn {
+    /**
+     * 窗口大小
+     */
+    windowSize: Ref<{
+        width: number;
+        height: number;
+    }>;
+}
+/**
+ * 监听 windows resize 事件
+ */
+export declare function useWindowResizeListener(callback?: (data: {
+    width: number;
+    height: number;
+}) => unknown, options?: UseWindowResizeListenerOptions): UseWindowResizeListenerReturn;

package/vue2/src/hooks/tools/use-z-index/index.d.ts

@@ -0,0 +1,29 @@
+declare const Z_INDEX_KEY = "@@polyvAdminUIzIndex";
+declare global {
+    interface Window {
+        [Z_INDEX_KEY]?: number;
+    }
+}
+export interface UseZIndexReturn {
+    /**
+     * 获取当前最顶层的层叠数
+     */
+    getTopmostZIndex: () => number;
+    /**
+     * 设置当前最顶层的层叠数
+     */
+    setTopmostZIndex: (zIndex: number) => void;
+    /**
+     * 增加当前最顶层的层叠数
+     */
+    increaseTopmostZIndex: () => number;
+}
+/**
+ * 层叠数管理
+ */
+export declare function useZIndex(): {
+    getTopmostZIndex: () => number;
+    setTopmostZIndex: (zIndex: number) => void;
+    increaseTopmostZIndex: () => number;
+};
+export {};

package/{src → vue2/src}/hooks/vue/use-model-value/index.d.ts

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

package/vue2/src/hooks/vue/use-vue/index.d.ts

@@ -0,0 +1,17 @@
+import { Component, VNode } from 'vue';
+/**
+ * 对 Vue 一些方法的简单封装
+ */
+export declare const useVue: () => {
+    getInstance: () => import('vue').default<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => import('vue').default> | undefined;
+    destroyCurrentInstance: () => void;
+    getCurrentElem: () => Element | undefined;
+    getCurrentChildrens: () => import('vue').default<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => import('vue').default<Record<string, any>, Record<string, any>, never, never, /*elided*/ any>>[] | undefined;
+    createVueInstance: <Props extends Record<string, any> = {}, Emits extends Record<string, any> = {}>(vueComponent: Component, options?: {
+        props?: Props;
+        on?: Emits;
+        vnode?: VNode;
+    }) => unknown;
+    getVueInstanceElem: (instance: import('../../..').ComponentInstance<any>) => Element | undefined;
+    destroyVueInstance: (instance: import('../../..').ComponentInstance<any>) => void;
+};

package/vue2/src/interface/index.d.ts

@@ -0,0 +1,15 @@
+/** 通用对象定义 */
+export type UniversalParams<V = unknown> = {
+    [key: string]: V;
+};
+export type MaybeArray<T> = T | T[];
+export interface SizeData {
+    /** 宽度 */
+    width: number;
+    /** 高度 */
+    height: number;
+}
+export interface Point {
+    x: number;
+    y: number;
+}

package/{src → vue2/src}/lang/internal/en.json.d.ts

@@ -15,6 +15,30 @@ declare const _default: {
     "error1": "Please fill in the information",
     "error2": "Please enter the correct phone number",
     "submitText": "Agree to submit"
+  },
+  "areaPicker": {
+    "province": "Province",
+    "city": "City",
+    "area": "Area",
+    "placeholder": "Please select region"
+  },
+  "dataExport": {
+    "defaultTitle": "Data Export Center",
+    "recordValidPeriod": "Export records are valid for 7 days",
+    "clearRecord": "Clear Records",
+    "fileGenerateTime": "File generation time: ",
+    "generating": "Generating",
+    "completed": "Completed",
+    "generationFailed": "Generation failed",
+    "expired": "Expired",
+    "downloadToLocal": "Download to local",
+    "regenerate": "Regenerate",
+    "entranceTitle": "Data Export Center",
+    "generationSuccess": "Generated successfully",
+    "downloadWithCountdown": "Download to local ({count}s)",
+    "viewExportRecords": "You can view your export records here",
+    "gotIt": "Got it",
+    "empty": "Empty"
   }
 };
 

package/{src → vue2/src}/lang/internal/index.d.ts

@@ -17,6 +17,30 @@ declare const useInternalI18n: () => {
             error2: string;
             submitText: string;
         };
+        areaPicker: {
+            province: string;
+            city: string;
+            area: string;
+            placeholder: string;
+        };
+        dataExport: {
+            defaultTitle: string;
+            recordValidPeriod: string;
+            clearRecord: string;
+            fileGenerateTime: string;
+            generating: string;
+            completed: string;
+            generationFailed: string;
+            expired: string;
+            downloadToLocal: string;
+            regenerate: string;
+            entranceTitle: string;
+            generationSuccess: string;
+            downloadWithCountdown: string;
+            viewExportRecords: string;
+            gotIt: string;
+            empty: string;
+        };
     } & {
         common: {
             confirm: string;

package/{src → vue2/src}/lang/internal/ja.json.d.ts

@@ -15,6 +15,30 @@ declare const _default: {
     "error1": "情報を入力してください",
     "error2": "正しい電話番号を入力してください",
     "submitText": "同意する"
+  },
+  "areaPicker": {
+    "province": "都道府県",
+    "city": "市区町村",
+    "area": "市区町村",
+    "placeholder": "地域を選択してください"
+  },
+  "dataExport": {
+    "defaultTitle": "データエクスポートセンター",
+    "recordValidPeriod": "エクスポート記録の有効期限は7日間です",
+    "clearRecord": "記録をクリア",
+    "fileGenerateTime": "ファイル生成時間：",
+    "generating": "生成中",
+    "completed": "完了",
+    "generationFailed": "生成異常",
+    "expired": "期限切れ",
+    "downloadToLocal": "ローカルにダウンロード",
+    "regenerate": "再生成",
+    "entranceTitle": "データエクスポートセンター",
+    "generationSuccess": "生成成功",
+    "downloadWithCountdown": "ローカルにダウンロード（{count}秒）",
+    "viewExportRecords": "ここでエクスポート記録を確認できます",
+    "gotIt": "了解しました",
+    "empty": "空"
   }
 };
 

package/vue2/src/lang/internal/ko.json.d.ts

@@ -0,0 +1,45 @@
+declare const _default: {
+  "rewardReceive": {
+    "receiveTitleForm": "당첨 정보 작성",
+    "receiveTitleView": "당첨 정보 보기",
+    "receiveTitleQrcode": "QR 코드 스캔하여 상품 수령",
+    "receiveTitleLink": "링크 열기",
+    "receiveDesc": "상품 발송 및 문의를 위해 개인 정보를 입력해 주세요.",
+    "overTimeDesc": "정보 작성 기한: ",
+    "choiceAddress": "지역 선택",
+    "addressDetail": "상세 주소",
+    "addressPlaceholder": "지역을 선택해 주세요",
+    "qrcodeTips": "QR 코드를 길게 눌러 인식",
+    "deadLine": "연락 정보 작성 유효 기간이 초과되었습니다",
+    "checkProtocol": "개인정보 처리방침에 동의해 주세요",
+    "error1": "정보를 입력해 주세요",
+    "error2": "정확한 전화번호를 입력해 주세요",
+    "submitText": "동의하기"
+  },
+  "areaPicker": {
+    "province": "시/도",
+    "city": "시/군/구",
+    "area": "시/군/구",
+    "placeholder": "지역을 선택해 주세요"
+  },
+  "dataExport": {
+    "defaultTitle": "데이터 내보내기 센터",
+    "recordValidPeriod": "내보내기 기록은 7일간 유효합니다",
+    "clearRecord": "기록 지우기",
+    "fileGenerateTime": "파일 생성 시간: ",
+    "generating": "생성 중",
+    "completed": "완료",
+    "generationFailed": "생성 실패",
+    "expired": "만료됨",
+    "downloadToLocal": "로컬에 다운로드",
+    "regenerate": "다시 생성",
+    "entranceTitle": "데이터 내보내기 센터",
+    "generationSuccess": "생성 성공",
+    "downloadWithCountdown": "로컬에 다운로드 ({count}초)",
+    "viewExportRecords": "여기서 내보내기 기록을 확인할 수 있습니다",
+    "gotIt": "알겠습니다",
+    "empty": "비어 있음"
+  }
+};
+
+export default _default;

package/{src → vue2/src}/lang/internal/ru.json.d.ts

@@ -15,6 +15,30 @@ declare const _default: {
     "error1": "Пожалуйста, заполните информацию",
     "error2": "Пожалуйста, введите правильный номер телефона",
     "submitText": "Согласиться"
+  },
+  "areaPicker": {
+    "province": "Область",
+    "city": "Город",
+    "area": "Район",
+    "placeholder": "Выберите регион"
+  },
+  "dataExport": {
+    "defaultTitle": "Центр экспорта данных",
+    "recordValidPeriod": "Записи экспорта действительны в течение 7 дней",
+    "clearRecord": "Очистить записи",
+    "fileGenerateTime": "Время создания файла: ",
+    "generating": "Создание",
+    "completed": "Завершено",
+    "generationFailed": "Ошибка создания",
+    "expired": "Истек срок",
+    "downloadToLocal": "Скачать локально",
+    "regenerate": "Пересоздать",
+    "entranceTitle": "Центр экспорта данных",
+    "generationSuccess": "Успешно создано",
+    "downloadWithCountdown": "Скачать локально ({count}с)",
+    "viewExportRecords": "Здесь вы можете просмотреть записи экспорта",
+    "gotIt": "Понятно",
+    "empty": "Пусто"
   }
 } ;
 

package/vue2/src/lang/internal/zh-CN.json.d.ts

@@ -0,0 +1,45 @@
+declare const _default: {
+  "rewardReceive": {
+    "receiveTitleForm": "填写信息",
+    "receiveTitleView": "查看信息",
+    "receiveTitleQrcode": "扫码领奖",
+    "receiveTitleLink": "打开链接",
+    "receiveDesc": "请填写您的个人信息，用于发送奖品及联系您。",
+    "overTimeDesc": "截止填写时间：",
+    "choiceAddress": "选择地区",
+    "addressDetail": "详细地址",
+    "addressPlaceholder": "请选择地区",
+    "qrcodeTips": "长按识别二维码",
+    "deadLine": "您已超过填写联系信息的有效期",
+    "checkProtocol": "请勾选隐私声明",
+    "error1": "请完善信息",
+    "error2": "请输入正确的手机号码",
+    "submitText": "同意提交"
+  },
+  "areaPicker": {
+    "province": "省份",
+    "city": "城市",
+    "area": "地区",
+    "placeholder": "请选择地区"
+  },
+  "dataExport": {
+    "defaultTitle": "数据导出中心",
+    "recordValidPeriod": "导出记录有效期为7天",
+    "clearRecord": "清除记录",
+    "fileGenerateTime": "文件生成时间：",
+    "generating": "正在生成",
+    "completed": "已完成",
+    "generationFailed": "生成异常",
+    "expired": "已过期",
+    "downloadToLocal": "下载到本地",
+    "regenerate": "重新生成",
+    "entranceTitle": "数据导出中心",
+    "generationSuccess": "生成成功",
+    "downloadWithCountdown": "下载到本地（{count}s）",
+    "viewExportRecords": "可以在这里查看你的导出记录",
+    "gotIt": "我知道了",
+    "empty": "暂无导出记录"
+  }
+};
+
+export default _default;