directix 1.0.0-alpha.0 → 1.0.0-beta.0

package/dist/index.d.ts

@@ -0,0 +1,571 @@
+import { ComponentPublicInstance } from 'vue';
+import { Directive } from 'vue';
+import { Plugin as Plugin_2 } from 'vue';
+import { VNode } from 'vue';
+
+/**
+ * 添加清理函数到元素
+ */
+export declare function addCleanupVue2(el: Element, fn: () => void): void;
+
+/**
+ * 添加清理函数到元素
+ */
+export declare function addCleanupVue3(el: Element, fn: () => void): void;
+
+/**
+ * 指令绑定值类型
+ */
+export declare type ClickOutsideBinding = ClickOutsideHandler | ClickOutsideOptions;
+
+/**
+ * 点击外部处理函数
+ */
+export declare type ClickOutsideHandler = (event: MouseEvent | TouchEvent) => void;
+
+/**
+ * 点击外部指令选项
+ */
+export declare interface ClickOutsideOptions {
+    /**
+     * 点击外部时的回调函数
+     * @required
+     */
+    handler: ClickOutsideHandler;
+    /**
+     * 排除的元素选择器或元素引用
+     */
+    exclude?: (string | HTMLElement | (() => HTMLElement | null))[];
+    /**
+     * 是否使用捕获模式
+     * @default true
+     */
+    capture?: boolean;
+    /**
+     * 监听的事件类型
+     * @default ['click']
+     */
+    events?: ('click' | 'mousedown' | 'mouseup' | 'touchstart' | 'touchend')[];
+    /**
+     * 是否禁用
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * 停止传播
+     * @default false
+     */
+    stop?: boolean;
+    /**
+     * 阻止默认行为
+     * @default false
+     */
+    prevent?: boolean;
+}
+
+/**
+ * 指令绑定值类型
+ */
+export declare type CopyBinding = string | CopyOptions;
+
+/**
+ * 复制失败回调
+ */
+export declare type CopyErrorCallback = (error: Error) => void;
+
+/**
+ * 复制指令选项
+ */
+export declare interface CopyOptions {
+    /**
+     * 要复制的文本
+     * @required
+     */
+    value: string;
+    /**
+     * 复制成功回调
+     */
+    onSuccess?: CopySuccessCallback;
+    /**
+     * 复制失败回调
+     */
+    onError?: CopyErrorCallback;
+    /**
+     * 复制按钮的提示文本
+     */
+    title?: string;
+    /**
+     * 是否禁用
+     * @default false
+     */
+    disabled?: boolean;
+}
+
+/**
+ * 复制成功回调
+ */
+export declare type CopySuccessCallback = (text: string) => void;
+
+/**
+ * Vue 2 指令适配器
+ * @returns Vue 2 directive object with bind/inserted/update/unbind hooks
+ */
+export declare function createVue2Directive<T, B extends Element>(hooks: DirectiveHooks<T, B>): Record<string, any>;
+
+/**
+ * Vue 3 指令适配器
+ * @returns Vue 3 directive object with created/mounted/updated/unmounted hooks
+ */
+export declare function createVue3Directive<T, B extends Element>(hooks: DirectiveHooks<T, B>): Record<string, any>;
+
+/**
+ * 跨版本指令类型（兼容 Vue 2/3）
+ */
+export declare type CrossVersionDirective = Directive | Vue2DirectiveHooks | Vue3DirectiveHooks;
+
+/**
+ * 指令绑定值类型
+ */
+export declare type DebounceBinding<T extends (...args: any[]) => any = any> = T | DebounceOptions<T>;
+
+/**
+ * 防抖函数类型
+ */
+export declare interface DebouncedFunction<T extends (...args: any[]) => any> {
+    (...args: Parameters<T>): void;
+    cancel: () => void;
+    flush: () => void;
+}
+
+/**
+ * 防抖函数
+ */
+export declare function debounceFn<T extends (...args: any[]) => any>(func: T, wait?: number, options?: {
+    leading?: boolean;
+    trailing?: boolean;
+}): ((...args: Parameters<T>) => void) & {
+    cancel: () => void;
+    flush: () => void;
+};
+
+/**
+ * 防抖指令选项
+ */
+export declare interface DebounceOptions<T extends (...args: any[]) => any = any> {
+    /**
+     * 要防抖的函数
+     */
+    handler: T;
+    /**
+     * 延迟时间（毫秒）
+     * @default 300
+     */
+    wait?: number;
+    /**
+     * 是否在延迟开始前立即调用
+     * @default false
+     */
+    leading?: boolean;
+    /**
+     * 是否在延迟结束后调用
+     * @default true
+     */
+    trailing?: boolean;
+}
+
+/**
+ * 深拷贝
+ */
+export declare function deepClone<T>(obj: T): T;
+
+/**
+ * 深合并
+ */
+export declare function deepMerge<T extends Record<string, any>>(target: T, ...sources: Partial<T>[]): T;
+
+/**
+ * 定义一个跨版本兼容的指令
+ * @param definition 指令定义
+ * @returns Vue 指令对象
+ */
+export declare function defineDirective<T = any, B extends Element = Element>(definition: DirectiveDefinition<T, B>): Directive;
+
+/**
+ * 定义指令组
+ */
+export declare function defineDirectiveGroup(name: string, directives: Record<string, any>): {
+    name: string;
+    directives: Record<string, any>;
+    install: (app: any) => void;
+};
+
+/**
+ * 统一的指令绑定对象
+ */
+export declare interface DirectiveBinding<T = any> {
+    /** 指令绑定的值 */
+    value: T;
+    /** 上一次绑定的值 */
+    oldValue: T | null;
+    /** 指令参数 (v-xxx:arg) */
+    arg?: string;
+    /** 修饰符对象 (v-xxx.modifier) */
+    modifiers: Record<string, boolean>;
+    /** 组件实例 */
+    instance: ComponentPublicInstance | null;
+}
+
+/**
+ * 指令定义接口
+ */
+export declare interface DirectiveDefinition<T = any, B extends Element = Element> extends DirectiveHooks<T, B> {
+    /** 指令名称 */
+    name: string;
+    /** 指令版本 */
+    version?: '2' | '3' | 'both';
+    /** 是否服务端渲染兼容 */
+    ssr?: boolean;
+    /** 默认值 */
+    defaults?: Partial<T>;
+}
+
+/**
+ * 统一的指令钩子函数
+ */
+export declare interface DirectiveHooks<T = any, B extends Element = Element> {
+    /**
+     * 指令绑定到元素时调用
+     * @param el 绑定的 DOM 元素
+     * @param binding 绑定对象
+     * @param vnode Vue 虚拟节点
+     */
+    mounted?: (el: B, binding: DirectiveBinding<T>, vnode: VNode) => void;
+    /**
+     * 元素更新时调用
+     * @param el 绑定的 DOM 元素
+     * @param binding 新的绑定对象
+     * @param vnode 新的虚拟节点
+     * @param prevBinding 旧的绑定对象
+     * @param prevVnode 旧的虚拟节点
+     */
+    updated?: (el: B, binding: DirectiveBinding<T>, vnode: VNode, prevBinding: DirectiveBinding<T>, prevVnode: VNode) => void;
+    /**
+     * 指令卸载时调用
+     * @param el 绑定的 DOM 元素
+     * @param binding 绑定对象
+     * @param vnode 虚拟节点
+     */
+    unmounted?: (el: B, binding: DirectiveBinding<T>, vnode: VNode) => void;
+}
+
+/**
+ * 指令安装选项
+ */
+export declare interface DirectiveInstallOptions {
+    /** 注册的指令名称列表，不传则注册全部 */
+    directives?: string[];
+    /** 是否注册全部指令 */
+    all?: boolean;
+    /** 全局配置 */
+    config?: Record<string, any>;
+}
+
+/**
+ * Directix 插件
+ */
+export declare const Directix: Plugin_2;
+
+/**
+ * 指令绑定值类型
+ */
+export declare type FocusBinding = boolean | FocusOptions_2;
+
+/**
+ * 焦点指令选项
+ */
+declare interface FocusOptions_2 {
+    /**
+     * 是否自动聚焦
+     * @default true
+     */
+    focus?: boolean;
+    /**
+     * 是否在每次更新时重新聚焦
+     * @default false
+     */
+    refocus?: boolean;
+    /**
+     * 聚焦时的回调
+     */
+    onFocus?: (el: HTMLElement) => void;
+    /**
+     * 失焦时的回调
+     */
+    onBlur?: (el: HTMLElement) => void;
+}
+export { FocusOptions_2 as FocusOptions }
+
+/**
+ * 生成唯一 ID
+ */
+export declare function generateId(prefix?: string): string;
+
+/**
+ * 获取嵌套属性值
+ */
+export declare function get<T = any>(obj: Record<string, any>, path: string, defaultValue?: T): T;
+
+/**
+ * 获取当前 Vue 版本
+ */
+export declare function getVueVersion(): 2 | 3;
+
+/**
+ * 检查是否为数组
+ */
+export declare function isArray(value: unknown): value is any[];
+
+/**
+ * 检查是否为布尔值
+ */
+export declare function isBoolean(value: unknown): value is boolean;
+
+/**
+ * 是否浏览器环境
+ */
+export declare const isBrowser: () => boolean;
+
+/**
+ * 检查是否为空
+ */
+export declare function isEmpty(value: unknown): boolean;
+
+/**
+ * 检查是否为函数
+ */
+export declare function isFunction(value: unknown): value is (...args: any[]) => any;
+
+/**
+ * 检查是否为数字
+ */
+export declare function isNumber(value: unknown): value is number;
+
+/**
+ * 检查是否为对象
+ */
+export declare function isObject(value: unknown): value is Record<string, any>;
+
+/**
+ * 检查是否为 Promise
+ */
+export declare function isPromise<T = any>(value: unknown): value is Promise<T>;
+
+/**
+ * 是否服务端渲染
+ */
+export declare const isSSR: () => boolean;
+
+/**
+ * 检查是否为字符串
+ */
+export declare function isString(value: unknown): value is string;
+
+/**
+ * 是否 Vue 2
+ */
+export declare const isVue2: () => boolean;
+
+/**
+ * 是否 Vue 3
+ */
+export declare const isVue3: () => boolean;
+
+/**
+ * 解析时间参数
+ * 支持格式: "300" | "300ms" | "1s"
+ */
+export declare function parseTime(arg?: string): number | null;
+
+/**
+ * 设置嵌套属性值
+ */
+export declare function set(obj: Record<string, any>, path: string, value: any): void;
+
+/**
+ * 是否支持 Clipboard API
+ */
+export declare const supportsClipboard: () => boolean;
+
+/**
+ * 是否支持 IntersectionObserver
+ */
+export declare const supportsIntersectionObserver: () => boolean;
+
+/**
+ * 是否支持 MutationObserver
+ */
+export declare const supportsMutationObserver: () => boolean;
+
+/**
+ * 是否支持 Passive 事件监听
+ */
+export declare const supportsPassive: () => boolean;
+
+/**
+ * 是否支持 ResizeObserver
+ */
+export declare const supportsResizeObserver: () => boolean;
+
+/**
+ * 指令绑定值类型
+ */
+export declare type ThrottleBinding<T extends (...args: any[]) => any = any> = T | ThrottleOptions<T>;
+
+/**
+ * 节流函数类型
+ */
+export declare interface ThrottledFunction<T extends (...args: any[]) => any> {
+    (...args: Parameters<T>): void;
+    cancel: () => void;
+}
+
+/**
+ * 节流函数
+ */
+export declare function throttleFn<T extends (...args: any[]) => any>(func: T, wait?: number, options?: {
+    leading?: boolean;
+    trailing?: boolean;
+}): ((...args: Parameters<T>) => void) & {
+    cancel: () => void;
+};
+
+/**
+ * 节流指令选项
+ */
+export declare interface ThrottleOptions<T extends (...args: any[]) => any = any> {
+    /**
+     * 要节流的函数
+     */
+    handler: T;
+    /**
+     * 延迟时间（毫秒）
+     * @default 300
+     */
+    wait?: number;
+    /**
+     * 是否在延迟开始前立即调用
+     * @default true
+     */
+    leading?: boolean;
+    /**
+     * 是否在延迟结束后调用
+     * @default true
+     */
+    trailing?: boolean;
+}
+
+/**
+ * v-click-outside 指令
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <div v-click-outside="handleClickOutside">
+ *     下拉菜单
+ *   </div>
+ * </template>
+ * ```
+ */
+declare const vClickOutside: Directive;
+export { vClickOutside as clickOutside }
+export { vClickOutside }
+
+/**
+ * v-copy 指令
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <button v-copy="textToCopy">复制文本</button>
+ * </template>
+ * ```
+ */
+declare const vCopy: Directive;
+export { vCopy as copy }
+export { vCopy }
+
+/**
+ * v-debounce 指令
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <input v-debounce="handleInput" />
+ *   <input v-debounce:500ms="handleInput" />
+ *   <input v-debounce="{ handler: handleInput, wait: 500 }" />
+ *   <div v-debounce.scroll="handleScroll">滚动防抖</div>
+ *   <div v-debounce:100.scroll="handleScroll">100ms 滚动防抖</div>
+ * </template>
+ * ```
+ */
+declare const vDebounce: Directive;
+export { vDebounce as debounce }
+export { vDebounce }
+
+/**
+ * v-focus 指令
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <input v-focus />
+ *   <input v-focus="{ focus: true, refocus: true }" />
+ * </template>
+ * ```
+ */
+declare const vFocus: Directive;
+export { vFocus as focus }
+export { vFocus }
+
+/**
+ * v-throttle 指令
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <button v-throttle="handleClick">节流按钮</button>
+ *   <button v-throttle:1s="handleClick">1秒节流</button>
+ *   <div v-throttle.scroll="handleScroll">滚动节流</div>
+ *   <div v-throttle:100.scroll="handleScroll">100ms 滚动节流</div>
+ * </template>
+ * ```
+ */
+declare const vThrottle: Directive;
+export { vThrottle as throttle }
+export { vThrottle }
+
+/**
+ * Vue 2 指令钩子
+ */
+export declare interface Vue2DirectiveHooks {
+    bind?: (el: any, binding: any, vnode: any, oldVnode: any) => void;
+    inserted?: (el: any, binding: any, vnode: any, oldVnode: any) => void;
+    update?: (el: any, binding: any, vnode: any, oldVnode: any) => void;
+    componentUpdated?: (el: any, binding: any, vnode: any, oldVnode: any) => void;
+    unbind?: (el: any, binding: any, vnode: any, oldVnode: any) => void;
+}
+
+/**
+ * Vue 3 指令钩子
+ */
+export declare interface Vue3DirectiveHooks {
+    created?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+    beforeMount?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+    mounted?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+    beforeUpdate?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+    updated?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+    beforeUnmount?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+    unmounted?: (el: any, binding: any, vnode: any, prevVnode: any) => void;
+}
+
+export { }