@itwin/appui-react 4.0.0-dev.9 → 4.0.1

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

@@ -1,286 +1,290 @@
-/// <reference types="react" />
-/** @packageDocumentation
- * @module Frontstage
- */
-import { UiEvent } from "@itwin/appui-abstract";
-import { IModelConnection, Tool } from "@itwin/core-frontend";
-import { ToolInformation } from "../toolsettings/ToolInformation";
-import { TimeTracker } from "../configurableui/TimeTracker";
-import { ContentControlActivatedEvent } from "../content/ContentControl";
-import { ContentLayoutActivatedEvent } from "../content/ContentLayout";
-import { FrontstageDef } from "../frontstage/FrontstageDef";
-import { FrontstageProvider } from "../frontstage/FrontstageProvider";
-import { NavigationAidActivatedEvent } from "../navigationaids/NavigationAidControl";
-import { PanelStateChangedEvent } from "../stagepanels/StagePanelDef";
-import { WidgetDef, WidgetStateChangedEvent } from "../widgets/WidgetDef";
-import { WidgetState } from "../widgets/WidgetState";
-/** Frontstage Activated Event Args interface.
- * @public
- */
-export interface FrontstageActivatedEventArgs {
-    deactivatedFrontstageDef?: FrontstageDef;
-    activatedFrontstageDef: FrontstageDef;
-}
-/** Frontstage Activated Event class.
- * @public
- */
-export declare class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> {
-}
-/** Frontstage Deactivated Event Args interface.
- * @public
- */
-export interface FrontstageDeactivatedEventArgs {
-    /** Frontstage being deactivated */
-    deactivatedFrontstageDef: FrontstageDef;
-    /** Frontstage being activated */
-    activatedFrontstageDef?: FrontstageDef;
-    /** Total time spent in frontstage */
-    totalTime: number;
-    /** Engagement time spent in frontstage */
-    engagementTime: number;
-    /** Idle time spent in frontstage */
-    idleTime: number;
-}
-/** Frontstage Deactivated Event class.
- * @public
- */
-export declare class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> {
-}
-/** Frontstage Ready Event Args interface.
- * @public
- */
-export interface FrontstageReadyEventArgs {
-    frontstageDef: FrontstageDef;
-}
-/** Frontstage Ready Event class.
- * @public
- */
-export declare class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> {
-}
-/** Modal Frontstage Changed Event Args interface.
- * @public
- */
-export interface ModalFrontstageChangedEventArgs {
-    modalFrontstageCount: number;
-}
-/** Modal Frontstage Stack Changed Event class.
- * @public
- */
-export declare class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> {
-}
-/** Modal Frontstage Closed Event Args interface.
- * @public
- */
-export interface ModalFrontstageClosedEventArgs {
-    /** Modal Frontstage being closed */
-    modalFrontstage: ModalFrontstageInfo;
-    /** Total time spent in frontstage */
-    totalTime: number;
-    /** Engagement time spent in frontstage */
-    engagementTime: number;
-    /** Idle time spent in frontstage */
-    idleTime: number;
-}
-/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was
- * pressed and passes the function to actually close the modal stage. This allows stage to do any
- * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest
- * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved
- * any unsaved data.
- * @alpha
- */
-export declare class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> {
-}
-/** Modal Frontstage RequestedClose Event Args interface.
- * @alpha
- */
-export interface ModalFrontstageRequestedCloseEventArgs {
-    /** Modal Frontstage that is to be closed */
-    modalFrontstage: ModalFrontstageInfo;
-    /** Function to call to close the stage */
-    stageCloseFunc: () => void;
-}
-/** Modal Frontstage Closed Event class.
- * @public
- */
-export declare class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> {
-}
-/** Tool Activated Event Args interface.
- * @public
- */
-export interface ToolActivatedEventArgs {
-    toolId: string;
-}
-/** Tool Activated Event class.
- * @public
- */
-export declare class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> {
-}
-/** Tool Icon Changed Event Args interface.
- * @public
- */
-export interface ToolIconChangedEventArgs {
-    iconSpec: string;
-}
-/** Tool Icon Changed Event class.
- * @public
- */
-export declare class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> {
-}
-/** Modal Frontstage information interface.
- * @public
- */
-export interface ModalFrontstageInfo {
-    title: string;
-    content: React.ReactNode;
-    appBarRight?: React.ReactNode;
-    /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so
-     * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.
-     * @alpha */
-    notifyCloseRequest?: boolean;
-}
-/** Modal Frontstage array item interface.
- * @internal
- */
-export interface ModalFrontstageItem {
-    modalFrontstage: ModalFrontstageInfo;
-    timeTracker: TimeTracker;
-}
-/**
- * [[UiFramework.frontstages]] interface
- * @beta
- */
-export interface FrameworkFrontstages {
-    /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */
-    readonly isLoading: boolean;
-    /** Get Frontstage Deactivated event. */
-    readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;
-    /** Get Frontstage Activated event. */
-    readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;
-    /** Get Frontstage Activated event. */
-    readonly onFrontstageReadyEvent: FrontstageReadyEvent;
-    /** Get Modal Frontstage Changed event. */
-    readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;
-    /** Get Modal Frontstage Closed event. */
-    readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;
-    /** Get Modal Frontstage Requested Closed event.
-     * @alpha
-     */
-    readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;
-    /** Get Tool Activated event. */
-    readonly onToolActivatedEvent: ToolActivatedEvent;
-    /** Get ToolSetting Reload event. */
-    readonly onToolSettingsReloadEvent: UiEvent<void>;
-    /** Get Tool Icon Changed event. */
-    readonly onToolIconChangedEvent: ToolIconChangedEvent;
-    /** Get Content Layout Activated event. */
-    readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;
-    /** Get Content Control Activated event. */
-    readonly onContentControlActivatedEvent: ContentControlActivatedEvent;
-    /** Get Navigation Aid Activated event. */
-    readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;
-    /** Get Widget State Changed event. */
-    readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;
-    /** Get Widget State Changed event.
-     * @alpha
-     */
-    readonly onPanelStateChangedEvent: PanelStateChangedEvent;
-    /** Clears the Frontstage map.
-     */
-    clearFrontstageDefs(): void;
-    /** Clears the Frontstage Providers and the defs that may have been created from them.
-     */
-    clearFrontstageProviders(): void;
-    /** Add a Frontstage via a [[FrontstageProvider]].
-     * @param frontstageProvider  FrontstageProvider representing the Frontstage to add
-     */
-    addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
-    /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If
-     * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and
-     * returned.
-     * @param id  Id of the Frontstage to find
-     * @returns  FrontstageDef with a given id if found, or undefined if not found.
-     */
-    getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;
-    /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.
-     * @return  Active FrontstageDef, or undefined if one is not active.
-     */
-    readonly activeFrontstageDef: FrontstageDef | undefined;
-    /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.
-     * @return  Id of the active FrontstageDef, or blank if one is not active.
-     */
-    readonly activeFrontstageId: string;
-    hasFrontstage(frontstageId: string): boolean;
-    /** Sets the active FrontstageDef give the stageId.
-     * @param  frontstageId  Id of the Frontstage to set active.
-     * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.
-     */
-    setActiveFrontstage(frontstageId: string): Promise<void>;
-    /** Sets the active FrontstageDef.
-     * @param  frontstageDef  FrontstageDef to set active.
-     * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.
-     */
-    setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void>;
-    /** Deactivates the active FrontstageDef.
-     */
-    deactivateFrontstageDef(): Promise<void>;
-    /** Gets the Id of the active tool. If a tool is not active, blank is returned.
-     * @return  Id of the active tool, or blank if one is not active.
-     */
-    readonly activeToolId: string;
-    /** Sets the active tool id */
-    setActiveToolId(toolId: string): void;
-    /** Sets the active tool */
-    setActiveTool(tool: Tool): void;
-    /** Gets the active tool's [[ToolInformation]] */
-    readonly activeToolInformation: ToolInformation | undefined;
-    /** Opens a modal Frontstage. Modal Frontstages can be stacked.
-     * @param modalFrontstage  Information about the modal Frontstage
-     */
-    openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;
-    /** Closes the top-most modal Frontstage.
-     */
-    closeModalFrontstage(): void;
-    /** Updates the top-most modal Frontstage.
-     */
-    updateModalFrontstage(): void;
-    /** Gets the top-most modal Frontstage.
-     * @returns Top-most modal Frontstage, or undefined if there is none.
-     */
-    readonly activeModalFrontstage: ModalFrontstageInfo | undefined;
-    /** Gets the number of modal Frontstages.
-     * @returns Modal Frontstage count
-     */
-    readonly modalFrontstageCount: number;
-    /** Sets the active Navigation Aid via its Id.
-     * @param navigationAidId  Id of the Navigation Aid to set as active
-     * @param iModelConnection IModelConnection to query for view data
-     */
-    setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void;
-    /** Sets the state of the widget with the given id
-     * @param widgetId  Id of the Widget for which to set the state
-     * @param state     New state of the widget
-     * @returns true if the widget state was set successfully, or false if not.
-     */
-    setWidgetState(widgetId: string, state: WidgetState): boolean;
-    /** Finds a widget with the given id in the active frontstage
-     * @param widgetId  Id of the Widget to find
-     * @returns The WidgetDef with the given id, or undefined if not found.
-     */
-    findWidget(widgetId: string): WidgetDef | undefined;
-    /** Opens a nested Frontstage. Nested Frontstages can be stacked.
-     * @param nestedFrontstage  Information about the nested Frontstage
-     */
-    openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;
-    /** Closes the top-most nested Frontstage.
-     */
-    closeNestedFrontstage(): Promise<void>;
-    /** Gets the top-most nested Frontstage.
-     * @returns Top-most nested Frontstage, or undefined if there is none.
-     */
-    readonly activeNestedFrontstage: FrontstageDef | undefined;
-    /** Gets the number of nested Frontstages.
-     * @returns Nested Frontstage count
-     */
-    readonly nestedFrontstageCount: number;
-}
+/// <reference types="react" />
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import { UiEvent } from "@itwin/appui-abstract";
+import { IModelConnection, Tool } from "@itwin/core-frontend";
+import { ToolInformation } from "../toolsettings/ToolInformation";
+import { TimeTracker } from "../configurableui/TimeTracker";
+import { ContentControlActivatedEvent } from "../content/ContentControl";
+import { ContentLayoutActivatedEvent } from "../content/ContentLayout";
+import { FrontstageDef } from "../frontstage/FrontstageDef";
+import { FrontstageProvider } from "../frontstage/FrontstageProvider";
+import { NavigationAidActivatedEvent } from "../navigationaids/NavigationAidControl";
+import { PanelPinnedChangedEventArgs, PanelStateChangedEvent } from "../stagepanels/StagePanelDef";
+import { WidgetDef, WidgetStateChangedEvent } from "../widgets/WidgetDef";
+import { WidgetState } from "../widgets/WidgetState";
+/** Frontstage Activated Event Args interface.
+ * @public
+ */
+export interface FrontstageActivatedEventArgs {
+    deactivatedFrontstageDef?: FrontstageDef;
+    activatedFrontstageDef: FrontstageDef;
+}
+/** Frontstage Activated Event class.
+ * @public
+ */
+export declare class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> {
+}
+/** Frontstage Deactivated Event Args interface.
+ * @public
+ */
+export interface FrontstageDeactivatedEventArgs {
+    /** Frontstage being deactivated */
+    deactivatedFrontstageDef: FrontstageDef;
+    /** Frontstage being activated */
+    activatedFrontstageDef?: FrontstageDef;
+    /** Total time spent in frontstage */
+    totalTime: number;
+    /** Engagement time spent in frontstage */
+    engagementTime: number;
+    /** Idle time spent in frontstage */
+    idleTime: number;
+}
+/** Frontstage Deactivated Event class.
+ * @public
+ */
+export declare class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> {
+}
+/** Frontstage Ready Event Args interface.
+ * @public
+ */
+export interface FrontstageReadyEventArgs {
+    frontstageDef: FrontstageDef;
+}
+/** Frontstage Ready Event class.
+ * @public
+ */
+export declare class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> {
+}
+/** Modal Frontstage Changed Event Args interface.
+ * @public
+ */
+export interface ModalFrontstageChangedEventArgs {
+    modalFrontstageCount: number;
+}
+/** Modal Frontstage Stack Changed Event class.
+ * @public
+ */
+export declare class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> {
+}
+/** Modal Frontstage Closed Event Args interface.
+ * @public
+ */
+export interface ModalFrontstageClosedEventArgs {
+    /** Modal Frontstage being closed */
+    modalFrontstage: ModalFrontstageInfo;
+    /** Total time spent in frontstage */
+    totalTime: number;
+    /** Engagement time spent in frontstage */
+    engagementTime: number;
+    /** Idle time spent in frontstage */
+    idleTime: number;
+}
+/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was
+ * pressed and passes the function to actually close the modal stage. This allows stage to do any
+ * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest
+ * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved
+ * any unsaved data.
+ * @alpha
+ */
+export declare class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> {
+}
+/** Modal Frontstage RequestedClose Event Args interface.
+ * @alpha
+ */
+export interface ModalFrontstageRequestedCloseEventArgs {
+    /** Modal Frontstage that is to be closed */
+    modalFrontstage: ModalFrontstageInfo;
+    /** Function to call to close the stage */
+    stageCloseFunc: () => void;
+}
+/** Modal Frontstage Closed Event class.
+ * @public
+ */
+export declare class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> {
+}
+/** Tool Activated Event Args interface.
+ * @public
+ */
+export interface ToolActivatedEventArgs {
+    toolId: string;
+}
+/** Tool Activated Event class.
+ * @public
+ */
+export declare class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> {
+}
+/** Tool Icon Changed Event Args interface.
+ * @public
+ */
+export interface ToolIconChangedEventArgs {
+    iconSpec: string;
+}
+/** Tool Icon Changed Event class.
+ * @public
+ */
+export declare class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> {
+}
+/** Modal Frontstage information interface.
+ * @public
+ */
+export interface ModalFrontstageInfo {
+    title: string;
+    content: React.ReactNode;
+    appBarRight?: React.ReactNode;
+    /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so
+     * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.
+     * @alpha */
+    notifyCloseRequest?: boolean;
+}
+/** Modal Frontstage array item interface.
+ * @internal
+ */
+export interface ModalFrontstageItem {
+    modalFrontstage: ModalFrontstageInfo;
+    timeTracker: TimeTracker;
+}
+/**
+ * [[UiFramework.frontstages]] interface
+ * @public
+ */
+export interface FrameworkFrontstages {
+    /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */
+    readonly isLoading: boolean;
+    /** Get Frontstage Deactivated event. */
+    readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;
+    /** Get Frontstage Activated event. */
+    readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;
+    /** Get Frontstage Activated event. */
+    readonly onFrontstageReadyEvent: FrontstageReadyEvent;
+    /** Get Modal Frontstage Changed event. */
+    readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;
+    /** Get Modal Frontstage Closed event. */
+    readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;
+    /** Get Modal Frontstage Requested Closed event.
+     * @alpha
+     */
+    readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;
+    /** Get Tool Activated event. */
+    readonly onToolActivatedEvent: ToolActivatedEvent;
+    /** Get ToolSetting Reload event. */
+    readonly onToolSettingsReloadEvent: UiEvent<void>;
+    /** Get Tool Icon Changed event. */
+    readonly onToolIconChangedEvent: ToolIconChangedEvent;
+    /** Get Content Layout Activated event. */
+    readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;
+    /** Get Content Control Activated event. */
+    readonly onContentControlActivatedEvent: ContentControlActivatedEvent;
+    /** Get Navigation Aid Activated event. */
+    readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;
+    /** Get Widget State Changed event. */
+    readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;
+    /** Get panel state changed event.
+     * @alpha
+     */
+    readonly onPanelStateChangedEvent: PanelStateChangedEvent;
+    /** Get panel pinned changed event.
+     * @alpha
+     */
+    readonly onPanelPinnedChangedEvent: UiEvent<PanelPinnedChangedEventArgs>;
+    /** Clears the Frontstage map.
+     */
+    clearFrontstageDefs(): void;
+    /** Clears the Frontstage Providers and the defs that may have been created from them.
+     */
+    clearFrontstageProviders(): void;
+    /** Add a Frontstage via a [[FrontstageProvider]].
+     * @param frontstageProvider  FrontstageProvider representing the Frontstage to add
+     */
+    addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If
+     * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and
+     * returned.
+     * @param id  Id of the Frontstage to find
+     * @returns  FrontstageDef with a given id if found, or undefined if not found.
+     */
+    getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;
+    /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.
+     * @return  Active FrontstageDef, or undefined if one is not active.
+     */
+    readonly activeFrontstageDef: FrontstageDef | undefined;
+    /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.
+     * @return  Id of the active FrontstageDef, or blank if one is not active.
+     */
+    readonly activeFrontstageId: string;
+    hasFrontstage(frontstageId: string): boolean;
+    /** Sets the active FrontstageDef give the stageId.
+     * @param  frontstageId  Id of the Frontstage to set active.
+     * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.
+     */
+    setActiveFrontstage(frontstageId: string): Promise<void>;
+    /** Sets the active FrontstageDef.
+     * @param  frontstageDef  FrontstageDef to set active.
+     * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.
+     */
+    setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void>;
+    /** Deactivates the active FrontstageDef.
+     */
+    deactivateFrontstageDef(): Promise<void>;
+    /** Gets the Id of the active tool. If a tool is not active, blank is returned.
+     * @return  Id of the active tool, or blank if one is not active.
+     */
+    readonly activeToolId: string;
+    /** Sets the active tool id */
+    setActiveToolId(toolId: string): void;
+    /** Sets the active tool */
+    setActiveTool(tool: Tool): void;
+    /** Gets the active tool's [[ToolInformation]] */
+    readonly activeToolInformation: ToolInformation | undefined;
+    /** Opens a modal Frontstage. Modal Frontstages can be stacked.
+     * @param modalFrontstage  Information about the modal Frontstage
+     */
+    openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;
+    /** Closes the top-most modal Frontstage.
+     */
+    closeModalFrontstage(): void;
+    /** Updates the top-most modal Frontstage.
+     */
+    updateModalFrontstage(): void;
+    /** Gets the top-most modal Frontstage.
+     * @returns Top-most modal Frontstage, or undefined if there is none.
+     */
+    readonly activeModalFrontstage: ModalFrontstageInfo | undefined;
+    /** Gets the number of modal Frontstages.
+     * @returns Modal Frontstage count
+     */
+    readonly modalFrontstageCount: number;
+    /** Sets the active Navigation Aid via its Id.
+     * @param navigationAidId  Id of the Navigation Aid to set as active
+     * @param iModelConnection IModelConnection to query for view data
+     */
+    setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void;
+    /** Sets the state of the widget with the given id
+     * @param widgetId  Id of the Widget for which to set the state
+     * @param state     New state of the widget
+     * @returns true if the widget state was set successfully, or false if not.
+     */
+    setWidgetState(widgetId: string, state: WidgetState): boolean;
+    /** Finds a widget with the given id in the active frontstage
+     * @param widgetId  Id of the Widget to find
+     * @returns The WidgetDef with the given id, or undefined if not found.
+     */
+    findWidget(widgetId: string): WidgetDef | undefined;
+    /** Opens a nested Frontstage. Nested Frontstages can be stacked.
+     * @param nestedFrontstage  Information about the nested Frontstage
+     */
+    openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;
+    /** Closes the top-most nested Frontstage.
+     */
+    closeNestedFrontstage(): Promise<void>;
+    /** Gets the top-most nested Frontstage.
+     * @returns Top-most nested Frontstage, or undefined if there is none.
+     */
+    readonly activeNestedFrontstage: FrontstageDef | undefined;
+    /** Gets the number of nested Frontstages.
+     * @returns Nested Frontstage count
+     */
+    readonly nestedFrontstageCount: number;
+}
 //# sourceMappingURL=FrameworkFrontstages.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FrameworkFrontstages.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,sBAAsB,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;CAAI;AAEvF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,mCAAmC;IACnC,wBAAwB,EAAE,aAAa,CAAC;IACxC,iCAAiC;IACjC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IAEvC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAI;AAE7F;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oCAAoC;IACpC,eAAe,EAAE,mBAAmB,CAAC;IAErC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,kCAAmC,SAAQ,OAAO,CAAC,sCAAsC,CAAC;CAAI;AAE3G;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,eAAe,EAAE,mBAAmB,CAAC;IACrC,0CAA0C;IAC1C,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B;;gBAEY;IACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0HAA0H;IAC1H,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE,sCAAsC;IACtC,QAAQ,CAAC,0BAA0B,EAAE,wBAAwB,CAAC;IAE9D,sCAAsC;IACtC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,yCAAyC;IACzC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,oCAAoC,EAAE,kCAAkC,CAAC;IAElF,gCAAgC;IAChC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAElD,oCAAoC;IACpC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,mCAAmC;IACnC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,2CAA2C;IAC3C,QAAQ,CAAC,8BAA8B,EAAE,4BAA4B,CAAC;IAEtE,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,sCAAsC;IACtC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAE5D;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAE1D;OACG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;OACG;IACH,wBAAwB,IAAI,IAAI,CAAC;IAEjC;;OAEG;IACH,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,aAAa,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;OACG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,8BAA8B;IAC9B,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,2BAA2B;IAC3B,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAEhC,iDAAiD;IACjD,QAAQ,CAAC,qBAAqB,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEhE;OACG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;OACG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,sBAAsB,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1F;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC;IAE9D;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;OACG;IACH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;CACxC"}
