MaskedTextBoxProps
Represents the props of the Kendo UI for Vue MaskedTextBox component.
Definition
Package:@progress/kendo-vue-inputs
Properties
accessKey?
string
Specifies the accessKey of the MaskedTextBox.
ariaDescribedBy?
string
Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.
ariaLabelledBy?
string
Identifies the element(s) which will label the component.
defaultValue?
string
Specifies the initial value. Leaves the subsequent updates uncontrolled.
dir?
string
Represents the dir HTML attribute.
disabled?
boolean
Determines whether the MaskedTextBox is disabled.
fillMode?
"flat" | "solid" | "outline"
Configures the fillMode of the MaskedTextBox.
The available options are:
- solid
- outline
- flat
undefined
iconName?
String
Defines a string prop that controls the input icon. This property works only with the Kendo UI for Vue FontIcons. Check the Icons article for more information about how the Font Icon can be loaded to your project.
id?
string
Sets the id of the input DOM element.
includeLiterals?
boolean
Indicates whether to include literals in the raw value. Defaults to false.
inputAttributes?
Object
Sets the built-in HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
inputClass?
String
Defines additional class to the inner input element.
inputPrefix?
Object | Function | String | Boolean
Defines if the inputPrefix will be shown. Accepts a slot name, a render function, or a Vue component.
inputSuffix?
Object | Function | String | Boolean
Defines if the inputSuffix will be shown. Accepts a slot name, a render function, or a Vue component.
label?
string
Renders a floating label for the MaskedTextBox.
mask?
string
Represents the current mask. If no mask is set, the component behaves as a standard type="text" input.
maskValidation?
boolean
Determines whether the built-in mask validator is enforced when a form is validated. Defaults to true.
modelRawValue?
string
v-model raw value
modelValue?
string
v-model value
name?
string
Specifies the name property of the input DOM element.
onBlur?
(event: MaskedTextBoxEvent) => void
Fires each time the MaskedTextBox gets blurred.
onChange?
(event: MaskedTextBoxChangeEvent) => void
Determines the event handler that will be fired when the user edits the value.
onFocus?
(event: MaskedTextBoxEvent) => void
Fires each time the user focuses the MaskedTextBox.
placeholder?
string
Specifies the input placeholder.
prompt?
string
Represents a prompt character for the masked value. Defaults to _.
promptPlaceholder?
string
Indicates a character which represents an empty position in the raw value. Defaults to .
readonly?
boolean
Determines whether the MaskedTextBox is in its read-only state.
required?
boolean
Specifies if null is a valid value for the component.
rounded?
"small" | "medium" | "large" | "none" | "full"
Configures the roundness of the MaskedTextBox.
The available options are:
- none
- small
- medium
- large
- full
undefined
rules?
{ [key: string]: RegExp }
Represents the RegExp-based mask validation array.
selection?
{ start: number; end: number }
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.
showClearButton?
Boolean
Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
showLoadingIcon?
Boolean
Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
showValidationIcon?
Boolean
Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
size?
"small" | "medium" | "large"
Configures the size of the MaskedTextBox.
The available options are:
- small
- medium
- large
undefined
tabIndex?
number
Sets the tabIndex property of the MaskedTextBox.
title?
string
Sets the title of the input element of the MaskedTextBox.
type?
string
The type of the input - 'text' by default
valid?
boolean
Overrides the validity state of the component.
If valid is set, the required property will be ignored.
validationMessage?
string
Controls the form error message of the component. If set to an empty string, no error will be thrown.
validityStyles?
boolean
If set to false, no visual representation of the invalid state of the component will be applied.
value?
string
Specifies the value of the MaskedTextBox.
width?
string | number
Specifies the width of the MaskedTextBox.
wrapperClass?
String
Defines additional class to the wrapper element.