@eodash/eodash / Configuration / WebComponentProps

Interface: WebComponentProps ​

Properties ​

constructorProp? ​

Exported Constructor, needs to be provided if the web component is not registered in by the link provided

ts
optional constructorProp?: string;

Imports web component file, either using a URL or an import function.

ts
optional link?: string | (() => Promise<unknown>);

Example ​

importing eox-itemfilter web component, after installing @eox/itemfilter it can be referenced:

js
link: async () => import("@eox/itemfilter");

WARNING

Importing by package name only works when a bundler resolves it (build-time configs, or runtime configs bundled into your app). Otherwise import by URL.

onMounted? ​

Triggered when the web component is mounted in the DOM.

ts
optional onMounted?: (el, store) => void | Promise<void>;

Parameters ​

el ​

Element | null

Web component

store ​

Store<"stac">

Return value of the core STAC pinia store in /core/client/store/stac.ts

Returns ​

void | Promise<void>

onUnmounted? ​

Triggered when the web component is unmounted from the DOM.

ts
optional onUnmounted?: (el, store) => void | Promise<void>;

Parameters ​

el ​

Element | null

Web component

store ​

Store<"stac">

Return value of the core STAC pinia store in /core/client/store/stac.ts

Returns ​

void | Promise<void>

properties? ​

Object defining all the properties and attributes of the web component

ts
optional properties?: Record<string, unknown>;

tagName ​

ts
tagName: `${string}-${string}`;