CustomItemSpec Interface


Describes the data needed to insert a custom item into the backstage menu.



Name Type Description
customItemProviderId string    
itemType CustomItem    

Inherited properties

Name Type Inherited from Description
badge undefined | BadgeType BackstageItemSpec if not specified no badge will be created.
condition undefined | ConditionalDisplaySpecification BackstageItemSpec if item's display is conditional then a ConditionalDisplaySpecification is specified.
groupPriority number BackstageItemSpec GroupPriority specifies the group an item is in (recommend using values 1 through 100).
icon undefined | string BackstageItemSpec Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.
itemId string BackstageItemSpec Require uniqueId for the item.
itemPriority number BackstageItemSpec Priority within a group (recommend using values 1 through 100)
label string BackstageItemSpec Label
subtitle undefined | string BackstageItemSpec Subtitle
toolTip undefined | string BackstageItemSpec Tooltip.

Defined in

Last Updated: 20 September, 2019