+{"version":3,"file":"FrameworkFrontstages.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,sBAAsB,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;CAAI;AAEvF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,mCAAmC;IACnC,wBAAwB,EAAE,aAAa,CAAC;IACxC,iCAAiC;IACjC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IAEvC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAI;AAE7F;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oCAAoC;IACpC,eAAe,EAAE,mBAAmB,CAAC;IAErC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,kCAAmC,SAAQ,OAAO,CAAC,sCAAsC,CAAC;CAAI;AAE3G;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,eAAe,EAAE,mBAAmB,CAAC;IACrC,0CAA0C;IAC1C,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B;;gBAEY;IACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0HAA0H;IAC1H,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE,sCAAsC;IACtC,QAAQ,CAAC,0BAA0B,EAAE,wBAAwB,CAAC;IAE9D,sCAAsC;IACtC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,yCAAyC;IACzC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,oCAAoC,EAAE,kCAAkC,CAAC;IAElF,gCAAgC;IAChC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAElD,oCAAoC;IACpC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,mCAAmC;IACnC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,2CAA2C;IAC3C,QAAQ,CAAC,8BAA8B,EAAE,4BAA4B,CAAC;IAEtE,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,sCAAsC;IACtC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAE5D;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAE1D;;OAEG;IACH,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEzE;OACG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;OACG;IACH,wBAAwB,IAAI,IAAI,CAAC;IAEjC;;OAEG;IACH,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,aAAa,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;OACG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,8BAA8B;IAC9B,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,2BAA2B;IAC3B,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAEhC,iDAAiD;IACjD,QAAQ,CAAC,qBAAqB,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEhE;OACG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;OACG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,sBAAsB,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1F;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC;IAE9D;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;OACG;IACH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;CACxC"}