@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.13

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

@@ -1,37 +1,37 @@
-/// <reference types="react" />
-/** @packageDocumentation
- * @module Utilities
- */
-/**
- * [[UiFramework.visibility]] interface
- * @beta
- */
-export interface FrameworkVisibility {
-    /** Determines if the Ui is visible */
-    isUiVisible: boolean;
-    /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.
-     * When true, the Ui automatically hides after a few seconds of inactivity.
-     */
-    autoHideUi: boolean;
-    /** Determines whether the widget panels are shown and hidden. Defaults to false. */
-    showHidePanels: boolean;
-    /** Determines whether the status bar is shown and hidden. Defaults to false. */
-    showHideFooter: boolean;
-    /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
-    inactivityTime: number;
-    /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
-    useProximityOpacity: boolean;
-    /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
-    snapWidgetOpacity: boolean;
-    /** Handler for when a Frontstage is ready */
-    handleFrontstageReady(): void;
-    /** Handler for when the mouse moves over the content area */
-    handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
-    /** Handler for when the mouse enters a widget */
-    handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
-    /** Shows the Ui and resets the inactivity timer */
-    showUiAndResetTimer(): void;
-    /** Shows the Ui and cancels the inactivity timer */
-    showUiAndCancelTimer(): void;
-}
+/// <reference types="react" />
+/** @packageDocumentation
+ * @module Utilities
+ */
+/**
+ * [[UiFramework.visibility]] interface
+ * @beta
+ */
+export interface FrameworkVisibility {
+    /** Determines if the Ui is visible */
+    isUiVisible: boolean;
+    /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.
+     * When true, the Ui automatically hides after a few seconds of inactivity.
+     */
+    autoHideUi: boolean;
+    /** Determines whether the widget panels are shown and hidden. Defaults to false. */
+    showHidePanels: boolean;
+    /** Determines whether the status bar is shown and hidden. Defaults to false. */
+    showHideFooter: boolean;
+    /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
+    inactivityTime: number;
+    /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
+    useProximityOpacity: boolean;
+    /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
+    snapWidgetOpacity: boolean;
+    /** Handler for when a Frontstage is ready */
+    handleFrontstageReady(): void;
+    /** Handler for when the mouse moves over the content area */
+    handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
+    /** Handler for when the mouse enters a widget */
+    handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
+    /** Shows the Ui and resets the inactivity timer */
+    showUiAndResetTimer(): void;
+    /** Shows the Ui and cancels the inactivity timer */
+    showUiAndCancelTimer(): void;
+}
 //# sourceMappingURL=FrameworkVisibility.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkVisibility.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=FrameworkVisibility.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"FrameworkVisibility.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkVisibility.ts"],"names":[],"mappings":"","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utilities\r\n */\r\n/**\r\n * [[UiFramework.visibility]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkVisibility {\r\n  /** Determines if the Ui is visible */\r\n  isUiVisible: boolean;\r\n\r\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\r\n   * When true, the Ui automatically hides after a few seconds of inactivity.\r\n   */\r\n  autoHideUi: boolean;\r\n\r\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\r\n  showHidePanels: boolean;\r\n\r\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\r\n  showHideFooter: boolean;\r\n\r\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\r\n  inactivityTime: number;\r\n\r\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\r\n  useProximityOpacity: boolean;\r\n\r\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\r\n  snapWidgetOpacity: boolean;\r\n\r\n  /** Handler for when a Frontstage is ready */\r\n  handleFrontstageReady(): void;\r\n\r\n  /** Handler for when the mouse moves over the content area */\r\n  handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;\r\n\r\n  /** Handler for when the mouse enters a widget */\r\n  handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;\r\n\r\n  /** Shows the Ui and resets the inactivity timer */\r\n  showUiAndResetTimer(): void;\r\n\r\n  /** Shows the Ui and cancels the inactivity timer */\r\n  showUiAndCancelTimer(): void;\r\n}\r\n"]}
