Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcInputComponent

Element

igc-input

Slot

prefix - Renders content before the input.

Slot

suffix - Renders content after input.

Slot

helper-text - Renders content below the input.

Slot

value-missing - Renders content when the required validation fails.

Slot

type-mismatch - Renders content when the a type url/email input pattern validation fails.

Slot

pattern-mismatch - Renders content when the pattern validation fails.

Slot

too-long - Renders content when the maxlength validation fails.

Slot

too-short - Renders content when the minlength validation fails.

Slot

range-overflow - Renders content when the max validation fails.

Slot

range-underflow - Renders content when the min validation fails.

Slot

step-mismatch - Renders content when the step validation fails.

Slot

custom-error - Renders content when setCustomValidity(message) is set.

Slot

invalid - Renders content when the component is in invalid state (validity.valid = false).

Fires

igcInput - Emitted when the control input receives user input.

Fires

igcChange - Emitted when the control's checked state changes.

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

  • IgcInputBaseComponent
    • IgcInputComponent

Properties

Accessors

Methods

Properties

autocomplete

autocomplete: string

The autocomplete attribute of the control.

Attr

autofocus

autofocus: boolean

The autofocus attribute of the control.

Attr

disabled

disabled: boolean

The disabled state of the component.

Attr

Default

false

inputMode

inputMode: string

The input mode attribute of the control. See relevant MDN article

Attr

inputmode

invalid

invalid: boolean

Sets the control into invalid state (visual state only).

Attr

Default

false

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

readOnly

readOnly: boolean = false

Makes the control a readonly field.

Attr

readonly

InternaltabIndex

tabIndex: number = 0

type

type: InputType = 'text'

The type attribute of the control.

Attr

validateOnly

validateOnly: boolean = false

Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property for string-type inputs or allows spin buttons to exceed the predefined min/max limits for number-type inputs.

Attr

validate-only

Accessors

defaultValue

form

max

  • set max(value: undefined | number): void

    The max attribute of the control.

    Attr

    Parameters

    • value: undefined | number

    Returns void

maxLength

  • set maxLength(value: undefined | number): void

    The maximum string length of the control.

    Attr

    maxlength

    Parameters

    • value: undefined | number

    Returns void

min

  • set min(value: undefined | number): void

    The min attribute of the control.

    Attr

    Parameters

    • value: undefined | number

    Returns void

minLength

  • set minLength(value: undefined | number): void

    The minimum string length required by the control.

    Attr

    minlength

    Parameters

    • value: undefined | number

    Returns void

pattern

  • set pattern(value: undefined | string): void

    The pattern attribute of the control.

    Attr

    Parameters

    • value: undefined | string

    Returns void

required

  • set required(value: boolean): void

    When set, makes the component a required field for validation.

    Attr

    Default

    false

    Parameters

    • value: boolean

    Returns void

step

  • set step(value: undefined | number): void

    The step attribute of the control.

    Attr

    Parameters

    • value: undefined | number

    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

  • get value(): string

    The value attribute of the control.

    Returns string

  • set value(value: string): void

    The value of the control.

    Attr

    Parameters

    • value: string

    Returns void

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

focus

  • focus(options?: FocusOptions): void

    Sets focus on the control.

    Parameters

    • options: FocusOptions

    Returns void

reportValidity

select

setCustomValidity

  • setCustomValidity(message: string): 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: string,
        start: number,
        end: number,
        selectMode?: RangeTextSelectMode,
    ): void

    Replaces the selected text in the input.

    Parameters

    • replacement: string
    • start: number
    • end: number
    • selectMode: RangeTextSelectMode = 'preserve'

    Returns void

setSelectionRange

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

    Sets the text selection range of the control

    Parameters

    • start: number
    • end: number
    • direction: SelectionRangeDirection = 'none'

    Returns void

stepDown

  • stepDown(n?: number): void

    Decrements the numeric value of the input by one or more steps.

    Parameters

    • n: number

    Returns void

stepUp