@ray-js/smart-ui-typings/dist/action-sheet/index.d.ts

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

import { VantOpenTypeCamelCaseProps, VantComponent, VantEventHandler } from '../base';
import { VantTransitionEvents } from '../transition';
export interface VantAction extends Omit<VantOpenTypeCamelCaseProps, 'businessId'> {
    /**
     * 标题
     */
    name?: string;
    /**
     * 二级标题
     */
    subname?: string;
    /**
     * 选项文字颜色
     */
    color?: string;
    /**
     * 是否为加载状态
     */
    loading?: boolean;
    /**
     * 是否为选中状态
     */
    checked?: boolean;
    /**
     * 是否为禁用状态
     */
    disabled?: boolean;
    /**
     * 为对应列添加额外的 `class` 类名
     */
    className?: string;
}
export interface VantActionSheetProps {
    /**
     * 是否显示动作面板
     */
    show?: boolean;
    /**
     * 菜单选项
     *
     * @default []
     */
    actions?: VantAction[];
    /**
     * 标题
     */
    title?: string;
    /**
     * 选项上方的描述信息
     */
    description?: string;
    /**
     * `z-index` 层级
     *
     * @default 100
     */
    zIndex?: number;
    /**
     * 取消按钮文字
     */
    cancelText?: string;
    /**
     * 确认按钮文字
     */
    confirmText?: string;
    /**
     * 是否显示遮罩层
     */
    overlay?: boolean;
    /**
     * 是否显示圆角
     *
     * @default true
     */
    round?: boolean;
    /**
     * 是否在点击选项后关闭
     *
     * @default true
     */
    closeOnClickAction?: boolean;
    /**
     * 点击遮罩是否关闭菜单
     */
    closeOnClickOverlay?: boolean;
    /**
     * 是否为 `iPhoneX` 留出底部安全距离
     *
     * @default true
     */
    safeAreaInsetBottom?: boolean;
}
export interface VantActionSheetEvents extends VantTransitionEvents {
    /**
     * 选中选项时触发，禁用或加载状态下不会触发
     */
    onSelect?: VantEventHandler<VantAction>;
    /**
     * 关闭时触发
     */
    onClose?: VantEventHandler;
    /**
     * 取消按钮点击时触发
     */
    onCancel?: VantEventHandler;
    /**
     * 确认按钮点击时触发
     */
    onConfirm?: VantEventHandler;
    /**
     * 点击遮罩层时触发
     */
    onClickOverlay?: VantEventHandler;
}
export type VantActionSheet = VantComponent<VantActionSheetProps, VantActionSheetEvents>;