ant-design-vue/types/checkbox/checkbox-group.d.ts

43 lines
1.2 KiB
TypeScript

// Project: https://github.com/vueComponent/ant-design-vue
// Definitions by: akki-jat <https://github.com/akki-jat>
// Definitions: https://github.com/vueComponent/ant-design-vue/types
import { AntdComponent, AntdProps } from '../component';
export declare class CheckboxGroup extends AntdComponent {
$props: Omit<AntdProps, 'onChange'> & {
/**
* Default selected value
* @type string[]
*/
defaultValue?: string[];
/**
* Disable all checkboxes
* @default false
* @type boolean
*/
disabled?: boolean;
/**
* Specifies options, you can customize `label` with slot = "label" slot-scope = "option"
* @type Array<string | { label: string, value: string, disabled?: boolean, onChange?: Function }>
*/
options?: Array<
string | { label: string; value: string; disabled?: boolean; onChange?: Function }
>;
/**
* Used for setting the currently selected value.
* @type string[]
*/
value?: string[];
name?: string;
/**
* The callback function that is triggered when the state changes.
* @param {string[]} checkedValue
*/
onChange?: (checkedValue?: string[]) => void;
};
}