@itwin/appui-react 4.15.5 → 4.16.0

package/lib/cjs/appui-react/framework/FrameworkFrontstages.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkFrontstages.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";;;AAAA;;;gGAGgG;AAChG;;GAEG;AACH,0DAAgD;AA0BhD;;;GAGG;AACH,mDAAmD;AACnD,MAAa,wBAAyB,SAAQ,wBAAqC;CAAG;AAAtF,4DAAsF;AAoBtF;;;GAGG;AACH,mDAAmD;AACnD,MAAa,0BAA2B,SAAQ,wBAAuC;CAAG;AAA1F,gEAA0F;AAU1F;;;GAGG;AACH,mDAAmD;AACnD,MAAa,oBAAqB,SAAQ,wBAAiC;CAAG;AAA9E,oDAA8E;AAU9E;;;GAGG;AACH,mDAAmD;AACnD,MAAa,2BAA4B,SAAQ,wBAAwC;CAAG;AAA5F,kEAA4F;AAkB5F;;;;;;;GAOG;AACH,mDAAmD;AACnD,MAAa,kCAAmC,SAAQ,wBAA+C;CAAG;AAA1G,gFAA0G;AAa1G;;;GAGG;AACH,mDAAmD;AACnD,MAAa,0BAA2B,SAAQ,wBAAuC;CAAG;AAA1F,gEAA0F;AAU1F;;;GAGG;AACH,mDAAmD;AACnD,MAAa,kBAAmB,SAAQ,wBAA+B;CAAG;AAA1E,gDAA0E;AAU1E;;;GAGG;AACH,mDAAmD;AACnD,MAAa,oBAAqB,SAAQ,wBAAiC;CAAG;AAA9E,oDAA8E","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\nimport { UiEvent } from \"@itwin/appui-abstract\";\nimport type { IModelConnection, Tool } from \"@itwin/core-frontend\";\nimport type { ToolInformation } from \"../toolsettings/ToolInformation\";\nimport type { TimeTracker } from \"../configurableui/TimeTracker\";\nimport type { ContentControlActivatedEvent } from \"../content/ContentControl\";\nimport type { ContentLayoutActivatedEvent } from \"../content/ContentLayout\";\nimport type { FrontstageDef } from \"../frontstage/FrontstageDef\";\nimport type { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\nimport type { NavigationAidActivatedEvent } from \"../navigationaids/NavigationAidControl\";\nimport type {\n  PanelPinnedChangedEventArgs,\n  PanelStateChangedEvent,\n} from \"../stagepanels/StagePanelDef\";\nimport type { WidgetDef, WidgetStateChangedEvent } from \"../widgets/WidgetDef\";\nimport type { WidgetState } from \"../widgets/WidgetState\";\nimport type { Frontstage } from \"../frontstage/Frontstage\";\n\n/** Frontstage Activated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface FrontstageActivatedEventArgs {\n  deactivatedFrontstageDef?: FrontstageDef;\n  activatedFrontstageDef: FrontstageDef;\n}\n\n/** Frontstage Activated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> {}\n\n/** Frontstage Deactivated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface FrontstageDeactivatedEventArgs {\n  /** Frontstage being deactivated */\n  deactivatedFrontstageDef: FrontstageDef;\n  /** Frontstage being activated */\n  activatedFrontstageDef?: FrontstageDef;\n\n  /** Total time spent in frontstage */\n  totalTime: number;\n  /** Engagement time spent in frontstage */\n  engagementTime: number;\n  /** Idle time spent in frontstage */\n  idleTime: number;\n}\n\n/** Frontstage Deactivated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> {}\n\n/** Frontstage Ready Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface FrontstageReadyEventArgs {\n  frontstageDef: FrontstageDef;\n}\n\n/** Frontstage Ready Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> {}\n\n/** Modal Frontstage Changed Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ModalFrontstageChangedEventArgs {\n  modalFrontstageCount: number;\n}\n\n/** Modal Frontstage Stack Changed Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> {}\n\n/** Modal Frontstage Closed Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ModalFrontstageClosedEventArgs {\n  /** Modal Frontstage being closed */\n  modalFrontstage: ModalFrontstageInfo;\n\n  /** Total time spent in frontstage */\n  totalTime: number;\n  /** Engagement time spent in frontstage */\n  engagementTime: number;\n  /** Idle time spent in frontstage */\n  idleTime: number;\n}\n\n/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was\n * pressed and passes the function to actually close the modal stage. This allows stage to do any\n * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest\n * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved\n * any unsaved data.\n * @alpha\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> {}\n\n/** Modal Frontstage RequestedClose Event Args interface.\n * @alpha\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ModalFrontstageRequestedCloseEventArgs {\n  /** Modal Frontstage that is to be closed */\n  modalFrontstage: ModalFrontstageInfo;\n  /** Function to call to close the stage */\n  stageCloseFunc: () => void;\n}\n\n/** Modal Frontstage Closed Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> {}\n\n/** Tool Activated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ToolActivatedEventArgs {\n  toolId: string;\n}\n\n/** Tool Activated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> {}\n\n/** Tool Icon Changed Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ToolIconChangedEventArgs {\n  iconSpec: string;\n}\n\n/** Tool Icon Changed Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> {}\n\n/** Modal Frontstage information interface.\n * @public\n */\nexport interface ModalFrontstageInfo {\n  title: string;\n  content: React.ReactNode;\n  appBarRight?: React.ReactNode;\n  /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so\n   * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.\n   * @alpha */\n  notifyCloseRequest?: boolean;\n}\n\n/** Modal Frontstage array item interface.\n * @internal\n */\nexport interface ModalFrontstageItem {\n  modalFrontstage: ModalFrontstageInfo;\n  timeTracker: TimeTracker;\n}\n\n/** [[UiFramework.frontstages]] interface\n * @public\n */\nexport interface FrameworkFrontstages {\n  /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */\n  readonly isLoading: boolean;\n\n  /** Get Frontstage Deactivated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;\n\n  /** Get Frontstage Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;\n\n  /** Get Frontstage Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onFrontstageReadyEvent: FrontstageReadyEvent;\n\n  /** Get Modal Frontstage Changed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;\n\n  /** Get Modal Frontstage Closed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;\n\n  /** Get Modal Frontstage Requested Closed event.\n   * @alpha\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;\n\n  /** Get Tool Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onToolActivatedEvent: ToolActivatedEvent;\n\n  /** Get ToolSetting Reload event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onToolSettingsReloadEvent: UiEvent<void>;\n\n  /** Get Tool Icon Changed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onToolIconChangedEvent: ToolIconChangedEvent;\n\n  /** Get Content Layout Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;\n\n  /** Get Content Control Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onContentControlActivatedEvent: ContentControlActivatedEvent;\n\n  /** Get Navigation Aid Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;\n\n  /** Get Widget State Changed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;\n\n  /** Get panel state changed event.\n   * @alpha\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onPanelStateChangedEvent: PanelStateChangedEvent;\n\n  /** Get panel pinned changed event.\n   * @alpha\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onPanelPinnedChangedEvent: UiEvent<PanelPinnedChangedEventArgs>;\n\n  /** Clears the Frontstage map.\n   */\n  clearFrontstageDefs(): void;\n\n  /** Clears the Frontstage Providers and the defs that may have been created from them.\n   */\n  clearFrontstageProviders(): void;\n\n  /** Adds a frontstage provider.\n   * @param frontstageProvider  FrontstageProvider representing the Frontstage to add\n   * @deprecated in 4.15.0. Use {@link FrameworkFrontstages.addFrontstage} instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  addFrontstageProvider(frontstageProvider: FrontstageProvider): void;\n\n  /** Adds a frontstage.\n   * @beta\n   */\n  addFrontstage(frontstage: Frontstage): void;\n\n  /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If\n   * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and\n   * returned.\n   * @param id  Id of the Frontstage to find\n   * @returns  FrontstageDef with a given id if found, or undefined if not found.\n   */\n  getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;\n\n  /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.\n   * @return  Active FrontstageDef, or undefined if one is not active.\n   */\n  readonly activeFrontstageDef: FrontstageDef | undefined;\n\n  /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.\n   * @return  Id of the active FrontstageDef, or blank if one is not active.\n   */\n  readonly activeFrontstageId: string;\n\n  hasFrontstage(frontstageId: string): boolean;\n\n  /** Sets the active FrontstageDef give the stageId.\n   * @param  frontstageId  Id of the Frontstage to set active.\n   * @returns A Promise that is fulfilled when the Frontstage is ready.\n   */\n  setActiveFrontstage(frontstageId: string): Promise<void>;\n\n  /** Sets the active FrontstageDef.\n   * @param  frontstageDef  FrontstageDef to set active.\n   * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.\n   */\n  setActiveFrontstageDef(\n    frontstageDef: FrontstageDef | undefined\n  ): Promise<void>;\n\n  /** Deactivates the active FrontstageDef.\n   */\n  deactivateFrontstageDef(): Promise<void>;\n\n  /** Gets the Id of the active tool. If a tool is not active, blank is returned.\n   * @return  Id of the active tool, or blank if one is not active.\n   */\n  readonly activeToolId: string;\n\n  /** Sets the active tool id */\n  setActiveToolId(toolId: string): void;\n\n  /** Sets the active tool */\n  setActiveTool(tool: Tool): void;\n\n  /** Gets the active tool's [[ToolInformation]] */\n  readonly activeToolInformation: ToolInformation | undefined;\n\n  /** Opens a modal Frontstage. Modal Frontstages can be stacked.\n   * @param modalFrontstage  Information about the modal Frontstage\n   */\n  openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;\n\n  /** Closes the top-most modal Frontstage.\n   */\n  closeModalFrontstage(): void;\n\n  /** Updates the top-most modal Frontstage.\n   */\n  updateModalFrontstage(): void;\n\n  /** Gets the top-most modal Frontstage.\n   * @returns Top-most modal Frontstage, or undefined if there is none.\n   */\n  readonly activeModalFrontstage: ModalFrontstageInfo | undefined;\n\n  /** Gets the number of modal Frontstages.\n   * @returns Modal Frontstage count\n   */\n  readonly modalFrontstageCount: number;\n\n  /** Sets the active Navigation Aid via its Id.\n   * @param navigationAidId  Id of the Navigation Aid to set as active\n   * @param iModelConnection IModelConnection to query for view data\n   */\n  setActiveNavigationAid(\n    navigationAidId: string,\n    iModelConnection: IModelConnection\n  ): void;\n\n  /** Sets the state of the widget with the given id\n   * @param widgetId  Id of the Widget for which to set the state\n   * @param state     New state of the widget\n   * @returns true if the widget state was set successfully, or false if not.\n   */\n  setWidgetState(widgetId: string, state: WidgetState): boolean;\n\n  /** Finds a widget with the given id in the active frontstage\n   * @param widgetId  Id of the Widget to find\n   * @returns The WidgetDef with the given id, or undefined if not found.\n   */\n  findWidget(widgetId: string): WidgetDef | undefined;\n\n  /** Opens a nested Frontstage. Nested Frontstages can be stacked.\n   * @param nestedFrontstage  Information about the nested Frontstage\n   */\n  openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;\n\n  /** Closes the top-most nested Frontstage.\n   */\n  closeNestedFrontstage(): Promise<void>;\n\n  /** Gets the top-most nested Frontstage.\n   * @returns Top-most nested Frontstage, or undefined if there is none.\n   */\n  readonly activeNestedFrontstage: FrontstageDef | undefined;\n\n  /** Gets the number of nested Frontstages.\n   * @returns Nested Frontstage count\n   */\n  readonly nestedFrontstageCount: number;\n}\n"]}
+{"version":3,"file":"FrameworkFrontstages.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";;;AAAA;;;gGAGgG;AAChG;;GAEG;AACH,0DAAgD;AA2BhD;;;GAGG;AACH,mDAAmD;AACnD,MAAa,wBAAyB,SAAQ,wBAAqC;CAAG;AAAtF,4DAAsF;AAoBtF;;;GAGG;AACH,mDAAmD;AACnD,MAAa,0BAA2B,SAAQ,wBAAuC;CAAG;AAA1F,gEAA0F;AAU1F;;;GAGG;AACH,mDAAmD;AACnD,MAAa,oBAAqB,SAAQ,wBAAiC;CAAG;AAA9E,oDAA8E;AAU9E;;;GAGG;AACH,mDAAmD;AACnD,MAAa,2BAA4B,SAAQ,wBAAwC;CAAG;AAA5F,kEAA4F;AAkB5F;;;;;;;GAOG;AACH,mDAAmD;AACnD,MAAa,kCAAmC,SAAQ,wBAA+C;CAAG;AAA1G,gFAA0G;AAa1G;;;GAGG;AACH,mDAAmD;AACnD,MAAa,0BAA2B,SAAQ,wBAAuC;CAAG;AAA1F,gEAA0F;AAU1F;;;GAGG;AACH,mDAAmD;AACnD,MAAa,kBAAmB,SAAQ,wBAA+B;CAAG;AAA1E,gDAA0E;AAU1E;;;GAGG;AACH,mDAAmD;AACnD,MAAa,oBAAqB,SAAQ,wBAAiC;CAAG;AAA9E,oDAA8E","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\nimport { UiEvent } from \"@itwin/appui-abstract\";\nimport type { IModelConnection, Tool } from \"@itwin/core-frontend\";\nimport type { ToolInformation } from \"../toolsettings/ToolInformation\";\nimport type { TimeTracker } from \"../configurableui/TimeTracker\";\nimport { type ContentControlActivatedEvent } from \"../content/ContentControl\";\nimport type { ContentLayoutActivatedEvent } from \"../content/ContentLayout\";\nimport type { FrontstageDef } from \"../frontstage/FrontstageDef\";\nimport type { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\nimport type { NavigationAidActivatedEvent } from \"../navigationaids/NavigationAidControl\";\nimport type {\n  PanelPinnedChangedEventArgs,\n  PanelStateChangedEvent,\n} from \"../stagepanels/StagePanelDef\";\nimport type { WidgetDef, WidgetStateChangedEvent } from \"../widgets/WidgetDef\";\nimport type { WidgetState } from \"../widgets/WidgetState\";\nimport type { Frontstage } from \"../frontstage/Frontstage\";\nimport { FrameworkContent } from \"./FrameworkContent\";\n\n/** Frontstage Activated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface FrontstageActivatedEventArgs {\n  deactivatedFrontstageDef?: FrontstageDef;\n  activatedFrontstageDef: FrontstageDef;\n}\n\n/** Frontstage Activated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> {}\n\n/** Frontstage Deactivated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface FrontstageDeactivatedEventArgs {\n  /** Frontstage being deactivated */\n  deactivatedFrontstageDef: FrontstageDef;\n  /** Frontstage being activated */\n  activatedFrontstageDef?: FrontstageDef;\n\n  /** Total time spent in frontstage */\n  totalTime: number;\n  /** Engagement time spent in frontstage */\n  engagementTime: number;\n  /** Idle time spent in frontstage */\n  idleTime: number;\n}\n\n/** Frontstage Deactivated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> {}\n\n/** Frontstage Ready Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface FrontstageReadyEventArgs {\n  frontstageDef: FrontstageDef;\n}\n\n/** Frontstage Ready Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> {}\n\n/** Modal Frontstage Changed Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ModalFrontstageChangedEventArgs {\n  modalFrontstageCount: number;\n}\n\n/** Modal Frontstage Stack Changed Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> {}\n\n/** Modal Frontstage Closed Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ModalFrontstageClosedEventArgs {\n  /** Modal Frontstage being closed */\n  modalFrontstage: ModalFrontstageInfo;\n\n  /** Total time spent in frontstage */\n  totalTime: number;\n  /** Engagement time spent in frontstage */\n  engagementTime: number;\n  /** Idle time spent in frontstage */\n  idleTime: number;\n}\n\n/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was\n * pressed and passes the function to actually close the modal stage. This allows stage to do any\n * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest\n * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved\n * any unsaved data.\n * @alpha\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> {}\n\n/** Modal Frontstage RequestedClose Event Args interface.\n * @alpha\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ModalFrontstageRequestedCloseEventArgs {\n  /** Modal Frontstage that is to be closed */\n  modalFrontstage: ModalFrontstageInfo;\n  /** Function to call to close the stage */\n  stageCloseFunc: () => void;\n}\n\n/** Modal Frontstage Closed Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> {}\n\n/** Tool Activated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ToolActivatedEventArgs {\n  toolId: string;\n}\n\n/** Tool Activated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> {}\n\n/** Tool Icon Changed Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ToolIconChangedEventArgs {\n  iconSpec: string;\n}\n\n/** Tool Icon Changed Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> {}\n\n/** Modal Frontstage information interface.\n * @public\n */\nexport interface ModalFrontstageInfo {\n  title: string;\n  content: React.ReactNode;\n  appBarRight?: React.ReactNode;\n  /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so\n   * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.\n   * @alpha */\n  notifyCloseRequest?: boolean;\n}\n\n/** Modal Frontstage array item interface.\n * @internal\n */\nexport interface ModalFrontstageItem {\n  modalFrontstage: ModalFrontstageInfo;\n  timeTracker: TimeTracker;\n}\n\n/** [[UiFramework.frontstages]] interface\n * @public\n */\nexport interface FrameworkFrontstages {\n  /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */\n  readonly isLoading: boolean;\n\n  /** Get Frontstage Deactivated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;\n\n  /** Get Frontstage Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;\n\n  /** Get Frontstage Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onFrontstageReadyEvent: FrontstageReadyEvent;\n\n  /** Get Modal Frontstage Changed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;\n\n  /** Get Modal Frontstage Closed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;\n\n  /** Get Modal Frontstage Requested Closed event.\n   * @alpha\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;\n\n  /** Get Tool Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onToolActivatedEvent: ToolActivatedEvent;\n\n  /** Get ToolSetting Reload event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onToolSettingsReloadEvent: UiEvent<void>;\n\n  /** Get Tool Icon Changed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onToolIconChangedEvent: ToolIconChangedEvent;\n\n  /** Get Content Layout Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;\n\n  /** Get Content Control Activated event.\n   * @deprecated in 4.16.0. Use {@link FrameworkContent.onActiveContentChangedEvent} instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onContentControlActivatedEvent: ContentControlActivatedEvent;\n\n  /** Get Navigation Aid Activated event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;\n\n  /** Get Widget State Changed event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;\n\n  /** Get panel state changed event.\n   * @alpha\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onPanelStateChangedEvent: PanelStateChangedEvent;\n\n  /** Get panel pinned changed event.\n   * @alpha\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onPanelPinnedChangedEvent: UiEvent<PanelPinnedChangedEventArgs>;\n\n  /** Clears the Frontstage map.\n   */\n  clearFrontstageDefs(): void;\n\n  /** Clears the Frontstage Providers and the defs that may have been created from them.\n   */\n  clearFrontstageProviders(): void;\n\n  /** Adds a frontstage provider.\n   * @param frontstageProvider  FrontstageProvider representing the Frontstage to add\n   * @deprecated in 4.15.0. Use {@link FrameworkFrontstages.addFrontstage} instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  addFrontstageProvider(frontstageProvider: FrontstageProvider): void;\n\n  /** Adds a frontstage.\n   * @beta\n   */\n  addFrontstage(frontstage: Frontstage): void;\n\n  /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If\n   * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and\n   * returned.\n   * @param id  Id of the Frontstage to find\n   * @returns  FrontstageDef with a given id if found, or undefined if not found.\n   */\n  getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;\n\n  /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.\n   * @return  Active FrontstageDef, or undefined if one is not active.\n   */\n  readonly activeFrontstageDef: FrontstageDef | undefined;\n\n  /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.\n   * @return  Id of the active FrontstageDef, or blank if one is not active.\n   */\n  readonly activeFrontstageId: string;\n\n  hasFrontstage(frontstageId: string): boolean;\n\n  /** Sets the active FrontstageDef give the stageId.\n   * @param  frontstageId  Id of the Frontstage to set active.\n   * @returns A Promise that is fulfilled when the Frontstage is ready.\n   */\n  setActiveFrontstage(frontstageId: string): Promise<void>;\n\n  /** Sets the active FrontstageDef.\n   * @param  frontstageDef  FrontstageDef to set active.\n   * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.\n   */\n  setActiveFrontstageDef(\n    frontstageDef: FrontstageDef | undefined\n  ): Promise<void>;\n\n  /** Deactivates the active FrontstageDef.\n   */\n  deactivateFrontstageDef(): Promise<void>;\n\n  /** Gets the Id of the active tool. If a tool is not active, blank is returned.\n   * @return  Id of the active tool, or blank if one is not active.\n   */\n  readonly activeToolId: string;\n\n  /** Sets the active tool id */\n  setActiveToolId(toolId: string): void;\n\n  /** Sets the active tool */\n  setActiveTool(tool: Tool): void;\n\n  /** Gets the active tool's [[ToolInformation]].\n   * @deprecated in 4.16.0. Uses a deprecated class {@link ToolInformation}.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly activeToolInformation: ToolInformation | undefined;\n\n  /** Opens a modal Frontstage. Modal Frontstages can be stacked.\n   * @param modalFrontstage  Information about the modal Frontstage\n   */\n  openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;\n\n  /** Closes the top-most modal Frontstage.\n   */\n  closeModalFrontstage(): void;\n\n  /** Updates the top-most modal Frontstage.\n   */\n  updateModalFrontstage(): void;\n\n  /** Gets the top-most modal Frontstage.\n   * @returns Top-most modal Frontstage, or undefined if there is none.\n   */\n  readonly activeModalFrontstage: ModalFrontstageInfo | undefined;\n\n  /** Gets the number of modal Frontstages.\n   * @returns Modal Frontstage count\n   */\n  readonly modalFrontstageCount: number;\n\n  /** Sets the active Navigation Aid via its Id.\n   * @param navigationAidId  Id of the Navigation Aid to set as active\n   * @param iModelConnection IModelConnection to query for view data\n   */\n  setActiveNavigationAid(\n    navigationAidId: string,\n    iModelConnection: IModelConnection\n  ): void;\n\n  /** Sets the state of the widget with the given id\n   * @param widgetId  Id of the Widget for which to set the state\n   * @param state     New state of the widget\n   * @returns true if the widget state was set successfully, or false if not.\n   */\n  setWidgetState(widgetId: string, state: WidgetState): boolean;\n\n  /** Finds a widget with the given id in the active frontstage\n   * @param widgetId  Id of the Widget to find\n   * @returns The WidgetDef with the given id, or undefined if not found.\n   */\n  findWidget(widgetId: string): WidgetDef | undefined;\n\n  /** Opens a nested Frontstage. Nested Frontstages can be stacked.\n   * @param nestedFrontstage  Information about the nested Frontstage\n   */\n  openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;\n\n  /** Closes the top-most nested Frontstage.\n   */\n  closeNestedFrontstage(): Promise<void>;\n\n  /** Gets the top-most nested Frontstage.\n   * @returns Top-most nested Frontstage, or undefined if there is none.\n   */\n  readonly activeNestedFrontstage: FrontstageDef | undefined;\n\n  /** Gets the number of nested Frontstages.\n   * @returns Nested Frontstage count\n   */\n  readonly nestedFrontstageCount: number;\n}\n"]}

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.d.ts

