Skip to content

@eodash/eodash / client/types / WebComponentProps

Interface: WebComponentProps<T>

Type Parameters

T extends ExecutionTime = "compiletime"

Properties

constructorProp?

optional constructorProp: string

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

Defined in

core/client/types.d.ts:22


link: T extends "runtime" ? string : string | () => Promise<unknown>

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

Example

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

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

WARNING

import maps are not available in runtime config

Defined in

core/client/types.d.ts:17


onMounted()?

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

Triggered when the web component is mounted in the DOM.

Parameters

el: null | Element

Web component

store: Store<"stac", _UnwrapAll<Pick<object, "stac" | "selectedStac" | "selectedCompareStac">>, Pick<object, never>, Pick<object, "loadSTAC" | "loadSelectedSTAC" | "loadSelectedCompareSTAC" | "resetSelectedCompareSTAC">>

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

Returns

void | Promise<void>

Defined in

core/client/types.d.ts:33


onUnmounted()?

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

Triggered when the web component is unmounted from the DOM.

Parameters

el: null | Element

Web component

store: Store<"stac", _UnwrapAll<Pick<object, "stac" | "selectedStac" | "selectedCompareStac">>, Pick<object, never>, Pick<object, "loadSTAC" | "loadSelectedSTAC" | "loadSelectedCompareSTAC" | "resetSelectedCompareSTAC">>

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

Returns

void | Promise<void>

Defined in

core/client/types.d.ts:44


properties?

optional properties: Record<string, unknown>

Object defining all the properties and attributes of the web component

Defined in

core/client/types.d.ts:25


tagName

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

Defined in

core/client/types.d.ts:23