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

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

/// <reference types="wechat-miniprogram" />
import { VantBaseExternalClassName, VantComponent, VantEventHandler } from '../base';
interface OtherProps {
    /**
     * 形状
     *
     * @default 'round'
     */
    shape?: 'round' | 'square';
    /**
     * 是否为选中状态
     *
     * @default false
     */
    value?: boolean;
    /**
     * 是否禁用单选框
     *
     * @default false
     */
    disabled?: boolean;
    /**
     * 是否禁用单选框内容点击
     *
     * @default false
     */
    labelDisabled?: boolean;
    /**
     * 文本位置
     *
     * @default 'right'
     */
    labelPosition?: 'left' | 'right';
    /**
     * 是否使用`icon slot`
     *
     * @default false
     */
    useIconSlot?: boolean;
    /**
     * 选中状态颜色
     *
     * @default '#1989fa'
     */
    checkedColor?: string;
    /**
     * `icon`大小
     *
     * @default 20px
     */
    iconSize?: string | number;
}
interface VantCheckboxPropsWithName extends OtherProps {
    name: string;
    dataName: string;
}
interface VantCheckboxPropsWithoutName extends OtherProps {
    name?: never;
    dataName?: string;
}
export type VantCheckboxProps = VantCheckboxPropsWithName | VantCheckboxPropsWithoutName;
/**
 * @deprecated
 */
export interface VantCheckboxChangeEvent extends WechatMiniprogram.BaseEvent {
    detail: boolean;
}
export interface VantCheckboxEvents {
    /**
     * 当绑定值变化时触发的事件
     */
    onChange?: VantEventHandler<boolean>;
}
export interface VantCheckboxExternalClassName extends VantBaseExternalClassName {
    /**
     * 图标样式类
     */
    iconClass?: string;
    /**
     * 描述信息样式类
     */
    labelClass?: string;
}
export type VantCheckbox = VantComponent<VantCheckboxProps, VantCheckboxEvents, VantCheckboxExternalClassName>;
export {};