Interface MaskedSingleLineTextProps

Hierarchy

Properties

autoComplete? autoFocus? className? defaultValue? disabled? error? id? inlineMode? innerRef? inputProps? label? lazy? mask name onBlur? onChange onFocus? overwrite? placeholder? placeholderChar? tooltipContent? value?

Properties

Optional autoComplete

autoComplete?: "on" | "off"

Whether or not the control supports auto complete

Optional autoFocus

autoFocus?: boolean

Whether or not the control should start focused (default: false)

Optional className

className?: string

CSS Class name for additional styles

Optional defaultValue

defaultValue?: string | number | readonly string[]

Default value for the form control

Optional disabled

disabled?: boolean

Whether or not the control is disabled (default: false)

Optional error

error?: string

If set, indicates the control has an error and will display this prop as the error message

Optional id

id?: string

Form control id

Optional inlineMode

inlineMode?: boolean

Hide options not needed in the “inline” scenario

Optional innerRef

innerRef?: RefObject<HTMLInputElement>

Optional inputProps

inputProps?: InputHTMLAttributes<HTMLInputElement>

Additional props to be passed to the input element.

Optional label

label?: string

Form control label

Optional lazy

lazy?: boolean

Whether the mask should not be shown by default. (default: true)

mask

mask: string

Expression to be used as a validator. Refer https://imask.js.org/guide.html#masked-pattern for examples

name

name: string

Name of form control, required and must be unique from other form control names. This name should match the the name of the object corresponding to this control.

Optional onBlur

onBlur?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been selected

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

onChange

onChange: ((value) => unknown)

Type declaration

    • (value): unknown

    • Raised when the value has changed

      Parameters

      • value: string

      Returns unknown

Optional onFocus

onFocus?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been de-selected

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

Optional overwrite

overwrite?: boolean

Whether new inputs should overwrite existing text. (default: false)

Optional placeholder

placeholder?: string

Input placeholder

Optional placeholderChar

placeholderChar?: string

Placeholder character for the mask

Optional tooltipContent

tooltipContent?: ReactNode

A tooltip of additional information

Optional value

value?: string

Current value the form control has

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc