@itwin/appui-abstract 4.0.0-dev.2 → 4.0.0-dev.4

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

@@ -1,69 +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.
- * @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;
-    /** Application data attached to the Widget. */
-    readonly applicationData?: any;
-    /** optional data to used by item implementor. */
-    readonly internalData?: Map<string, any>;
-    /** 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?: {
-        readonly x: number;
-        readonly y: number;
-    };
-    /** Widget priority */
-    readonly priority?: number;
-    /** 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. */
-    readonly defaultFloatingSize?: {
-        readonly width: number;
-        readonly 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 */
-    readonly 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 [CommonWidgetProps]($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.
+     * */
+    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.
+    */
+    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/esm/appui-abstract/widget/AbstractWidgetProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8BAA8B;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC;IACrC,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC;IACpC,2KAA2K;IAC3K,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,kFAAkF;IAClF,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;+EAC2E;IAC3E,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,qEAAqE;IACrE,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,8GAA8G;IAC9G,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9E,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,qDAAqD;IACrD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC;IAC/C;;qBAEiB;IACjB,QAAQ,CAAC,mBAAmB,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACnF,8HAA8H;IAC9H,QAAQ,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAC1C;yFACqF;IACrF,QAAQ,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC,CAAC;CACnF"}
+{"version":3,"file":"AbstractWidgetProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,+BAA+B;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC;IACrC,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC;IACpC,2KAA2K;IAC3K,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD;;SAEK;IACL,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;+EAC2E;IAC3E,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,qEAAqE;IACrE,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,8GAA8G;IAC9G,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,gHAAgH;IAChH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC;;;MAGE;IACF,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;IACnE,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,qDAAqD;IACrD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC;IAC/C;;qBAEiB;IACjB,mBAAmB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACxD,8HAA8H;IAC9H,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;yFACqF;IACrF,QAAQ,CAAC,mBAAmB,CAAC,EAAG,aAAa,CAAC,MAAM,GAAC,OAAO,GAAC,QAAQ,GAAC,KAAK,CAAC,CAAC;CAC9E"}

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=AbstractWidgetProps.js.map

package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Widget\n */\n\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\nimport { WidgetState } from \"./WidgetState\";\n\n/** Properties for a Widget.\n * @public\n */\nexport interface AbstractWidgetProps extends ProvidedItem {\n  /** Gets the widget content */\n  readonly getWidgetContent: () => any;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Id used to uniquely identify the widget.\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\n   */\n  readonly id?: string;\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\n  readonly defaultState?: WidgetState;\n  /** 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. */\n  readonly label?: string | ConditionalStringValue;\n  /** used to explicitly set the tooltip shown by a component. */\n  readonly tooltip?: string | ConditionalStringValue;\n  /** Application data attached to the Widget. */\n  readonly applicationData?: any;\n  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\n  readonly canPopout?: boolean;\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\n   * floating panel by that name. If no name is specified, a GUID is used. */\n  readonly floatingContainerId?: string;\n  /** Indicates if widget can be in floating state, default to true. */\n  readonly isFloatingStateSupported?: boolean;\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\n  readonly isFloatingStateWindowResizable?: boolean;\n  /** Defines that default Top Left position when widget is floated via API calls */\n  readonly defaultFloatingPosition?: { readonly x: number, readonly y: number };\n  /** Widget priority */\n  readonly priority?: number;\n  /** Badge to be overlaid on the widget tab. */\n  readonly badgeType?: BadgeType;\n  /** Handler for widget state changed event */\n  readonly onWidgetStateChanged?: () => void;\n  /** Save transient DOM state (i.e. scroll offset). */\n  readonly saveTransientState?: () => void;\n  /** Restore transient DOM state.\n   * @note Return true if the state is restored or the Widget will remount.\n   */\n  readonly restoreTransientState?: () => boolean;\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\n   * internally. */\n  readonly defaultFloatingSize?: { readonly width: number, readonly height: number };\n  /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */\n  readonly hideWithUiWhenFloating?: boolean;\n  /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.\n   *  An empty array is treated the same as an undefined prop, allowing all targets. */\n  readonly allowedPanelTargets?: ReadonlyArray<\"left\" | \"right\" | \"bottom\" | \"top\">;\n}\n"]}
+{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\nimport { WidgetState } from \"./WidgetState\";\r\n\r\n/** Properties for a Widget.\r\n * @deprecated in 3.6. Use [CommonWidgetProps]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractWidgetProps extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** Gets the widget content. */\r\n  readonly getWidgetContent: () => any;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Id used to uniquely identify the widget.\r\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\r\n   */\r\n  readonly id?: string;\r\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\r\n  readonly defaultState?: WidgetState; // eslint-disable-line deprecation/deprecation\r\n  /** 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. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false.\r\n   * @deprecated in 3.0.\r\n   * */\r\n  readonly isFreeform?: boolean;\r\n  /** Application data attached to the Widget. */\r\n  readonly applicationData?: any;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Indicates whether this Widget is for the Tool Settings. */\r\n  readonly isToolSettings?: boolean;\r\n  /** Indicates whether this Widget is for the Status Bar. */\r\n  readonly isStatusBar?: boolean;\r\n  /** Indicates whether this Widget should fill the available space in the Zone. */\r\n  readonly fillZone?: boolean;\r\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\r\n  readonly canPopout?: boolean;\r\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\r\n   * floating panel by that name. If no name is specified, a GUID is used. */\r\n  readonly floatingContainerId?: string;\r\n  /** Indicates if widget can be in floating state, default to true. */\r\n  readonly isFloatingStateSupported?: boolean;\r\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\r\n  readonly isFloatingStateWindowResizable?: boolean;\r\n  /** Defines that default Top Left position when widget is floated via API calls */\r\n  readonly defaultFloatingPosition?: { x: number, y: number };\r\n  /** Widget priority */\r\n  readonly priority?: number;\r\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\r\n  readonly syncEventIds?: string[];\r\n  /** Function executed to determine the state of the widget.\r\n   *  Used by UI 1.0 widgets ONLY.\r\n   * @deprecated in 3.3.\r\n  */\r\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState; // eslint-disable-line deprecation/deprecation\r\n  /** Badge to be overlaid on the widget tab. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Handler for widget state changed event */\r\n  readonly onWidgetStateChanged?: () => void;\r\n  /** Save transient DOM state (i.e. scroll offset). */\r\n  readonly saveTransientState?: () => void;\r\n  /** Restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  readonly restoreTransientState?: () => boolean;\r\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\r\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\r\n   * internally. */\r\n  defaultFloatingSize?: { width: number, height: number };\r\n  /** Optional prop that tells the widget system to fade this widget out with the rest of the UI when it is in floating state */\r\n  hideWithUiWhenFloating?: boolean;\r\n  /** Optional prop specifying which Panel sides can be docking targets for this widget. If this prop is not specified, all sides are allowed.\r\n   *  An empty array is treated the same as an undefined prop, allowing all targets. */\r\n  readonly allowedPanelTargets?:  ReadonlyArray<\"left\"|\"right\"|\"bottom\"|\"top\">;\r\n}\r\n"]}

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

