kotlin-browser/web.components/CustomElementRegistry

CustomElementRegistry

open class CustomElementRegistry(source)

The CustomElementRegistry interface provides methods for registering custom elements and querying registered elements. To get an instance of it, use the window.customElements property. To create a scoped registry, use the CustomElementRegistry() constructor.

MDN Reference

Constructors

constructor()

Functions

define

fun <T : P, P : HTMLElement> define(name: TagName<T>, constructor: CustomElementConstructor<T>, options: ElementDefinitionOptions<P> = definedExternally)

The define() method of the CustomElementRegistry interface adds a definition for a custom element to the custom element registry, mapping its name to the constructor which will be used to create it.

define

inline fun <T : HTMLElement> CustomElementRegistry.define(name: TagName<T>, reference: CustomElementReference<T>)

get

fun <T : HTMLElement> get(name: TagName<T>): CustomElementConstructor<T>?

The get() method of the CustomElementRegistry interface returns the constructor for a previously-defined custom element.

getName

fun <T : HTMLElement> getName(constructor: CustomElementConstructor<T>): TagName<T>?

The getName() method of the CustomElementRegistry interface returns the name for a previously-defined custom element.

getName

inline fun <T : HTMLElement> CustomElementRegistry.getName(reference: CustomElementReference<T>): TagName<T>?

The getName() method of the CustomElementRegistry interface returns the name for a previously-defined custom element.

initialize

fun initialize(root: Node)

The initialize() method of the CustomElementRegistry interface associates this registry with a DOM subtree, setting the customElementRegistry of each inclusive descendant that doesn't already have one, and attempting to upgrade any custom elements found.

upgrade

fun upgrade(root: Node)

The upgrade() method of the CustomElementRegistry interface upgrades all shadow-containing custom elements in a Node subtree, even before they are connected to the main document.

whenDefined

inline suspend fun <T : HTMLElement> CustomElementRegistry.whenDefined(name: TagName<T>): CustomElementConstructor<T>

The whenDefined() method of the CustomElementRegistry interface returns a Promise that resolves when the named element is defined.

whenDefinedAsync

fun <T : HTMLElement> whenDefinedAsync(name: TagName<T>): Promise<CustomElementConstructor<T>>

The whenDefined() method of the CustomElementRegistry interface returns a Promise that resolves when the named element is defined.