@progress/kendo-react-inputs 5.7.0-sig.202208281415 → 5.7.0

package/docs/api/CheckboxProps.md

@@ -1,1068 +0,0 @@
----
-title: CheckboxProps
-description: "Learn how to build custom functionality when working with the React Inputs by Kendo UI with the help of the CheckboxProps."
-api_reference: true
-type: inner_api
-slug: api_inputs_checkboxprops
----
-
-# CheckboxProps
-Represents the props of the [KendoReact Checkbox component]({% slug overview_checkbox %}).
-Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
-
-
-<table class="api-table api-table-properties">
-<thead>
-<tr>
-<th class="th-name">Name</th>
-<th class="th-type">Type</th>
-<th class="th-default">Default</th>
-<th class="th-desc">Description</th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td class="table-cell-name">
-
-
-#### ariaDescribedBy?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
-For example these elements could contain error or hint message.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### ariaLabelledBy?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Identifies the element(s) which will label the component.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### checked?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"null" | boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the checked state of the Checkbox.
-Set to null to enable the indeterminate state of the Checkbox ([see example]({% slug overview_checkbox %})).
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### children?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-any
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-The React elements that are passed as children to the rendered component.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### className?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the `className` of the wrapping element of the Checkbox.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### defaultChecked?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the default value of checked attribute when used in uncontrolled mode ([see example]({% slug default_state %})).
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### defaultValue?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-any
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-The default value of the Checkbox.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### dir?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### disabled?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the disabled state of the Checkbox
-([see example]({% slug disabled_checkbox %})).
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### id?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the `id` of the Checkbox.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### label?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string | HTMLElement
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the label of the Checkbox component ([see example]({% slug labels_checkbox %})).
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### labelOptional?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the optional text after the label of the Checkbox component.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### labelPlacement?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"after" | "before"
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the label position of the Checkbox component ([see example]({% slug labels_checkbox %})).
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### name?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies the `name` property of the `input` DOM element.
-
-This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### required?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies if `null` is a valid value for the component.
-
-This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### rounded?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"null" | "small" | "medium" | "large"
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-<code>
-
-
-`medium`
-
-
-</code>
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Configures the `rounded` style of the Checkbox.
-
-The available options are:
-- small
-- medium
-- large
-- null&mdash;Does not set a rounded `className`.
-
-
-
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### size?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"null" | "small" | "medium" | "large"
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-<code>
-
-
-`medium`
-
-
-</code>
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Configures the `size` of the Checkbox.
-
-The available options are:
-- small
-- medium
-- large
-- null&mdash;Does not set a size `className`.
-
-
-
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### tabIndex?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-number
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the `tabIndex` property of the Checkbox.
-Defaults to `0`.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### valid?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Overrides the validity state of the component.
-If `valid` is set, the `required` property will be ignored.
-
-This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### validationMessage?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Controls the form error message of the component. If set to an empty string, no error will be thrown.
-
-This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### validityStyles?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-If set to `false`, no visual representation of the invalid state of the component will be applied.
-
-This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### value?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"null" | string | number | boolean | string[]
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-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]({% slug overview_checkbox %})).
-
-
-</td>
-</tr>
-</tbody>
-</table>
-
-
-
-## Methods
-
-<table class="api-table api-table-methods">
-<thead class="api-table-methods-head">
-<tr>
-<th>
-
-
-#### onBlur
-
-
-</th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-The event handler that will be fired when Checkbox is blurred.
-
-
-</td>
-</tr>
-<tr class="nested-table">
-<td>
-<table class="api-table api-table-parameters">
-<thead class="api-table-parameters-head">
-<tr>
-<th class="th-name">Parameters</th>
-<th class="th-type"></th>
-<th class="th-desc"></th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-event
-
-
-</td>
-<td type>
-
-
-<code>
-
-
-[CheckboxBlurEvent]({% slug api_inputs_checkboxblurevent %})
-
-
-</code>
-
-
-</td>
-<td>
-
-
-
-
-
-</td>
-</tr>
-</tbody>
-</table>
-</td>
-</tr>
-
-</tbody>
-</table>
-
-<table class="api-table api-table-methods">
-<thead class="api-table-methods-head">
-<tr>
-<th>
-
-
-#### onChange
-
-
-</th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-The event handler that will be fired when the user edits the value.
-
-
-</td>
-</tr>
-<tr class="nested-table">
-<td>
-<table class="api-table api-table-parameters">
-<thead class="api-table-parameters-head">
-<tr>
-<th class="th-name">Parameters</th>
-<th class="th-type"></th>
-<th class="th-desc"></th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-event
-
-
-</td>
-<td type>
-
-
-<code>
-
-
-[CheckboxChangeEvent]({% slug api_inputs_checkboxchangeevent %})
-
-
-</code>
-
-
-</td>
-<td>
-
-
-
-
-
-</td>
-</tr>
-</tbody>
-</table>
-</td>
-</tr>
-
-</tbody>
-</table>
-
-<table class="api-table api-table-methods">
-<thead class="api-table-methods-head">
-<tr>
-<th>
-
-
-#### onFocus
-
-
-</th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-The event handler that will be fired when Checkbox is focused.
-
-
-</td>
-</tr>
-<tr class="nested-table">
-<td>
-<table class="api-table api-table-parameters">
-<thead class="api-table-parameters-head">
-<tr>
-<th class="th-name">Parameters</th>
-<th class="th-type"></th>
-<th class="th-desc"></th>
-</tr>
-</thead>
-<tbody class="api-table-body">
-<tr>
-<td>
-
-
-event
-
-
-</td>
-<td type>
-
-
-<code>
-
-
-[CheckboxFocusEvent]({% slug api_inputs_checkboxfocusevent %})
-
-
-</code>
-
-
-</td>
-<td>
-
-
-
-
-
-</td>
-</tr>
-</tbody>
-</table>
-</td>
-</tr>
-
-</tbody>
-</table>
-
-
-