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

package/docs/api/SliderProps.md

@@ -0,0 +1,902 @@
+---
+title: SliderProps
+description: "Learn how to build custom functionality when working with the React Inputs by Kendo UI with the help of the SliderProps."
+api_reference: true
+type: inner_api
+slug: api_inputs_sliderprops
+---
+
+# SliderProps
+Represents the props of the [KendoReact Slider component]({% slug overview_slider %}).
+
+
+<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">
+
+
+#### ariaLabel?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The accessible label of the component.
+
+
+</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">
+
+
+#### buttons?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Renders the arrow side buttons of the Slider if set to true.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### children?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+React.ReactNode
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+
+
+
+</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 additional classes to the Slider.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### defaultValue?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+number
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The default value of the Slider.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### dir?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+[Direction]({% slug api_inputs_direction %})
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+
+
+
+</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">
+
+
+Determines whether the Slider is disabled.
+
+```jsx
+class App extends React.Component {
+   render() {
+      return (
+          <Slider disabled={true} min={0} max={10} defaultValue={5} />
+      );
+   }
+}
+ReactDOM.render(<App />, document.querySelector('my-app'));
+```
+
+
+
+</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">
+
+
+Specifies the id of the component.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### max
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+number
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The maximum value of the Slider.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### min
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+number
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The minimum value of the Slider.
+
+
+</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">
+
+
+#### step?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+number
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Specifies the step of the value increase and decrease.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### style?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+React.CSSProperties
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The styles that are applied to the Slider.
+
+
+</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 Slider.
+
+
+</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>
+
+
+number
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+The value of the Slider.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### vertical?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+If `vertical` is set to `true`, the orientation of the Slider changes from horizontal to vertical
+([see example]({% slug orientation_slider %})).
+
+
+</td>
+</tr>
+</tbody>
+</table>
+
+
+
+## Methods
+
+<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>
+
+
+Determines 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>
+
+
+[SliderChangeEvent]({% slug api_inputs_sliderchangeevent %})
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+
+