@itwin/appui-react 4.17.1 → 5.0.0-dev.2

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

@@ -0,0 +1,317 @@
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import { UiEvent } from "@itwin/appui-abstract";
+import type { IModelConnection, Tool } from "@itwin/core-frontend";
+import type { ToolInformation } from "../toolsettings/ToolInformation.js";
+import type { TimeTracker } from "../configurableui/TimeTracker.js";
+import { type ContentControlActivatedEvent } from "../content/ContentControl.js";
+import type { ContentLayoutActivatedEvent } from "../content/ContentLayout.js";
+import type { FrontstageDef } from "../frontstage/FrontstageDef.js";
+import type { FrontstageProvider } from "../frontstage/FrontstageProvider.js";
+import type { NavigationAidActivatedEvent } from "../navigationaids/NavigationAidControl.js";
+import type { PanelPinnedChangedEventArgs, PanelStateChangedEvent } from "../stagepanels/StagePanelDef.js";
+import type { WidgetDef, WidgetStateChangedEvent } from "../widgets/WidgetDef.js";
+import type { WidgetState } from "../widgets/WidgetState.js";
+import type { Frontstage } from "../frontstage/Frontstage.js";
+/** Frontstage Activated Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface FrontstageActivatedEventArgs {
+    deactivatedFrontstageDef?: FrontstageDef;
+    activatedFrontstageDef: FrontstageDef;
+}
+/** Frontstage Activated Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> {
+}
+/** Frontstage Deactivated Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+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
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> {
+}
+/** Frontstage Ready Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface FrontstageReadyEventArgs {
+    frontstageDef: FrontstageDef;
+}
+/** Frontstage Ready Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> {
+}
+/** Modal Frontstage Changed Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface ModalFrontstageChangedEventArgs {
+    modalFrontstageCount: number;
+}
+/** Modal Frontstage Stack Changed Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> {
+}
+/** Modal Frontstage Closed Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+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
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> {
+}
+/** Modal Frontstage RequestedClose Event Args interface.
+ * @alpha
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+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
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> {
+}
+/** Tool Activated Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface ToolActivatedEventArgs {
+    toolId: string;
+}
+/** Tool Activated Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> {
+}
+/** Tool Icon Changed Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface ToolIconChangedEventArgs {
+    iconSpec: string;
+}
+/** Tool Icon Changed Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+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.
+     * @deprecated in 4.16.0. Use {@link FrameworkContent.onActiveContentChangedEvent} instead.
+     */
+    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.
+     * @deprecated in 4.17.0. Use {@link FrameworkFrontstages.clearFrontstages} instead.
+     */
+    clearFrontstageProviders(): void;
+    /** Clears the Frontstages. */
+    clearFrontstages(): void;
+    /** Adds a frontstage provider.
+     * @param frontstageProvider  FrontstageProvider representing the Frontstage to add
+     * @deprecated in 4.15.0. Use {@link FrameworkFrontstages.addFrontstage} instead.
+     */
+    addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Adds a frontstage.
+     * @beta
+     */
+    addFrontstage(frontstage: Frontstage): 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]].
+     * @deprecated in 4.16.0. Uses a deprecated class {@link 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/appui-react/framework/FrameworkFrontstages.d.ts.map

@@ -0,0 +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,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,KAAK,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACjF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,KAAK,EACV,2BAA2B,EAC3B,sBAAsB,EACvB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,SAAS,EACT,uBAAuB,EACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAG9D;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,sBAAsB,EAAE,aAAa,CAAC;CACvC;AAED;;;GAGG;AAEH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;CAAG;AAEtF;;;GAGG;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;;;GAGG;AAEH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAG;AAE1F;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;GAGG;AAEH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAG;AAE9E;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AAEH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAG;AAE5F;;;GAGG;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;;;;;;;GAOG;AAEH,qBAAa,kCAAmC,SAAQ,OAAO,CAAC,sCAAsC,CAAC;CAAG;AAE1G;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,eAAe,EAAE,mBAAmB,CAAC;IACrC,0CAA0C;IAC1C,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;;GAGG;AAEH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAG;AAE1F;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AAEH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAG;AAE1E;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AAEH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAG;AAE9E;;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;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,0HAA0H;IAC1H,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,wCAAwC;IAExC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE,sCAAsC;IAEtC,QAAQ,CAAC,0BAA0B,EAAE,wBAAwB,CAAC;IAE9D,sCAAsC;IAEtC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAE1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,yCAAyC;IAEzC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE;;OAEG;IAEH,QAAQ,CAAC,oCAAoC,EAAE,kCAAkC,CAAC;IAElF,gCAAgC;IAEhC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAElD,oCAAoC;IAEpC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,mCAAmC;IAEnC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAE1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE;;OAEG;IAEH,QAAQ,CAAC,8BAA8B,EAAE,4BAA4B,CAAC;IAEtE,0CAA0C;IAE1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,sCAAsC;IAEtC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAE5D;;OAEG;IAEH,QAAQ,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAE1D;;OAEG;IAEH,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEzE;OACG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;;OAEG;IACH,wBAAwB,IAAI,IAAI,CAAC;IAEjC,8BAA8B;IAC9B,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;;OAGG;IAEH,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpE;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;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,CACpB,aAAa,EAAE,aAAa,GAAG,SAAS,GACvC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;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;;OAEG;IAEH,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,CACpB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,gBAAgB,GACjC,IAAI,CAAC;IAER;;;;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"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkFrontstages.js","sourceRoot":"","sources":["../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AA8BhD;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,wBAAyB,SAAQ,OAAqC;CAAG;AAoBtF;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,0BAA2B,SAAQ,OAAuC;CAAG;AAU1F;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAG;AAU9E;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,2BAA4B,SAAQ,OAAwC;CAAG;AAkB5F;;;;;;;GAOG;AACH,mDAAmD;AACnD,MAAM,OAAO,kCAAmC,SAAQ,OAA+C;CAAG;AAa1G;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,0BAA2B,SAAQ,OAAuC;CAAG;AAU1F;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,kBAAmB,SAAQ,OAA+B;CAAG;AAU1E;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,OAAiC;CAAG","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.js\";\nimport type { TimeTracker } from \"../configurableui/TimeTracker.js\";\nimport { type ContentControlActivatedEvent } from \"../content/ContentControl.js\";\nimport type { ContentLayoutActivatedEvent } from \"../content/ContentLayout.js\";\nimport type { FrontstageDef } from \"../frontstage/FrontstageDef.js\";\nimport type { FrontstageProvider } from \"../frontstage/FrontstageProvider.js\";\nimport type { NavigationAidActivatedEvent } from \"../navigationaids/NavigationAidControl.js\";\nimport type {\n  PanelPinnedChangedEventArgs,\n  PanelStateChangedEvent,\n} from \"../stagepanels/StagePanelDef.js\";\nimport type {\n  WidgetDef,\n  WidgetStateChangedEvent,\n} from \"../widgets/WidgetDef.js\";\nimport type { WidgetState } from \"../widgets/WidgetState.js\";\nimport type { Frontstage } from \"../frontstage/Frontstage.js\";\nimport { FrameworkContent } from \"./FrameworkContent.js\";\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   * @deprecated in 4.17.0. Use {@link FrameworkFrontstages.clearFrontstages} instead.\n   */\n  clearFrontstageProviders(): void;\n\n  /** Clears the Frontstages. */\n  clearFrontstages(): 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/appui-react/framework/FrameworkKeyboardShortcuts.d.ts

@@ -0,0 +1,106 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import type { BadgeType, IconSpec } from "@itwin/core-react";
+import type { BadgeKind } from "@itwin/core-react/internal";
+import type { KeyboardShortcutProps } from "../keyboardshortcut/KeyboardShortcutProps.js";
+import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef.js";
+import type { ConditionalBooleanValue, ConditionalStringValue } from "../shared/ConditionalValue.js";
+import type { StringGetter } from "@itwin/appui-abstract";
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+export interface FrameworkKeyboardShortcut {
+    /** Returns the id for this shortcut */
+    readonly id: string;
+    /** Returns the shortcut container */
+    readonly shortcutContainer: FrameworkKeyboardShortcutContainer;
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;
+    /** Returns the shortcut's key map key used as the id */
+    readonly keyMapKey: string;
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut.
+     * @deprecated in 4.15.0. Use properties of this object instead.
+     */
+    readonly item: ActionButtonItemDef | undefined;
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked(): void;
+    /** Gets the keyboard key */
+    readonly key: string;
+    /** Gets whether the Alt key required. */
+    readonly isAltKeyRequired: boolean;
+    /** Gets whether the Ctrl key required. */
+    readonly isCtrlKeyRequired: boolean;
+    /** Gets whether the Shift key required. */
+    readonly isShiftKeyRequired: boolean;
+    /** Gets whether this is a Function key. */
+    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;
+    readonly rawLabel: string | StringGetter | ConditionalStringValue;
+    readonly label: string;
+    setLabel(v: string | StringGetter | ConditionalStringValue): void;
+    readonly tooltip: string;
+    setTooltip(v: string | StringGetter | ConditionalStringValue): void;
+    readonly description: string;
+    setDescription(v: string | StringGetter | ConditionalStringValue): void;
+}
+/** Keyboard Shortcut Container
+ * @public
+ */
+export interface FrameworkKeyboardShortcutContainer {
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey: string, inShortcut: FrameworkKeyboardShortcut): FrameworkKeyboardShortcut | undefined;
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable(): boolean;
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData(): void;
+    getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu(): void;
+}
+/**
+ * [[UiFramework.keyboardShortcuts]] interface
+ * @public
+ */
+export interface FrameworkKeyboardShortcuts {
+    /** Loads Keyboard Shortcuts into the managed list */
+    loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Loads a Keyboard Shortcut into the managed list */
+    loadShortcut(shortcutProps: KeyboardShortcutProps): void;
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
+    /** Returns the managed list of Keyboard Shortcuts */
+    readonly shortcutContainer: FrameworkKeyboardShortcutContainer;
+    /** Returns a Keyboard Shortcut from the managed lists */
+    getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;
+    /** Determines if focus is set to Home */
+    readonly isFocusOnHome: boolean;
+    /** Sets focus to Home */
+    setFocusToHome(): void;
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    displayMenu(): void;
+    /** Closes the Keyboard Shortcuts menu */
+    closeMenu(): void;
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    readonly cursorX: number;
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    readonly cursorY: number;
+}
+//# sourceMappingURL=FrameworkKeyboardShortcuts.d.ts.map

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

@@ -0,0 +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,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAC1F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,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/appui-react/framework/FrameworkKeyboardShortcuts.js.map

@@ -0,0 +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 { BadgeKind } from \"@itwin/core-react/internal\";\nimport type { KeyboardShortcutProps } from \"../keyboardshortcut/KeyboardShortcutProps.js\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef.js\";\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"../shared/ConditionalValue.js\";\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/appui-react/framework/FrameworkToolSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkToolSettings.d.ts","sourceRoot":"","sources":["../../../src/appui-react/framework/FrameworkToolSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,sBAAsB,EAAE,CAAC;CAC1C;AAED;;;GAGG;AAEH,qBAAa,+BAAgC,SAAQ,OAAO,CAAC,mCAAmC,CAAC;CAAG;AAEpG;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,qBAAqB,IAAI,IAAI,CAAC;IAE9B,qCAAqC;IACrC,0BAA0B,CACxB,sBAAsB,EAAE,UAAU,EAAE,GAAG,SAAS,EAChD,MAAM,CAAC,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,EAClB,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC;IAEX;OACG;IACH,qBAAqB,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI,CAAC;IAEnD,iGAAiG;IACjG,QAAQ,CAAC,sBAAsB,EAAE,UAAU,EAAE,CAAC;IAE9C;;OAEG;IACH,8BAA8B,EAAE,OAAO,CAAC;IAExC,8FAA8F;IAC9F,eAAe,EAAE,MAAM,CAAC;IAExB,kDAAkD;IAClD,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8CAA8C;IAE9C,QAAQ,CAAC,4BAA4B,EAAE,+BAA+B,CAAC;IAEvE,QAAQ,CAAC,8BAA8B,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC;CAClC"}

package/lib/appui-react/framework/FrameworkToolSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkToolSettings.js","sourceRoot":"","sources":["../../../src/appui-react/framework/FrameworkToolSettings.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAYhD;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,+BAAgC,SAAQ,OAA4C;CAAG","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 ToolSettings\n */\nimport type { DialogItem, DialogPropertySyncItem } from \"@itwin/appui-abstract\";\nimport { UiEvent } from \"@itwin/appui-abstract\";\nimport type { InteractiveTool } from \"@itwin/core-frontend\";\n\n/** Sync Tool Settings Properties 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 SyncToolSettingsPropertiesEventArgs {\n  toolId: string;\n  syncProperties: DialogPropertySyncItem[];\n}\n\n/** Sync Tool Settings Properties 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 SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> {}\n\n/**\n * [[UiFramework.toolSettings]] interface\n * @public\n */\nexport interface FrameworkToolSettings {\n  /** clear cached Tool Settings properties. */\n  clearToolSettingsData(): void;\n\n  /** Cache Tool Settings properties */\n  initializeToolSettingsData(\n    toolSettingsProperties: DialogItem[] | undefined,\n    toolId?: string,\n    toolLabel?: string,\n    toolDescription?: string\n  ): boolean;\n\n  /** Set of data used in Tool Settings for the specified tool. The tool specified should be the \"active\" tool.\n   */\n  initializeDataForTool(tool: InteractiveTool): void;\n\n  /** Returns the toolSettings properties that can be used to populate the tool settings widget. */\n  readonly toolSettingsProperties: DialogItem[];\n\n  /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.\n   * The setter is chiefly for testing.\n   */\n  useDefaultToolSettingsProvider: boolean;\n\n  /** The name of the active tool. This is typically the flyover text specified for the tool. */\n  activeToolLabel: string;\n\n  /** Returns the description of the active tool. */\n  readonly activeToolDescription: string;\n\n  /** Get ToolSettings Properties sync event. */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;\n  // eslint-disable-next-line deprecation/deprecation\n  readonly onReloadToolSettingsProperties: UiEvent<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 toolIdForToolSettings: string;\n\n  /**\n   * Sets the focus on the ToolSettings UI element.\n   */\n  focusIntoToolSettings(): boolean;\n}\n"]}

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

