BackstageStageLauncher Interface

Describes the data needed to insert an action button into the backstage menu.

Extends

Properties

Name Type Description
stageId Readonly string    

Inherited properties

Name Type Inherited from Description
applicationData undefined | any CommonBackstageItem can be used by application to store miscellaneous data.
badgeType Readonly undefined | BadgeType CommonBackstageItem Describes badge.
groupPriority Readonly number CommonBackstageItem Specifies the item's grouping value.
icon Readonly string | ConditionalStringValue CommonBackstageItem Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.
id Readonly string CommonBackstageItem Required unique id of the item.
internalData Readonly undefined | Map<string, any> CommonBackstageItem optional data to be used by item implementor.
isActive Readonly boolean | ConditionalBooleanValue CommonBackstageItem Describes if the item is active.
isDisabled Readonly boolean | ConditionalBooleanValue CommonBackstageItem Describes if the item is enabled or disabled.
isHidden Readonly boolean | ConditionalBooleanValue CommonBackstageItem Describes if the item is visible or hidden.
itemPriority Readonly number CommonBackstageItem Priority within a group (recommend using values 1 through 100).
label Readonly string | ConditionalStringValue CommonBackstageItem Label.
providerId Readonly undefined | string CommonBackstageItem id of UiItemsProvider
subtitle Readonly string | ConditionalStringValue CommonBackstageItem Subtitle.
tooltip Readonly string | ConditionalStringValue CommonBackstageItem Tooltip.

Defined in

Last Updated: 11 June, 2024