Join us online - 19th of November
Save your spot

Interface ElementInternals

The ElementInternals interface of the Document Object Model gives web developers a way to allow custom elements to fully participate in HTML forms. It provides utilities for working with these elements in the same way you would work with any standard HTML form element, and also exposes the Accessibility Object Model to the element.

MDN Reference

interface ElementInternals {
    ariaActiveDescendantElement: Element | null;
    ariaAtomic: string | null;
    ariaAutoComplete: string | null;
    ariaBrailleLabel: string | null;
    ariaBrailleRoleDescription: string | null;
    ariaBusy: string | null;
    ariaChecked: string | null;
    ariaColCount: string | null;
    ariaColIndex: string | null;
    ariaColIndexText: string | null;
    ariaColSpan: string | null;
    ariaControlsElements: readonly Element[] | null;
    ariaCurrent: string | null;
    ariaDescribedByElements: readonly Element[] | null;
    ariaDescription: string | null;
    ariaDetailsElements: readonly Element[] | null;
    ariaDisabled: string | null;
    ariaErrorMessageElements: readonly Element[] | null;
    ariaExpanded: string | null;
    ariaFlowToElements: readonly Element[] | null;
    ariaHasPopup: string | null;
    ariaHidden: string | null;
    ariaInvalid: string | null;
    ariaKeyShortcuts: string | null;
    ariaLabel: string | null;
    ariaLabelledByElements: readonly Element[] | null;
    ariaLevel: string | null;
    ariaLive: string | null;
    ariaModal: string | null;
    ariaMultiLine: string | null;
    ariaMultiSelectable: string | null;
    ariaOrientation: string | null;
    ariaOwnsElements: readonly Element[] | null;
    ariaPlaceholder: string | null;
    ariaPosInSet: string | null;
    ariaPressed: string | null;
    ariaReadOnly: string | null;
    ariaRelevant: string | null;
    ariaRequired: string | null;
    ariaRoleDescription: string | null;
    ariaRowCount: string | null;
    ariaRowIndex: string | null;
    ariaRowIndexText: string | null;
    ariaRowSpan: string | null;
    ariaSelected: string | null;
    ariaSetSize: string | null;
    ariaSort: string | null;
    ariaValueMax: string | null;
    ariaValueMin: string | null;
    ariaValueNow: string | null;
    ariaValueText: string | null;
    form: HTMLFormElement | null;
    labels: NodeList;
    role: string | null;
    shadowRoot: ShadowRoot | null;
    states: CustomStateSet;
    validationMessage: string;
    validity: ValidityState;
    willValidate: boolean;
    checkValidity(): boolean;
    reportValidity(): boolean;
    setFormValue(
        value: string | File | FormData | null,
        state?: string | File | FormData | null,
    ): void;
    setValidity(
        flags?: ValidityStateFlags,
        message?: string,
        anchor?: HTMLElement,
    ): void;
}

Hierarchy (View Summary)

Index
ariaActiveDescendantElement ariaAtomic ariaAutoComplete ariaBrailleLabel ariaBrailleRoleDescription ariaBusy ariaChecked ariaColCount ariaColIndex ariaColIndexText ariaColSpan ariaControlsElements ariaCurrent ariaDescribedByElements ariaDescription ariaDetailsElements ariaDisabled ariaErrorMessageElements ariaExpanded ariaFlowToElements ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLabelledByElements ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaOwnsElements ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRelevant ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowIndexText ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText form labels role shadowRoot states validationMessage validity willValidate
checkValidity reportValidity setFormValue setValidity
ariaActiveDescendantElement: Element | null

MDN Reference

ariaAtomic: string | null

MDN Reference

ariaAutoComplete: string | null

MDN Reference

ariaBrailleLabel: string | null

MDN Reference

ariaBrailleRoleDescription: string | null

MDN Reference

ariaBusy: string | null

MDN Reference

ariaChecked: string | null

MDN Reference

ariaColCount: string | null

MDN Reference

ariaColIndex: string | null

MDN Reference

ariaColIndexText: string | null

MDN Reference

ariaColSpan: string | null

MDN Reference

ariaControlsElements: readonly Element[] | null

MDN Reference

ariaCurrent: string | null

MDN Reference

ariaDescribedByElements: readonly Element[] | null

MDN Reference

ariaDescription: string | null

MDN Reference

ariaDetailsElements: readonly Element[] | null

MDN Reference

ariaDisabled: string | null

MDN Reference

ariaErrorMessageElements: readonly Element[] | null

MDN Reference

ariaExpanded: string | null

MDN Reference

ariaFlowToElements: readonly Element[] | null

MDN Reference

ariaHasPopup: string | null

MDN Reference

ariaHidden: string | null

MDN Reference

ariaInvalid: string | null

MDN Reference

ariaKeyShortcuts: string | null

MDN Reference

ariaLabel: string | null

MDN Reference

ariaLabelledByElements: readonly Element[] | null

MDN Reference

ariaLevel: string | null

MDN Reference

ariaLive: string | null

MDN Reference

ariaModal: string | null

MDN Reference

ariaMultiLine: string | null

MDN Reference

ariaMultiSelectable: string | null

MDN Reference

ariaOrientation: string | null

MDN Reference

ariaOwnsElements: readonly Element[] | null

MDN Reference

ariaPlaceholder: string | null

MDN Reference

ariaPosInSet: string | null

MDN Reference

ariaPressed: string | null

MDN Reference

ariaReadOnly: string | null

MDN Reference

ariaRelevant: string | null

MDN Reference

ariaRequired: string | null

MDN Reference

ariaRoleDescription: string | null

MDN Reference

ariaRowCount: string | null

MDN Reference

ariaRowIndex: string | null

MDN Reference

ariaRowIndexText: string | null

MDN Reference

ariaRowSpan: string | null

MDN Reference

ariaSelected: string | null

MDN Reference

ariaSetSize: string | null

MDN Reference

ariaSort: string | null

MDN Reference

ariaValueMax: string | null

MDN Reference

ariaValueMin: string | null

MDN Reference

ariaValueNow: string | null

MDN Reference

ariaValueText: string | null

MDN Reference

form: HTMLFormElement | null

The form read-only property of the ElementInternals interface returns the HTMLFormElement associated with this element.

MDN Reference

labels: NodeList

The labels read-only property of the ElementInternals interface returns the labels associated with the element.

MDN Reference

role: string | null

MDN Reference

shadowRoot: ShadowRoot | null

The shadowRoot read-only property of the ElementInternals interface returns the ShadowRoot for this element.

MDN Reference

states: CustomStateSet

The states read-only property of the ElementInternals interface returns a CustomStateSet representing the possible states of the custom element.

MDN Reference

validationMessage: string

The validationMessage read-only property of the ElementInternals interface returns the validation message for the element.

MDN Reference

validity: ValidityState

The validity read-only property of the ElementInternals interface returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation.

MDN Reference

willValidate: boolean

The willValidate read-only property of the ElementInternals interface returns true if the element is a submittable element that is a candidate for constraint validation.

MDN Reference

  • The checkValidity() method of the ElementInternals interface checks if the element meets any constraint validation rules applied to it.

    MDN Reference

    Returns boolean

  • The reportValidity() method of the ElementInternals interface checks if the element meets any constraint validation rules applied to it.

    MDN Reference

    Returns boolean

  • The setFormValue() method of the ElementInternals interface sets the element's submission value and state, communicating these to the user agent.

    MDN Reference

    Parameters

    • value: string | File | FormData | null
    • Optionalstate: string | File | FormData | null

    Returns void

Was this helpful?