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

package/docs/api/MaskedTextBoxProps.md

@@ -0,0 +1,1395 @@
+---
+title: MaskedTextBoxProps
+description: "Learn how to build custom functionality when working with the React Inputs by Kendo UI with the help of the MaskedTextBoxProps."
+api_reference: true
+type: inner_api
+slug: api_inputs_maskedtextboxprops
+---
+
+# MaskedTextBoxProps
+Represents the props of the [KendoReact MaskedTextBox component]({% slug overview_maskedtextbox %}).
+
+
+<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 MaskedTextBox.
+
+
+</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">
+
+
+#### 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 MaskedTextBox DOM element.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### defaultValue?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</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 MaskedTextBox 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 MaskedTextBox.
+
+The available options are:
+- solid
+- outline
+- flat
+- null&mdash;Does not set a fillMode `className`.
+
+
+
+
+
+
+</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">
+
+
+#### includeLiterals?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+boolean
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Indicates whether to include literals in the raw value. Defaults to `false`.
+
+
+</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 MaskedTextBox.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### mask?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Represents the current mask. If no mask is set, the component behaves as a standard `type="text"` input.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### maskValidation?
+
+
+</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 built-in mask validator is enforced when a form is validated. Defaults to `true`.
+
+
+</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">
+
+
+#### 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">
+
+
+#### prompt?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Represents a prompt character for the masked value. Defaults to `_`.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### promptPlaceholder?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Indicates a character which represents an empty position in the raw value. Defaults to ` `.
+
+
+</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 MaskedTextBox 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 MaskedTextBox.
+
+The available options are:
+- small
+- medium
+- large
+- full
+- null&mdash;Does not set a rounded `className`.
+
+
+
+
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### rules?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+{[key: string]: RegExp}
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Represents the RegExp-based mask validation array.
+
+
+</td>
+</tr>
+<tr>
+<td class="table-cell-name">
+
+
+#### selection?
+
+
+</td>
+<td type class="table-cell-type">
+
+
+<code>
+
+
+{ end: number; start: number; }
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Represents the beginning and ending of the selected portion of the input content that will be applied the next time when the MaskedTextBox is rendered.
+
+
+</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 MaskedTextBox.
+
+The available options are:
+- small
+- medium
+- large
+- null&mdash;Does not set a size `className`.
+
+
+
+
+
+
+</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">
+
+
+Sets additional CSS styles to the MaskedTextBox DOM element.
+
+
+</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 MaskedTextBox.
+
+
+</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 MaskedTextBox.
+
+
+</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>
+
+
+string
+
+
+</code>
+
+
+</td>
+<td class="table-cell-default">
+
+
+
+
+</td>
+<td class="table-cell-comment">
+
+
+Specifies the value of the MaskedTextBox.
+
+
+</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 MaskedTextBox.
+
+
+</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 MaskedTextBox 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>
+
+
+[MaskedTextBoxEvent]({% slug api_inputs_maskedtextboxevent %})
+
+
+</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>
+
+
+[MaskedTextBoxChangeEvent]({% slug api_inputs_maskedtextboxchangeevent %})
+
+
+</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 user focuses the MaskedTextBox.
+
+
+</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>
+
+
+[MaskedTextBoxEvent]({% slug api_inputs_maskedtextboxevent %})
+
+
+</code>
+
+
+</td>
+<td>
+
+
+
+
+
+</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+
+</tbody>
+</table>
+
+
+