@@ -2,7 +2,7 @@
 /** @packageDocumentation
  * @module KeyboardShortcut
  */
-import type { BadgeType, IconSpec } from "@itwin/core-react";
+import type { BadgeKind, BadgeType, IconSpec } from "@itwin/core-react";
 import type { KeyboardShortcutProps } from "../keyboardshortcut/KeyboardShortcutProps";
 import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
 import type { ConditionalBooleanValue, ConditionalStringValue } from "../shared/ConditionalValue";
@@ -37,12 +37,17 @@ export interface FrameworkKeyboardShortcut {
     readonly isFunctionKey: boolean;
     /** Gets whether this is a Special key. */
     readonly isSpecialKey: boolean;
+    /** Specifies the kind of badge, if any, to be overlaid on the item. */
+    readonly badgeKind?: BadgeKind;
+    readonly iconNode?: React.ReactNode;
     isPressed: boolean;
     isActive: boolean;
     applicationData?: any;
     isHidden?: boolean | ConditionalBooleanValue;
     isDisabled?: boolean | ConditionalBooleanValue;
+    /** @deprecated in 4.16.0. Use {@link FrameworkKeyboardShortcut.badgeKind} property instead. */
     badgeType?: BadgeType;
+    /** @deprecated in 4.16.0. Use {@link FrameworkKeyboardShortcut.iconNode} property instead. */
     iconSpec?: IconSpec;
     iconElement?: React.ReactNode;
     trayId: undefined;

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AACvF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,uCAAuC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,oEAAoE;IACpE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEnE,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IAEH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE/C,uFAAuF;IACvF,UAAU,IAAI,IAAI,CAAC;IAEnB,4BAA4B;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,0CAA0C;IAC1C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,2CAA2C;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAI/B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC7C,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IAClE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,IAAI,CAAC;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,IAAI,CAAC;IACpE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,IAAI,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,oFAAoF;IACpF,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,yBAAyB,GACpC,yBAAyB,GAAG,SAAS,CAAC;IAEzC,4DAA4D;IAC5D,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAElE,2EAA2E;IAC3E,6BAA6B,IAAI,OAAO,CAAC;IAEzC,yDAAyD;IACzD,SAAS,IAAI,IAAI,CAAC;IAElB,6BAA6B,IAAI,yBAAyB,EAAE,CAAC;IAE7D,mEAAmE;IACnE,iBAAiB,IAAI,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,qDAAqD;IACrD,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC;IAE3D,sDAAsD;IACtD,YAAY,CAAC,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEzD,qEAAqE;IACrE,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,OAAO,EACzB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC;IAEX,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,yDAAyD;IACzD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEtE,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC,yBAAyB;IACzB,cAAc,IAAI,IAAI,CAAC;IAEvB,yDAAyD;IACzD,WAAW,IAAI,IAAI,CAAC;IAEpB,yCAAyC;IACzC,SAAS,IAAI,IAAI,CAAC;IAElB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"FrameworkKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AACvF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,uCAAuC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,oEAAoE;IACpE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEnE,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IAEH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE/C,uFAAuF;IACvF,UAAU,IAAI,IAAI,CAAC;IAEnB,4BAA4B;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,0CAA0C;IAC1C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,2CAA2C;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAE/B,uEAAuE;IACvE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAIpC,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC7C,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,+FAA+F;IAE/F,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,8FAA8F;IAE9F,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IAClE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,IAAI,CAAC;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,IAAI,CAAC;IACpE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,IAAI,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,oFAAoF;IACpF,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,yBAAyB,GACpC,yBAAyB,GAAG,SAAS,CAAC;IAEzC,4DAA4D;IAC5D,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAElE,2EAA2E;IAC3E,6BAA6B,IAAI,OAAO,CAAC;IAEzC,yDAAyD;IACzD,SAAS,IAAI,IAAI,CAAC;IAElB,6BAA6B,IAAI,yBAAyB,EAAE,CAAC;IAE7D,mEAAmE;IACnE,iBAAiB,IAAI,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,qDAAqD;IACrD,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC;IAE3D,sDAAsD;IACtD,YAAY,CAAC,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEzD,qEAAqE;IACrE,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,OAAO,EACzB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC;IAEX,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,yDAAyD;IACzD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEtE,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC,yBAAyB;IACzB,cAAc,IAAI,IAAI,CAAC;IAEvB,yDAAyD;IACzD,WAAW,IAAI,IAAI,CAAC;IAEpB,yCAAyC;IACzC,SAAS,IAAI,IAAI,CAAC;IAElB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\nimport type { BadgeType, IconSpec } from \"@itwin/core-react\";\nimport type { KeyboardShortcutProps } from \"../keyboardshortcut/KeyboardShortcutProps\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"../shared/ConditionalValue\";\nimport type { StringGetter } from \"@itwin/appui-abstract\";\n\n/** Keyboard Shortcut used to execute an action\n * @public\n */\nexport interface FrameworkKeyboardShortcut {\n  /** Returns the id for this shortcut */\n  readonly id: string;\n\n  /** Returns the shortcut container */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Returns the shortcut's key map key used as the id */\n  readonly keyMapKey: string;\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut.\n   * @deprecated in 4.15.0. Use properties of this object instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly item: ActionButtonItemDef | undefined;\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  itemPicked(): void;\n\n  /** Gets the keyboard key */\n  readonly key: string;\n  /** Gets whether the Alt key required. */\n  readonly isAltKeyRequired: boolean;\n  /** Gets whether the Ctrl key required. */\n  readonly isCtrlKeyRequired: boolean;\n  /** Gets whether the Shift key required. */\n  readonly isShiftKeyRequired: boolean;\n  /** Gets whether this is a Function key. */\n  readonly isFunctionKey: boolean;\n  /** Gets whether this is a Special key. */\n  readonly isSpecialKey: boolean;\n\n  // #region \"ItemDefBase\" properties previously extended from deprecated type.\n\n  isPressed: boolean;\n  isActive: boolean;\n  applicationData?: any;\n  isHidden?: boolean | ConditionalBooleanValue;\n  isDisabled?: boolean | ConditionalBooleanValue;\n  badgeType?: BadgeType;\n  iconSpec?: IconSpec;\n  iconElement?: React.ReactNode;\n  trayId: undefined;\n  readonly rawLabel: string | StringGetter | ConditionalStringValue;\n  readonly label: string;\n  setLabel(v: string | StringGetter | ConditionalStringValue): void;\n  readonly tooltip: string;\n  setTooltip(v: string | StringGetter | ConditionalStringValue): void;\n  readonly description: string;\n  setDescription(v: string | StringGetter | ConditionalStringValue): void;\n\n  // #endregion \"ItemDefBase\"\n}\n\n/** Keyboard Shortcut Container\n * @public\n */\nexport interface FrameworkKeyboardShortcutContainer {\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  registerKey(\n    keyMapKey: string,\n    inShortcut: FrameworkKeyboardShortcut\n  ): FrameworkKeyboardShortcut | undefined;\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  areKeyboardShortcutsAvailable(): boolean;\n\n  /** Empties any Keyboard Shortcuts from this container */\n  emptyData(): void;\n\n  getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  showShortcutsMenu(): void;\n}\n\n/**\n * [[UiFramework.keyboardShortcuts]] interface\n * @public\n */\nexport interface FrameworkKeyboardShortcuts {\n  /** Loads Keyboard Shortcuts into the managed list */\n  loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  loadShortcut(shortcutProps: KeyboardShortcutProps): void;\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  processKey(\n    keyboardKey: string,\n    isAltKeyPressed?: boolean,\n    isCtrlKeyPressed?: boolean,\n    isShiftKeyPressed?: boolean\n  ): boolean;\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if focus is set to Home */\n  readonly isFocusOnHome: boolean;\n\n  /** Sets focus to Home */\n  setFocusToHome(): void;\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  displayMenu(): void;\n\n  /** Closes the Keyboard Shortcuts menu */\n  closeMenu(): void;\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  readonly cursorX: number;\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  readonly cursorY: number;\n}\n"]}
+{"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\nimport type { BadgeKind, BadgeType, IconSpec } from \"@itwin/core-react\";\nimport type { KeyboardShortcutProps } from \"../keyboardshortcut/KeyboardShortcutProps\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"../shared/ConditionalValue\";\nimport type { StringGetter } from \"@itwin/appui-abstract\";\n\n/** Keyboard Shortcut used to execute an action\n * @public\n */\nexport interface FrameworkKeyboardShortcut {\n  /** Returns the id for this shortcut */\n  readonly id: string;\n\n  /** Returns the shortcut container */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Returns the shortcut's key map key used as the id */\n  readonly keyMapKey: string;\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut.\n   * @deprecated in 4.15.0. Use properties of this object instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly item: ActionButtonItemDef | undefined;\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  itemPicked(): void;\n\n  /** Gets the keyboard key */\n  readonly key: string;\n  /** Gets whether the Alt key required. */\n  readonly isAltKeyRequired: boolean;\n  /** Gets whether the Ctrl key required. */\n  readonly isCtrlKeyRequired: boolean;\n  /** Gets whether the Shift key required. */\n  readonly isShiftKeyRequired: boolean;\n  /** Gets whether this is a Function key. */\n  readonly isFunctionKey: boolean;\n  /** Gets whether this is a Special key. */\n  readonly isSpecialKey: boolean;\n\n  /** Specifies the kind of badge, if any, to be overlaid on the item. */\n  readonly badgeKind?: BadgeKind;\n  readonly iconNode?: React.ReactNode;\n\n  // #region \"ItemDefBase\" properties previously extended from deprecated type.\n\n  isPressed: boolean;\n  isActive: boolean;\n  applicationData?: any;\n  isHidden?: boolean | ConditionalBooleanValue;\n  isDisabled?: boolean | ConditionalBooleanValue;\n  /** @deprecated in 4.16.0. Use {@link FrameworkKeyboardShortcut.badgeKind} property instead. */\n  // eslint-disable-next-line deprecation/deprecation\n  badgeType?: BadgeType;\n  /** @deprecated in 4.16.0. Use {@link FrameworkKeyboardShortcut.iconNode} property instead. */\n  // eslint-disable-next-line deprecation/deprecation\n  iconSpec?: IconSpec;\n  iconElement?: React.ReactNode;\n  trayId: undefined;\n  readonly rawLabel: string | StringGetter | ConditionalStringValue;\n  readonly label: string;\n  setLabel(v: string | StringGetter | ConditionalStringValue): void;\n  readonly tooltip: string;\n  setTooltip(v: string | StringGetter | ConditionalStringValue): void;\n  readonly description: string;\n  setDescription(v: string | StringGetter | ConditionalStringValue): void;\n\n  // #endregion \"ItemDefBase\"\n}\n\n/** Keyboard Shortcut Container\n * @public\n */\nexport interface FrameworkKeyboardShortcutContainer {\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  registerKey(\n    keyMapKey: string,\n    inShortcut: FrameworkKeyboardShortcut\n  ): FrameworkKeyboardShortcut | undefined;\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  areKeyboardShortcutsAvailable(): boolean;\n\n  /** Empties any Keyboard Shortcuts from this container */\n  emptyData(): void;\n\n  getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  showShortcutsMenu(): void;\n}\n\n/**\n * [[UiFramework.keyboardShortcuts]] interface\n * @public\n */\nexport interface FrameworkKeyboardShortcuts {\n  /** Loads Keyboard Shortcuts into the managed list */\n  loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  loadShortcut(shortcutProps: KeyboardShortcutProps): void;\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  processKey(\n    keyboardKey: string,\n    isAltKeyPressed?: boolean,\n    isCtrlKeyPressed?: boolean,\n    isShiftKeyPressed?: boolean\n  ): boolean;\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\n\n  /** Determines if focus is set to Home */\n  readonly isFocusOnHome: boolean;\n\n  /** Sets focus to Home */\n  setFocusToHome(): void;\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  displayMenu(): void;\n\n  /** Closes the Keyboard Shortcuts menu */\n  closeMenu(): void;\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  readonly cursorX: number;\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  readonly cursorY: number;\n}\n"]}

