API Reference › appui-abstract› Backstage › CommonBackstageItem

CommonBackstageItem Interface

Deprecated  in 3.6. Use CommonBackstageItem instead.

Describes the data needed to insert a button into the backstage menu.

Extends

Properties

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

Inherited properties

Name Type Inherited from Description
providerId Readonly Inherited string | undefined ProvidedItem id of UiItemsProvider

Defined in

Last Updated: 23 November, 2024