@@ -1,20 +1,37 @@
-/** @packageDocumentation
- * @module Widget
- */
-/** Available Stage Panel locations.
- * @public
- */
-export declare enum StagePanelLocation {
-    Top = 101,
-    Left = 102,
-    Right = 103,
-    Bottom = 104
-}
-/** Enum for Stage Panel Sections
- * @public
- */
-export declare enum StagePanelSection {
-    Start = 0,
-    End = 1
-}
+/** @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.
+ */
+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 Used in UI1.0 only. */
+    TopMost = 102,
+    Left = 103,
+    Right = 104,
+    Bottom = 105,
+    /** @deprecated Used in UI1.0 only. */
+    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/esm/appui-abstract/widget/StagePanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;CACP;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,GAAG,IAAA;CACJ"}
+{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,sCAAsC;IACtC,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,sCAAsC;IACtC,UAAU,MAAA;CACX;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,mGAAmG;IACnG,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}

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

@@ -1,26 +1,44 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** Available Stage Panel locations.
- * @public
- */
-export var StagePanelLocation;
-(function (StagePanelLocation) {
-    StagePanelLocation[StagePanelLocation["Top"] = 101] = "Top";
-    StagePanelLocation[StagePanelLocation["Left"] = 102] = "Left";
-    StagePanelLocation[StagePanelLocation["Right"] = 103] = "Right";
-    StagePanelLocation[StagePanelLocation["Bottom"] = 104] = "Bottom";
-})(StagePanelLocation || (StagePanelLocation = {}));
-/** Enum for Stage Panel Sections
- * @public
- */
-export var StagePanelSection;
-(function (StagePanelSection) {
-    StagePanelSection[StagePanelSection["Start"] = 0] = "Start";
-    StagePanelSection[StagePanelSection["End"] = 1] = "End";
-})(StagePanelSection || (StagePanelSection = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
+ * @public @deprecated in 3.0.
+ */
+export 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 || (AbstractZoneLocation = {}));
+/** Available Stage Panel locations.
+ * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.
+ * @public
+ */
+export var StagePanelLocation;
+(function (StagePanelLocation) {
+    StagePanelLocation[StagePanelLocation["Top"] = 101] = "Top";
+    /** @deprecated Used in UI1.0 only. */
+    StagePanelLocation[StagePanelLocation["TopMost"] = 102] = "TopMost";
+    StagePanelLocation[StagePanelLocation["Left"] = 103] = "Left";
+    StagePanelLocation[StagePanelLocation["Right"] = 104] = "Right";
+    StagePanelLocation[StagePanelLocation["Bottom"] = 105] = "Bottom";
+    /** @deprecated Used in UI1.0 only. */
+    StagePanelLocation[StagePanelLocation["BottomMost"] = 106] = "BottomMost";
+})(StagePanelLocation || (StagePanelLocation = {}));
+/** Enum for Stage Panel Sections
+ * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.
+ * @public
+ */
+export 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 || (StagePanelSection = {}));
 //# sourceMappingURL=StagePanel.js.map

