Interface CustomElementRegistry

The CustomElementRegistry interface provides methods for registering custom elements and querying registered elements.

interface CustomElementRegistry {
    define(
        name: string,
        constructor: CustomElementConstructor,
        options?: ElementDefinitionOptions,
    ): void;
    get(name: string): undefined | CustomElementConstructor;
    getName(constructor: CustomElementConstructor): null | string;
    upgrade(root: Node): void;
    whenDefined(name: string): Promise<CustomElementConstructor>;
}

Index

Methods

define get getName upgrade whenDefined

Methods

define

define(
    name: string,
    constructor: CustomElementConstructor,
    options?: ElementDefinitionOptions,
): void
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.

MDN Reference
Parameters
- name: string
- constructor: CustomElementConstructor
- Optionaloptions: ElementDefinitionOptions
Returns void

get

get(name: string): undefined | CustomElementConstructor
The get() method of the previously-defined custom element.

MDN Reference
Parameters
- name: string
Returns undefined | CustomElementConstructor

getName

getName(constructor: CustomElementConstructor): null | string
The getName() method of the previously-defined custom element.

MDN Reference
Parameters
- constructor: CustomElementConstructor
Returns null | string

upgrade

upgrade(root: Node): void
The upgrade() method of the elements in a Node subtree, even before they are connected to the main document.

MDN Reference
Parameters
- root: Node
Returns void

whenDefined

whenDefined(name: string): Promise<CustomElementConstructor>
The whenDefined() method of the resolves when the named element is defined.

MDN Reference
Parameters
- name: string
Returns Promise<CustomElementConstructor>