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

package/docs/api/SwitchProps.md

@@ -0,0 +1,1081 @@
+---
+title: SwitchProps
+description: "Learn how to build custom functionality when working with the React Inputs by Kendo UI with the help of the SwitchProps."
+api_reference: true
+type: inner_api
+slug: api_inputs_switchprops
+---
+
+# SwitchProps
+Represents the props of the [KendoReact Switch component]({% slug overview_switch %}).
+
+
+<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">
+
+
+#### accessKey?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Specifies the `accessKey` of the Switch.
+
+
+</td>
+</tr>
+<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>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Sets the current value of the Switch ([see example]({% slug controlled_switch %})).
+
+
+</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 Switch.
+
+
+</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 value of the Switch when it is initially displayed ([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">
+
+
+Sets the default value of the Switch.
+
+
+</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">
+
+
+Sets the `dir` property of the wrapping element of the Switch.
+
+
+</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">
+
+
+Disables the Switch when set to `true` ([see example]({% slug disabled_switch %})).
+
+
+</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 Switch.
+
+
+</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">
+
+
+#### offLabel?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Changes the **Off** label([see example]({% slug labels_switch %})).
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### onLabel?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Changes the **On** label ([see example]({% slug labels_switch %})).
+
+
+</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">
+
+
+#### 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 Switch.
+
+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">
+
+
+Specifies the [`tabIndex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### thumbRounded?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+"null" | "small" | "medium" | "full" | "large"
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+<code>
+
+
+`full`
+
+
+</code>
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the `thumbRounded` of the Switch.
+
+The available options are:
+- small
+- medium
+- large
+- full
+- null&mdash;Does not set a thumbRounded `className`.
+
+
+
+
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### trackRounded?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+"null" | "small" | "medium" | "full" | "large"
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+<code>
+
+
+`full`
+
+
+</code>
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Configures the `trackRounded` of the Switch.
+
+The available options are:
+- small
+- medium
+- large
+- full
+- null&mdash;Does not set a trackRounded `className`.
+
+
+
+
+
+
+</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">
+
+
+Sets the value of the Switch. It can either be of the primitive (string, number, boolean) or of the complex (array) type.
+
+
+</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>
+
+
+Fires each time the Switch gets 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>
+
+
+FocusEvent&lt;HTMLSpanElement&gt;
+
+
+</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>
+
+
+Fires each time the user selects a new value ([see example]({% slug controlled_switch %})).
+
+
+</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>
+
+
+[SwitchChangeEvent]({% slug api_inputs_switchchangeevent %})
+
+
+</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>
+
+
+Fires each time the Switch component gets 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>
+
+
+FocusEvent&lt;HTMLSpanElement&gt;
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+
+