package/lib/esm/appui-abstract/widget/StagePanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;AACR,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,uDAAG,CAAA;AACL,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B","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 Widget\n */\n\n/** Available Stage Panel locations.\n * @public\n */\nexport enum StagePanelLocation {\n  Top = 101,\n  Left,\n  Right,\n  Bottom,\n}\n\n/** Enum for Stage Panel Sections\n * @public\n */\nexport enum StagePanelSection {\n  Start,\n  End,\n}\n"]}
+{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,sCAAsC;IACtC,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,sCAAsC;IACtC,yEAAU,CAAA;AACZ,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,mGAAmG;IACnG,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\r\n * @public @deprecated in 3.0.\r\n */\r\nexport enum AbstractZoneLocation {\r\n  CenterLeft = 4,\r\n  CenterRight = 6,\r\n  BottomLeft = 7,\r\n  BottomRight = 9,\r\n}\r\n\r\n/** Available Stage Panel locations.\r\n * @deprecated in 3.6. Use [StagePanelLocation]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StagePanelLocation {\r\n  Top = 101,\r\n  /** @deprecated Used in UI1.0 only. */\r\n  TopMost,\r\n  Left,\r\n  Right,\r\n  Bottom,\r\n  /** @deprecated Used in UI1.0 only. */\r\n  BottomMost,\r\n}\r\n\r\n/** Enum for Stage Panel Sections\r\n * @deprecated in 3.6. Use [StagePanelSection]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StagePanelSection {\r\n  Start,\r\n  /** @deprecated in 3.2. - all widgets that a targeted for Middle will be placed in `End` section */\r\n  Middle,\r\n  End,\r\n}\r\n"]}

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

