Class AbstractFormInputElement<FormInputValueType>

An abstract custom HTMLElement designed for use with form inputs.

Abstract

Fires

input An "input" event when the value of the input changes

Fires

change A "change" event when the value of the element changes

Type Parameters

  • FormInputValueType

Hierarchy (view full)

Properties

_internals _primaryInput _value tagName formAssociated

Accessors

form name value disabled editable

Methods

connectedCallback _applyInputAttributes _getValue _setValue _toggleDisabled _buildElements _refresh _activateListeners _onClick

Properties

Protected _internals

_internals: ElementInternals

Attached ElementInternals which provides form handling functionality.

Protected _primaryInput

_primaryInput: HTMLElement

The primary input (if any). Used to determine what element should receive focus when an associated label is clicked on.

Protected _value

_value: FormInputValueType

The underlying value of the element.

Static tagName

tagName: string

The HTML tag name used by this element.

Static formAssociated

formAssociated: boolean = true

Declare that this custom element provides form element functionality.

Accessors

form

  • get form(): HTMLFormElement

  • The form this element belongs to.

    Returns HTMLFormElement

name

  • get name(): string

  • The input element name.

    Returns string

value

disabled

  • get disabled(): boolean

  • Is this element disabled?

    Returns boolean

editable

  • get editable(): boolean

  • Is this field editable? The field can be neither disabled nor readonly.

    Returns boolean

Methods

connectedCallback

  • connectedCallback(): void

  • Initialize the custom element, constructing its HTML.

    Returns void

_applyInputAttributes

  • _applyInputAttributes(input): void
  • Internal

    Apply key attributes on the containing custom HTML element to input elements contained within it.

    Parameters

    • input: any

    Returns void

Protected _getValue

Protected _setValue

  • _setValue(value): void
  • Protected

    Translate user-provided input value into the format that should be stored.

    Parameters

    Returns void

    Throws

    An error if the provided value is invalid

Protected _toggleDisabled

  • _toggleDisabled(disabled): void
  • Protected

    Special behaviors that the subclass should implement when toggling the disabled state of the input.

    Parameters

    • disabled: boolean

      The new disabled state

    Returns void

Protected _buildElements

  • _buildElements(): HTMLElement[]
  • Protected

    Create the HTML elements that should be included in this custom element. Elements are returned as an array of ordered children.

    Returns HTMLElement[]

Protected _refresh

  • _refresh(): void
  • Protected

    Refresh the active state of the custom element.

    Returns void

Protected _activateListeners

  • _activateListeners(): void
  • Protected

    Activate event listeners which add dynamic behavior to the custom element.

    Returns void

Protected _onClick

  • _onClick(event): void
  • Protected

    Special handling when the custom element is clicked. This should be implemented to transfer focus to an appropriate internal element.

    Parameters

    • event: PointerEvent

    Returns void

Settings

Member Visibility

Theme

On This Page

_internals_primaryInput_valuetagNameformAssociatedformnamevaluedisablededitableconnectedCallback_applyInputAttributes_getValue_setValue_toggleDisabled_buildElements_refresh_activateListeners_onClick