@@ -0,0 +1,36 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+/**
+ * [[UiFramework.visibility]] interface
+ * @public
+ */
+export interface FrameworkVisibility {
+    /** Determines if the Ui is visible */
+    isUiVisible: boolean;
+    /** When true, the UI automatically hides after a specified period of inactivity, defined by {@link FrameworkVisibility.inactivityTime}. Defaults to `true`. */
+    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 in `ms` before the UI is hidden if {@link FrameworkVisibility.autoHideUi} is enabled. Defaults to `3.5` seconds. */
+    inactivityTime: number;
+    /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to `true`.
+     * @deprecated in 4.11.0. The preferred mode is to change opacity in a snappy way (use {@link FrameworkVisibility.snapWidgetOpacity}).
+     */
+    useProximityOpacity: boolean;
+    /** Determines whether the opacity of a toolbar should change immediately when the mouse gets close. 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/appui-react/framework/FrameworkVisibility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkVisibility.d.ts","sourceRoot":"","sources":["../../../src/appui-react/framework/FrameworkVisibility.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,sCAAsC;IACtC,WAAW,EAAE,OAAO,CAAC;IAErB,+JAA+J;IAC/J,UAAU,EAAE,OAAO,CAAC;IAEpB,oFAAoF;IACpF,cAAc,EAAE,OAAO,CAAC;IAExB,gFAAgF;IAChF,cAAc,EAAE,OAAO,CAAC;IAExB,gKAAgK;IAChK,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B,4HAA4H;IAC5H,iBAAiB,EAAE,OAAO,CAAC;IAE3B,6CAA6C;IAC7C,qBAAqB,IAAI,IAAI,CAAC;IAE9B,6DAA6D;IAC7D,sBAAsB,CACpB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,GACjD,IAAI,CAAC;IAER,iDAAiD;IACjD,sBAAsB,CACpB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,GACjD,IAAI,CAAC;IAER,mDAAmD;IACnD,mBAAmB,IAAI,IAAI,CAAC;IAE5B,oDAAoD;IACpD,oBAAoB,IAAI,IAAI,CAAC;CAC9B"}

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

@@ -0,0 +1 @@
+{"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 * @public\n */\nexport interface FrameworkVisibility {\n  /** Determines if the Ui is visible */\n  isUiVisible: boolean;\n\n  /** When true, the UI automatically hides after a specified period of inactivity, defined by {@link FrameworkVisibility.inactivityTime}. Defaults to `true`. */\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 in `ms` before the UI is hidden if {@link FrameworkVisibility.autoHideUi} is enabled. 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   * @deprecated in 4.11.0. The preferred mode is to change opacity in a snappy way (use {@link FrameworkVisibility.snapWidgetOpacity}).\n   */\n  useProximityOpacity: boolean;\n\n  /** Determines whether the opacity of a toolbar should change immediately when the mouse gets close. 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(\n    _event?: React.MouseEvent<HTMLElement, MouseEvent>\n  ): void;\n\n  /** Handler for when the mouse enters a widget */\n  handleWidgetMouseEnter(\n    _event?: React.MouseEvent<HTMLElement, MouseEvent>\n  ): 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/appui-react/frontstage/Frontstage.d.ts

@@ -0,0 +1,9 @@
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import type { FrontstageConfig } from "./FrontstageConfig.js";
+/** Configuration from which a frontstage is created.
+ * @public
+ */
+export type Frontstage = FrontstageConfig;
+//# sourceMappingURL=Frontstage.d.ts.map

package/lib/appui-react/frontstage/Frontstage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Frontstage.d.ts","sourceRoot":"","sources":["../../../src/appui-react/frontstage/Frontstage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;GAEG;AAEH,MAAM,MAAM,UAAU,GAAG,gBAAgB,CAAC"}

package/lib/appui-react/frontstage/Frontstage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Frontstage.js","sourceRoot":"","sources":["../../../src/appui-react/frontstage/Frontstage.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 { FrontstageConfig } from \"./FrontstageConfig.js\";\n\n/** Configuration from which a frontstage is created.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport type Frontstage = FrontstageConfig;\n"]}

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

