@itwin/appui-react 3.0.0-dev.100

package/lib/cjs/appui-react/widgets/WidgetDef.js

@@ -0,0 +1,331 @@
+"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.WidgetDef = exports.WidgetType = exports.WidgetStateChangedEvent = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const core_react_1 = require("@itwin/core-react");
+const ConfigurableUiControl_1 = require("../configurableui/ConfigurableUiControl");
+const ConfigurableUiManager_1 = require("../configurableui/ConfigurableUiManager");
+const FrontstageManager_1 = require("../frontstage/FrontstageManager");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const UiFramework_1 = require("../UiFramework");
+const PropsHelper_1 = require("../utils/PropsHelper");
+const StatusBarWidgetComposerControl_1 = require("./StatusBarWidgetComposerControl");
+const widgetStateNameMap = new Map([
+    [appui_abstract_1.WidgetState.Closed, "Closed"],
+    [appui_abstract_1.WidgetState.Floating, "Floating"],
+    [appui_abstract_1.WidgetState.Hidden, "Hidden"],
+    [appui_abstract_1.WidgetState.Open, "Open"],
+    [appui_abstract_1.WidgetState.Unloaded, "Unloaded"],
+]);
+/** Widget State Changed Event class.
+ * @public
+ */
+class WidgetStateChangedEvent extends core_react_1.UiEvent {
+}
+exports.WidgetStateChangedEvent = WidgetStateChangedEvent;
+/** Widget type enum.
+ * @public
+ */
+var WidgetType;
+(function (WidgetType) {
+    WidgetType[WidgetType["Tool"] = 0] = "Tool";
+    WidgetType[WidgetType["Navigation"] = 1] = "Navigation";
+    WidgetType[WidgetType["FreeFrom"] = 2] = "FreeFrom";
+    WidgetType[WidgetType["Rectangular"] = 3] = "Rectangular";
+    WidgetType[WidgetType["ToolSettings"] = 4] = "ToolSettings";
+    WidgetType[WidgetType["StatusBar"] = 5] = "StatusBar";
+})(WidgetType = exports.WidgetType || (exports.WidgetType = {}));
+// -----------------------------------------------------------------------------
+/** A Widget Definition in the 9-Zone Layout system.
+ * @public
+ */
+class WidgetDef {
+    constructor(widgetProps) {
+        this._label = "";
+        this._tooltip = "";
+        this._defaultState = appui_abstract_1.WidgetState.Unloaded;
+        this._state = appui_abstract_1.WidgetState.Unloaded;
+        this._classId = undefined;
+        this._priority = 0;
+        this._isFreeform = false;
+        this._isFloatingStateSupported = false;
+        this._isFloatingStateWindowResizable = true;
+        this._isToolSettings = false;
+        this._isStatusBar = false;
+        this._stateChanged = false;
+        this._fillZone = false;
+        this._syncEventIds = [];
+        this._widgetType = WidgetType.Rectangular;
+        this._tabLocation = {
+            side: "left",
+            tabIndex: 0,
+            widgetId: "",
+            widgetIndex: 0,
+        };
+        this._handleSyncUiEvent = (args) => {
+            if ((this.syncEventIds.length > 0) && this.syncEventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
+                // istanbul ignore else
+                if (this.stateFunc) {
+                    let newState = this.state;
+                    newState = this.stateFunc(newState);
+                    this.setWidgetState(newState);
+                }
+            }
+        };
+        if (widgetProps.id !== undefined)
+            this._id = widgetProps.id;
+        else {
+            WidgetDef._sId++;
+            this._id = `Widget-${WidgetDef._sId}`;
+        }
+        WidgetDef.initializeFromWidgetProps(widgetProps, this);
+    }
+    get state() { return this._state; }
+    get id() { return this._id; }
+    get classId() { return this._classId; }
+    get priority() { return this._priority; }
+    get isFreeform() { return this._isFreeform; }
+    get isFloatingStateSupported() { return this._isFloatingStateSupported; }
+    get isFloatingStateWindowResizable() { return this._isFloatingStateWindowResizable; }
+    get isToolSettings() { return this._isToolSettings; }
+    get isStatusBar() { return this._isStatusBar; }
+    get stateChanged() { return this._stateChanged; }
+    get fillZone() { return this._fillZone; }
+    get syncEventIds() { return this._syncEventIds; }
+    get stateFunc() { return this._stateFunc; }
+    get applicationData() { return this._applicationData; }
+    get isFloating() { return this._state === appui_abstract_1.WidgetState.Floating; }
+    get iconSpec() { return this._iconSpec; }
+    get badgeType() { return this._badgeType; }
+    get widgetType() { return this._widgetType; }
+    set widgetType(type) { this._widgetType = type; }
+    /** @internal */
+    get tabLocation() { return this._tabLocation; }
+    set tabLocation(tabLocation) { this._tabLocation = tabLocation; }
+    /** @internal */
+    get defaultFloatingPosition() { return this._defaultFloatingPosition; }
+    set defaultFloatingPosition(position) { this._defaultFloatingPosition = position; }
+    /** @internal */
+    get defaultState() { return this._defaultState; }
+    static initializeFromWidgetProps(widgetProps, me) {
+        if (widgetProps.label)
+            me.setLabel(widgetProps.label);
+        else if (widgetProps.labelKey)
+            me._label = UiFramework_1.UiFramework.localization.getLocalizedString(widgetProps.labelKey);
+        me.setCanPopout(widgetProps.canPopout);
+        me.setFloatingContainerId(widgetProps.floatingContainerId);
+        me.defaultFloatingPosition = widgetProps.defaultFloatingPosition ? widgetProps.defaultFloatingPosition : undefined;
+        if (widgetProps.priority !== undefined)
+            me._priority = widgetProps.priority;
+        if (widgetProps.tooltip)
+            me.setTooltip(widgetProps.tooltip);
+        else if (widgetProps.tooltipKey)
+            me._tooltip = UiFramework_1.UiFramework.localization.getLocalizedString(widgetProps.tooltipKey);
+        if (widgetProps.control !== undefined)
+            me._classId = widgetProps.control;
+        else if (widgetProps.classId !== undefined)
+            me._classId = widgetProps.classId;
+        if (widgetProps.defaultState !== undefined) {
+            me._defaultState = widgetProps.defaultState;
+            me._state = widgetProps.defaultState === appui_abstract_1.WidgetState.Floating ? appui_abstract_1.WidgetState.Open : widgetProps.defaultState;
+        }
+        if (widgetProps.isFreeform !== undefined) {
+            me._isFreeform = widgetProps.isFreeform;
+            me._widgetType = me.isFreeform ? WidgetType.FreeFrom : WidgetType.Rectangular;
+        }
+        if (widgetProps.isFloatingStateSupported !== undefined)
+            me._isFloatingStateSupported = widgetProps.isFloatingStateSupported;
+        if (widgetProps.isFloatingStateWindowResizable !== undefined)
+            me._isFloatingStateWindowResizable = widgetProps.isFloatingStateWindowResizable;
+        if (widgetProps.isToolSettings !== undefined)
+            me._isToolSettings = widgetProps.isToolSettings;
+        if (widgetProps.isStatusBar !== undefined)
+            me._isStatusBar = widgetProps.isStatusBar;
+        if (widgetProps.fillZone !== undefined)
+            me._fillZone = widgetProps.fillZone;
+        if (widgetProps.applicationData !== undefined)
+            me._applicationData = widgetProps.applicationData;
+        if (widgetProps.element !== undefined)
+            me._widgetReactNode = widgetProps.element;
+        if (widgetProps.iconSpec !== undefined)
+            me._iconSpec = widgetProps.iconSpec;
+        // istanbul ignore if
+        if (widgetProps.icon !== undefined)
+            me._iconSpec = widgetProps.icon;
+        if (widgetProps.badgeType !== undefined)
+            me._badgeType = widgetProps.badgeType;
+        me._preferredPanelSize = widgetProps.preferredPanelSize;
+        me._onWidgetStateChanged = widgetProps.onWidgetStateChanged;
+        me._saveTransientState = widgetProps.saveTransientState;
+        me._restoreTransientState = widgetProps.restoreTransientState;
+        me.setUpSyncSupport(widgetProps);
+    }
+    static createWidgetPropsFromAbstractProps(abstractWidgetProps) {
+        const widgetProps = abstractWidgetProps;
+        widgetProps.element = abstractWidgetProps.getWidgetContent();
+        return widgetProps;
+    }
+    setUpSyncSupport(props) {
+        if (props.stateFunc && props.syncEventIds && props.syncEventIds.length > 0) {
+            this._syncEventIds = props.syncEventIds;
+            this._stateFunc = props.stateFunc;
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
+        }
+    }
+    /** @alpha */
+    get preferredPanelSize() {
+        return this._preferredPanelSize;
+    }
+    /** Get the label string */
+    get label() {
+        return PropsHelper_1.PropsHelper.getStringFromSpec(this._label);
+    }
+    /** Set the label.
+     * @param v A string or a function to get the string.
+     */
+    setLabel(v) {
+        if (this._label === v)
+            return;
+        this._label = v;
+        FrontstageManager_1.FrontstageManager.onWidgetLabelChangedEvent.emit({ widgetDef: this });
+    }
+    /** Get the tooltip string */
+    get tooltip() {
+        return PropsHelper_1.PropsHelper.getStringFromSpec(this._tooltip);
+    }
+    /** Set the tooltip.
+     * @param v A string or a function to get the string.
+     */
+    setTooltip(v) {
+        this._tooltip = v;
+    }
+    get widgetControl() {
+        return this._widgetControl;
+    }
+    getWidgetControl(type) {
+        if (!this._widgetControl && this.classId) {
+            let usedClassId = "";
+            if (typeof this.classId === "string") {
+                // istanbul ignore else
+                if (this.classId)
+                    this._widgetControl = ConfigurableUiManager_1.ConfigurableUiManager.createControl(this.classId, this.id, this.applicationData);
+                usedClassId = this.classId;
+            }
+            else {
+                const info = new ConfigurableUiControl_1.ConfigurableCreateInfo(this.classId.name, this.id, this.id);
+                usedClassId = this.classId.name;
+                this._widgetControl = new this.classId(info, this.applicationData);
+            }
+            // istanbul ignore else
+            if (this._widgetControl) {
+                if (this._widgetControl.getType() !== type) {
+                    throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `getWidgetControl: '${usedClassId}' is NOT a ${type}; it is a ${this._widgetControl.getType()}`);
+                }
+                this._widgetControl.widgetDef = this;
+                this._widgetControl.initialize();
+            }
+        }
+        // istanbul ignore next - To avoid breaking API changes, if a WidgetControl is not specified for a status bar use Default one.
+        if (!this._widgetControl && this.isStatusBar) {
+            const info = new ConfigurableUiControl_1.ConfigurableCreateInfo("StatusBarWidgetComposerControl", StatusBarWidgetComposerControl_1.StatusBarWidgetComposerControl.controlId, StatusBarWidgetComposerControl_1.StatusBarWidgetComposerControl.controlId);
+            this._widgetControl = new StatusBarWidgetComposerControl_1.StatusBarWidgetComposerControl(info, undefined);
+            this._widgetControl.widgetDef = this;
+            this._widgetControl.initialize();
+        }
+        return this._widgetControl;
+    }
+    get reactNode() {
+        if (!this._widgetReactNode) {
+            const widgetControl = this.getWidgetControl(ConfigurableUiControl_1.ConfigurableUiControlType.Widget);
+            // istanbul ignore else
+            if (widgetControl && widgetControl.reactNode)
+                this._widgetReactNode = widgetControl.reactNode;
+        }
+        return this._widgetReactNode;
+    }
+    set reactNode(node) {
+        this._widgetReactNode = node;
+    }
+    setWidgetState(newState) {
+        if (this.state === newState)
+            return;
+        this._state = newState;
+        this._stateChanged = true;
+        FrontstageManager_1.FrontstageManager.onWidgetStateChangedEvent.emit({ widgetDef: this, widgetState: newState });
+        this.onWidgetStateChanged();
+    }
+    setCanPopout(value) {
+        this._canPopout = value;
+    }
+    get canPopout() {
+        return (this._canPopout);
+    }
+    setFloatingContainerId(value) {
+        this._floatingContainerId = value;
+    }
+    get floatingContainerId() {
+        return (this._floatingContainerId);
+    }
+    canOpen() {
+        return (this.isFloating || this.isActive);
+    }
+    get isVisible() {
+        return appui_abstract_1.WidgetState.Hidden !== this.state;
+    }
+    get activeState() {
+        return this.state;
+    }
+    get isActive() {
+        return appui_abstract_1.WidgetState.Open === this.activeState;
+    }
+    onWidgetStateChanged() {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this.widgetControl && UiFramework_1.UiFramework.postTelemetry(`Widget ${this.widgetControl.classId} state set to ${widgetStateNameMap.get(this._state)}`, "35402486-9839-441E-A5C7-46D546142D11");
+        this.widgetControl && this.widgetControl.onWidgetStateChanged();
+        // istanbul ignore next
+        this._onWidgetStateChanged && this._onWidgetStateChanged();
+    }
+    /** Overwrite to save transient DOM state (i.e. scroll offset). */
+    saveTransientState() {
+        this.widgetControl && this.widgetControl.saveTransientState();
+        this._saveTransientState && this._saveTransientState();
+    }
+    /** Overwrite to restore transient DOM state.
+     * @note Return true if the state is restored or the Widget will remount.
+     */
+    restoreTransientState() {
+        let result = true;
+        if (this.widgetControl || this._restoreTransientState) {
+            let result1 = false, result2 = false;
+            if (this.widgetControl)
+                result1 = this.widgetControl.restoreTransientState();
+            if (this._restoreTransientState)
+                result2 = this._restoreTransientState();
+            result = !(result1 || result2);
+        }
+        return result;
+    }
+    /** Opens the widget and makes it visible to the user.
+     * I.e. opens the stage panel or brings the floating widget to front of the screen.
+     * @alpha
+     */
+    show() {
+        FrontstageManager_1.FrontstageManager.onWidgetShowEvent.emit({ widgetDef: this });
+    }
+    /** Opens the widget and expands it to fill full size of the stage panel.
+     * @alpha
+     */
+    expand() {
+        FrontstageManager_1.FrontstageManager.onWidgetExpandEvent.emit({ widgetDef: this });
+    }
+}
+exports.WidgetDef = WidgetDef;
+WidgetDef._sId = 0;
+//# sourceMappingURL=WidgetDef.js.map

package/lib/cjs/appui-react/widgets/WidgetDef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetDef.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetDef.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,0DAA+I;AAC/I,kDAA4C;AAE5C,mFAA8I;AAC9I,mFAAgF;AAChF,uEAAoE;AAGpE,2EAAyF;AACzF,gDAA6C;AAC7C,sDAAmD;AAGnD,qFAAkF;AAElF,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAsB;IACtD,CAAC,4BAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC9B,CAAC,4BAAW,CAAC,QAAQ,EAAE,UAAU,CAAC;IAClC,CAAC,4BAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC9B,CAAC,4BAAW,CAAC,IAAI,EAAE,MAAM,CAAC;IAC1B,CAAC,4BAAW,CAAC,QAAQ,EAAE,UAAU,CAAC;CACnC,CAAC,CAAC;AAUH;;GAEG;AACH,MAAa,uBAAwB,SAAQ,oBAAoC;CAAI;AAArF,0DAAqF;AAYrF;;GAEG;AACH,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2CAAI,CAAA;IACJ,uDAAU,CAAA;IACV,mDAAQ,CAAA;IACR,yDAAW,CAAA;IACX,2DAAY,CAAA;IACZ,qDAAS,CAAA;AACX,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AA6CD,gFAAgF;AAEhF;;GAEG;AACH,MAAa,SAAS;IAuEpB,YAAY,WAAwB;QArE5B,WAAM,GAAmD,EAAE,CAAC;QAC5D,aAAQ,GAAmD,EAAE,CAAC;QAG9D,kBAAa,GAAgB,4BAAW,CAAC,QAAQ,CAAC;QAClD,WAAM,GAAgB,4BAAW,CAAC,QAAQ,CAAC;QAE3C,aAAQ,GAA0D,SAAS,CAAC;QAC5E,cAAS,GAAW,CAAC,CAAC;QACtB,gBAAW,GAAY,KAAK,CAAC;QAC7B,8BAAyB,GAAY,KAAK,CAAC;QAC3C,oCAA+B,GAAY,IAAI,CAAC;QAChD,oBAAe,GAAY,KAAK,CAAC;QACjC,iBAAY,GAAY,KAAK,CAAC;QAC9B,kBAAa,GAAY,KAAK,CAAC;QAC/B,cAAS,GAAY,KAAK,CAAC;QAC3B,kBAAa,GAAa,EAAE,CAAC;QAE7B,gBAAW,GAAe,UAAU,CAAC,WAAW,CAAC;QAYjD,iBAAY,GAAgB;YAClC,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,CAAC;SACf,CAAC;QA8HM,uBAAkB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YAC3D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBAChI,uBAAuB;gBACvB,IAAI,IAAI,CAAC,SAAS,EAAE;oBAClB,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;oBAC1B,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;oBACpC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;iBAC/B;aACF;QACH,CAAC,CAAC;QApGA,IAAI,WAAW,CAAC,EAAE,KAAK,SAAS;YAC9B,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC,EAAE,CAAC;aACvB;YACH,SAAS,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,GAAG,UAAU,SAAS,CAAC,IAAI,EAAE,CAAC;SACvC;QAED,SAAS,CAAC,yBAAyB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAzCD,IAAW,KAAK,KAAkB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACvD,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,IAAW,OAAO,KAA4D,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrG,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACxD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7D,IAAW,wBAAwB,KAAc,OAAO,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACzF,IAAW,8BAA8B,KAAc,OAAO,IAAI,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACrG,IAAW,cAAc,KAAc,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IACrE,IAAW,WAAW,KAAc,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,IAAW,YAAY,KAAc,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,IAAW,YAAY,KAAe,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAClE,IAAW,SAAS,KAAkC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/E,IAAW,eAAe,KAAsB,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC/E,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,MAAM,KAAK,4BAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjF,IAAW,QAAQ,KAAwD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACnG,IAAW,SAAS,KAA4B,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzE,IAAW,UAAU,KAAiB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAChE,IAAW,UAAU,CAAC,IAAgB,IAAI,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC;IAEpE,gBAAgB;IAChB,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD,IAAW,WAAW,CAAC,WAAwB,IAAI,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC,CAAC;IAErF,gBAAgB;IAChB,IAAW,uBAAuB,KAAK,OAAO,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAC9E,IAAW,uBAAuB,CAAC,QAAgC,IAAI,IAAI,CAAC,wBAAwB,GAAG,QAAQ,CAAC,CAAC,CAAC;IAElH,gBAAgB;IAChB,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAajD,MAAM,CAAC,yBAAyB,CAAC,WAAwB,EAAE,EAAa;QAC7E,IAAI,WAAW,CAAC,KAAK;YACnB,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAC5B,IAAI,WAAW,CAAC,QAAQ;YAC3B,EAAE,CAAC,MAAM,GAAG,yBAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEhF,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACvC,EAAE,CAAC,sBAAsB,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;QAC3D,EAAE,CAAC,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC,CAAC,CAAC,WAAW,CAAC,uBAAqC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEjI,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS;YACpC,EAAE,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;QAEtC,IAAI,WAAW,CAAC,OAAO;YACrB,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;aAChC,IAAI,WAAW,CAAC,UAAU;YAC7B,EAAE,CAAC,QAAQ,GAAG,yBAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAEpF,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS;YACnC,EAAE,CAAC,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC;aAC/B,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS;YACxC,EAAE,CAAC,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC;QAEpC,IAAI,WAAW,CAAC,YAAY,KAAK,SAAS,EAAE;YAC1C,EAAE,CAAC,aAAa,GAAG,WAAW,CAAC,YAAY,CAAC;YAC5C,EAAE,CAAC,MAAM,GAAG,WAAW,CAAC,YAAY,KAAK,4BAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,4BAAW,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC;SAC7G;QAED,IAAI,WAAW,CAAC,UAAU,KAAK,SAAS,EAAE;YACxC,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC;YACxC,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC;SAC/E;QAED,IAAI,WAAW,CAAC,wBAAwB,KAAK,SAAS;YACpD,EAAE,CAAC,yBAAyB,GAAG,WAAW,CAAC,wBAAwB,CAAC;QACtE,IAAI,WAAW,CAAC,8BAA8B,KAAK,SAAS;YAC1D,EAAE,CAAC,+BAA+B,GAAG,WAAW,CAAC,8BAA8B,CAAC;QAClF,IAAI,WAAW,CAAC,cAAc,KAAK,SAAS;YAC1C,EAAE,CAAC,eAAe,GAAG,WAAW,CAAC,cAAc,CAAC;QAClD,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS;YACvC,EAAE,CAAC,YAAY,GAAG,WAAW,CAAC,WAAW,CAAC;QAC5C,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS;YACpC,EAAE,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;QAEtC,IAAI,WAAW,CAAC,eAAe,KAAK,SAAS;YAC3C,EAAE,CAAC,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC;QAEpD,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS;YACnC,EAAE,CAAC,gBAAgB,GAAG,WAAW,CAAC,OAAO,CAAC;QAE5C,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS;YACpC,EAAE,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;QACtC,qBAAqB;QACrB,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS;YAChC,EAAE,CAAC,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC;QAElC,IAAI,WAAW,CAAC,SAAS,KAAK,SAAS;YACrC,EAAE,CAAC,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC;QAExC,EAAE,CAAC,mBAAmB,GAAG,WAAW,CAAC,kBAAkB,CAAC;QACxD,EAAE,CAAC,qBAAqB,GAAG,WAAW,CAAC,oBAAoB,CAAC;QAC5D,EAAE,CAAC,mBAAmB,GAAG,WAAW,CAAC,kBAAkB,CAAC;QACxD,EAAE,CAAC,sBAAsB,GAAG,WAAW,CAAC,qBAAqB,CAAC;QAE9D,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,kCAAkC,CAAC,mBAAwC;QACvF,MAAM,WAAW,GAAgB,mBAAmB,CAAC;QACrD,WAAW,CAAC,OAAO,GAAG,mBAAmB,CAAC,gBAAgB,EAAE,CAAC;QAC7D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,gBAAgB,CAAC,KAAkB;QACxC,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1E,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;YACxC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;YAClC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SAC1E;IACH,CAAC;IAaD,aAAa;IACb,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED,2BAA2B;IAC3B,IAAW,KAAK;QACd,OAAO,yBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,CAAiD;QAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YACnB,OAAO;QACT,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,qCAAiB,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,6BAA6B;IAC7B,IAAW,OAAO;QAChB,OAAO,yBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,CAAiD;QACjE,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IACpB,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAEM,gBAAgB,CAAC,IAA+B;QACrD,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,OAAO,EAAE;YACxC,IAAI,WAAW,GAAW,EAAE,CAAC;YAE7B,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACpC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,OAAO;oBACd,IAAI,CAAC,cAAc,GAAG,6CAAqB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,eAAe,CAAkB,CAAC;gBAC1H,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC;aAC5B;iBAAM;gBACL,MAAM,IAAI,GAAG,IAAI,8CAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC7E,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBAChC,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAkB,CAAC;aACrF;YAED,uBAAuB;YACvB,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBAC1C,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,sBAAsB,WAAW,cAAc,IAAI,aAAa,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;iBACtJ;gBAED,IAAI,CAAC,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;aAClC;SACF;QAED,8HAA8H;QAC9H,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,WAAW,EAAE;YAC5C,MAAM,IAAI,GAAG,IAAI,8CAAsB,CAAC,gCAAgC,EAAE,+DAA8B,CAAC,SAAS,EAAE,+DAA8B,CAAC,SAAS,CAAC,CAAC;YAC9J,IAAI,CAAC,cAAc,GAAG,IAAI,+DAA8B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC1E,IAAI,CAAC,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC;YACrC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;SAClC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAW,SAAS;QAClB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;YAC1B,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,iDAAyB,CAAC,MAAM,CAAC,CAAC;YAE9E,uBAAuB;YACvB,IAAI,aAAa,IAAI,aAAa,CAAC,SAAS;gBAC1C,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAC,SAAS,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,IAAW,SAAS,CAAC,IAAqB;QACxC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC/B,CAAC;IAEM,cAAc,CAAC,QAAqB;QACzC,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ;YACzB,OAAO;QACT,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,qCAAiB,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7F,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEM,YAAY,CAAC,KAA0B;QAC5C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC;IAEM,sBAAsB,CAAC,KAAyB;QACrD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACpC,CAAC;IAED,IAAW,mBAAmB;QAC5B,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO;QACZ,OAAO,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,4BAAW,CAAC,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC;IAC3C,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,4BAAW,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,oBAAoB;QACzB,mEAAmE;QACnE,IAAI,CAAC,aAAa,IAAI,yBAAW,CAAC,aAAa,CAAC,UAAU,IAAI,CAAC,aAAa,CAAC,OAAO,iBAAiB,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,sCAAsC,CAAC,CAAC;QACpL,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,CAAC;QAChE,uBAAuB;QACvB,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC7D,CAAC;IAED,kEAAkE;IAC3D,kBAAkB;QACvB,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,CAAC;QAC9D,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,sBAAsB,EAAE;YACrD,IAAI,OAAO,GAAG,KAAK,EAAE,OAAO,GAAG,KAAK,CAAC;YACrC,IAAI,IAAI,CAAC,aAAa;gBACpB,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;YACvD,IAAI,IAAI,CAAC,sBAAsB;gBAC7B,OAAO,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC1C,MAAM,GAAG,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC;SAChC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,IAAI;QACT,qCAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,MAAM;QACX,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;;AA3VH,8BA4VC;AA3VgB,cAAI,GAAG,CAAC,CAAC","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 * as React from \"react\";\r\nimport { AbstractWidgetProps, BadgeType, ConditionalStringValue, PointProps, StringGetter, UiError, WidgetState } from \"@itwin/appui-abstract\";\r\nimport { UiEvent } from \"@itwin/core-react\";\r\nimport { Direction, PanelSide } from \"@itwin/appui-layout-react\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlConstructor, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { ConfigurableUiManager } from \"../configurableui/ConfigurableUiManager\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\r\nimport { ItemList } from \"../shared/ItemMap\";\r\nimport { SyncUiEventArgs, SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { PropsHelper } from \"../utils/PropsHelper\";\r\nimport { WidgetControl } from \"./WidgetControl\";\r\nimport { WidgetProps } from \"./WidgetProps\";\r\nimport { StatusBarWidgetComposerControl } from \"./StatusBarWidgetComposerControl\";\r\n\r\nconst widgetStateNameMap = new Map<WidgetState, string>([\r\n  [WidgetState.Closed, \"Closed\"],\r\n  [WidgetState.Floating, \"Floating\"],\r\n  [WidgetState.Hidden, \"Hidden\"],\r\n  [WidgetState.Open, \"Open\"],\r\n  [WidgetState.Unloaded, \"Unloaded\"],\r\n]);\r\n\r\n/** Widget State Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface WidgetStateChangedEventArgs {\r\n  widgetDef: WidgetDef;\r\n  widgetState: WidgetState;\r\n}\r\n\r\n/** Widget State Changed Event class.\r\n * @public\r\n */\r\nexport class WidgetStateChangedEvent extends UiEvent<WidgetStateChangedEventArgs> { }\r\n\r\n/** @internal */\r\nexport interface WidgetChangedEventArgs {\r\n  widgetDef: WidgetDef;\r\n}\r\n\r\n/** @internal */\r\nexport interface WidgetEventArgs {\r\n  widgetDef: WidgetDef;\r\n}\r\n\r\n/** Widget type enum.\r\n * @public\r\n */\r\nexport enum WidgetType {\r\n  Tool,\r\n  Navigation,\r\n  FreeFrom,\r\n  Rectangular,\r\n  ToolSettings,\r\n  StatusBar,\r\n}\r\n\r\n/** Properties for a Toolbar Widget.\r\n * @public\r\n */\r\nexport interface ToolbarWidgetProps extends WidgetProps {\r\n  horizontalDirection?: Direction;\r\n  verticalDirection?: Direction;\r\n\r\n  horizontalItems?: ItemList;\r\n  verticalItems?: ItemList;\r\n}\r\n\r\n/** Properties for a Tool Widget.\r\n * @public\r\n */\r\nexport interface ToolWidgetProps extends ToolbarWidgetProps {\r\n  appButton?: CommandItemDef;\r\n}\r\n\r\n/** Properties for a Navigation Widget.\r\n * @public\r\n */\r\nexport interface NavigationWidgetProps extends ToolbarWidgetProps {\r\n  navigationAidId?: string;\r\n}\r\n\r\n/** Union of all Widget properties.\r\n * @public\r\n */\r\nexport type AnyWidgetProps = WidgetProps | ToolWidgetProps | NavigationWidgetProps;\r\n\r\n/** Prototype for WidgetDef StateFunc\r\n * @public\r\n */\r\nexport type WidgetStateFunc = (state: Readonly<WidgetState>) => WidgetState;\r\n\r\n/** @internal */\r\nexport interface TabLocation {\r\n  widgetId: string;\r\n  widgetIndex: number;\r\n  side: PanelSide;\r\n  tabIndex: number;\r\n}\r\n\r\n// -----------------------------------------------------------------------------\r\n\r\n/** A Widget Definition in the 9-Zone Layout system.\r\n * @public\r\n */\r\nexport class WidgetDef {\r\n  private static _sId = 0;\r\n  private _label: string | ConditionalStringValue | StringGetter = \"\";\r\n  private _tooltip: string | ConditionalStringValue | StringGetter = \"\";\r\n  private _widgetReactNode: React.ReactNode;\r\n  private _widgetControl!: WidgetControl;\r\n  private _defaultState: WidgetState = WidgetState.Unloaded;\r\n  private _state: WidgetState = WidgetState.Unloaded;\r\n  private _id: string;\r\n  private _classId: string | ConfigurableUiControlConstructor | undefined = undefined;\r\n  private _priority: number = 0;\r\n  private _isFreeform: boolean = false;\r\n  private _isFloatingStateSupported: boolean = false;\r\n  private _isFloatingStateWindowResizable: boolean = true;\r\n  private _isToolSettings: boolean = false;\r\n  private _isStatusBar: boolean = false;\r\n  private _stateChanged: boolean = false;\r\n  private _fillZone: boolean = false;\r\n  private _syncEventIds: string[] = [];\r\n  private _stateFunc?: WidgetStateFunc;\r\n  private _widgetType: WidgetType = WidgetType.Rectangular;\r\n  private _applicationData?: any;\r\n  private _iconSpec?: string | ConditionalStringValue | React.ReactNode;\r\n  private _badgeType?: BadgeType;\r\n  private _onWidgetStateChanged?: () => void;\r\n  private _saveTransientState?: () => void;\r\n  private _restoreTransientState?: () => boolean;\r\n  private _preferredPanelSize: \"fit-content\" | undefined;\r\n  private _canPopout?: boolean;\r\n  private _floatingContainerId?: string;\r\n  private _defaultFloatingPosition: PointProps | undefined;\r\n\r\n  private _tabLocation: TabLocation = {\r\n    side: \"left\",\r\n    tabIndex: 0,\r\n    widgetId: \"\",\r\n    widgetIndex: 0,\r\n  };\r\n\r\n  public get state(): WidgetState { return this._state; }\r\n  public get id(): string { return this._id; }\r\n  public get classId(): string | ConfigurableUiControlConstructor | undefined { return this._classId; }\r\n  public get priority(): number { return this._priority; }\r\n  public get isFreeform(): boolean { return this._isFreeform; }\r\n  public get isFloatingStateSupported(): boolean { return this._isFloatingStateSupported; }\r\n  public get isFloatingStateWindowResizable(): boolean { return this._isFloatingStateWindowResizable; }\r\n  public get isToolSettings(): boolean { return this._isToolSettings; }\r\n  public get isStatusBar(): boolean { return this._isStatusBar; }\r\n  public get stateChanged(): boolean { return this._stateChanged; }\r\n  public get fillZone(): boolean { return this._fillZone; }\r\n  public get syncEventIds(): string[] { return this._syncEventIds; }\r\n  public get stateFunc(): WidgetStateFunc | undefined { return this._stateFunc; }\r\n  public get applicationData(): any | undefined { return this._applicationData; }\r\n  public get isFloating(): boolean { return this._state === WidgetState.Floating; }\r\n  public get iconSpec(): string | ConditionalStringValue | React.ReactNode { return this._iconSpec; }\r\n  public get badgeType(): BadgeType | undefined { return this._badgeType; }\r\n\r\n  public get widgetType(): WidgetType { return this._widgetType; }\r\n  public set widgetType(type: WidgetType) { this._widgetType = type; }\r\n\r\n  /** @internal */\r\n  public get tabLocation() { return this._tabLocation; }\r\n  public set tabLocation(tabLocation: TabLocation) { this._tabLocation = tabLocation; }\r\n\r\n  /** @internal */\r\n  public get defaultFloatingPosition() { return this._defaultFloatingPosition; }\r\n  public set defaultFloatingPosition(position: PointProps | undefined) { this._defaultFloatingPosition = position; }\r\n\r\n  /** @internal */\r\n  public get defaultState() { return this._defaultState; }\r\n\r\n  constructor(widgetProps: WidgetProps) {\r\n    if (widgetProps.id !== undefined)\r\n      this._id = widgetProps.id;\r\n    else {\r\n      WidgetDef._sId++;\r\n      this._id = `Widget-${WidgetDef._sId}`;\r\n    }\r\n\r\n    WidgetDef.initializeFromWidgetProps(widgetProps, this);\r\n  }\r\n\r\n  public static initializeFromWidgetProps(widgetProps: WidgetProps, me: WidgetDef) {\r\n    if (widgetProps.label)\r\n      me.setLabel(widgetProps.label);\r\n    else if (widgetProps.labelKey)\r\n      me._label = UiFramework.localization.getLocalizedString(widgetProps.labelKey);\r\n\r\n    me.setCanPopout(widgetProps.canPopout);\r\n    me.setFloatingContainerId(widgetProps.floatingContainerId);\r\n    me.defaultFloatingPosition = widgetProps.defaultFloatingPosition ? widgetProps.defaultFloatingPosition as PointProps : undefined;\r\n\r\n    if (widgetProps.priority !== undefined)\r\n      me._priority = widgetProps.priority;\r\n\r\n    if (widgetProps.tooltip)\r\n      me.setTooltip(widgetProps.tooltip);\r\n    else if (widgetProps.tooltipKey)\r\n      me._tooltip = UiFramework.localization.getLocalizedString(widgetProps.tooltipKey);\r\n\r\n    if (widgetProps.control !== undefined)\r\n      me._classId = widgetProps.control;\r\n    else if (widgetProps.classId !== undefined)\r\n      me._classId = widgetProps.classId;\r\n\r\n    if (widgetProps.defaultState !== undefined) {\r\n      me._defaultState = widgetProps.defaultState;\r\n      me._state = widgetProps.defaultState === WidgetState.Floating ? WidgetState.Open : widgetProps.defaultState;\r\n    }\r\n\r\n    if (widgetProps.isFreeform !== undefined) {\r\n      me._isFreeform = widgetProps.isFreeform;\r\n      me._widgetType = me.isFreeform ? WidgetType.FreeFrom : WidgetType.Rectangular;\r\n    }\r\n\r\n    if (widgetProps.isFloatingStateSupported !== undefined)\r\n      me._isFloatingStateSupported = widgetProps.isFloatingStateSupported;\r\n    if (widgetProps.isFloatingStateWindowResizable !== undefined)\r\n      me._isFloatingStateWindowResizable = widgetProps.isFloatingStateWindowResizable;\r\n    if (widgetProps.isToolSettings !== undefined)\r\n      me._isToolSettings = widgetProps.isToolSettings;\r\n    if (widgetProps.isStatusBar !== undefined)\r\n      me._isStatusBar = widgetProps.isStatusBar;\r\n    if (widgetProps.fillZone !== undefined)\r\n      me._fillZone = widgetProps.fillZone;\r\n\r\n    if (widgetProps.applicationData !== undefined)\r\n      me._applicationData = widgetProps.applicationData;\r\n\r\n    if (widgetProps.element !== undefined)\r\n      me._widgetReactNode = widgetProps.element;\r\n\r\n    if (widgetProps.iconSpec !== undefined)\r\n      me._iconSpec = widgetProps.iconSpec;\r\n    // istanbul ignore if\r\n    if (widgetProps.icon !== undefined)\r\n      me._iconSpec = widgetProps.icon;\r\n\r\n    if (widgetProps.badgeType !== undefined)\r\n      me._badgeType = widgetProps.badgeType;\r\n\r\n    me._preferredPanelSize = widgetProps.preferredPanelSize;\r\n    me._onWidgetStateChanged = widgetProps.onWidgetStateChanged;\r\n    me._saveTransientState = widgetProps.saveTransientState;\r\n    me._restoreTransientState = widgetProps.restoreTransientState;\r\n\r\n    me.setUpSyncSupport(widgetProps);\r\n  }\r\n\r\n  public static createWidgetPropsFromAbstractProps(abstractWidgetProps: AbstractWidgetProps): WidgetProps {\r\n    const widgetProps: WidgetProps = abstractWidgetProps;\r\n    widgetProps.element = abstractWidgetProps.getWidgetContent();\r\n    return widgetProps;\r\n  }\r\n\r\n  public setUpSyncSupport(props: WidgetProps) {\r\n    if (props.stateFunc && props.syncEventIds && props.syncEventIds.length > 0) {\r\n      this._syncEventIds = props.syncEventIds;\r\n      this._stateFunc = props.stateFunc;\r\n      SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);\r\n    }\r\n  }\r\n\r\n  private _handleSyncUiEvent = (args: SyncUiEventArgs): void => {\r\n    if ((this.syncEventIds.length > 0) && this.syncEventIds.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\r\n      // istanbul ignore else\r\n      if (this.stateFunc) {\r\n        let newState = this.state;\r\n        newState = this.stateFunc(newState);\r\n        this.setWidgetState(newState);\r\n      }\r\n    }\r\n  };\r\n\r\n  /** @alpha */\r\n  public get preferredPanelSize() {\r\n    return this._preferredPanelSize;\r\n  }\r\n\r\n  /** Get the label string */\r\n  public get label(): string {\r\n    return PropsHelper.getStringFromSpec(this._label);\r\n  }\r\n\r\n  /** Set the label.\r\n   * @param v A string or a function to get the string.\r\n   */\r\n  public setLabel(v: string | ConditionalStringValue | StringGetter) {\r\n    if (this._label === v)\r\n      return;\r\n    this._label = v;\r\n    FrontstageManager.onWidgetLabelChangedEvent.emit({ widgetDef: this });\r\n  }\r\n\r\n  /** Get the tooltip string */\r\n  public get tooltip(): string {\r\n    return PropsHelper.getStringFromSpec(this._tooltip);\r\n  }\r\n\r\n  /** Set the tooltip.\r\n   * @param v A string or a function to get the string.\r\n   */\r\n  public setTooltip(v: string | ConditionalStringValue | StringGetter) {\r\n    this._tooltip = v;\r\n  }\r\n\r\n  public get widgetControl(): WidgetControl | undefined {\r\n    return this._widgetControl;\r\n  }\r\n\r\n  public getWidgetControl(type: ConfigurableUiControlType): WidgetControl | undefined {\r\n    if (!this._widgetControl && this.classId) {\r\n      let usedClassId: string = \"\";\r\n\r\n      if (typeof this.classId === \"string\") {\r\n        // istanbul ignore else\r\n        if (this.classId)\r\n          this._widgetControl = ConfigurableUiManager.createControl(this.classId, this.id, this.applicationData) as WidgetControl;\r\n        usedClassId = this.classId;\r\n      } else {\r\n        const info = new ConfigurableCreateInfo(this.classId.name, this.id, this.id);\r\n        usedClassId = this.classId.name;\r\n        this._widgetControl = new this.classId(info, this.applicationData) as WidgetControl;\r\n      }\r\n\r\n      // istanbul ignore else\r\n      if (this._widgetControl) {\r\n        if (this._widgetControl.getType() !== type) {\r\n          throw new UiError(UiFramework.loggerCategory(this), `getWidgetControl: '${usedClassId}' is NOT a ${type}; it is a ${this._widgetControl.getType()}`);\r\n        }\r\n\r\n        this._widgetControl.widgetDef = this;\r\n        this._widgetControl.initialize();\r\n      }\r\n    }\r\n\r\n    // istanbul ignore next - To avoid breaking API changes, if a WidgetControl is not specified for a status bar use Default one.\r\n    if (!this._widgetControl && this.isStatusBar) {\r\n      const info = new ConfigurableCreateInfo(\"StatusBarWidgetComposerControl\", StatusBarWidgetComposerControl.controlId, StatusBarWidgetComposerControl.controlId);\r\n      this._widgetControl = new StatusBarWidgetComposerControl(info, undefined);\r\n      this._widgetControl.widgetDef = this;\r\n      this._widgetControl.initialize();\r\n    }\r\n\r\n    return this._widgetControl;\r\n  }\r\n\r\n  public get reactNode(): React.ReactNode {\r\n    if (!this._widgetReactNode) {\r\n      const widgetControl = this.getWidgetControl(ConfigurableUiControlType.Widget);\r\n\r\n      // istanbul ignore else\r\n      if (widgetControl && widgetControl.reactNode)\r\n        this._widgetReactNode = widgetControl.reactNode;\r\n    }\r\n\r\n    return this._widgetReactNode;\r\n  }\r\n\r\n  public set reactNode(node: React.ReactNode) {\r\n    this._widgetReactNode = node;\r\n  }\r\n\r\n  public setWidgetState(newState: WidgetState): void {\r\n    if (this.state === newState)\r\n      return;\r\n    this._state = newState;\r\n    this._stateChanged = true;\r\n    FrontstageManager.onWidgetStateChangedEvent.emit({ widgetDef: this, widgetState: newState });\r\n    this.onWidgetStateChanged();\r\n  }\r\n\r\n  public setCanPopout(value: boolean | undefined) {\r\n    this._canPopout = value;\r\n  }\r\n\r\n  public get canPopout(): boolean | undefined {\r\n    return (this._canPopout);\r\n  }\r\n\r\n  public setFloatingContainerId(value: string | undefined) {\r\n    this._floatingContainerId = value;\r\n  }\r\n\r\n  public get floatingContainerId(): string | undefined {\r\n    return (this._floatingContainerId);\r\n  }\r\n\r\n  public canOpen(): boolean {\r\n    return (this.isFloating || this.isActive);\r\n  }\r\n\r\n  public get isVisible(): boolean {\r\n    return WidgetState.Hidden !== this.state;\r\n  }\r\n\r\n  public get activeState(): WidgetState {\r\n    return this.state;\r\n  }\r\n\r\n  public get isActive(): boolean {\r\n    return WidgetState.Open === this.activeState;\r\n  }\r\n\r\n  public onWidgetStateChanged(): void {\r\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n    this.widgetControl && UiFramework.postTelemetry(`Widget ${this.widgetControl.classId} state set to ${widgetStateNameMap.get(this._state)}`, \"35402486-9839-441E-A5C7-46D546142D11\");\r\n    this.widgetControl && this.widgetControl.onWidgetStateChanged();\r\n    // istanbul ignore next\r\n    this._onWidgetStateChanged && this._onWidgetStateChanged();\r\n  }\r\n\r\n  /** Overwrite to save transient DOM state (i.e. scroll offset). */\r\n  public saveTransientState(): void {\r\n    this.widgetControl && this.widgetControl.saveTransientState();\r\n    this._saveTransientState && this._saveTransientState();\r\n  }\r\n\r\n  /** Overwrite to restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  public restoreTransientState(): boolean {\r\n    let result = true;\r\n    if (this.widgetControl || this._restoreTransientState) {\r\n      let result1 = false, result2 = false;\r\n      if (this.widgetControl)\r\n        result1 = this.widgetControl.restoreTransientState();\r\n      if (this._restoreTransientState)\r\n        result2 = this._restoreTransientState();\r\n      result = !(result1 || result2);\r\n    }\r\n    return result;\r\n  }\r\n\r\n  /** Opens the widget and makes it visible to the user.\r\n   * I.e. opens the stage panel or brings the floating widget to front of the screen.\r\n   * @alpha\r\n   */\r\n  public show() {\r\n    FrontstageManager.onWidgetShowEvent.emit({ widgetDef: this });\r\n  }\r\n\r\n  /** Opens the widget and expands it to fill full size of the stage panel.\r\n   * @alpha\r\n   */\r\n  public expand() {\r\n    FrontstageManager.onWidgetExpandEvent.emit({ widgetDef: this });\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/widgets/WidgetHost.d.ts

