@itwin/appui-abstract 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts

@@ -1,87 +1,87 @@
-/** @packageDocumentation
- * @module Widget
- */
-import { ConditionalStringValue } from "../items/ConditionalStringValue";
-import { BadgeType } from "../items/BadgeType";
-import { ProvidedItem } from "../items/ProvidedItem";
-import { WidgetState } from "./WidgetState";
-/** Properties for a Widget.
- * @deprecated in 3.6. Use [WidgetProps]($appui-react) instead.
- * @public
- */
-export interface AbstractWidgetProps extends ProvidedItem {
-    /** Gets the widget content. */
-    readonly getWidgetContent: () => any;
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
-    readonly icon?: string | ConditionalStringValue;
-    /** Id used to uniquely identify the widget.
-     * @note It is recommended to provide unique widget id to correctly save/restore App layout.
-     */
-    readonly id?: string;
-    /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */
-    readonly defaultState?: WidgetState;
-    /** if set, component will be considered selected but will NOT display an "active stripe" - defaults to false. Typically used by buttons that toggle between two states. */
-    readonly label?: string | ConditionalStringValue;
-    /** used to explicitly set the tooltip shown by a component. */
-    readonly tooltip?: string | ConditionalStringValue;
-    /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.
-     * @deprecated in 3.0. Free-form widgets are obsolete.
-     * */
-    readonly isFreeform?: boolean;
-    /** Application data attached to the Widget. */
-    readonly applicationData?: any;
-    /** optional data to used by item implementor. */
-    readonly internalData?: Map<string, any>;
-    /** Indicates whether this Widget is for the Tool Settings. */
-    readonly isToolSettings?: boolean;
-    /** Indicates whether this Widget is for the Status Bar. */
-    readonly isStatusBar?: boolean;
-    /** Indicates whether this Widget should fill the available space in the Zone. */
-    readonly fillZone?: boolean;
-    /** Indicates if widget can be popped out to a child window. Defaults to false. */
-    readonly canPopout?: boolean;
-    /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a
-     * floating panel by that name. If no name is specified, a GUID is used. */
-    readonly floatingContainerId?: string;
-    /** Indicates if widget can be in floating state, default to true. */
-    readonly isFloatingStateSupported?: boolean;
-    /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */
-    readonly isFloatingStateWindowResizable?: boolean;
-    /** Defines that default Top Left position when widget is floated via API calls */
-    readonly defaultFloatingPosition?: {
-        x: number;
-        y: number;
-    };
-    /** Widget priority */
-    readonly priority?: number;
-    /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */
-    readonly syncEventIds?: string[];
-    /** Function executed to determine the state of the widget.
-     *  Used by UI 1.0 widgets ONLY.
-     * @deprecated in 3.3. UI 1.0 support will be removed in AppUi 4.0.
-    */
-    readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;
-    /** Badge to be overlaid on the widget tab. */
-    readonly badgeType?: BadgeType;
-    /** Handler for widget state changed event */
-    readonly onWidgetStateChanged?: () => void;
-    /** Save transient DOM state (i.e. scroll offset). */
-    readonly saveTransientState?: () => void;
-    /** Restore transient DOM state.
-     * @note Return true if the state is restored or the Widget will remount.
-     */
-    readonly restoreTransientState?: () => boolean;
-    /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.
-     * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element
-     * internally. */
-    defaultFloatingSize?: {
-        width: number;
-        height: number;
-    };
-    /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */
-    hideWithUiWhenFloating?: boolean;
-    /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.
-     *  An empty array is treated the same as an undefined prop, allowing all targets. */
-    readonly allowedPanelTargets?: ReadonlyArray<"left" | "right" | "bottom" | "top">;
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+import { BadgeType } from "../items/BadgeType";
+import { ProvidedItem } from "../items/ProvidedItem";
+import { WidgetState } from "./WidgetState";
+/** Properties for a Widget.
+ * @deprecated in 3.6. Use [WidgetProps]($appui-react) instead.
+ * @public
+ */
+export interface AbstractWidgetProps extends ProvidedItem {
+    /** Gets the widget content. */
+    readonly getWidgetContent: () => any;
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon?: string | ConditionalStringValue;
+    /** Id used to uniquely identify the widget.
+     * @note It is recommended to provide unique widget id to correctly save/restore App layout.
+     */
+    readonly id?: string;
+    /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */
+    readonly defaultState?: WidgetState;
+    /** if set, component will be considered selected but will NOT display an "active stripe" - defaults to false. Typically used by buttons that toggle between two states. */
+    readonly label?: string | ConditionalStringValue;
+    /** used to explicitly set the tooltip shown by a component. */
+    readonly tooltip?: string | ConditionalStringValue;
+    /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.
+     * @deprecated in 3.0. Free-form widgets are obsolete.
+     * */
+    readonly isFreeform?: boolean;
+    /** Application data attached to the Widget. */
+    readonly applicationData?: any;
+    /** optional data to used by item implementor. */
+    readonly internalData?: Map<string, any>;
+    /** Indicates whether this Widget is for the Tool Settings. */
+    readonly isToolSettings?: boolean;
+    /** Indicates whether this Widget is for the Status Bar. */
+    readonly isStatusBar?: boolean;
+    /** Indicates whether this Widget should fill the available space in the Zone. */
+    readonly fillZone?: boolean;
+    /** Indicates if widget can be popped out to a child window. Defaults to false. */
+    readonly canPopout?: boolean;
+    /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a
+     * floating panel by that name. If no name is specified, a GUID is used. */
+    readonly floatingContainerId?: string;
+    /** Indicates if widget can be in floating state, default to true. */
+    readonly isFloatingStateSupported?: boolean;
+    /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */
+    readonly isFloatingStateWindowResizable?: boolean;
+    /** Defines that default Top Left position when widget is floated via API calls */
+    readonly defaultFloatingPosition?: {
+        x: number;
+        y: number;
+    };
+    /** Widget priority */
+    readonly priority?: number;
+    /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */
+    readonly syncEventIds?: string[];
+    /** Function executed to determine the state of the widget.
+     *  Used by UI 1.0 widgets ONLY.
+     * @deprecated in 3.3. UI 1.0 support will be removed in AppUi 4.0.
+    */
+    readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;
+    /** Badge to be overlaid on the widget tab. */
+    readonly badgeType?: BadgeType;
+    /** Handler for widget state changed event */
+    readonly onWidgetStateChanged?: () => void;
+    /** Save transient DOM state (i.e. scroll offset). */
+    readonly saveTransientState?: () => void;
+    /** Restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    readonly restoreTransientState?: () => boolean;
+    /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.
+     * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element
+     * internally. */
+    defaultFloatingSize?: {
+        width: number;
+        height: number;
+    };
+    /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */
+    hideWithUiWhenFloating?: boolean;
+    /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.
+     *  An empty array is treated the same as an undefined prop, allowing all targets. */
+    readonly allowedPanelTargets?: ReadonlyArray<"left" | "right" | "bottom" | "top">;
+}
 //# sourceMappingURL=AbstractWidgetProps.d.ts.map

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js

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

package/lib/cjs/appui-abstract/widget/StagePanel.d.ts

@@ -1,37 +1,37 @@
-/** @packageDocumentation
- * @module Widget
- */
-/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
- */
-export declare enum AbstractZoneLocation {
-    CenterLeft = 4,
-    CenterRight = 6,
-    BottomLeft = 7,
-    BottomRight = 9
-}
-/** Available Stage Panel locations.
- * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.
- * @public
- */
-export declare enum StagePanelLocation {
-    Top = 101,
-    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
-    TopMost = 102,
-    Left = 103,
-    Right = 104,
-    Bottom = 105,
-    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
-    BottomMost = 106
-}
-/** Enum for Stage Panel Sections
- * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.
- * @public
- */
-export declare enum StagePanelSection {
-    Start = 0,
-    /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */
-    Middle = 1,
-    End = 2
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
+ * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
+ */
+export declare enum AbstractZoneLocation {
+    CenterLeft = 4,
+    CenterRight = 6,
+    BottomLeft = 7,
+    BottomRight = 9
+}
+/** Available Stage Panel locations.
+ * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.
+ * @public
+ */
+export declare enum StagePanelLocation {
+    Top = 101,
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
+    TopMost = 102,
+    Left = 103,
+    Right = 104,
+    Bottom = 105,
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
+    BottomMost = 106
+}
+/** Enum for Stage Panel Sections
+ * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.
+ * @public
+ */
+export declare enum StagePanelSection {
+    Start = 0,
+    /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */
+    Middle = 1,
+    End = 2
+}
 //# sourceMappingURL=StagePanel.d.ts.map

package/lib/cjs/appui-abstract/widget/StagePanel.js

@@ -1,47 +1,47 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StagePanelSection = exports.StagePanelLocation = exports.AbstractZoneLocation = void 0;
-/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
- */
-var AbstractZoneLocation;
-(function (AbstractZoneLocation) {
-    AbstractZoneLocation[AbstractZoneLocation["CenterLeft"] = 4] = "CenterLeft";
-    AbstractZoneLocation[AbstractZoneLocation["CenterRight"] = 6] = "CenterRight";
-    AbstractZoneLocation[AbstractZoneLocation["BottomLeft"] = 7] = "BottomLeft";
-    AbstractZoneLocation[AbstractZoneLocation["BottomRight"] = 9] = "BottomRight";
-})(AbstractZoneLocation = exports.AbstractZoneLocation || (exports.AbstractZoneLocation = {}));
-/** Available Stage Panel locations.
- * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.
- * @public
- */
-var StagePanelLocation;
-(function (StagePanelLocation) {
-    StagePanelLocation[StagePanelLocation["Top"] = 101] = "Top";
-    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
-    StagePanelLocation[StagePanelLocation["TopMost"] = 102] = "TopMost";
-    StagePanelLocation[StagePanelLocation["Left"] = 103] = "Left";
-    StagePanelLocation[StagePanelLocation["Right"] = 104] = "Right";
-    StagePanelLocation[StagePanelLocation["Bottom"] = 105] = "Bottom";
-    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
-    StagePanelLocation[StagePanelLocation["BottomMost"] = 106] = "BottomMost";
-})(StagePanelLocation = exports.StagePanelLocation || (exports.StagePanelLocation = {}));
-/** Enum for Stage Panel Sections
- * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.
- * @public
- */
-var StagePanelSection;
-(function (StagePanelSection) {
-    StagePanelSection[StagePanelSection["Start"] = 0] = "Start";
-    /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */
-    StagePanelSection[StagePanelSection["Middle"] = 1] = "Middle";
-    StagePanelSection[StagePanelSection["End"] = 2] = "End";
-})(StagePanelSection = exports.StagePanelSection || (exports.StagePanelSection = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StagePanelSection = exports.StagePanelLocation = exports.AbstractZoneLocation = void 0;
+/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
+ * @public @deprecated in 3.0. UI 1.0 support will be removed in AppUi 4.0.
+ */
+var AbstractZoneLocation;
+(function (AbstractZoneLocation) {
+    AbstractZoneLocation[AbstractZoneLocation["CenterLeft"] = 4] = "CenterLeft";
+    AbstractZoneLocation[AbstractZoneLocation["CenterRight"] = 6] = "CenterRight";
+    AbstractZoneLocation[AbstractZoneLocation["BottomLeft"] = 7] = "BottomLeft";
+    AbstractZoneLocation[AbstractZoneLocation["BottomRight"] = 9] = "BottomRight";
+})(AbstractZoneLocation = exports.AbstractZoneLocation || (exports.AbstractZoneLocation = {}));
+/** Available Stage Panel locations.
+ * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.
+ * @public
+ */
+var StagePanelLocation;
+(function (StagePanelLocation) {
+    StagePanelLocation[StagePanelLocation["Top"] = 101] = "Top";
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
+    StagePanelLocation[StagePanelLocation["TopMost"] = 102] = "TopMost";
+    StagePanelLocation[StagePanelLocation["Left"] = 103] = "Left";
+    StagePanelLocation[StagePanelLocation["Right"] = 104] = "Right";
+    StagePanelLocation[StagePanelLocation["Bottom"] = 105] = "Bottom";
+    /** @deprecated in 3.6 UI 1.0 support will be removed in AppUi 4.0. */
+    StagePanelLocation[StagePanelLocation["BottomMost"] = 106] = "BottomMost";
+})(StagePanelLocation = exports.StagePanelLocation || (exports.StagePanelLocation = {}));
+/** Enum for Stage Panel Sections
+ * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.
+ * @public
+ */
+var StagePanelSection;
+(function (StagePanelSection) {
+    StagePanelSection[StagePanelSection["Start"] = 0] = "Start";
+    /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */
+    StagePanelSection[StagePanelSection["Middle"] = 1] = "Middle";
+    StagePanelSection[StagePanelSection["End"] = 2] = "End";
+})(StagePanelSection = exports.StagePanelSection || (exports.StagePanelSection = {}));
 //# sourceMappingURL=StagePanel.js.map

package/lib/cjs/appui-abstract/widget/WidgetState.d.ts

@@ -1,20 +1,20 @@
-/** @packageDocumentation
- * @module Widget
- */
-/** Widget state enum.
- * @deprecated in 3.6. Use [WidgetState]($appui-react) instead.
- * @public
- */
-export declare enum WidgetState {
-    /** Widget tab is visible and active and its contents are visible */
-    Open = 0,
-    /** Widget tab is visible but its contents are not visible */
-    Closed = 1,
-    /** Widget tab nor its contents are visible */
-    Hidden = 2,
-    /** Widget tab is in a 'floating' state and is not docked in zone's tab stack */
-    Floating = 3,
-    /** Widget tab is visible but its contents are not loaded */
-    Unloaded = 4
-}
+/** @packageDocumentation
+ * @module Widget
+ */
+/** Widget state enum.
+ * @deprecated in 3.6. Use [WidgetState]($appui-react) instead.
+ * @public
+ */
+export declare enum WidgetState {
+    /** Widget tab is visible and active and its contents are visible */
+    Open = 0,
+    /** Widget tab is visible but its contents are not visible */
+    Closed = 1,
+    /** Widget tab nor its contents are visible */
+    Hidden = 2,
+    /** Widget tab is in a 'floating' state and is not docked in zone's tab stack */
+    Floating = 3,
+    /** Widget tab is visible but its contents are not loaded */
+    Unloaded = 4
+}
 //# sourceMappingURL=WidgetState.d.ts.map

package/lib/cjs/appui-abstract/widget/WidgetState.js

@@ -1,28 +1,28 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WidgetState = void 0;
-/** Widget state enum.
- * @deprecated in 3.6. Use [WidgetState]($appui-react) instead.
- * @public
- */
-var WidgetState;
-(function (WidgetState) {
-    /** Widget tab is visible and active and its contents are visible */
-    WidgetState[WidgetState["Open"] = 0] = "Open";
-    /** Widget tab is visible but its contents are not visible */
-    WidgetState[WidgetState["Closed"] = 1] = "Closed";
-    /** Widget tab nor its contents are visible */
-    WidgetState[WidgetState["Hidden"] = 2] = "Hidden";
-    /** Widget tab is in a 'floating' state and is not docked in zone's tab stack */
-    WidgetState[WidgetState["Floating"] = 3] = "Floating";
-    /** Widget tab is visible but its contents are not loaded */
-    WidgetState[WidgetState["Unloaded"] = 4] = "Unloaded";
-})(WidgetState = exports.WidgetState || (exports.WidgetState = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetState = void 0;
+/** Widget state enum.
+ * @deprecated in 3.6. Use [WidgetState]($appui-react) instead.
+ * @public
+ */
+var WidgetState;
+(function (WidgetState) {
+    /** Widget tab is visible and active and its contents are visible */
+    WidgetState[WidgetState["Open"] = 0] = "Open";
+    /** Widget tab is visible but its contents are not visible */
+    WidgetState[WidgetState["Closed"] = 1] = "Closed";
+    /** Widget tab nor its contents are visible */
+    WidgetState[WidgetState["Hidden"] = 2] = "Hidden";
+    /** Widget tab is in a 'floating' state and is not docked in zone's tab stack */
+    WidgetState[WidgetState["Floating"] = 3] = "Floating";
+    /** Widget tab is visible but its contents are not loaded */
+    WidgetState[WidgetState["Unloaded"] = 4] = "Unloaded";
+})(WidgetState = exports.WidgetState || (exports.WidgetState = {}));
 //# sourceMappingURL=WidgetState.js.map