API Reference > ui-framework > Backstage > BackstageStageLauncher

BackstageStageLauncher Interface

Beta  @deprecated Use BackstageStageLauncher in bentley/ui-abstract instead

Describes the data needed to insert an action button into the backstage menu. Deprecated - Use BackstageStageLauncher in bentley/ui-abstract instead.

Extends

  • BackstageStageLauncher

Properties

Name Type Description
type StageLauncher    

Inherited properties

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

Defined in

Last Updated: 13 June, 2024