Interface ManifestWorkspace<MetaType, ElementType, ApiType>

interface ManifestWorkspace<
    MetaType extends MetaWorkspace = MetaWorkspace,
    ElementType extends UmbControllerHostElement = UmbControllerHostElement,
    ApiType extends UmbWorkspaceContext = UmbWorkspaceContext,
> {
    alias: string;
    api?: ApiLoaderProperty<ApiType>;
    API_TYPE?: ApiType;
    element?: ElementLoaderProperty<ElementType>;
    ELEMENT_TYPE?: ElementType;
    elementName?: string;
    js?: ElementAndApiLoaderProperty<ElementType, ApiType>;
    kind?: unknown;
    meta: MetaType;
    name: string;
    type: "workspace";
    weight?: number;
}

Type Parameters

Hierarchy (View Summary, Expand)

Properties

alias api? API_TYPE? element? ELEMENT_TYPE? elementName? js? kind? meta name type weight?

Properties

alias

alias: string

The alias of the extension, ensure it is unique

Optionalapi

api?: ApiLoaderProperty<ApiType>

The file location of the api javascript file to load @TJS-type string

Optional ReadonlyAPI_TYPE

API_TYPE?: ApiType

@TJS-ignore

Optionalelement

element?: ElementLoaderProperty<ElementType>

The file location of the element javascript file to load @TJS-type string

Optional ReadonlyELEMENT_TYPE

ELEMENT_TYPE?: ElementType

@TJS-ignore

OptionalelementName

elementName?: string

The HTML web component name to use such as 'my-dashboard' Note it is NOT , just the element name.

Optionaljs

js?: ElementAndApiLoaderProperty<ElementType, ApiType>

The file location of the javascript file to load @TJS-type string

Optionalkind

kind?: unknown

The kind of the extension, used to group extensions together

Examples

["button"]

meta

meta: MetaType

name

name: string

The friendly name of the extension

type

type: "workspace"

The type of extension such as dashboard etc...

Optionalweight

weight?: number

Extensions such as dashboards are ordered by weight with lower numbers being first in the list

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR