For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Interface CustomElementRegistry
interface CustomElementRegistry {
define(
name: string,
constructor: CustomElementConstructor,
options?: ElementDefinitionOptions,
): void;
get(name: string): CustomElementConstructor | undefined;
getName(constructor: CustomElementConstructor): string | null;
initialize(root: Node): void;
upgrade(root: Node): void;
whenDefined(name: string): Promise<CustomElementConstructor>;
}
define(
name: string,
constructor: CustomElementConstructor,
options?: ElementDefinitionOptions,
): void;
get(name: string): CustomElementConstructor | undefined;
getName(constructor: CustomElementConstructor): string | null;
initialize(root: Node): void;
upgrade(root: Node): void;
whenDefined(name: string): Promise<CustomElementConstructor>;
}
Methods
define
-
define(
name: string,
constructor: CustomElementConstructor,
options?: ElementDefinitionOptions,
): voidThe
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.Parameters
- name: string
- constructor: CustomElementConstructor
Optionaloptions: ElementDefinitionOptions
Returns void
get
-
The
get()method of the CustomElementRegistry interface returns the constructor for a previously-defined custom element.Parameters
- name: string
Returns CustomElementConstructor | undefined
getName
-
The
getName()method of the CustomElementRegistry interface returns the name for a previously-defined custom element.Parameters
- constructor: CustomElementConstructor
Returns string | null
initialize
-
Parameters
- root: Node
Returns void
upgrade
-
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.Parameters
- root: Node
Returns void
whenDefined
-
The
whenDefined()method of the CustomElementRegistry interface returns a Promise that resolves when the named element is defined.Parameters
- name: string
Returns Promise<CustomElementConstructor>
The
CustomElementRegistryinterface provides methods for registering custom elements and querying registered elements. To get an instance of it, use the window.customElements property.MDN Reference