package/lib/cjs/appui-react/frontstage/FrontstageConfig.d.ts

@@ -10,11 +10,11 @@ import type { WidgetConfig } from "../widgets/WidgetConfig";
  * @deprecated in 4.15.0. Use {@link Frontstage} instead.
  */
 export interface FrontstageConfig extends CommonProps {
-    /** Id for the Frontstage */
+    /** Id of the frontstage. To ensure uniqueness it is common practice to format id like `appName:stageId` */
     readonly id: string;
-    /** The Content Group providing the Content Views */
+    /** Content group of the frontstage that describes the content views. Or a content group provider. */
     readonly contentGroup: ContentGroup | ContentGroupProvider;
-    /** Usage type for this Frontstage. */
+    /** Usage type for this Frontstage. To allow generic {@link UiItemsProvider} to populate this stage set to {@link StageUsage.General}. */
     readonly usage?: string;
     /** Frontstage version. Used to force saved layout reinitialization after changes to frontstage.
      * @note This value should be increased when changes are made to the Frontstage.

package/lib/cjs/appui-react/frontstage/FrontstageConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrontstageConfig.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageConfig.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;;GAGG;AAEH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,oBAAoB,CAAC;IAC3D,sCAAsC;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,uFAAuF;IACvF,QAAQ,CAAC,mBAAmB,CAAC,EAAE,YAAY,CAAC;IAC5C,uCAAuC;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC,6DAA6D;IAC7D,QAAQ,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC;IACvC,yCAAyC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;IAElC,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACrC,qCAAqC;IACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACtC,sCAAsC;IACtC,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IACvC,uCAAuC;IACvC,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC;CACzC"}
+{"version":3,"file":"FrontstageConfig.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageConfig.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAK5D;;;GAGG;AAEH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,2GAA2G;IAC3G,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,qGAAqG;IACrG,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,oBAAoB,CAAC;IAC3D,yIAAyI;IACzI,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,uFAAuF;IACvF,QAAQ,CAAC,mBAAmB,CAAC,EAAE,YAAY,CAAC;IAC5C,uCAAuC;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC,6DAA6D;IAC7D,QAAQ,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC;IACvC,yCAAyC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;IAElC,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACrC,qCAAqC;IACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACtC,sCAAsC;IACtC,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IACvC,uCAAuC;IACvC,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC;CACzC"}

package/lib/cjs/appui-react/frontstage/FrontstageConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrontstageConfig.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageConfig.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\n\nimport type { CommonProps } from \"@itwin/core-react\";\nimport type {\n  ContentGroup,\n  ContentGroupProvider,\n} from \"../content/ContentGroup\";\nimport type { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\nimport type { WidgetConfig } from \"../widgets/WidgetConfig\";\nimport type { Frontstage } from \"./Frontstage\";\n\n/** Configuration from which a frontstage is created.\n * @public\n * @deprecated in 4.15.0. Use {@link Frontstage} instead.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface FrontstageConfig extends CommonProps {\n  /** Id for the Frontstage */\n  readonly id: string;\n  /** The Content Group providing the Content Views */\n  readonly contentGroup: ContentGroup | ContentGroupProvider;\n  /** Usage type for this Frontstage. */\n  readonly usage?: string;\n  /** Frontstage version. Used to force saved layout reinitialization after changes to frontstage.\n   * @note This value should be increased when changes are made to the Frontstage.\n   * Increasing the value will make sure to reinitialize App layout instead of restoring to old layout.\n   */\n  readonly version: number;\n  /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.\n   * Most of the time, this is the Element Selection Tool (SelectionTool.toolId).\n   * Your app can specify its own tool or another core tool as default with this property.\n   */\n  readonly defaultTool?: string;\n\n  /** The top-left corner that shows tools typically used to query and modify content. */\n  readonly contentManipulation?: WidgetConfig;\n  /** The settings of the active tool. */\n  readonly toolSettings?: WidgetConfig;\n  /** The top-right corner that shows view navigation tools. */\n  readonly viewNavigation?: WidgetConfig;\n  /** The status bar of the application. */\n  readonly statusBar?: WidgetConfig;\n\n  /** Top panel of the application. */\n  readonly topPanel?: StagePanelConfig;\n  /** Left panel of the application. */\n  readonly leftPanel?: StagePanelConfig;\n  /** Right panel of the application. */\n  readonly rightPanel?: StagePanelConfig;\n  /** Bottom panel of the application. */\n  readonly bottomPanel?: StagePanelConfig;\n}\n"]}
+{"version":3,"file":"FrontstageConfig.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageConfig.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\n\nimport type { CommonProps } from \"@itwin/core-react\";\nimport type {\n  ContentGroup,\n  ContentGroupProvider,\n} from \"../content/ContentGroup\";\nimport type { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\nimport type { WidgetConfig } from \"../widgets/WidgetConfig\";\nimport type { Frontstage } from \"./Frontstage\";\nimport type { UiItemsProvider } from \"../ui-items-provider/UiItemsProvider\";\nimport type { StageUsage } from \"./StageUsage\";\n\n/** Configuration from which a frontstage is created.\n * @public\n * @deprecated in 4.15.0. Use {@link Frontstage} instead.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface FrontstageConfig extends CommonProps {\n  /** Id of the frontstage. To ensure uniqueness it is common practice to format id like `appName:stageId` */\n  readonly id: string;\n  /** Content group of the frontstage that describes the content views. Or a content group provider. */\n  readonly contentGroup: ContentGroup | ContentGroupProvider;\n  /** Usage type for this Frontstage. To allow generic {@link UiItemsProvider} to populate this stage set to {@link StageUsage.General}. */\n  readonly usage?: string;\n  /** Frontstage version. Used to force saved layout reinitialization after changes to frontstage.\n   * @note This value should be increased when changes are made to the Frontstage.\n   * Increasing the value will make sure to reinitialize App layout instead of restoring to old layout.\n   */\n  readonly version: number;\n  /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.\n   * Most of the time, this is the Element Selection Tool (SelectionTool.toolId).\n   * Your app can specify its own tool or another core tool as default with this property.\n   */\n  readonly defaultTool?: string;\n\n  /** The top-left corner that shows tools typically used to query and modify content. */\n  readonly contentManipulation?: WidgetConfig;\n  /** The settings of the active tool. */\n  readonly toolSettings?: WidgetConfig;\n  /** The top-right corner that shows view navigation tools. */\n  readonly viewNavigation?: WidgetConfig;\n  /** The status bar of the application. */\n  readonly statusBar?: WidgetConfig;\n\n  /** Top panel of the application. */\n  readonly topPanel?: StagePanelConfig;\n  /** Left panel of the application. */\n  readonly leftPanel?: StagePanelConfig;\n  /** Right panel of the application. */\n  readonly rightPanel?: StagePanelConfig;\n  /** Bottom panel of the application. */\n  readonly bottomPanel?: StagePanelConfig;\n}\n"]}

