iview/types/checkbox.d.ts

61 lines
No EOL
1.9 KiB
TypeScript

// Type definitions for iview 3.3.1
// Project: https://github.com/iview/iview
// Definitions by: yangdan
// Definitions: https://github.com/yangdan8/iview.git
import Vue, { VNode } from 'vue';
export declare class Checkbox extends Vue {
/**
* 只在单独使用时有效。可以使用 v-model 双向绑定数据
* @default false
*/
value?: boolean;
/**
* 只在组合使用时有效。指定当前选项的 value 值,组合会自动判断是否选中
*/
label?: string | number | boolean;
/**
* 是否禁用当前项
* @default false
*/
disabled?: boolean;
/**
* 设置 indeterminate 状态,只负责样式控制
* @default false
*/
indeterminate?: boolean;
/**
* 多选框的尺寸,可选值为 large、small、default 或者不设置
*/
size?: '' | 'large' | 'small' | 'default';
/**
* 选中时的值,当使用类似 1 和 0 来判断是否选中时会很有用
* @default true
*/
'true-value'?: string | number | boolean;
/**
* 没有选中时的值,当使用类似 1 和 0 来判断是否选中时会很有用
* @default false
*/
'false-value'?: string | number | boolean;
/**
* 只在单独使用时有效。在选项状态发生改变时触发,通过修改外部的数据改变时不会触发
*/
$emit(eventName: 'on-change', value: boolean): this;
}
export declare class CheckboxGroup extends Vue {
/**
* 指定选中项目的集合,可以使用 v-model 双向绑定数据
* @default []
*/
value?: string[] | number[] | boolean[];
/**
* 多选框组的尺寸,可选值为 large、small、default 或者不设置
*/
size?: '' | 'large' | 'small' | 'default';
/**
* 在选项状态发生改变时触发,返回已选中的数组。通过修改外部的数据改变时不会触发
*/
$emit(eventName: 'on-change', values: Array<string | number | boolean>): this;
}