@@ -0,0 +1,42 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import { StagePanelLocation, StagePanelSection } from "@itwin/appui-abstract";
+import { ZoneLocation } from "../zones/Zone";
+import { WidgetDef } from "./WidgetDef";
+/**
+ * A WidgetHost represents a definition that hosts one or most Widgets in a Frontstage.
+ * @public
+ */
+export declare class WidgetHost {
+    private _widgetDefs;
+    private _dynamicWidgetDefs;
+    private _sortedWidgetDefs;
+    /** Constructor for WidgetHost.
+     */
+    constructor();
+    /** Adds a WidgetDef to the list of Widgets.
+     * @param widgetDef  Definition of the Widget to add
+     */
+    addWidgetDef(widgetDef: WidgetDef): void;
+    /** Gets the list of Widgets. */
+    get widgetDefs(): ReadonlyArray<WidgetDef>;
+    /** Gets the number of Widgets. */
+    get widgetCount(): number;
+    /** If there is only one Widget in the Panel, gets the single WidgetDef.
+     * @returns The single WidgetDef if there is only one Widget; otherwise, undefined is returned.
+     */
+    getSingleWidgetDef(): WidgetDef | undefined;
+    /** Finds a WidgetDef with a given Id.
+     * @param id  Id of the WidgetDef to find
+     * @returns The WidgetDef if found; otherwise, undefined is returned.
+     */
+    findWidgetDef(id: string): WidgetDef | undefined;
+    /** Updates the WidgetHost with dynamic widgets
+     * @internal
+     */
+    updateDynamicWidgetDefs(stageId: string, stageUsage: string, location: ZoneLocation | StagePanelLocation, section: StagePanelSection | undefined, widgetDefs: WidgetDef[], frontstageApplicationData?: any): void;
+    /** Sorts all widgets */
+    private sortWidgetDefs;
+}
+//# sourceMappingURL=WidgetHost.d.ts.map

