@polyv/vue-components 1.1.1 → 1.2.0

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

@@ -0,0 +1,7 @@
+import { MaybeElement } from '../../../vue-utils';
+/**
+ * 将节点插入到某个容器中
+ * @param elemRef 对应的节点
+ * @param parentRef 父节点
+ */
+export declare function useAppendTo(elemRef: MaybeElement, parentRef?: MaybeElement): void;

package/vue3/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/vue3/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/vue3/src/hooks/tools/use-clipboard/index.d.ts

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

package/vue3/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/vue3/src/hooks/tools/use-download/index.d.ts

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

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

@@ -0,0 +1,25 @@
+import { EventEmitter } from '@polyv/utils/es/event';
+import { UseAutoListenFn, UseAutoListenOptions } from '../use-auto-listen';
+type PwcMittEvents = {
+    [key: string]: any;
+};
+export type PwcEventEmitter = EventEmitter<PwcMittEvents>;
+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 function useEventBusListener(event: string, callback: (...arg: any[]) => unknown, options?: UseEventBusListenerOptions): UseEventBusListenerReturn;
+export {};

package/vue3/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/vue3/src/hooks/tools/use-link-open/index.d.ts

@@ -0,0 +1,3 @@
+export declare const useLinkOpen: () => {
+    openLink: (link: string) => void;
+};

package/vue3/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/vue3/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/vue3/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/vue3/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/vue3/src/hooks/tools/use-simple-visible/index.d.ts

@@ -0,0 +1,58 @@
+import { Ref } from 'vue';
+export interface UseSimpleVisibleOptions {
+    /**
+     * 是否自动关闭
+     *
+     * @default false
+     */
+    autoClose?: boolean;
+    /**
+     * 自动关闭时间
+     *
+     * @default 5 * 1000
+     */
+    autoCloseTime?: number;
+    /**
+     * 显示时回调
+     */
+    showCallback?: () => void;
+    /**
+     * 隐藏时回调
+     */
+    hideCallback?: () => void;
+    /**
+     * 隐藏延迟回调
+     */
+    hideDelayCallback?: () => void;
+    /**
+     * 更新回调
+     */
+    changeCallback?: (visible: boolean) => void;
+}
+export interface UseSimpleVisibleReturn {
+    /** 显示状态 */
+    visible: Ref<boolean>;
+    /** 设置显示状态 */
+    setVisible: (visible: boolean) => void;
+    /** 显示 */
+    open: () => void;
+    /** 关闭 */
+    close: () => void;
+    /** 显示 */
+    show: () => void;
+    /** 关闭 */
+    hide: () => void;
+    /** 切换显示状态 */
+    toggle: () => void;
+}
+/**
+ * 简单的显隐 hook
+ * @param defaultVisible 默认显示状态，默认：false
+ * @param options 选项
+ */
+export declare function useSimpleVisible(defaultVisible?: boolean, options?: UseSimpleVisibleOptions): UseSimpleVisibleReturn;
+/**
+ * 简单的显隐 hook
+ * @param options 选项
+ */
+export declare function useSimpleVisible(options?: UseSimpleVisibleOptions): UseSimpleVisibleReturn;

package/vue3/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/vue3/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/vue3/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/vue3/src/hooks/vue/use-model-value/index.d.ts

@@ -0,0 +1,13 @@
+import { PropUtils } from '../../../vue-utils';
+type MVProps = {
+    [PropUtils.modelValueKey]?: unknown;
+};
+/**
+ * 使用 v-model 的值
+ * @param props 组件 props
+ */
+export declare const useModelValue: <P extends MVProps>(props: P) => {
+    modelValue: import('vue').ComputedRef<P["v-model-key"]>;
+    updateModelValue: (value: P[typeof PropUtils.modelValueKey]) => void;
+};
+export {};

package/vue3/src/hooks/vue/use-storage-ref/index.d.ts

@@ -0,0 +1,3 @@
+import { Ref, UnwrapRef } from 'vue';
+export declare function useStorageRef<T>(key: string, value: T): Ref<UnwrapRef<T>>;
+export declare function useStorageRef<T = any>(key: string): Ref<T | undefined>;

package/vue3/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/vue3/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './components/exports';
+export * from './hooks/exports';
+export * from './plugins/exports';
+export * from './lang/exports';
+export * from './interface';
+export * from './vue-utils';

package/vue3/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/vue3/src/lang/common/en.json.d.ts

