@ray-js/smart-ui-typings/dist/dialog/dialog.d.ts

@ray-js/smart-ui 智能小程序 UI 框架的类型声明文件

/// <reference types="wechat-miniprogram" />
/// <reference types="wechat-miniprogram" />
import { VantDialogProps } from './index';
type VantDialogCommonProps = Pick<VantDialogProps, 'title' | 'width' | 'message' | 'theme' | 'overlay' | 'transition' | 'icon'>;
export type VantDialogOptions = {
    /**
     * 内容对齐方式
     *
     * @default 'center'
     */
    messageAlign?: VantDialogProps['messageAlign'];
    /**
     * `z-index`层级
     *
     * @default 100
     */
    zIndex?: VantDialogProps['zIndex'];
    /**
     * 自定义类名，`dialog` 在自定义组件内时无效
     *
     * @default ''
     */
    className?: VantDialogProps['className'];
    /**
     * 自定义样式
     *
     * @default ''
     */
    customStyle?: VantDialogProps['customStyle'];
    /**
     * 自定义选择器
     *
     * @default 'smart-dialog'
     */
    selector?: string;
    /**
     * 是否展示确认按钮
     *
     * @default true
     */
    showConfirmButton?: VantDialogProps['showConfirmButton'];
    /**
     * 是否展示取消按钮
     *
     * @default false
     */
    showCancelButton?: VantDialogProps['showCancelButton'];
    /**
     * 确认按钮的文案
     *
     * @default '确认'
     */
    confirmButtonText?: VantDialogProps['confirmButtonText'];
    /**
     * 取消按钮的文案
     *
     * @default '取消'
     */
    cancelButtonText?: VantDialogProps['cancelButtonText'];
    /**
     * 自定义遮罩层样式
     */
    overlayStyle?: VantDialogProps['overlayStyle'];
    /**
     * 点击遮罩层时是否关闭弹窗
     *
     * @default false
     */
    closeOnClickOverlay?: VantDialogProps['closeOnClickOverlay'];
    /**
     * 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 `Promise`
     */
    beforeClose?: VantDialogProps['beforeClose'];
    /**
     * 选择器的选择范围，可以传入自定义组件的 `this` 作为上下文
     *
     * @default 当前页面
     */
    context?: WechatMiniprogram.Page.TrivialInstance | WechatMiniprogram.Component.TrivialInstance;
} & VantDialogCommonProps;
export interface VantDialogInputOptions extends VantDialogOptions {
    /**
     * 输入框的值
     */
    value: string;
    /**
     * 输入框的类型
     */
    type?: string;
    /**
     * 是否是密码类型
     */
    password?: boolean;
    /**
     * 输入框为空时的占位符
     */
    placeholder?: string;
    /**
     * 输入框的最大输入长度
     */
    maxlength?: number;
}
export interface VantDialogInstance {
    /**
     * 展示弹窗
     */
    (options: VantDialogOptions): Promise<WechatMiniprogram.Component.TrivialInstance>;
    /**
     * 展示消息提示弹窗
     */
    alert(options: VantDialogOptions): Promise<WechatMiniprogram.Component.TrivialInstance>;
    /**
     * 展示消息确认弹窗
     */
    confirm(options: VantDialogOptions): Promise<WechatMiniprogram.Component.TrivialInstance>;
    /**
     * 展示输入确认弹窗
     */
    input(options: VantDialogInputOptions): Promise<WechatMiniprogram.Component.TrivialInstance>;
    /**
     * 修改默认配置，对所有 `Dialog` 生效
     */
    setDefaultOptions(options: VantDialogOptions): void;
    /**
     * 重置默认配置，对所有 `Dialog` 生效
     */
    resetDefaultOptions(): void;
    /**
     * 关闭弹窗
     */
    close(): void;
    /**
     * 停止按钮的加载状态
     */
    stopLoading(): void;
}
export {};