Kotlin Wrappers API Reference

kotlin-browser/web.components/ElementInternals

ElementInternals

class ElementInternals : ARIAMixin, ValidationTarget(source)

The ElementInternals interface of the Document Object Model gives web developers a way to allow custom elements to fully participate in HTML forms.

Properties

ariaActiveDescendantElement

open var ariaActiveDescendantElement: Element?

open var ariaAtomic: String?

ariaAutoComplete

open var ariaAutoComplete: String?

ariaBrailleLabel

open var ariaBrailleLabel: String?

ariaBrailleRoleDescription

open var ariaBrailleRoleDescription: String?

open var ariaBusy: String?

open var ariaChecked: String?

open var ariaColCount: String?

open var ariaColIndex: String?

ariaColIndexText

open var ariaColIndexText: String?

open var ariaColSpan: String?

ariaControlsElements

open var ariaControlsElements: ReadonlyArray<Element>?

open var ariaCurrent: String?

ariaDescribedByElements

open var ariaDescribedByElements: ReadonlyArray<Element>?

ariaDescription

open var ariaDescription: String?

ariaDetailsElements

open var ariaDetailsElements: ReadonlyArray<Element>?

open var ariaDisabled: String?

ariaErrorMessageElements

open var ariaErrorMessageElements: ReadonlyArray<Element>?

open var ariaExpanded: String?

ariaFlowToElements

open var ariaFlowToElements: ReadonlyArray<Element>?

open var ariaHasPopup: String?

open var ariaHidden: String?

open var ariaInvalid: String?

ariaKeyShortcuts

open var ariaKeyShortcuts: String?

open var ariaLabel: String?

ariaLabelledByElements

open var ariaLabelledByElements: ReadonlyArray<Element>?

open var ariaLevel: String?

open var ariaLive: String?

open var ariaModal: String?

open var ariaMultiLine: String?

ariaMultiSelectable

open var ariaMultiSelectable: String?

ariaOrientation

open var ariaOrientation: String?

ariaOwnsElements

open var ariaOwnsElements: ReadonlyArray<Element>?

ariaPlaceholder

open var ariaPlaceholder: String?

open var ariaPosInSet: String?

open var ariaPressed: String?

open var ariaReadOnly: String?

open var ariaRelevant: String?

open var ariaRequired: String?

ariaRoleDescription

open var ariaRoleDescription: String?

open var ariaRowCount: String?

open var ariaRowIndex: String?

ariaRowIndexText

open var ariaRowIndexText: String?

open var ariaRowSpan: String?

open var ariaSelected: String?

open var ariaSetSize: String?

open var ariaSort: String?

open var ariaValueMax: String?

open var ariaValueMin: String?

open var ariaValueNow: String?

open var ariaValueText: String?

val form: HTMLFormElement?

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

val labels: NodeList<HTMLLabelElement>

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

open var role: String?

val shadowRoot: ShadowRoot?

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

val states: CustomStateSet

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

validationMessage

open override val validationMessage: String

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

open override val 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.

open override val 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.

Functions

open override fun checkValidity(): Boolean

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

open override fun reportValidity(): Boolean

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

fun setFormValue(value: String?, state: String? = definedExternally)

fun setFormValue(value: FormData?, state: FormData? = definedExternally)

fun setFormValue(value: File?, state: File? = definedExternally)

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

fun setValidity(flags: ValidityStateFlags = definedExternally, message: String = definedExternally, anchor: HTMLElement = definedExternally)

The setValidity() method of the ElementInternals interface sets the validity of the element.