CommonBackstageItem Interface

Beta  

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

Properties

Name Type Description
badge undefined | BadgeType Describes badge.  
groupPriority number GroupPriority specifies the group an item is in (recommend using values 1 through 100).  
icon undefined | string Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.  
id string Required unique id of the item.  
isEnabled boolean Describes if the item is enabled.  
isVisible boolean Describes if the item is visible.  
itemPriority number Priority within a group (recommend using values 1 through 100).  
itemType BackstageItemType Type of item to be inserted.  
label string Label.  
subtitle undefined | string Subtitle.  
tooltip undefined | string Tooltip.  

Defined in

Last Updated: 13 June, 2024