Interface WebComponentRegistry`Beta`

Registry containing web components

A typical web component does not need to be registered. Registration of web components are only needed when they are associated with a title, description, icon etc.

interface WebComponentRegistry {
getAll(): WebComponentMetadata[];
register(name: string, config?: Omit<WebComponentMetadata, "name">): void;
}

Index

Methods

getAll register

Methods

getAll

getAll(): WebComponentMetadata[]
Beta
Get all registered web components

Returns WebComponentMetadata[]

register

register(name: string, config?: Omit<WebComponentMetadata, "name">): void
Beta
Register a web component
Parameters
- name: string
  the name of the component
- Optionalconfig: Omit<WebComponentMetadata, "name">
  configuration options
Returns void