Interface ManifestWorkspaceActionMenuItemDefaultKind<MetaType>

interface ManifestWorkspaceActionMenuItemDefaultKind<MetaType> {
    API_TYPE?: UmbWorkspaceActionMenuItem<MetaType>;
    ELEMENT_TYPE?: UmbControllerHostElement;
    alias: string;
    api?: ApiLoaderProperty<UmbWorkspaceActionMenuItem<MetaType>>;
    conditions?: ConditionTypes[];
    element?: ElementLoaderProperty<UmbControllerHostElement>;
    elementName?: string;
    forWorkspaceActions: string | string[];
    js?: ElementAndApiLoaderProperty<UmbControllerHostElement, UmbWorkspaceActionMenuItem<MetaType>>;
    kind: "default";
    meta: MetaType;
    name: string;
    overwrites?: string | string[];
    type: "workspaceActionMenuItem";
    weight?: number;
}

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyAPI_TYPE

API_TYPE?: UmbWorkspaceActionMenuItem<MetaType>

@TJS-ignore

Optional ReadonlyELEMENT_TYPE

ELEMENT_TYPE?: UmbControllerHostElement

@TJS-ignore

alias

alias: string

The alias of the extension, ensure it is unique

Optionalapi

api?: ApiLoaderProperty<UmbWorkspaceActionMenuItem<MetaType>>

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

Optionalconditions

conditions?: ConditionTypes[]

Set the conditions for when the extension should be loaded

Optionalelement

element?: ElementLoaderProperty<UmbControllerHostElement>

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

OptionalelementName

elementName?: string

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

forWorkspaceActions

forWorkspaceActions: string | string[]

Define which workspace actions this menu item should be shown for.

Examples

[ ['Umb.WorkspaceAction.Document.Save', 'Umb.WorkspaceAction.Document.SaveAndPublish'], "Umb.WorkspaceAction.Document.Save" ]

Required

Optionaljs

js?: ElementAndApiLoaderProperty<UmbControllerHostElement, UmbWorkspaceActionMenuItem<MetaType>>

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

kind

kind: "default"

The kind of the extension, used to group extensions together

Examples

["button"]

meta

meta: MetaType

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

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