@@ -0,0 +1,18 @@
+declare const _default: {
+  "common": {
+    "confirm": "Confirm",
+    "cancel": "Cancel",
+    "close": "Close",
+    "submit": "Submit",
+    "submitSuccess": "Success",
+    "known": "I know",
+    "copySuccess": "Copy success",
+    "copyLinkSuccess": "Link copy success, you can paste it in the browser to download",
+    "tips": "Tips",
+    "success": "Success",
+    "empty": "Empty"
+  }
+}
+;
+
+export default _default;

package/vue3/src/lang/common/index.d.ts

@@ -0,0 +1,4 @@
+import { default as zhCN } from './zh-CN.json';
+import { I18nConfig } from '../types';
+export type CommonLangs = typeof zhCN;
+export declare const commonLangs: I18nConfig<typeof zhCN>;

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

@@ -0,0 +1,17 @@
+declare const _default: {
+  "common": {
+    "confirm": "確認",
+    "cancel": "キャンセル",
+    "close": "閉じる",
+    "submit": "送信",
+    "submitSuccess": "送信成功",
+    "known": "わかりました",
+    "copySuccess": "コピー成功",
+    "copyLinkSuccess": "リンクをコピーしました。ブラウザに貼り付けてダウンロードしてください",
+    "tips": "ヒント",
+    "success": "成功",
+    "empty": "空"
+  }
+};
+
+export default _default;

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

@@ -0,0 +1,17 @@
+declare const _default: {
+  "common": {
+    "confirm": "확인",
+    "cancel": "취소",
+    "close": "닫기",
+    "submit": "제출",
+    "submitSuccess": "제출 성공",
+    "known": "알겠습니다",
+    "copySuccess": "복사 성공",
+    "copyLinkSuccess": "링크 복사 성공, 브라우저에 붙여넣기하여 다운로드",
+    "tips": "팁",
+    "success": "성공",
+    "empty": "비어있음"
+  }
+};
+
+export default _default;

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

@@ -0,0 +1,17 @@
+declare const _default: {
+  "common": {
+    "confirm": "Подтвердить",
+    "cancel": "Отмена",
+    "close": "Закрыть",
+    "submit": "Отправить",
+    "submitSuccess": "Успешно отправлено",
+    "known": "Понятно",
+    "copySuccess": "Скопировано успешно",
+    "copyLinkSuccess": "Ссылка скопирована успешно, можно перейти в браузер и вставить для загрузки",
+    "tips": "Подсказка",
+    "success": "Успешно",
+    "empty": "Пусто"
+  }
+};
+
+export default _default;

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

@@ -0,0 +1,18 @@
+declare const _default: {
+  "common": {
+    "confirm": "确认",
+    "cancel": "取消",
+    "close": "关闭",
+    "submit": "提交",
+    "submitSuccess": "提交成功",
+    "known": "我知道了",
+    "copySuccess": "复制成功",
+    "copyLinkSuccess": "链接复制成功，可去浏览器粘贴下载",
+    "tips": "提示",
+    "success": "成功",
+    "empty": "暂无内容"
+  }
+}
+;
+
+export default _default;

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

@@ -0,0 +1,17 @@
+declare const _default: {
+  "common": {
+    "confirm": "確認",
+    "cancel": "取消",
+    "close": "關閉",
+    "submit": "提交",
+    "submitSuccess": "提交成功",
+    "known": "我知道了",
+    "copySuccess": "複製成功",
+    "copyLinkSuccess": "連結複製成功，可去瀏覽器貼上下載",
+    "tips": "提示",
+    "success": "成功",
+    "empty": "暫無內容"
+  }
+};
+
+export default _default;

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

@@ -0,0 +1,2 @@
+export * from './hook';
+export type { I18nLangs, I18nConfig } from './types';

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

@@ -0,0 +1,12 @@
+import { CommonLangs } from './common';
+import { I18nConfig, I18nLangs, NestedKeys } from './types';
+import { UniversalParams } from '../interface';
+type LangData<C extends Record<string, unknown>> = C & CommonLangs;
+export declare function createI18n<C extends Record<string, unknown> = {}>(config?: I18nConfig<C>): {
+    useI18n: () => {
+        $t: (key: NestedKeys<LangData<C>>, options?: UniversalParams<string | number>) => string;
+        currentLang: import('vue').ComputedRef<I18nLangs>;
+        isZhCN: import('vue').ComputedRef<boolean>;
+    };
+};
+export {};