Interface ManifestApi<ApiType>

The type of extension such as dashboard etc...

interface ManifestApi<ApiType extends UmbApi = UmbApi> {
    alias: string;
    api?: ApiLoaderProperty<ApiType>;
    API_TYPE?: ApiType;
    js?: ApiLoaderProperty<ApiType>;
    kind?: unknown;
    name: string;
    type: string;
    weight?: number;
}

Type Parameters

Hierarchy (View Summary, Expand)

Properties

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

Properties

alias

alias: string

The alias of the extension, ensure it is unique

Optionalapi

api?: ApiLoaderProperty<ApiType>

@TJS-type string

Optional ReadonlyAPI_TYPE

API_TYPE?: ApiType

@TJS-ignore

Optionaljs

js?: ApiLoaderProperty<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"]

name

name: string

The friendly name of the extension

type

type: string

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