Interface ManifestWorkspaceContext

The type of extension such as dashboard etc...

interface ManifestWorkspaceContext {
    API_TYPE?: UmbApi;
    alias: string;
    api?: ApiLoaderProperty<UmbApi>;
    conditions?: ConditionTypes[];
    js?: ApiLoaderProperty<UmbApi>;
    kind?: unknown;
    name: string;
    overwrites?: string | string[];
    type: "workspaceContext";
    weight?: number;
}

Hierarchy (view full)

Properties

API_TYPE? alias api? conditions? js? kind? name overwrites? type weight?

Properties

Optional ReadonlyAPI_TYPE

API_TYPE?: UmbApi

@TJS-ignore

alias

alias: string

The alias of the extension, ensure it is unique

Optionalapi

api?: ApiLoaderProperty<UmbApi>

@TJS-type string

Optionalconditions

conditions?: ConditionTypes[]

Set the conditions for when the extension should be loaded

Optionaljs

js?: ApiLoaderProperty<UmbApi>

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"]

name

name: string

The friendly name of the extension

Optionaloverwrites

overwrites?: string | string[]

Define one or more extension aliases that this extension should overwrite.

type

type: "workspaceContext"

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
""