@@ -0,0 +1,46 @@
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import type { CommonProps } from "@itwin/core-react";
+import type { ContentGroup, ContentGroupProvider } from "../content/ContentGroup.js";
+import type { StagePanelConfig } from "../stagepanels/StagePanelConfig.js";
+import type { WidgetConfig } from "../widgets/WidgetConfig.js";
+/** Configuration from which a frontstage is created.
+ * @public
+ * @deprecated in 4.15.0. Use {@link Frontstage} instead.
+ */
+export interface FrontstageConfig extends CommonProps {
+    /** Id of the frontstage. To ensure uniqueness it is common practice to format id like `appName:stageId` */
+    readonly id: string;
+    /** Content group of the frontstage that describes the content views. Or a content group provider. */
+    readonly contentGroup: ContentGroup | ContentGroupProvider;
+    /** 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.
+     * Increasing the value will make sure to reinitialize App layout instead of restoring to old layout.
+     */
+    readonly version: number;
+    /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.
+     * Most of the time, this is the Element Selection Tool (SelectionTool.toolId).
+     * Your app can specify its own tool or another core tool as default with this property.
+     */
+    readonly defaultTool?: string;
+    /** 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/appui-react/frontstage/FrontstageConfig.d.ts.map

@@ -0,0 +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,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAK/D;;;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"}