+{"version":3,"file":"FrameworkVisibility.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkVisibility.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 Utilities\n */\n/**\n * [[UiFramework.visibility]] interface\n * @beta\n */\nexport interface FrameworkVisibility {\n  /** Determines if the Ui is visible */\n  isUiVisible: boolean;\n\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\n   * When true, the Ui automatically hides after a few seconds of inactivity.\n   */\n  autoHideUi: boolean;\n\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\n  showHidePanels: boolean;\n\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\n  showHideFooter: boolean;\n\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\n  inactivityTime: number;\n\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\n  useProximityOpacity: boolean;\n\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\n  snapWidgetOpacity: boolean;\n\n  /** Handler for when a Frontstage is ready */\n  handleFrontstageReady(): void;\n\n  /** Handler for when the mouse moves over the content area */\n  handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;\n\n  /** Handler for when the mouse enters a widget */\n  handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;\n\n  /** Shows the Ui and resets the inactivity timer */\n  showUiAndResetTimer(): void;\n\n  /** Shows the Ui and cancels the inactivity timer */\n  showUiAndCancelTimer(): void;\n}\n"]}

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

@@ -1,40 +1,40 @@
-/** @packageDocumentation
- * @module Frontstage
- */
-import { CommonProps } from "@itwin/core-react";
-import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
-import { StagePanelConfig } from "../stagepanels/StagePanelConfig";
-import { WidgetConfig } from "../widgets/WidgetConfig";
-/** Configuration from which a frontstage is created.
- * @public
- */
-export interface FrontstageConfig extends CommonProps {
-    /** Id for the Frontstage */
-    readonly id: string;
-    /** The Content Group providing the Content Views */
-    readonly contentGroup: ContentGroup | ContentGroupProvider;
-    /** Usage type for this Frontstage. */
-    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.
-     * Increasing the value will make sure to reinitialize App layout instead of restoring to old layout.
-     */
-    readonly version: number;
-    /** The top-left corner that shows tools typically used to query and modify content. */
-    readonly contentManipulation?: WidgetConfig;
-    /** The settings of the active tool. */
-    readonly toolSettings?: WidgetConfig;
-    /** The top-right corner that shows view navigation tools. */
-    readonly viewNavigation?: WidgetConfig;
-    /** The status bar of the application. */
-    readonly statusBar?: WidgetConfig;
-    /** Top panel of the application. */
-    readonly topPanel?: StagePanelConfig;
-    /** Left panel of the application. */
-    readonly leftPanel?: StagePanelConfig;
-    /** Right panel of the application. */
-    readonly rightPanel?: StagePanelConfig;
-    /** Bottom panel of the application. */
-    readonly bottomPanel?: StagePanelConfig;
-}
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import { CommonProps } from "@itwin/core-react";
+import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
+import { StagePanelConfig } from "../stagepanels/StagePanelConfig";
+import { WidgetConfig } from "../widgets/WidgetConfig";
+/** Configuration from which a frontstage is created.
+ * @public
+ */
+export interface FrontstageConfig extends CommonProps {
+    /** Id for the Frontstage */
+    readonly id: string;
+    /** The Content Group providing the Content Views */
+    readonly contentGroup: ContentGroup | ContentGroupProvider;
+    /** Usage type for this Frontstage. */
+    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.
+     * Increasing the value will make sure to reinitialize App layout instead of restoring to old layout.
+     */
+    readonly version: number;
+    /** The top-left corner that shows tools typically used to query and modify content. */
+    readonly contentManipulation?: WidgetConfig;
+    /** The settings of the active tool. */
+    readonly toolSettings?: WidgetConfig;
+    /** The top-right corner that shows view navigation tools. */
+    readonly viewNavigation?: WidgetConfig;
+    /** The status bar of the application. */
+    readonly statusBar?: WidgetConfig;
+    /** Top panel of the application. */
+    readonly topPanel?: StagePanelConfig;
+    /** Left panel of the application. */
+    readonly leftPanel?: StagePanelConfig;
+    /** Right panel of the application. */
+    readonly rightPanel?: StagePanelConfig;
+    /** Bottom panel of the application. */
+    readonly bottomPanel?: StagePanelConfig;
+}
 //# sourceMappingURL=FrontstageConfig.d.ts.map

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Frontstage
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Frontstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=FrontstageConfig.js.map

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;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Frontstage\r\n */\r\n\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { ContentGroup, ContentGroupProvider } from \"../content/ContentGroup\";\r\nimport { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\r\nimport { WidgetConfig } from \"../widgets/WidgetConfig\";\r\n\r\n/** Configuration from which a frontstage is created.\r\n * @public\r\n */\r\nexport interface FrontstageConfig extends CommonProps {\r\n  /** Id for the Frontstage */\r\n  readonly id: string;\r\n  /** The Content Group providing the Content Views */\r\n  readonly contentGroup: ContentGroup | ContentGroupProvider;\r\n  /** Usage type for this Frontstage. */\r\n  readonly usage?: string;\r\n  /** Frontstage version. Used to force saved layout reinitialization after changes to frontstage.\r\n   * @note This value should be increased when changes are made to the Frontstage.\r\n   * Increasing the value will make sure to reinitialize App layout instead of restoring to old layout.\r\n   */\r\n  readonly version: number;\r\n\r\n  /** The top-left corner that shows tools typically used to query and modify content. */\r\n  readonly contentManipulation?: WidgetConfig;\r\n  /** The settings of the active tool. */\r\n  readonly toolSettings?: WidgetConfig;\r\n  /** The top-right corner that shows view navigation tools. */\r\n  readonly viewNavigation?: WidgetConfig;\r\n  /** The status bar of the application. */\r\n  readonly statusBar?: WidgetConfig;\r\n\r\n  /** Top panel of the application. */\r\n  readonly topPanel?: StagePanelConfig;\r\n  /** Left panel of the application. */\r\n  readonly leftPanel?: StagePanelConfig;\r\n  /** Right panel of the application. */\r\n  readonly rightPanel?: StagePanelConfig;\r\n  /** Bottom panel of the application. */\r\n  readonly bottomPanel?: StagePanelConfig;\r\n}\r\n"]}
+{"version":3,"file":"FrontstageConfig.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageConfig.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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 { CommonProps } from \"@itwin/core-react\";\nimport { ContentGroup, ContentGroupProvider } from \"../content/ContentGroup\";\nimport { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\nimport { WidgetConfig } from \"../widgets/WidgetConfig\";\n\n/** Configuration from which a frontstage is created.\n * @public\n */\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\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

@@ -1,206 +1,206 @@
-/** @packageDocumentation
- * @module Frontstage
- */
-import { ScreenViewport } from "@itwin/core-frontend";
-import { PointProps } from "@itwin/appui-abstract";
-import { RectangleProps, SizeProps } from "@itwin/core-react";
-import { NineZoneState } from "@itwin/appui-layout-react";
-import { ContentControl } from "../content/ContentControl";
-import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
-import { ContentLayoutDef } from "../content/ContentLayout";
-import { StagePanelDef, StagePanelState } from "../stagepanels/StagePanelDef";
-import { WidgetDef } from "../widgets/WidgetDef";
-import { FrontstageProvider } from "./FrontstageProvider";
-import { TimeTracker } from "../configurableui/TimeTracker";
-import { SavedWidgets } from "../widget-panels/Frontstage";
-import { FrontstageConfig } from "./FrontstageConfig";
-import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
-import { WidgetState } from "../widgets/WidgetState";
-/** @internal */
-export interface FrontstageEventArgs {
-    frontstageDef: FrontstageDef;
-}
-/** @internal */
-export interface FrontstageNineZoneStateChangedEventArgs extends FrontstageEventArgs {
-    state: NineZoneState | undefined;
-}
-/** FrontstageDef class provides an API for a Frontstage.
- * @public
- */
-export declare class FrontstageDef {
-    private _id;
-    private _initialConfig?;
-    private _isStageClosing;
-    private _isReady;
-    private _isApplicationClosing;
-    private _usage?;
-    private _version;
-    private _toolSettings?;
-    private _statusBar?;
-    private _contentManipulation?;
-    private _viewNavigation?;
-    private _topPanel?;
-    private _leftPanel?;
-    private _rightPanel?;
-    private _bottomPanel?;
-    private _contentLayoutDef?;
-    private _contentGroup?;
-    private _frontstageProvider?;
-    private _timeTracker;
-    private _nineZoneState?;
-    private _contentGroupProvider?;
-    private _floatingContentControls?;
-    private _savedWidgetDefs?;
-    get id(): string;
-    get usage(): string;
-    get version(): number;
-    get contentGroupProvider(): ContentGroupProvider | undefined;
-    get floatingContentControls(): ContentControl[] | undefined;
-    get toolSettings(): WidgetDef | undefined;
-    get statusBar(): WidgetDef | undefined;
-    get contentManipulation(): WidgetDef | undefined;
-    get viewNavigation(): WidgetDef | undefined;
-    get topPanel(): StagePanelDef | undefined;
-    get leftPanel(): StagePanelDef | undefined;
-    get rightPanel(): StagePanelDef | undefined;
-    get bottomPanel(): StagePanelDef | undefined;
-    get contentLayoutDef(): ContentLayoutDef | undefined;
-    get contentGroup(): ContentGroup | undefined;
-    get frontstageProvider(): FrontstageProvider | undefined;
-    private toStagePanelLocation;
-    private populateStateMaps;
-    private triggerStateChangeEventForWidgetsAndPanels;
-    /** @internal */
-    get nineZoneState(): NineZoneState | undefined;
-    set nineZoneState(state: NineZoneState | undefined);
-    /** @internal */
-    get savedWidgetDefs(): SavedWidgets | undefined;
-    set savedWidgetDefs(widgets: SavedWidgets | undefined);
-    /** @internal */
-    get timeTracker(): TimeTracker;
-    /** Created a [[FrontstageDef]] and initialize it */
-    static create(provider: FrontstageProvider): Promise<FrontstageDef>;
-    /** Handles when the Frontstage becomes activated */
-    protected _onActivated(): Promise<void>;
-    /** Handles when the Frontstage becomes activated */
-    onActivated(): Promise<void>;
-    /** Handles when the Frontstage becomes inactive */
-    protected _onDeactivated(): Promise<void>;
-    /** Handles when the Frontstage becomes inactive */
-    onDeactivated(): Promise<void>;
-    /** @internal */
-    setIsApplicationClosing(value: boolean): void;
-    /** Returns once the contained widgets and content controls are ready to use */
-    waitUntilReady(): Promise<void>;
-    /** Handles when the Frontstage becomes active */
-    protected _onFrontstageReady(): void;
-    /** Handles when the Frontstage becomes active */
-    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 */
-    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
-     */
-    getStagePanelDef(location: StagePanelLocation): StagePanelDef | undefined;
-    /** Gets a list of [[StagePanelDef]]s
-     * @beta
-     */
-    get panelDefs(): StagePanelDef[];
-    /** Finds a [[WidgetDef]] based on a given id */
-    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 FrontstageConfig.
-     * @internal
-     */
-    initializeFromConfig(config: FrontstageConfig): Promise<void>;
-    /** @internal */
-    updateWidgetDefs(): void;
-    /** @beta */
-    restoreLayout(): void;
-    /** Used only in UI 2.0 to determine WidgetState from NinezoneState
-     *  @internal
-     */
-    getWidgetCurrentState(widgetDef: WidgetDef): WidgetState | undefined;
-    /** Used only in UI 2.0 to determine StagePanelState and size from NinezoneState
-     *  @internal
-     */
-    getPanelCurrentState(panelDef: StagePanelDef): [StagePanelState, number];
-    isPopoutWidget(widgetId: string): boolean;
-    isFloatingWidget(widgetId: string): boolean;
-    /** Create a new floating panel that contains the widget specified by its Id. Supported only when in
-     *  UI 2.0 or higher.
-     * @param widgetId case sensitive Widget Id
-     * @param point Position of top left corner of floating panel in pixels. If undefined {x:50, y:100} is used.
-     * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
-     * the previous size is used, else {height:400, width:400} is used.
-     * @beta
-     */
-    floatWidget(widgetId: string, point?: PointProps, size?: SizeProps): void;
-    /** Check widget and panel state to determine whether the widget is currently displayed
-     * @param widgetId case-sensitive Widget Id
-     * @public
-     */
-    isWidgetDisplayed(widgetId: string): boolean;
-    /** Opens window for specified PopoutWidget container. Used to reopen popout when running in Electron.
-     * @internal */
-    openPopoutWidgetContainer(state: NineZoneState, widgetContainerId: string): void;
-    /** Create a new popout/child window that contains the widget specified by its Id. Supported only when in
-     *  UI 2.0 or higher.
-     * @param widgetId case sensitive Widget Id
-     * @param point Position of top left corner of floating panel in pixels. If undefined {x:0, y:0} is used.
-     * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
-     * the previous size is used, else {height:800, width:600} is used.
-     * @beta
-     */
-    popoutWidget(widgetId: string, point?: PointProps, size?: SizeProps): void;
-    get isStageClosing(): boolean;
-    get isApplicationClosing(): boolean;
-    get isReady(): boolean;
-    /** @internal */
-    saveChildWindowSizeAndPosition(childWindowId: string, childWindow: Window): void;
-    /** Method used to possibly change a Popout Widget back to a docked widget if the user was the one closing the popout's child
-     * window.
-     *  @internal
-     */
-    dockPopoutWidgetContainer(widgetContainerId: string): void;
-    /** Finds the container with the specified widget and re-docks all widgets
-     * back to the panel zone location that was used when the floating container
-     * was generated. Supported only when in UI 2.0 or higher.
-     * @param widgetId  case sensitive Widget Id.
-     * @beta
-     */
-    dockWidgetContainer(widgetId: string): void;
-    setFloatingWidgetContainerBounds(floatingWidgetId: string, bounds: RectangleProps): boolean;
-    getFloatingWidgetContainerIds(): string[];
-    getFloatingWidgetContainerIdByWidgetId(widgetId: string): string | undefined;
-    getFloatingWidgetContainerBounds(floatingWidgetId: string | undefined): RectangleProps | undefined;
-    private _widgetDefs;
-    /** Iterable of all widget definitions in a frontstage.
-     * @internal
-     */
-    get widgetDefs(): {
-        [Symbol.iterator](): Iterator<WidgetDef, any, undefined>;
-    };
-}
-/** Hook that returns active frontstage id.
- * @public
- */
-export declare const useActiveFrontstageId: () => string;
-/** @internal */
-export declare function useActiveFrontstageDef(): FrontstageDef | undefined;
-/** Hook that returns the widgetDef for a specific widgetId within the active frontstage.
- * @public
- */
-export declare function useSpecificWidgetDef(widgetId: string): WidgetDef | undefined;
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import { ScreenViewport } from "@itwin/core-frontend";
+import { PointProps } from "@itwin/appui-abstract";
+import { RectangleProps, SizeProps } from "@itwin/core-react";
+import { NineZoneState } from "@itwin/appui-layout-react";
+import { ContentControl } from "../content/ContentControl";
+import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
+import { ContentLayoutDef } from "../content/ContentLayout";
+import { StagePanelDef, StagePanelState } from "../stagepanels/StagePanelDef";
+import { WidgetDef } from "../widgets/WidgetDef";
+import { FrontstageProvider } from "./FrontstageProvider";
+import { TimeTracker } from "../configurableui/TimeTracker";
+import { SavedWidgets } from "../widget-panels/Frontstage";
+import { FrontstageConfig } from "./FrontstageConfig";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
+import { WidgetState } from "../widgets/WidgetState";
+/** @internal */
+export interface FrontstageEventArgs {
+    frontstageDef: FrontstageDef;
+}
+/** @internal */
+export interface FrontstageNineZoneStateChangedEventArgs extends FrontstageEventArgs {
+    state: NineZoneState | undefined;
+}
+/** FrontstageDef class provides an API for a Frontstage.
+ * @public
+ */
+export declare class FrontstageDef {
+    private _id;
+    private _initialConfig?;
+    private _isStageClosing;
+    private _isReady;
+    private _isApplicationClosing;
+    private _usage?;
+    private _version;
+    private _toolSettings?;
+    private _statusBar?;
+    private _contentManipulation?;
+    private _viewNavigation?;
+    private _topPanel?;
+    private _leftPanel?;
+    private _rightPanel?;
+    private _bottomPanel?;
+    private _contentLayoutDef?;
+    private _contentGroup?;
+    private _frontstageProvider?;
+    private _timeTracker;
+    private _nineZoneState?;
+    private _contentGroupProvider?;
+    private _floatingContentControls?;
+    private _savedWidgetDefs?;
+    get id(): string;
+    get usage(): string;
+    get version(): number;
+    get contentGroupProvider(): ContentGroupProvider | undefined;
+    get floatingContentControls(): ContentControl[] | undefined;
+    get toolSettings(): WidgetDef | undefined;
+    get statusBar(): WidgetDef | undefined;
+    get contentManipulation(): WidgetDef | undefined;
+    get viewNavigation(): WidgetDef | undefined;
+    get topPanel(): StagePanelDef | undefined;
+    get leftPanel(): StagePanelDef | undefined;
+    get rightPanel(): StagePanelDef | undefined;
+    get bottomPanel(): StagePanelDef | undefined;
+    get contentLayoutDef(): ContentLayoutDef | undefined;
+    get contentGroup(): ContentGroup | undefined;
+    get frontstageProvider(): FrontstageProvider | undefined;
+    private toStagePanelLocation;
+    private populateStateMaps;
+    private triggerStateChangeEventForWidgetsAndPanels;
+    /** @internal */
+    get nineZoneState(): NineZoneState | undefined;
+    set nineZoneState(state: NineZoneState | undefined);
+    /** @internal */
+    get savedWidgetDefs(): SavedWidgets | undefined;
+    set savedWidgetDefs(widgets: SavedWidgets | undefined);
+    /** @internal */
+    get timeTracker(): TimeTracker;
+    /** Created a [[FrontstageDef]] and initialize it */
+    static create(provider: FrontstageProvider): Promise<FrontstageDef>;
+    /** Handles when the Frontstage becomes activated */
+    protected _onActivated(): Promise<void>;
+    /** Handles when the Frontstage becomes activated */
+    onActivated(): Promise<void>;
+    /** Handles when the Frontstage becomes inactive */
+    protected _onDeactivated(): Promise<void>;
+    /** Handles when the Frontstage becomes inactive */
+    onDeactivated(): Promise<void>;
+    /** @internal */
+    setIsApplicationClosing(value: boolean): void;
+    /** Returns once the contained widgets and content controls are ready to use */
+    waitUntilReady(): Promise<void>;
+    /** Handles when the Frontstage becomes active */
+    protected _onFrontstageReady(): void;
+    /** Handles when the Frontstage becomes active */
+    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 */
+    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
+     */
+    getStagePanelDef(location: StagePanelLocation): StagePanelDef | undefined;
+    /** Gets a list of [[StagePanelDef]]s
+     * @beta
+     */
+    get panelDefs(): StagePanelDef[];
+    /** Finds a [[WidgetDef]] based on a given id */
+    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 FrontstageConfig.
+     * @internal
+     */
+    initializeFromConfig(config: FrontstageConfig): Promise<void>;
+    /** @internal */
+    updateWidgetDefs(): void;
+    /** @beta */
+    restoreLayout(): void;
+    /** Used only in UI 2.0 to determine WidgetState from NinezoneState
+     *  @internal
+     */
+    getWidgetCurrentState(widgetDef: WidgetDef): WidgetState | undefined;
+    /** Used only in UI 2.0 to determine StagePanelState and size from NinezoneState
+     *  @internal
+     */
+    getPanelCurrentState(panelDef: StagePanelDef): [StagePanelState, number];
+    isPopoutWidget(widgetId: string): boolean;
+    isFloatingWidget(widgetId: string): boolean;
+    /** Create a new floating panel that contains the widget specified by its Id. Supported only when in
+     *  UI 2.0 or higher.
+     * @param widgetId case sensitive Widget Id
+     * @param point Position of top left corner of floating panel in pixels. If undefined {x:50, y:100} is used.
+     * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
+     * the previous size is used, else {height:400, width:400} is used.
+     * @beta
+     */
+    floatWidget(widgetId: string, point?: PointProps, size?: SizeProps): void;
+    /** Check widget and panel state to determine whether the widget is currently displayed
+     * @param widgetId case-sensitive Widget Id
+     * @public
+     */
+    isWidgetDisplayed(widgetId: string): boolean;
+    /** Opens window for specified PopoutWidget container. Used to reopen popout when running in Electron.
+     * @internal */
+    openPopoutWidgetContainer(state: NineZoneState, widgetContainerId: string): void;
+    /** Create a new popout/child window that contains the widget specified by its Id. Supported only when in
+     *  UI 2.0 or higher.
+     * @param widgetId case sensitive Widget Id
+     * @param point Position of top left corner of floating panel in pixels. If undefined {x:0, y:0} is used.
+     * @param size defines the width and height of the floating panel. If undefined and widget has been floated before
+     * the previous size is used, else {height:800, width:600} is used.
+     * @beta
+     */
+    popoutWidget(widgetId: string, point?: PointProps, size?: SizeProps): void;
+    get isStageClosing(): boolean;
+    get isApplicationClosing(): boolean;
+    get isReady(): boolean;
+    /** @internal */
+    saveChildWindowSizeAndPosition(childWindowId: string, childWindow: Window): void;
+    /** Method used to possibly change a Popout Widget back to a docked widget if the user was the one closing the popout's child
+     * window.
+     *  @internal
+     */
+    dockPopoutWidgetContainer(widgetContainerId: string): void;
+    /** Finds the container with the specified widget and re-docks all widgets
+     * back to the panel zone location that was used when the floating container
+     * was generated. Supported only when in UI 2.0 or higher.
+     * @param widgetId  case sensitive Widget Id.
+     * @beta
+     */
+    dockWidgetContainer(widgetId: string): void;
+    setFloatingWidgetContainerBounds(floatingWidgetId: string, bounds: RectangleProps): boolean;
+    getFloatingWidgetContainerIds(): string[];
+    getFloatingWidgetContainerIdByWidgetId(widgetId: string): string | undefined;
+    getFloatingWidgetContainerBounds(floatingWidgetId: string | undefined): RectangleProps | undefined;
+    private _widgetDefs;
+    /** Iterable of all widget definitions in a frontstage.
+     * @internal
+     */
+    get widgetDefs(): {
+        [Symbol.iterator](): Iterator<WidgetDef, any, undefined>;
+    };
+}
+/** Hook that returns active frontstage id.
+ * @public
+ */
+export declare const useActiveFrontstageId: () => string;
+/** @internal */
+export declare function useActiveFrontstageDef(): FrontstageDef | undefined;
+/** Hook that returns the widgetDef for a specific widgetId within the active frontstage.
+ * @public
+ */
+export declare function useSpecificWidgetDef(widgetId: string): WidgetDef | undefined;
 //# sourceMappingURL=FrontstageDef.d.ts.map