package/lib/cjs/appui-react/widgets/WidgetHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetHost.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetHost.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE9E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,qBAAa,UAAU;IAErB,OAAO,CAAC,WAAW,CAAuC;IAC1D,OAAO,CAAC,kBAAkB,CAAuC;IACjE,OAAO,CAAC,iBAAiB,CAAgC;IAEzD;OACG;;IAGH;;OAEG;IACI,YAAY,CAAC,SAAS,EAAE,SAAS;IAKxC,gCAAgC;IAChC,IAAW,UAAU,IAAI,aAAa,CAAC,SAAS,CAAC,CAEhD;IAED,kCAAkC;IAClC,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED;;OAEG;IACI,kBAAkB,IAAI,SAAS,GAAG,SAAS;IAOlD;;;OAGG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIvD;;OAEG;IACI,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,kBAAkB,EAAE,OAAO,EAAE,iBAAiB,GAAG,SAAS,EACrJ,UAAU,EAAE,SAAS,EAAE,EAAE,yBAAyB,CAAC,EAAE,GAAG,GACvD,IAAI;IAWP,wBAAwB;IACxB,OAAO,CAAC,cAAc;CAWvB"}

package/lib/cjs/appui-react/widgets/WidgetHost.js

@@ -0,0 +1,79 @@
+"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.WidgetHost = void 0;
+const UiFramework_1 = require("../UiFramework");
+/**
+ * A WidgetHost represents a definition that hosts one or most Widgets in a Frontstage.
+ * @public
+ */
+class WidgetHost {
+    /** Constructor for WidgetHost.
+     */
+    constructor() {
+        this._widgetDefs = new Array();
+        this._sortedWidgetDefs = [];
+    }
+    /** Adds a WidgetDef to the list of Widgets.
+     * @param widgetDef  Definition of the Widget to add
+     */
+    addWidgetDef(widgetDef) {
+        this._widgetDefs.push(widgetDef);
+        this.sortWidgetDefs();
+    }
+    /** Gets the list of Widgets. */
+    get widgetDefs() {
+        return this._sortedWidgetDefs;
+    }
+    /** Gets the number of Widgets. */
+    get widgetCount() {
+        return this.widgetDefs.length;
+    }
+    /** If there is only one Widget in the Panel, gets the single WidgetDef.
+     * @returns The single WidgetDef if there is only one Widget; otherwise, undefined is returned.
+     */
+    getSingleWidgetDef() {
+        if (this.widgetCount === 1) {
+            return this.widgetDefs[0];
+        }
+        return undefined;
+    }
+    /** Finds a WidgetDef with a given Id.
+     * @param id  Id of the WidgetDef to find
+     * @returns The WidgetDef if found; otherwise, undefined is returned.
+     */
+    findWidgetDef(id) {
+        return this.widgetDefs.find((widgetDef) => widgetDef.id === id);
+    }
+    /** Updates the WidgetHost with dynamic widgets
+     * @internal
+     */
+    updateDynamicWidgetDefs(stageId, stageUsage, location, section, widgetDefs, frontstageApplicationData) {
+        var _a;
+        widgetDefs.push(...this._widgetDefs);
+        this._dynamicWidgetDefs = (_a = UiFramework_1.UiFramework.widgetManager.getWidgetDefs(stageId, stageUsage, location, section, frontstageApplicationData)) === null || _a === void 0 ? void 0 : _a.filter((widgetDef) => {
+            const duplicate = widgetDefs.find((wDef) => wDef.id === widgetDef.id);
+            return !duplicate;
+        });
+        this._dynamicWidgetDefs && widgetDefs.push(...this._dynamicWidgetDefs);
+        this.sortWidgetDefs();
+    }
+    /** Sorts all widgets */
+    sortWidgetDefs() {
+        let sortedWidgetDefs = [];
+        if (this._dynamicWidgetDefs)
+            sortedWidgetDefs = this._widgetDefs.concat(this._dynamicWidgetDefs);
+        else
+            sortedWidgetDefs = this._widgetDefs.slice();
+        sortedWidgetDefs.sort((a, b) => a.priority - b.priority);
+        this._sortedWidgetDefs = sortedWidgetDefs;
+    }
+}
+exports.WidgetHost = WidgetHost;
+//# sourceMappingURL=WidgetHost.js.map

