New to KendoReact? Start a free 30-day trial

MaskedTextBoxProps

Interface

Represents the props of the KendoReact MaskedTextBox component.

Definition

Package:@progress/kendo-react-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.

autoFocus?

boolean

Represents the autoFocus HTML attribute that will be applied to the input element of the MaskedTextBox. (Defaults to false)

className?

string

Sets a class of the MaskedTextBox DOM element.

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

Default:

undefined (theme-controlled)

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?

InputHTMLAttributes<HTMLInputElement>

Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.

label?

ReactNode

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.

name?

string

Specifies the name property of the input DOM element.

This property is part of the FormComponentProps interface.

onBlur?

(event: MaskedTextBoxEvent) => void

Fires each time the MaskedTextBox gets blurred.

Parameters:eventMaskedTextBoxEvent

onChange?

(event: MaskedTextBoxChangeEvent) => void

Determines the event handler that will be fired when the user edits the value.

Parameters:eventMaskedTextBoxChangeEvent

onFocus?

(event: MaskedTextBoxEvent) => void

Fires each time the user focuses the MaskedTextBox.

Parameters:eventMaskedTextBoxEvent

placeholder?

string

Specifies the input placeholder.

prefix?

CustomComponent<any>

Sets a custom prefix to the MaskedTextBox component.

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.

This property is part of the FormComponentProps interface.

rounded?

"small" | "medium" | "large" | "none" | "full"

Configures the roundness of the MaskedTextBox.

The available options are:

small
medium
large
full

Default:

undefined (theme-controlled)

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.