Backstage

The Backstage is a menu used to open frontstages and launch tasks and commands. It can also open full-screen overlays presenting application settings and data management to the user. These overlays are an implementation of a modal frontstage. The backstage is opened by clicking or pressing the App button and displays along the left edge of the window.

Defining the Backstage

To ensure that an extension can supply items for the Backstage menu, it should be created using the BackstageComposer component. The example below shows how to provide BackstageActionItem and BackstageStageLauncher item to the BackstageComposer.

import stageIconSvg from "@bentley/icons-generic/icons/imodeljs.svg";
import settingsIconSvg from "@bentley/icons-generic/icons/settings.svg";

export function AppBackstageComposer() {
  const [backstageItems] = React.useState(() => [
    BackstageItemUtilities.createStageLauncher("app.SampleFrontstage", 100, 10, IModelApp.i18n.translate("app:backstage.sampleFrontstage"), undefined, IconSpecUtilities.createWebComponentIconSpec(stageIconSvg)),
    SettingsModalFrontstage.getBackstageActionItem (300, 10),
  ]);

  return (
    <BackstageComposer items={backstageItems} />
  );
}

Note: the static method SettingsModalFrontstage.getBackstageActionItem used above, will create an entry for a Settings stage. This stage will display SettingsTabEntry items from SettingsTabsProvider classes registered with the SettingsManager. The SettingsManager instance is referenced by property UiFramework.settingsManager.

See additional info in Backstage.

Specifying a Backstage in ConfigurableUiContent

Below is an example of defining the ConfigurableUiContent and specifying the backstage, using the component from the above example.

<ConfigurableUiContent appBackstage={<AppBackstageComposer />} />

API Reference

• Backstage in appui-react
• Backstage in appui-abstract

Last Updated: 30 November, 2023