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

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

@@ -1,64 +1,64 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolIconChangedEvent = exports.ToolActivatedEvent = exports.ModalFrontstageClosedEvent = exports.ModalFrontstageRequestedCloseEvent = exports.ModalFrontstageChangedEvent = exports.FrontstageReadyEvent = exports.FrontstageDeactivatedEvent = exports.FrontstageActivatedEvent = void 0;
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-const appui_abstract_1 = require("@itwin/appui-abstract");
-/** Frontstage Activated Event class.
- * @public
- */
-class FrontstageActivatedEvent extends appui_abstract_1.UiEvent {
-}
-exports.FrontstageActivatedEvent = FrontstageActivatedEvent;
-/** Frontstage Deactivated Event class.
- * @public
- */
-class FrontstageDeactivatedEvent extends appui_abstract_1.UiEvent {
-}
-exports.FrontstageDeactivatedEvent = FrontstageDeactivatedEvent;
-/** Frontstage Ready Event class.
- * @public
- */
-class FrontstageReadyEvent extends appui_abstract_1.UiEvent {
-}
-exports.FrontstageReadyEvent = FrontstageReadyEvent;
-/** Modal Frontstage Stack Changed Event class.
- * @public
- */
-class ModalFrontstageChangedEvent extends appui_abstract_1.UiEvent {
-}
-exports.ModalFrontstageChangedEvent = ModalFrontstageChangedEvent;
-/** 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
- */
-class ModalFrontstageRequestedCloseEvent extends appui_abstract_1.UiEvent {
-}
-exports.ModalFrontstageRequestedCloseEvent = ModalFrontstageRequestedCloseEvent;
-/** Modal Frontstage Closed Event class.
- * @public
- */
-class ModalFrontstageClosedEvent extends appui_abstract_1.UiEvent {
-}
-exports.ModalFrontstageClosedEvent = ModalFrontstageClosedEvent;
-/** Tool Activated Event class.
- * @public
- */
-class ToolActivatedEvent extends appui_abstract_1.UiEvent {
-}
-exports.ToolActivatedEvent = ToolActivatedEvent;
-/** Tool Icon Changed Event class.
- * @public
- */
-class ToolIconChangedEvent extends appui_abstract_1.UiEvent {
-}
-exports.ToolIconChangedEvent = ToolIconChangedEvent;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolIconChangedEvent = exports.ToolActivatedEvent = exports.ModalFrontstageClosedEvent = exports.ModalFrontstageRequestedCloseEvent = exports.ModalFrontstageChangedEvent = exports.FrontstageReadyEvent = exports.FrontstageDeactivatedEvent = exports.FrontstageActivatedEvent = void 0;
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/** Frontstage Activated Event class.
+ * @public
+ */
+class FrontstageActivatedEvent extends appui_abstract_1.UiEvent {
+}
+exports.FrontstageActivatedEvent = FrontstageActivatedEvent;
+/** Frontstage Deactivated Event class.
+ * @public
+ */
+class FrontstageDeactivatedEvent extends appui_abstract_1.UiEvent {
+}
+exports.FrontstageDeactivatedEvent = FrontstageDeactivatedEvent;
+/** Frontstage Ready Event class.
+ * @public
+ */
+class FrontstageReadyEvent extends appui_abstract_1.UiEvent {
+}
+exports.FrontstageReadyEvent = FrontstageReadyEvent;
+/** Modal Frontstage Stack Changed Event class.
+ * @public
+ */
+class ModalFrontstageChangedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ModalFrontstageChangedEvent = ModalFrontstageChangedEvent;
+/** 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
+ */
+class ModalFrontstageRequestedCloseEvent extends appui_abstract_1.UiEvent {
+}
+exports.ModalFrontstageRequestedCloseEvent = ModalFrontstageRequestedCloseEvent;
+/** Modal Frontstage Closed Event class.
+ * @public
+ */
+class ModalFrontstageClosedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ModalFrontstageClosedEvent = ModalFrontstageClosedEvent;
+/** Tool Activated Event class.
+ * @public
+ */
+class ToolActivatedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ToolActivatedEvent = ToolActivatedEvent;
+/** Tool Icon Changed Event class.
+ * @public
+ */
+class ToolIconChangedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ToolIconChangedEvent = ToolIconChangedEvent;
 //# sourceMappingURL=FrameworkFrontstages.js.map

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

