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

package/docs/api/NumericTextBoxProps.md

@@ -1,1471 +0,0 @@
----
-title: NumericTextBoxProps
-description: "Learn how to build custom functionality when working with the React Inputs by Kendo UI with the help of the NumericTextBoxProps."
-api_reference: true
-type: inner_api
-slug: api_inputs_numerictextboxprops
----
-
-# NumericTextBoxProps
-Represents the props of the [KendoReact NumericTextBox component]({% slug overview_numerictextbox %}).
-
-
-<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 NumericTextBox.
-
-
-</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">
-
-
-#### 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">
-
-
-#### className?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets a class of the NumericTextBox DOM element.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### defaultValue?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"null" | number
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies the initial value. Leaves the subsequent updates uncontrolled.
-
-
-</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.
-
-
-</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 NumericTextBox is disabled.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### fillMode?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-"null" | "flat" | "outline" | "solid"
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-<code>
-
-
-`solid`
-
-
-</code>
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Configures the `fillMode` of the NumericTextBox.
-
-The available options are:
-- solid
-- outline
-- flat
-- null&mdash;Does not set a fillMode `className`.
-
-
-
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### format?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string | NumberFormatOptions
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies the number format which is used for formatting the value ([see example]({% slug formats_numerictextbox %})). If set to `an empty string` or `undefined`, the default format will be used. Format cannot contain decimal separators or numbers. Power signs are supported.
-
-
-</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 `input` DOM element.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### inputStyle?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-React.CSSProperties
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Represents the input element `style` HTML attribute.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### inputType?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-NumericTextBoxInputType
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the `type` of the `input` DOM element.
-
-The available options are:
-- (Default) `tel`
-- `text`
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### label?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Renders a floating label for the NumericTextBox.
-
-
-</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">
-
-
-Specifies the greatest value that can be entered.
-
-
-</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">
-
-
-Specifies the smallest value that can be entered.
-
-
-</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 of the `input` DOM element.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### placeholder?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies the input placeholder.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### rangeOnEnter?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-If enabled, the NumericTextBox will handle the `enter` key to range the current invalid value between `min` and `max` props.
-The available options are:
-- (Default) `true`
-- `false`
-Can be disabled when form submit is required on pressing the `enter` key.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### readOnly?
-
-
-</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 NumericTextBox is in its read-only state.
-
-
-</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" | "full" | "large"
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-<code>
-
-
-`medium`
-
-
-</code>
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Configures the `roundness` of the NumericTextBox.
-
-The available options are:
-- small
-- medium
-- large
-- full
-- 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 NumericTextBox.
-
-The available options are:
-- small
-- medium
-- large
-- null&mdash;Does not set a size `className`.
-
-
-
-
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### spinners?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-boolean
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies whether the **Up** and **Down** spin buttons will be rendered ([see example]({% slug spinbuttons_numerictextbox %})).
-
-
-</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 value that is used to increment or decrement the value of the NumericTextBox ([see example]({% slug predefinedsteps_numerictextbox %})).
-
-
-</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">
-
-
-Represents the `style` HTML attribute.
-
-
-</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 NumericTextBox.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### title?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Sets the title of the `input` element of the NumericTextBox.
-
-
-</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" | number
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies the value of the NumericTextBox.
-
-
-</td>
-</tr>
-<tr>
-<td class="table-cell-name">
-
-
-#### width?
-
-
-</td>
-<td type class="table-cell-type">
-
-
-<code>
-
-
-string | number
-
-
-</code>
-
-
-</td>
-<td class="table-cell-default">
-
-
-
-
-</td>
-<td class="table-cell-comment">
-
-
-Specifies the width of the NumericTextBox.
-
-
-</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 NumericTextBox 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>
-
-
-[NumericTextBoxBlurEvent]({% slug api_inputs_numerictextboxblurevent %})
-
-
-</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>
-
-
-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>
-
-
-[NumericTextBoxChangeEvent]({% slug api_inputs_numerictextboxchangeevent %})
-
-
-</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 NumericTextBox 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>
-
-
-[NumericTextBoxFocusEvent]({% slug api_inputs_numerictextboxfocusevent %})
-
-
-</code>
-
-
-</td>
-<td>
-
-
-
-
-
-</td>
-</tr>
-</tbody>
-</table>
-</td>
-</tr>
-
-</tbody>
-</table>
-
-
-