Interface ManifestHeaderAppButtonKind

Header apps are displayed in the top right corner of the backoffice The two provided header apps are the search and the user menu

interface ManifestHeaderAppButtonKind {
    alias: string;
    element?: ElementLoaderProperty<HTMLElement>;
    ELEMENT_TYPE?: HTMLElement;
    elementName?: string;
    js?: ElementLoaderProperty<HTMLElement>;
    kind: "button";
    meta: MetaHeaderAppButtonKind;
    name: string;
    type: "headerApp";
    weight?: number;
}

Hierarchy (View Summary, Expand)

Properties

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

Properties

alias

alias: string

The alias of the extension, ensure it is unique

Optionalelement

element?: ElementLoaderProperty<HTMLElement>

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

Optional ReadonlyELEMENT_TYPE

ELEMENT_TYPE?: HTMLElement

@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?: ElementLoaderProperty<HTMLElement>

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

kind

kind: "button"

The kind of the extension, used to group extensions together

Examples

["button"]

meta

meta: MetaHeaderAppButtonKind

This contains properties specific to the type of extension

name

name: string

The friendly name of the extension

type

type: "headerApp"

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