@@ -1,100 +1,100 @@
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-import { FunctionKey, SpecialKey } from "@itwin/appui-abstract";
-import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
-import { ItemDefBase } from "../shared/ItemDefBase";
-import { ItemProps } from "../shared/ItemProps";
-/** Properties for a Keyboard Shortcut
- * @public
- */
-export interface KeyboardShortcutProps extends ItemProps {
-    /** The key that invokes the shortcut.
-     * This is either an alphanumeric key, a function key or a special key.
-     */
-    key: string | FunctionKey | SpecialKey;
-    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */
-    item?: ActionButtonItemDef;
-    /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */
-    shortcuts?: KeyboardShortcutProps[];
-    /** Indicates whether the Alt key required. Default - false */
-    isAltKeyRequired?: boolean;
-    /** Indicates whether the Ctrl key required. Default - false */
-    isCtrlKeyRequired?: boolean;
-    /** Indicates whether the Shift key required. Default - false */
-    isShiftKeyRequired?: boolean;
-}
-/** Keyboard Shortcut used to execute an action
- * @public
- */
-export interface FrameworkKeyboardShortcut extends ItemDefBase {
-    /** 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 */
-    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;
-}
-/** 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
- * @beta
- */
-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;
-}
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { FunctionKey, SpecialKey } from "@itwin/appui-abstract";
+import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { ItemProps } from "../shared/ItemProps";
+/** Properties for a Keyboard Shortcut
+ * @public
+ */
+export interface KeyboardShortcutProps extends ItemProps {
+    /** The key that invokes the shortcut.
+     * This is either an alphanumeric key, a function key or a special key.
+     */
+    key: string | FunctionKey | SpecialKey;
+    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */
+    item?: ActionButtonItemDef;
+    /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */
+    shortcuts?: KeyboardShortcutProps[];
+    /** Indicates whether the Alt key required. Default - false */
+    isAltKeyRequired?: boolean;
+    /** Indicates whether the Ctrl key required. Default - false */
+    isCtrlKeyRequired?: boolean;
+    /** Indicates whether the Shift key required. Default - false */
+    isShiftKeyRequired?: boolean;
+}
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+export interface FrameworkKeyboardShortcut extends ItemDefBase {
+    /** 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 */
+    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;
+}
+/** 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
+ * @beta
+ */
+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/cjs/appui-react/framework/FrameworkKeyboardShortcuts.js

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

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

@@ -1,52 +1,52 @@
-/** @packageDocumentation
- * @module ToolSettings
- */
-import { DialogItem, DialogPropertySyncItem, UiEvent } from "@itwin/appui-abstract";
-import { InteractiveTool } from "@itwin/core-frontend";
-/** Sync Tool Settings Properties Event Args interface.
- * @public
- */
-export interface SyncToolSettingsPropertiesEventArgs {
-    toolId: string;
-    syncProperties: DialogPropertySyncItem[];
-}
-/** Sync Tool Settings Properties Event class.
- * @public
- */
-export declare class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> {
-}
-/**
- * [[UiFramework.toolSettings]] interface
- * @beta
- */
-export interface FrameworkToolSettings {
-    /** clear cached Tool Settings properties. */
-    clearToolSettingsData(): void;
-    /** Cache Tool Settings properties */
-    initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;
-    /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
-     */
-    initializeDataForTool(tool: InteractiveTool): void;
-    /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
-    readonly toolSettingsProperties: DialogItem[];
-    /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
-     * The setter is chiefly for testing.
-     */
-    useDefaultToolSettingsProvider: boolean;
-    /** The name of the active tool. This is typically the flyover text specified for the tool. */
-    activeToolLabel: string;
-    /** Returns the description of the active tool. */
-    readonly activeToolDescription: string;
-    /** Get ToolSettings Properties sync event. */
-    readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;
-    readonly onReloadToolSettingsProperties: UiEvent<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 toolIdForToolSettings: string;
-    /**
-     * Sets the focus on the ToolSettings UI element.
-     */
-    focusIntoToolSettings(): boolean;
-}
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+import { DialogItem, DialogPropertySyncItem, UiEvent } from "@itwin/appui-abstract";
+import { InteractiveTool } from "@itwin/core-frontend";
+/** Sync Tool Settings Properties Event Args interface.
+ * @public
+ */
+export interface SyncToolSettingsPropertiesEventArgs {
+    toolId: string;
+    syncProperties: DialogPropertySyncItem[];
+}
+/** Sync Tool Settings Properties Event class.
+ * @public
+ */
+export declare class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> {
+}
+/**
+ * [[UiFramework.toolSettings]] interface
+ * @beta
+ */
+export interface FrameworkToolSettings {
+    /** clear cached Tool Settings properties. */
+    clearToolSettingsData(): void;
+    /** Cache Tool Settings properties */
+    initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;
+    /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
+     */
+    initializeDataForTool(tool: InteractiveTool): void;
+    /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
+    readonly toolSettingsProperties: DialogItem[];
+    /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
+     * The setter is chiefly for testing.
+     */
+    useDefaultToolSettingsProvider: boolean;
+    /** The name of the active tool. This is typically the flyover text specified for the tool. */
+    activeToolLabel: string;
+    /** Returns the description of the active tool. */
+    readonly activeToolDescription: string;
+    /** Get ToolSettings Properties sync event. */
+    readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;
+    readonly onReloadToolSettingsProperties: UiEvent<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 toolIdForToolSettings: string;
+    /**
+     * Sets the focus on the ToolSettings UI element.
+     */
+    focusIntoToolSettings(): boolean;
+}
 //# sourceMappingURL=FrameworkToolSettings.d.ts.map

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

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SyncToolSettingsPropertiesEvent = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module ToolSettings
- */
-const appui_abstract_1 = require("@itwin/appui-abstract");
-/** Sync Tool Settings Properties Event class.
- * @public
- */
-class SyncToolSettingsPropertiesEvent extends appui_abstract_1.UiEvent {
-}
-exports.SyncToolSettingsPropertiesEvent = SyncToolSettingsPropertiesEvent;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncToolSettingsPropertiesEvent = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/** Sync Tool Settings Properties Event class.
+ * @public
+ */
+class SyncToolSettingsPropertiesEvent extends appui_abstract_1.UiEvent {
+}
+exports.SyncToolSettingsPropertiesEvent = SyncToolSettingsPropertiesEvent;
 //# sourceMappingURL=FrameworkToolSettings.js.map

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/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