package/lib/cjs/appui-react/widgets/WidgetHost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetHost.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetHost.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,gDAA6C;AAI7C;;;GAGG;AACH,MAAa,UAAU;IAMrB;OACG;IACH;QANQ,gBAAW,GAAgB,IAAI,KAAK,EAAa,CAAC;QAElD,sBAAiB,GAA6B,EAAE,CAAC;IAIzC,CAAC;IAEjB;;OAEG;IACI,YAAY,CAAC,SAAoB;QACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,gCAAgC;IAChC,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,kCAAkC;IAClC,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,kBAAkB;QACvB,IAAI,IAAI,CAAC,WAAW,KAAK,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;SAC3B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA2C,EAAE,OAAsC,EACrJ,UAAuB,EAAE,yBAA+B;;QAExD,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,MAAA,yBAAW,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,yBAAyB,CAAC,0CAChI,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE;YACrB,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC;YACtE,OAAO,CAAC,SAAS,CAAC;QACpB,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,kBAAkB,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,wBAAwB;IAChB,cAAc;QACpB,IAAI,gBAAgB,GAAG,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,kBAAkB;YACzB,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;;YAEpE,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QAE9C,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;QAEzD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;CACF;AA1ED,gCA0EC","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 { StagePanelLocation, StagePanelSection } from \"@itwin/appui-abstract\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ZoneLocation } from \"../zones/Zone\";\r\nimport { WidgetDef } from \"./WidgetDef\";\r\n\r\n/**\r\n * A WidgetHost represents a definition that hosts one or most Widgets in a Frontstage.\r\n * @public\r\n */\r\nexport class WidgetHost {\r\n\r\n  private _widgetDefs: WidgetDef[] = new Array<WidgetDef>();\r\n  private _dynamicWidgetDefs: ReadonlyArray<WidgetDef> | undefined;\r\n  private _sortedWidgetDefs: ReadonlyArray<WidgetDef> = [];\r\n\r\n  /** Constructor for WidgetHost.\r\n   */\r\n  constructor() { }\r\n\r\n  /** Adds a WidgetDef to the list of Widgets.\r\n   * @param widgetDef  Definition of the Widget to add\r\n   */\r\n  public addWidgetDef(widgetDef: WidgetDef) {\r\n    this._widgetDefs.push(widgetDef);\r\n    this.sortWidgetDefs();\r\n  }\r\n\r\n  /** Gets the list of Widgets. */\r\n  public get widgetDefs(): ReadonlyArray<WidgetDef> {\r\n    return this._sortedWidgetDefs;\r\n  }\r\n\r\n  /** Gets the number of Widgets. */\r\n  public get widgetCount(): number {\r\n    return this.widgetDefs.length;\r\n  }\r\n\r\n  /** If there is only one Widget in the Panel, gets the single WidgetDef.\r\n   * @returns The single WidgetDef if there is only one Widget; otherwise, undefined is returned.\r\n   */\r\n  public getSingleWidgetDef(): WidgetDef | undefined {\r\n    if (this.widgetCount === 1) {\r\n      return this.widgetDefs[0];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  /** Finds a WidgetDef with a given Id.\r\n   * @param id  Id of the WidgetDef to find\r\n   * @returns The WidgetDef if found; otherwise, undefined is returned.\r\n   */\r\n  public findWidgetDef(id: string): WidgetDef | undefined {\r\n    return this.widgetDefs.find((widgetDef: WidgetDef) => widgetDef.id === id);\r\n  }\r\n\r\n  /** Updates the WidgetHost with dynamic widgets\r\n   * @internal\r\n   */\r\n  public updateDynamicWidgetDefs(stageId: string, stageUsage: string, location: ZoneLocation | StagePanelLocation, section: StagePanelSection | undefined,\r\n    widgetDefs: WidgetDef[], frontstageApplicationData?: any\r\n  ): void {\r\n    widgetDefs.push(...this._widgetDefs);\r\n    this._dynamicWidgetDefs = UiFramework.widgetManager.getWidgetDefs(stageId, stageUsage, location, section, frontstageApplicationData)\r\n      ?.filter((widgetDef) => {\r\n        const duplicate = widgetDefs.find((wDef) => wDef.id === widgetDef.id);\r\n        return !duplicate;\r\n      });\r\n    this._dynamicWidgetDefs && widgetDefs.push(...this._dynamicWidgetDefs);\r\n    this.sortWidgetDefs();\r\n  }\r\n\r\n  /** Sorts all widgets */\r\n  private sortWidgetDefs(): void {\r\n    let sortedWidgetDefs = [];\r\n    if (this._dynamicWidgetDefs)\r\n      sortedWidgetDefs = this._widgetDefs.concat(this._dynamicWidgetDefs);\r\n    else\r\n      sortedWidgetDefs = this._widgetDefs.slice();\r\n\r\n    sortedWidgetDefs.sort((a, b) => a.priority - b.priority);\r\n\r\n    this._sortedWidgetDefs = sortedWidgetDefs;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/widgets/WidgetManager.d.ts