@@ -1,19 +1,20 @@
-/** @packageDocumentation
- * @module Widget
- */
-/** Widget state enum.
- * @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/esm/appui-abstract/widget/WidgetState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WidgetState.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/WidgetState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,WAAW;IACrB,oEAAoE;IACpE,IAAI,IAAA;IACJ,6DAA6D;IAC7D,MAAM,IAAA;IACN,8CAA8C;IAC9C,MAAM,IAAA;IACN,gFAAgF;IAChF,QAAQ,IAAA;IACR,4DAA4D;IAC5D,QAAQ,IAAA;CACT"}
+{"version":3,"file":"WidgetState.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/WidgetState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,oBAAY,WAAW;IACrB,oEAAoE;IACpE,IAAI,IAAA;IACJ,6DAA6D;IAC7D,MAAM,IAAA;IACN,8CAA8C;IAC9C,MAAM,IAAA;IACN,gFAAgF;IAChF,QAAQ,IAAA;IACR,4DAA4D;IAC5D,QAAQ,IAAA;CACT"}

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

@@ -1,24 +1,25 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** Widget state enum.
- * @public
- */
-export 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 || (WidgetState = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Widget state enum.
+ * @deprecated in 3.6. Use [WidgetState]($appui-react) instead.
+ * @public
+ */
+export 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 || (WidgetState = {}));
 //# sourceMappingURL=WidgetState.js.map

package/lib/esm/appui-abstract/widget/WidgetState.js.map

@@ -1 +1 @@
-{"version":3,"file":"WidgetState.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/WidgetState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,WAWX;AAXD,WAAY,WAAW;IACrB,oEAAoE;IACpE,6CAAI,CAAA;IACJ,6DAA6D;IAC7D,iDAAM,CAAA;IACN,8CAA8C;IAC9C,iDAAM,CAAA;IACN,gFAAgF;IAChF,qDAAQ,CAAA;IACR,4DAA4D;IAC5D,qDAAQ,CAAA;AACV,CAAC,EAXW,WAAW,KAAX,WAAW,QAWtB","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 Widget\n */\n\n/** Widget state enum.\n * @public\n */\nexport enum WidgetState {\n  /** Widget tab is visible and active and its contents are visible */\n  Open,\n  /** Widget tab is visible but its contents are not visible */\n  Closed,\n  /** Widget tab nor its contents are visible */\n  Hidden,\n  /** Widget tab is in a 'floating' state and is not docked in zone's tab stack */\n  Floating,\n  /** Widget tab is visible but its contents are not loaded */\n  Unloaded,\n}\n"]}
+{"version":3,"file":"WidgetState.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/WidgetState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAWX;AAXD,WAAY,WAAW;IACrB,oEAAoE;IACpE,6CAAI,CAAA;IACJ,6DAA6D;IAC7D,iDAAM,CAAA;IACN,8CAA8C;IAC9C,iDAAM,CAAA;IACN,gFAAgF;IAChF,qDAAQ,CAAA;IACR,4DAA4D;IAC5D,qDAAQ,CAAA;AACV,CAAC,EAXW,WAAW,KAAX,WAAW,QAWtB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\n/** Widget state enum.\r\n * @deprecated in 3.6. Use [WidgetState]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum WidgetState {\r\n  /** Widget tab is visible and active and its contents are visible */\r\n  Open,\r\n  /** Widget tab is visible but its contents are not visible */\r\n  Closed,\r\n  /** Widget tab nor its contents are visible */\r\n  Hidden,\r\n  /** Widget tab is in a 'floating' state and is not docked in zone's tab stack */\r\n  Floating,\r\n  /** Widget tab is visible but its contents are not loaded */\r\n  Unloaded,\r\n}\r\n"]}