Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcMaskInputComponent

A masked input is an input field where a developer can control user input and format the visible value, based on configurable rules

Element

igc-mask-input

Slot

prefix - Renders content before the input

Slot

suffix - Renders content after the input

Slot

helper-text - Renders content below the input

Fires

igcInput - Emitted when the control receives user input

Fires

igcChange - Emitted when an alteration of the control's value is committed by the user

Fires

igcFocus - Emitted when the control gains focus

Fires

igcBlur - Emitted when the control loses focus

Csspart

container - The main wrapper that holds all main input elements

Csspart

input - The native input element

Csspart

label - The native label element

Csspart

prefix - The prefix wrapper

Csspart

suffix - The suffix wrapper

Csspart

helper-text - The helper text wrapper

Hierarchy

Hierarchy

  • IgcMaskInputBaseComponent
    • IgcMaskInputComponent

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

disabled

disabled: boolean

The disabled state of the component

Attr

[disabled=false]

invalid

invalid: boolean

Control the validity of the control.

Attr

label

label: string

The label for the control.

Attr

name

name: string

The name attribute of the control.

Attr

outlined

outlined: boolean = false

Whether the control will have outlined appearance.

Attr

placeholder

placeholder: string

The placeholder attribute of the control.

Attr

prompt

prompt: string

The prompt symbol to use for unfilled parts of the mask.

readOnly

readOnly: boolean = false

Makes the control a readonly field.

Attr

readonly

required

required: boolean

Makes the control a required field in a form context.

Attr

size

size: "small" | "medium" | "large"

Determines the size of the component.

Attr

Deprecated

since v4.5.0. Use the --ig-size CSS custom property instead.

valueMode

valueMode: "raw" | "withFormatting" = 'raw'

Dictates the behavior when retrieving the value of the control:

  • raw will return the clean user input.
  • withFormatting will return the value with all literals and prompts.

Attr

value-mode

Static styles

styles: CSSResult[] = ...

Static Readonly tagName

tagName: "igc-mask-input" = 'igc-mask-input'

Accessors

form

mask

readonly

  • get readonly(): boolean

  • Returns boolean

  • set readonly(value): void

  • Makes the control a readonly field.

    Deprecated

    since v4.4.0. Use the readOnly property instead.

    Parameters

    • value: boolean

    Returns void

validationMessage

validity

  • get validity(): ValidityState

  • Returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation.

    Returns ValidityState

value

willValidate

  • get willValidate(): boolean

  • A boolean value which returns true if the element is a submittable element that is a candidate for constraint validation.

    Returns boolean

Methods

blur

checkValidity

connectedCallback

disconnectedCallback

emitEvent

  • emitEvent<K, D>(type, eventInitDict?): boolean

  • Type parameters

    Type Parameters

    • K extends keyof IgcInputEventMap
    • D extends string | void

    Parameters

    • type: K
    • Optional eventInitDict: CustomEventInit<D>

    Returns boolean

focus

  • focus(options?): void

  • Sets focus on the control.

    Parameters

    • Optional options: FocusOptions

    Returns void

reportValidity

select

setCustomValidity

  • setCustomValidity(message): void

  • Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

    Parameters

    • message: string

    Returns void

setRangeText

  • setRangeText(replacement, start?, end?, selectMode?): void

  • Replaces the selected text in the control and re-applies the mask

    Parameters

    • replacement: string
    • Optional start: number
    • Optional end: number
    • Optional selectMode: "end" | "start" | "select" | "preserve"

    Returns void

setSelectionRange

  • setSelectionRange(start, end, direction?): void

  • Parameters

    • start: number
    • end: number
    • Optional direction: "none" | "forward" | "backward"

    Returns void

Static register