@opensig/opendesign/es/popup/types.d.ts

import { ComponentPublicInstance, ExtractPropTypes, PropType } from 'vue';
export declare const PopupPositionTypes: readonly ["top", "tl", "tr", "bottom", "bl", "br", "left", "lt", "lb", "right", "rt", "rb"];
export type PopupPositionT = (typeof PopupPositionTypes)[number];
export declare const PopupTriggerTypes: readonly ["none", "click", "click-outclick", "hover", "hover-outclick", "focus", "contextmenu"];
export type PopupTriggerT = (typeof PopupTriggerTypes)[number];
export declare const popupProps: {
    /**
     * @zh-CN 是否可见，双向绑定值
     * @en-US Whether visible, bidirectional binding value.
     */
    visible: {
        type: BooleanConstructor;
    };
    /**
     * @zh-CN 弹出位置
     * @en-US Pop-up position.
     * @default 'top'
     */
    position: {
        type: PropType<PopupPositionT>;
        default: string;
    };
    /**
     * @zh-CN 触发事件
     * @en-US Trigger event.
     * @default 'click'
     */
    trigger: {
        type: PropType<PopupTriggerT | PopupTriggerT[]>;
        default: string;
    };
    /**
     * @zh-CN 触发元素或组件
     * @en-US Trigger element or component.
     * @default null
     */
    target: {
        type: PropType<string | ComponentPublicInstance | HTMLElement | null>;
        default: null;
    };
    /**
     * @zh-CN 是否禁用
     * @en-US Whether to disable.
     */
    disabled: {
        type: BooleanConstructor;
    };
    /**
     * @zh-CN 挂载容器，默认为body
     * @en-US Mount the container, with the default being body.
     * @default 'body'
     */
    wrapper: {
        type: PropType<string | HTMLElement | null>;
        default: string;
    };
    /**
     * @zh-CN 距离触发对象的偏移量
     * @en-US The offset of the distance triggered object.
     * @default 0
     */
    offset: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * @zh-CN 距离viewport(屏幕)边缘偏移量
     * @en-US Offset from the edge of the viewport(screen).
     * @default 0
     */
    edgeOffset: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * @zh-CN hover事件延时触发的时间（毫秒）
     * @en-US The time (in milliseconds) for the hover event to be delayed and triggered.
     * @default 100
     */
    hoverDelay: {
        type: NumberConstructor;
        default: number;
    };
    /**
     * @zh-CN 是否当触发元素不可见时隐藏弹层
     * @en-US Whether to hide the bullet layer when the trigger element is invisible.
     * @default true
     */
    hideWhenTargetInvisible: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * @zh-CN 是否计算锚点位置
     * @en-US Whether to calculate the anchor point position.
     * @default false
     */
    anchor: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * @zh-CN 锚点自定义类名
     * @en-US Anchor point custom class name.
     * @default undefined
     */
    anchorClass: {
        type: PropType<string | {
            [k: string]: boolean;
        } | Array<{
            [k: string]: boolean;
        } | string>>;
    };
    /**
     * @zh-CN 是否在popup隐藏时卸载组件
     * @en-US Whether to uninstall the component when the popup is hidden.
     * @default true
     */
    unmountOnHide: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * @zh-CN popup挂载容器自定义类
     * @en-US popup mounts a custom container class.
     * @default undefined
     */
    wrapClass: {
        type: PropType<string | {
            [k: string]: boolean;
        } | Array<{
            [k: string]: boolean;
        } | string>>;
    };
    /**
     * @zh-CN popup挂载容器的内容体的自定义类
     * @en-US popup is a custom class for mounting the content body of a container.
     * @default undefined
     */
    bodyClass: {
        type: PropType<string | {
            [k: string]: boolean;
        } | Array<{
            [k: string]: boolean;
        } | string>>;
    };
    /**
     * @zh-CN popup最小宽度设置为触发元素宽度
     * @en-US The minimum width of popup is set to the width of the trigger element.
     * @default true
     */
    adjustMinWidth: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * @zh-CN popup宽度设置为触发元素宽度
     * @en-US The popup width is set to the width of the trigger element.
     * @default true
     */
    adjustWidth: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * @zh-CN 过渡名称
     * @en-US Transitional name.
     * @default 'o-zoom-fade'
     */
    transition: {
        type: StringConstructor;
        default: string;
    };
    /**
     * @zh-CN 是否自动隐藏
     * @en-US Whether to hide automatically.
     * @default true
     */
    autoHide: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * @zh-CN 显示前的回调函数。返回 `false` 取消显示，返回 `true` 或 `undefined`（Promise resolve 为 `true`/`undefined`）则继续显示。注意：该函数中不应包含副作用，仅用于判断
     * @en-US Callback invoked before showing. Return `false` to cancel showing; return `true` or `undefined` (or a Promise resolving to `true`/`undefined`) to proceed. Pure function only — do not perform side effects inside
     */
    beforeShow: {
        type: PropType<() => Promise<boolean> | boolean>;
    };
    /**
     * @zh-CN 隐藏前的回调函数。返回 `false` 取消隐藏，返回 `true` 或 `undefined`（Promise resolve 为 `true`/`undefined`）则继续隐藏。注意：该函数中不应包含副作用，仅用于判断
     * @en-US Callback invoked before hiding. Return `false` to cancel hiding; return `true` or `undefined` (or a Promise resolving to `true`/`undefined`) to proceed. Pure function only — do not perform side effects inside
     */
    beforeHide: {
        type: PropType<() => Promise<boolean> | boolean>;
    };
    /**
     * @zh-CN popup是否自适应边缘
     * @en-US Is popup adaptive edge.
     * @default true
     */
    adaptive: {
        type: BooleanConstructor;
        default: boolean;
    };
};
export type PopupPropsT = ExtractPropTypes<typeof popupProps>;