@@ -0,0 +1,57 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import { StagePanelLocation, StagePanelSection } from "@itwin/appui-abstract";
+import { ZoneLocation } from "../zones/Zone";
+import { WidgetDef } from "./WidgetDef";
+/** Information about WidgetDefs in the WidgetManager
+ * @internal
+ */
+export interface WidgetInfo {
+    widgetDef: WidgetDef;
+    stageId?: string;
+    stageUsage?: string;
+    location: ZoneLocation | StagePanelLocation;
+    section: StagePanelSection;
+}
+/** Arguments of [[this.onWidgetsChanged]] event.
+ * @internal
+ */
+export interface WidgetsChangedEventArgs {
+    readonly items: ReadonlyArray<WidgetInfo>;
+}
+/** Event class for [[this.onWidgetsChanged]].
+ * @internal
+ */
+export declare class WidgetsChangedEvent extends BeUiEvent<WidgetsChangedEventArgs> {
+}
+/** Widget Manager class.
+ * @beta
+ */
+export declare class WidgetManager {
+    private _widgets;
+    /** Event raised when Widgets are changed.
+     * @internal
+     */
+    readonly onWidgetsChanged: WidgetsChangedEvent;
+    /** @internal */
+    get widgetCount(): number;
+    /** @internal */
+    get widgets(): ReadonlyArray<WidgetInfo>;
+    set widgets(w: ReadonlyArray<WidgetInfo>);
+    /** Adds a WidgetDef for use in a Frontstage.
+     * @note Added `widgetDef` must return unique id to correctly save/restore App layout.
+     * Semi-stable id is generated when auto-generated `widgetDef` id is detected,
+     * but correctness of such id depends on `addWidgetDef` call order and widget location.
+     */
+    addWidgetDef(widgetDef: WidgetDef, stageId: string | undefined, stageUsage: string | undefined, location: ZoneLocation | StagePanelLocation, section?: StagePanelSection): boolean;
+    /** Removes a WidgetDef.
+     */
+    removeWidgetDef(widgetId: string): boolean;
+    private getStagePanelLocationFromZoneLocation;
+    /** Gets WidgetDefs for a Frontstage location.
+     */
+    getWidgetDefs(stageId: string, stageUsage: string, location: ZoneLocation | StagePanelLocation, section?: StagePanelSection, frontstageApplicationData?: any): ReadonlyArray<WidgetDef> | undefined;
+}
+//# sourceMappingURL=WidgetManager.d.ts.map

package/lib/cjs/appui-react/widgets/WidgetManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAU,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAA6C,kBAAkB,EAAE,iBAAiB,EAAkB,MAAM,uBAAuB,CAAC;AAEzI,OAAO,EAAwB,YAAY,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,YAAY,GAAG,kBAAkB,CAAC;IAC5C,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,SAAS,CAAC,uBAAuB,CAAC;CAAI;AAmB/E;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAiC;IAEjD;;OAEG;IACH,SAAgB,gBAAgB,sBAA6B;IAE7D,gBAAgB;IAChB,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,gBAAgB;IAChB,IAAW,OAAO,IAAI,aAAa,CAAC,UAAU,CAAC,CAA0B;IACzE,IAAW,OAAO,CAAC,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,EAG9C;IAED;;;;OAIG;IACI,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,EAAE,YAAY,GAAG,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO;IA0BzL;OACG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAajD,OAAO,CAAC,qCAAqC;IAgB7C;OACG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAChI,yBAAyB,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,SAAS,CAAC,GAAG,SAAS;CA0CzE"}