package/lib/cjs/appui-react/frontstage/FrontstageDef.d.ts

@@ -3,7 +3,6 @@
  */
 import type { ScreenViewport } from "@itwin/core-frontend";
 import type { XAndY } from "@itwin/core-geometry";
-import type { RectangleProps, SizeProps } from "@itwin/core-react";
 import type { ChildWindow } from "../childwindow/ChildWindowConfig";
 import { TimeTracker } from "../configurableui/TimeTracker";
 import type { ContentControl } from "../content/ContentControl";
@@ -17,14 +16,8 @@ import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
 import { WidgetDef } from "../widgets/WidgetDef";
 import type { FrontstageProvider } from "./FrontstageProvider";
 import type { Frontstage } from "./Frontstage";
-/** @internal */
-export interface FrontstageEventArgs {
-    frontstageDef: FrontstageDef;
-}
-/** @internal */
-export interface FrontstageNineZoneStateChangedEventArgs extends FrontstageEventArgs {
-    state: NineZoneState | undefined;
-}
+import type { SizeProps } from "../utils/SizeProps";
+import type { RectangleProps } from "../utils/RectangleProps";
 /** FrontstageDef class provides an API for a Frontstage.
  * @public
  */
@@ -69,8 +62,6 @@ export declare class FrontstageDef {
     get bottomPanel(): StagePanelDef | undefined;
     get contentLayoutDef(): ContentLayoutDef | undefined;
     get contentGroup(): ContentGroup | undefined;
-    /** @deprecated in 4.15.0. Use {@link FrontstageDef.id} to look up a frontstage. */
-    get frontstageProvider(): FrontstageProvider | undefined;
     private toStagePanelLocation;
     private populateStateMaps;
     private triggerStateChangeEvents;
@@ -107,12 +98,8 @@ export declare class FrontstageDef {
     onFrontstageReady(): void;
     /** Sets the Content Layout and Content Group */
     setContentLayoutAndGroup(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): void;
-    /** Sets the active view content control to the default or first */
+    /** Sets the active view content to the default or first. */
     setActiveContent(): Promise<boolean>;
-    /** Sets the active view content control */
-    setActiveView(newContent: ContentControl, oldContent?: ContentControl): void;
-    /** Sets the active view content control based on the selected viewport. */
-    setActiveViewFromViewport(viewport: ScreenViewport): boolean;
     /** Gets a [[StagePanelDef]] based on a given panel location
      * @beta
      */
@@ -125,10 +112,6 @@ export declare class FrontstageDef {
     findWidgetDef(id: string): WidgetDef | undefined;
     /** Gets the list of [[WidgetControl]]s */
     private get _widgetControls();
-    addFloatingContentControl(contentControl?: ContentControl): void;
-    dropFloatingContentControl(contentControl?: ContentControl): void;
-    /** Gets the list of [[ContentControl]]s */
-    get contentControls(): ContentControl[];
     /** Initializes a FrontstageDef from frontstage.
      * @internal
      */
@@ -183,7 +166,7 @@ export declare class FrontstageDef {
     setFloatingWidgetContainerBounds(floatingWidgetId: string, bounds: RectangleProps): boolean;
     getFloatingWidgetContainerIds(): string[];
     getFloatingWidgetContainerIdByWidgetId(widgetId: string): string | undefined;
-    getFloatingWidgetContainerBounds(floatingWidgetId: string | undefined): RectangleProps | undefined;
+    getFloatingWidgetContainerBounds(floatingWidgetId: string | undefined): import("@itwin/core-react").RectangleProps | undefined;
     private _widgetDefs;
     /** Iterable of all widget definitions in a frontstage.
      * @internal
@@ -191,6 +174,24 @@ export declare class FrontstageDef {
     get widgetDefs(): {
         [Symbol.iterator](): Iterator<WidgetDef, any, undefined>;
     };
+    /** @deprecated in 4.15.0. Use {@link FrontstageDef.id} to look up a frontstage. */
+    get frontstageProvider(): FrontstageProvider | undefined;
+    /** Sets the active view content control.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    setActiveView(newContent: ContentControl, oldContent?: ContentControl): void;
+    /** @deprecated in 4.16.0. Use {@link UiItemsProvider} to provide a floating widget. */
+    addFloatingContentControl(contentControl?: ContentControl): void;
+    /** @deprecated in 4.16.0. Unregister {@link UiItemsProvider} to remove a floating widget. */
+    dropFloatingContentControl(contentControl?: ContentControl): void;
+    /** Gets the list of {@link ContentControl}s.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    get contentControls(): ContentControl[];
+    /** Sets the active view content control based on the selected viewport.
+     * @deprecated in 4.16.0. Use {@link FrameworkContent.setActiveId} instead.
+     */
+    setActiveViewFromViewport(viewport: ScreenViewport): boolean;
 }
 /** Hook that returns active frontstage id.
  * @public

package/lib/cjs/appui-react/frontstage/FrontstageDef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrontstageDef.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageDef.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAO3D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAInE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAEpE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAgBnE,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAIvE,OAAO,EAAkB,SAAS,EAAc,MAAM,sBAAsB,CAAC;AAE7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,MAAM,WAAW,uCACf,SAAQ,mBAAmB;IAC3B,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,cAAc,CAAC,CAAa;IACpC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,aAAa,CAAC,CAAY;IAClC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAY;IACzC,OAAO,CAAC,eAAe,CAAC,CAAY;IACpC,OAAO,CAAC,SAAS,CAAC,CAAgB;IAClC,OAAO,CAAC,UAAU,CAAC,CAAgB;IACnC,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,YAAY,CAAC,CAAgB;IACrC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,aAAa,CAAC,CAAe;IAErC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,qBAAqB,CAAC,CAAuB;IACrD,OAAO,CAAC,wBAAwB,CAAC,CAAmB;IACpD,OAAO,CAAC,uBAAuB,CAAC,CAAS;IACzC,OAAO,CAAC,SAAS,CAAC,CAAmB;IACrC,OAAO,CAAC,SAAS,CAAS;IAE1B,IAAW,EAAE,IAAI,MAAM,CAEtB;IACD,IAAW,KAAK,IAAI,MAAM,CAEzB;IACD,IAAW,OAAO,IAAI,MAAM,CAE3B;IACD,IAAW,oBAAoB,IAAI,oBAAoB,GAAG,SAAS,CAElE;IACD,IAAW,uBAAuB,iCAEjC;IAED,IAAW,YAAY,IAAI,SAAS,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IACD,IAAW,mBAAmB,IAAI,SAAS,GAAG,SAAS,CAEtD;IACD,IAAW,cAAc,IAAI,SAAS,GAAG,SAAS,CAEjD;IAED,IAAW,QAAQ,IAAI,aAAa,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,aAAa,GAAG,SAAS,CAEhD;IACD,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAEjD;IACD,IAAW,WAAW,IAAI,aAAa,GAAG,SAAS,CAElD;IAED,IAAW,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAE1D;IACD,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IAED,mFAAmF;IAEnF,IAAW,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAE9D;IAED,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,wBAAwB;IAuChC,OAAO,CAAC,aAAa;IAoBrB,gBAAgB;IAChB,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAEpD;IACD,IAAW,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EA8BxD;IAED,gBAAgB;IAChB,IAAW,QAAQ,IAAI,gBAAgB,CAMtC;IACD,IAAW,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,EAE7C;IAED;;OAEG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI;IAYlC,gBAAgB;IAChB,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,sDAAsD;WAClC,MAAM,CAExB,oBAAoB,EAAE,kBAAkB,GAAG,UAAU;IAgBvD,oDAAoD;cACpC,YAAY;IAE5B,oDAAoD;IACvC,WAAW;IA2BxB,mDAAmD;cACnC,cAAc;IAE9B,mDAAmD;IACtC,aAAa;IAgC1B,gBAAgB;IACT,uBAAuB,CAAC,KAAK,EAAE,OAAO;IAI7C,+EAA+E;IAClE,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAqB5C,iDAAiD;IACjD,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAEpC,iDAAiD;IAC1C,iBAAiB,IAAI,IAAI;IAyBhC,gDAAgD;IACzC,wBAAwB,CAC7B,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,YAAY,GACzB,IAAI;IAKP,mEAAmE;IACtD,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC;IAqBjD,2CAA2C;IACpC,aAAa,CAClB,UAAU,EAAE,cAAc,EAC1B,UAAU,CAAC,EAAE,cAAc,GAC1B,IAAI;IASP,2EAA2E;IACpE,yBAAyB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAYnE;;OAEG;IACI,gBAAgB,CACrB,QAAQ,EAAE,kBAAkB,GAC3B,aAAa,GAAG,SAAS;IAsB5B;;OAEG;IACH,IAAW,SAAS,IAAI,aAAa,EAAE,CAetC;IAED,gDAAgD;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAOvD,0CAA0C;IAC1C,OAAO,KAAK,eAAe,GAW1B;IAEM,yBAAyB,CAAC,cAAc,CAAC,EAAE,cAAc;IAWzD,0BAA0B,CAAC,cAAc,CAAC,EAAE,cAAc;IAYjE,2CAA2C;IAC3C,IAAW,eAAe,IAAI,cAAc,EAAE,CAS7C;IAED;;OAEG;IACU,oBAAoB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCpE,gBAAgB;IACT,gBAAgB,IAAI,IAAI;IAoB/B;;OAEG;IACI,aAAa;IAgBb,cAAc,CAAC,QAAQ,EAAE,MAAM;IAS/B,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IASxC;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcvE;;;OAGG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAiBnD;;OAEG;IACI,yBAAyB,CAC9B,iBAAiB,EAAE,MAAM,EACzB,QAAQ,EAAE,aAAa,GAAG,SAAS,GAClC,OAAO;IAgDV;;;;;;OAMG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcxE,IAAW,cAAc,YAExB;IAED,IAAW,oBAAoB,YAE9B;IAED,IAAW,OAAO,YAEjB;IAED,gBAAgB;IACT,8BAA8B,CACnC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,WAAW;IA2C1B,gBAAgB;IACT,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;IAuBjE;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM;IAUpC,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,cAAc;IAqBjB,6BAA6B,IAAI,MAAM,EAAE;IAMzC,sCAAsC,CAC3C,QAAQ,EAAE,MAAM,GACf,MAAM,GAAG,SAAS;IAUd,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,GAAG,SAAS;IAyBtC,OAAO,CAAE,WAAW;IAWpB;;OAEG;IACH,IAAW,UAAU;;MAOpB;CACF;AAuCD;;GAEG;AACH,eAAO,MAAM,qBAAqB,cAIjC,CAAC;AAEF;;GAEG;AACH,wBAAgB,sBAAsB,8BAYrC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,yBAepD"}
+{"version":3,"file":"FrontstageDef.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageDef.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAO3D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAIlD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAEpE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAgBnE,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAIvE,OAAO,EAAkB,SAAS,EAAc,MAAM,sBAAsB,CAAC;AAE7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,cAAc,CAAC,CAAa;IACpC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,aAAa,CAAC,CAAY;IAClC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAY;IACzC,OAAO,CAAC,eAAe,CAAC,CAAY;IACpC,OAAO,CAAC,SAAS,CAAC,CAAgB;IAClC,OAAO,CAAC,UAAU,CAAC,CAAgB;IACnC,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,YAAY,CAAC,CAAgB;IACrC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,aAAa,CAAC,CAAe;IAErC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,qBAAqB,CAAC,CAAuB;IAErD,OAAO,CAAC,wBAAwB,CAAC,CAAmB;IACpD,OAAO,CAAC,uBAAuB,CAAC,CAAS;IACzC,OAAO,CAAC,SAAS,CAAC,CAAmB;IACrC,OAAO,CAAC,SAAS,CAAS;IAE1B,IAAW,EAAE,IAAI,MAAM,CAEtB;IACD,IAAW,KAAK,IAAI,MAAM,CAEzB;IACD,IAAW,OAAO,IAAI,MAAM,CAE3B;IACD,IAAW,oBAAoB,IAAI,oBAAoB,GAAG,SAAS,CAElE;IACD,IAAW,uBAAuB,iCAEjC;IAED,IAAW,YAAY,IAAI,SAAS,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,SAAS,GAAG,SAAS,CAE5C;IACD,IAAW,mBAAmB,IAAI,SAAS,GAAG,SAAS,CAEtD;IACD,IAAW,cAAc,IAAI,SAAS,GAAG,SAAS,CAEjD;IAED,IAAW,QAAQ,IAAI,aAAa,GAAG,SAAS,CAE/C;IACD,IAAW,SAAS,IAAI,aAAa,GAAG,SAAS,CAEhD;IACD,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAEjD;IACD,IAAW,WAAW,IAAI,aAAa,GAAG,SAAS,CAElD;IAED,IAAW,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAE1D;IACD,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IAED,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,wBAAwB;IAuChC,OAAO,CAAC,aAAa;IAoBrB,gBAAgB;IAChB,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAEpD;IACD,IAAW,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EA8BxD;IAED,gBAAgB;IAChB,IAAW,QAAQ,IAAI,gBAAgB,CAMtC;IACD,IAAW,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,EAE7C;IAED;;OAEG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI;IAYlC,gBAAgB;IAChB,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,sDAAsD;WAClC,MAAM,CAExB,oBAAoB,EAAE,kBAAkB,GAAG,UAAU;IAgBvD,oDAAoD;cACpC,YAAY;IAE5B,oDAAoD;IACvC,WAAW;IA2BxB,mDAAmD;cACnC,cAAc;IAE9B,mDAAmD;IACtC,aAAa;IAiC1B,gBAAgB;IACT,uBAAuB,CAAC,KAAK,EAAE,OAAO;IAI7C,+EAA+E;IAClE,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB5C,iDAAiD;IACjD,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAEpC,iDAAiD;IAC1C,iBAAiB,IAAI,IAAI;IA0BhC,gDAAgD;IACzC,wBAAwB,CAC7B,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,YAAY,GACzB,IAAI;IAKP,4DAA4D;IAC/C,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC;IAyBjD;;OAEG;IACI,gBAAgB,CACrB,QAAQ,EAAE,kBAAkB,GAC3B,aAAa,GAAG,SAAS;IAsB5B;;OAEG;IACH,IAAW,SAAS,IAAI,aAAa,EAAE,CAetC;IAED,gDAAgD;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAOvD,0CAA0C;IAE1C,OAAO,KAAK,eAAe,GAa1B;IAED;;OAEG;IACU,oBAAoB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCpE,gBAAgB;IACT,gBAAgB,IAAI,IAAI;IAoB/B;;OAEG;IACI,aAAa;IAgBb,cAAc,CAAC,QAAQ,EAAE,MAAM;IAS/B,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IASxC;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcvE;;;OAGG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAiBnD;;OAEG;IACI,yBAAyB,CAC9B,iBAAiB,EAAE,MAAM,EACzB,QAAQ,EAAE,aAAa,GAAG,SAAS,GAClC,OAAO;IAgDV;;;;;;OAMG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS;IAcxE,IAAW,cAAc,YAExB;IAED,IAAW,oBAAoB,YAE9B;IAED,IAAW,OAAO,YAEjB;IAED,gBAAgB;IACT,8BAA8B,CACnC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,WAAW;IA2C1B,gBAAgB;IACT,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;IAuBjE;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM;IAUpC,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,cAAc;IAqBjB,6BAA6B,IAAI,MAAM,EAAE;IAMzC,sCAAsC,CAC3C,QAAQ,EAAE,MAAM,GACf,MAAM,GAAG,SAAS;IAUd,gCAAgC,CACrC,gBAAgB,EAAE,MAAM,GAAG,SAAS;IAyBtC,OAAO,CAAE,WAAW;IAWpB;;OAEG;IACH,IAAW,UAAU;;MAOpB;IAID,mFAAmF;IACnF,IAAW,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAE9D;IAED;;OAEG;IACI,aAAa,CAClB,UAAU,EAAE,cAAc,EAC1B,UAAU,CAAC,EAAE,cAAc,GAC1B,IAAI;IASP,uFAAuF;IAChF,yBAAyB,CAAC,cAAc,CAAC,EAAE,cAAc;IAYhE,6FAA6F;IACtF,0BAA0B,CAAC,cAAc,CAAC,EAAE,cAAc;IAYjE;;OAEG;IACH,IAAW,eAAe,IAAI,cAAc,EAAE,CAS7C;IAED;;OAEG;IACI,yBAAyB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;CAepE;AAuCD;;GAEG;AACH,eAAO,MAAM,qBAAqB,cAIjC,CAAC;AAEF;;GAEG;AACH,wBAAgB,sBAAsB,8BAYrC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,yBAepD"}

package/lib/cjs/appui-react/frontstage/FrontstageDef.js

@@ -8,7 +8,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useSpecificWidgetDef = exports.useActiveFrontstageDef = exports.useActiveFrontstageId = exports.FrontstageDef = void 0;
-// cSpell:ignore popout
 const appui_abstract_1 = require("@itwin/appui-abstract");
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_frontend_1 = require("@itwin/core-frontend");
@@ -42,6 +41,7 @@ class FrontstageDef {
         this._version = 0;
         this._timeTracker = new TimeTracker_1.TimeTracker();
         this._batching = false;
+        /* eslint-enable deprecation/deprecation */
     }
     get id() {
         return this._id;
@@ -88,11 +88,6 @@ class FrontstageDef {
     get contentGroup() {
         return this._contentGroup;
     }
-    /** @deprecated in 4.15.0. Use {@link FrontstageDef.id} to look up a frontstage. */
-    // eslint-disable-next-line deprecation/deprecation
-    get frontstageProvider() {
-        return this._frontstageProvider;
-    }
     toStagePanelLocation(side) {
         switch (side) {
             case "bottom":
@@ -275,6 +270,7 @@ class FrontstageDef {
         for (const control of this._widgetControls) {
             control.onFrontstageDeactivated();
         }
+        // eslint-disable-next-line deprecation/deprecation
         for (const control of this.contentControls) {
             control.onFrontstageDeactivated();
         }
@@ -310,6 +306,7 @@ class FrontstageDef {
         });
         if (this.contentLayoutDef) {
             const usedContentIndexes = this.contentLayoutDef.getUsedContentIndexes();
+            // eslint-disable-next-line deprecation/deprecation
             this.contentControls.forEach((control, index) => {
                 if (usedContentIndexes.includes(index))
                     controlReadyPromises.push(control.isReady);
@@ -326,6 +323,7 @@ class FrontstageDef {
         for (const control of this._widgetControls) {
             control.onFrontstageReady();
         }
+        // eslint-disable-next-line deprecation/deprecation
         for (const control of this.contentControls) {
             control.onFrontstageReady();
         }
@@ -349,40 +347,27 @@ class FrontstageDef {
         this._contentLayoutDef = contentLayoutDef;
         this._contentGroup = contentGroup;
     }
-    /** Sets the active view content control to the default or first */
+    /** Sets the active view content to the default or first. */
     async setActiveContent() {
-        let contentControl;
-        let activated = false;
-        if (!contentControl && this.contentControls.length >= 0) {
-            contentControl = this.contentControls[0];
-        }
-        if (contentControl) {
-            UiFramework_1.UiFramework.content.setActive(contentControl.reactNode, true);
-            if (contentControl.viewport) {
-                const status = await core_frontend_1.IModelApp.viewManager.setSelectedView(contentControl.viewport);
-                activated = status === core_bentley_1.BentleyStatus.SUCCESS;
-            }
+        const content = this.contentGroup?.contentPropsList?.[0];
+        if (!content)
+            return false;
+        let contentReactNode = content.content;
+        // eslint-disable-next-line deprecation/deprecation
+        let control;
+        if (!contentReactNode) {
+            // eslint-disable-next-line deprecation/deprecation
+            control = this.contentGroup.getContentControl(content, 0);
+            contentReactNode = control?.reactNode;
         }
-        return activated;
-    }
-    /** Sets the active view content control */
-    setActiveView(newContent, oldContent) {
-        if (oldContent)
-            oldContent.onDeactivated();
-        newContent.onActivated();
-        UiFramework_1.UiFramework.frontstages.onContentControlActivatedEvent.emit({
-            activeContentControl: newContent,
-            oldContentControl: oldContent,
-        });
-    }
-    /** Sets the active view content control based on the selected viewport. */
-    setActiveViewFromViewport(viewport) {
-        const contentControl = this.contentControls.find((control) => control.viewport === viewport);
-        if (contentControl) {
-            UiFramework_1.UiFramework.content.setActive(contentControl.reactNode, true);
+        if (!contentReactNode)
+            return false;
+        // eslint-disable-next-line deprecation/deprecation
+        UiFramework_1.UiFramework.content.setActive(contentReactNode, true);
+        if (!control?.viewport)
             return true;
-        }
-        return false;
+        const status = await core_frontend_1.IModelApp.viewManager.setSelectedView(control.viewport);
+        return status === core_bentley_1.BentleyStatus.SUCCESS;
     }
     /** Gets a [[StagePanelDef]] based on a given panel location
      * @beta
@@ -433,10 +418,13 @@ class FrontstageDef {
         return undefined;
     }
     /** Gets the list of [[WidgetControl]]s */
+    // eslint-disable-next-line deprecation/deprecation
     get _widgetControls() {
+        // eslint-disable-next-line deprecation/deprecation
         const widgetControls = new Array();
         this.panelDefs.forEach((panelDef) => {
             panelDef.widgetDefs.forEach((widgetDef) => {
+                // eslint-disable-next-line deprecation/deprecation
                 const widgetControl = widgetDef.widgetControl;
                 if (widgetControl)
                     widgetControls.push(widgetControl);
@@ -444,38 +432,6 @@ class FrontstageDef {
         });
         return widgetControls;
     }
-    addFloatingContentControl(contentControl) {
-        if (!contentControl)
-            return;
-        if (!this._floatingContentControls)
-            this._floatingContentControls = new Array();
-        this._floatingContentControls.push(contentControl);
-        UiFramework_1.UiFramework.content.onAvailableContentChangedEvent.emit({
-            contentId: contentControl.uniqueId,
-        });
-    }
-    dropFloatingContentControl(contentControl) {
-        if (!contentControl || !this._floatingContentControls)
-            return;
-        const index = this._floatingContentControls.indexOf(contentControl);
-        if (index > -1) {
-            this._floatingContentControls.splice(index, 1);
-            UiFramework_1.UiFramework.content.onAvailableContentChangedEvent.emit({
-                contentId: contentControl.uniqueId,
-            });
-        }
-    }
-    /** Gets the list of [[ContentControl]]s */
-    get contentControls() {
-        const contentControls = new Array();
-        if (this.contentGroup) {
-            contentControls.push(...this.contentGroup.getContentControls());
-        }
-        if (this._floatingContentControls) {
-            contentControls.push(...this._floatingContentControls);
-        }
-        return contentControls;
-    }
     /** Initializes a FrontstageDef from frontstage.
      * @internal
      */
@@ -801,6 +757,73 @@ class FrontstageDef {
             },
         };
     }
+    /* eslint-disable deprecation/deprecation */
+    /** @deprecated in 4.15.0. Use {@link FrontstageDef.id} to look up a frontstage. */
+    get frontstageProvider() {
+        return this._frontstageProvider;
+    }
+    /** Sets the active view content control.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    setActiveView(newContent, oldContent) {
+        if (oldContent)
+            oldContent.onDeactivated();
+        newContent.onActivated();
+        UiFramework_1.UiFramework.frontstages.onContentControlActivatedEvent.emit({
+            activeContentControl: newContent,
+            oldContentControl: oldContent,
+        });
+    }
+    /** @deprecated in 4.16.0. Use {@link UiItemsProvider} to provide a floating widget. */
+    addFloatingContentControl(contentControl) {
+        if (!contentControl)
+            return;
+        if (!this._floatingContentControls)
+            // eslint-disable-next-line deprecation/deprecation
+            this._floatingContentControls = new Array();
+        this._floatingContentControls.push(contentControl);
+        UiFramework_1.UiFramework.content.onAvailableContentChangedEvent.emit({
+            contentId: contentControl.uniqueId,
+        });
+    }
+    /** @deprecated in 4.16.0. Unregister {@link UiItemsProvider} to remove a floating widget. */
+    dropFloatingContentControl(contentControl) {
+        if (!contentControl || !this._floatingContentControls)
+            return;
+        const index = this._floatingContentControls.indexOf(contentControl);
+        if (index > -1) {
+            this._floatingContentControls.splice(index, 1);
+            UiFramework_1.UiFramework.content.onAvailableContentChangedEvent.emit({
+                contentId: contentControl.uniqueId,
+            });
+        }
+    }
+    /** Gets the list of {@link ContentControl}s.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    get contentControls() {
+        const contentControls = new Array();
+        if (this.contentGroup) {
+            contentControls.push(...this.contentGroup.getContentControls());
+        }
+        if (this._floatingContentControls) {
+            contentControls.push(...this._floatingContentControls);
+        }
+        return contentControls;
+    }
+    /** Sets the active view content control based on the selected viewport.
+     * @deprecated in 4.16.0. Use {@link FrameworkContent.setActiveId} instead.
+     */
+    setActiveViewFromViewport(viewport) {
+        // eslint-disable-next-line deprecation/deprecation
+        const contentControl = this.contentControls.find((control) => control.viewport === viewport);
+        if (contentControl) {
+            // eslint-disable-next-line deprecation/deprecation
+            UiFramework_1.UiFramework.content.setActive(contentControl.reactNode, true);
+            return true;
+        }
+        return false;
+    }
 }
 exports.FrontstageDef = FrontstageDef;
 function createWidgetDef(config, type) {