CheckboxProps
Represents the props of the Kendo UI for Vue Checkbox component.
Definition
Package:@progress/kendo-vue-inputs
Properties
ariaDescribedBy?
string
Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.
ariaLabelledBy?
string
Identifies the element(s) which will label the component.
checked?
boolean
Sets the checked state of the Checkbox. Set to null to enable the indeterminate state of the Checkbox (see example).
defaultChecked?
boolean
Sets the default value of checked attribute when used in uncontrolled mode (see example).
The default value of the Checkbox.
dir?
string
Represents the dir HTML attribute. This is used to switch from LTR to RTL.
disabled?
boolean
Sets the disabled state of the Checkbox (see example).
id?
string
Sets the id of the Checkbox.
label?
string | HTMLElement
Sets the label of the Checkbox component (see example).
labelClass?
string
Sets the class of the label element of the Checkbox.
labelOptional?
boolean
Sets the optional text after the label of the Checkbox component.
labelPlacement?
string
Sets the label position of the Checkbox component 'before' | 'after' (see example).
labelRender?
any
Sets the label render template of the Checkbox component.
Accepts a slot name, a render function, or a Vue component.
name?
string
Specifies the name property of the input DOM element.
onChange?
(event: CheckboxChangeEvent) => void
The event handler that will be fired when the user edits the value.
onFocus?
(event: CheckboxFocusEvent) => void
The event handler that will be fired when Checkbox is focused.
required?
boolean
Specifies if null is a valid value for the component.
rounded?
"small" | "medium" | "large" | "none"
Configures the rounded style of the Checkbox.
The available options are:
- none
- small
- medium
- large
undefined
size?
"small" | "medium" | "large"
Configures the size of the Checkbox.
The available options are:
- small
- medium
- large
undefined
tabIndex?
number
Sets the tabIndex property of the Checkbox.
Defaults to 0.
valid?
boolean
Overrides the validity state of the component.
If valid is set, the required property will be ignored.
validationMessage?
string
Controls the form error message of the component. If set to an empty string, no error will be thrown.
validityStyles?
boolean
If set to false, no visual representation of the invalid state of the component will be applied.
value?
string | number | boolean | string[]
If the type is different than boolean and the checked property is provided it's
passed to the underlying input element.
If set to boolean and the checked property is omitted sets the checked state of the Checkbox.
Set null to enable the indeterminate state of the Checkbox (see example).