Backstage

The Backstage category in the @bentley/ui-abstract package includes abstractions used by the @bentley/ui-framework package to create and manage the display of Backstage menu items. The Backstage is a menu used to open frontstages and launch tasks and commands. It can also open full-screen overlays, or modal stages, presenting application settings and data management to the user.

Backstage Item Utilities

BackstageItemUtilities is a utility class for creating abstract Backstage item definitions used to create entries in the Backstage menu.

The following shows an example of defining an item to create an item that opens a primary stage.

BackstageItemUtilities.createStageLauncher("IModelIndex", 200, 20, IModelApp.i18n.translate("SampleApp:backstage.imodelindex"), undefined, "icon-placeholder"),

The following shows an example of defining an item that executes an action.

BackstageItemUtilities.createActionItem("SampleApp.settings", 300, 10, () => FrontstageManager.openModalFrontstage(new SettingsModalFrontstage()), IModelApp.i18n.translate("SampleApp:backstage.testFrontstage6"), undefined, "icon-placeholder"),

In both examples, the first parameter is a key for the backstage item. This key must be unique across all other backstage items. The next two parameters define the group priority and the item priority within the group. These values are use to determine the order of the item in the menu. This method allows other packages and extensions to insert items at specific positions within the menu. It is recommended that the host application increment group priority by 100 and item priority by 10 to provide sufficient gaps for additional groups and items. The ordering is done from lowest to highest priority values.

See additional example in Backstage.

API Reference

• Backstage

Last Updated: 11 June, 2024