@itwin/appui-react 3.0.0-dev.100

package/lib/cjs/appui-react/configurableui/ConfigurableUiContent.js

@@ -0,0 +1,61 @@
+"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 ConfigurableUi
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurableUiContent = void 0;
+require("./configurableui.scss");
+const React = require("react");
+const core_react_1 = require("@itwin/core-react");
+const CursorInformation_1 = require("../cursor/CursorInformation");
+const CursorMenu_1 = require("../cursor/cursormenu/CursorMenu");
+const CursorPopupManager_1 = require("../cursor/cursorpopup/CursorPopupManager");
+const ModalDialogManager_1 = require("../dialog/ModalDialogManager");
+const ModelessDialogManager_1 = require("../dialog/ModelessDialogManager");
+const ElementTooltip_1 = require("../feedback/ElementTooltip");
+const FrontstageComposer_1 = require("../frontstage/FrontstageComposer");
+const useFrameworkVersion_1 = require("../hooks/useFrameworkVersion");
+const KeyboardShortcut_1 = require("../keyboardshortcut/KeyboardShortcut");
+const KeyboardShortcutMenu_1 = require("../keyboardshortcut/KeyboardShortcutMenu");
+const InputField_1 = require("../messages/InputField");
+const Pointer_1 = require("../messages/Pointer");
+const PopupManager_1 = require("../popup/PopupManager");
+const Frontstage_1 = require("../widget-panels/Frontstage");
+const ConfigurableUiManager_1 = require("./ConfigurableUiManager");
+/** The ConfigurableUiContent component is the component the pages specified using ConfigurableUi
+ * @public
+ */
+function ConfigurableUiContent(props) {
+    const version = (0, useFrameworkVersion_1.useFrameworkVersion)();
+    React.useEffect(() => {
+        KeyboardShortcut_1.KeyboardShortcutManager.setFocusToHome();
+    }, []);
+    React.useEffect(() => {
+        ConfigurableUiManager_1.ConfigurableUiManager.activityTracker.initialize({ idleTimeout: props.idleTimeout, intervalTimeout: props.intervalTimeout });
+        return () => {
+            ConfigurableUiManager_1.ConfigurableUiManager.activityTracker.terminate();
+        };
+    }, [props.idleTimeout, props.intervalTimeout]);
+    const handleMouseMove = React.useCallback((e) => {
+        const point = new core_react_1.Point(e.pageX, e.pageY);
+        CursorInformation_1.CursorInformation.handleMouseMove(point);
+    }, []);
+    return (React.createElement("main", { role: "main", id: "uifw-configurableui-wrapper", className: props.className, style: props.style, onMouseMove: handleMouseMove },
+        props.appBackstage,
+        version === "1" ? React.createElement(FrontstageComposer_1.FrontstageComposer, { style: { position: "relative", height: "100%" } }) : /* istanbul ignore next */ React.createElement(Frontstage_1.WidgetPanelsFrontstage, null),
+        React.createElement(ModelessDialogManager_1.ModelessDialogRenderer, null),
+        React.createElement(ModalDialogManager_1.ModalDialogRenderer, null),
+        React.createElement(ElementTooltip_1.ElementTooltip, null),
+        React.createElement(Pointer_1.PointerMessage, null),
+        React.createElement(KeyboardShortcutMenu_1.KeyboardShortcutMenu, null),
+        React.createElement(InputField_1.InputFieldMessage, null),
+        React.createElement(CursorMenu_1.CursorPopupMenu, null),
+        React.createElement(CursorPopupManager_1.CursorPopupRenderer, null),
+        React.createElement(PopupManager_1.PopupRenderer, null)));
+}
+exports.ConfigurableUiContent = ConfigurableUiContent;
+//# sourceMappingURL=ConfigurableUiContent.js.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiContent.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiContent.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iCAA+B;AAC/B,+BAA+B;AAC/B,kDAAuD;AACvD,mEAAgE;AAChE,gEAAkE;AAClE,iFAA+E;AAC/E,qEAAmE;AACnE,2EAAyE;AACzE,+DAA4D;AAC5D,yEAAsE;AACtE,sEAAmE;AACnE,2EAA+E;AAC/E,mFAAgF;AAChF,uDAA2D;AAC3D,iDAAqD;AACrD,wDAAsD;AACtD,4DAAqE;AACrE,mEAAgE;AAiBhE;;GAEG;AACH,SAAgB,qBAAqB,CAAC,KAAiC;IACrE,MAAM,OAAO,GAAG,IAAA,yCAAmB,GAAE,CAAC;IACtC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,0CAAuB,CAAC,cAAc,EAAE,CAAC;IAC3C,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,6CAAqB,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,eAAe,EAAE,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC;QAC7H,OAAO,GAAG,EAAE;YACV,6CAAqB,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;QACpD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/C,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAmB,EAAE,EAAE;QAChE,MAAM,KAAK,GAAG,IAAI,kBAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;QAC1C,qCAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL,8BAAM,IAAI,EAAC,MAAM,EACf,EAAE,EAAC,6BAA6B,EAChC,SAAS,EAAE,KAAK,CAAC,SAAS,EAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,WAAW,EAAE,eAAe;QAE3B,KAAK,CAAC,YAAY;QAClB,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,oBAAC,uCAAkB,IAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,GAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,oBAAC,mCAAsB,OAAG;QAClJ,oBAAC,8CAAsB,OAAG;QAC1B,oBAAC,wCAAmB,OAAG;QACvB,oBAAC,+BAAc,OAAG;QAClB,oBAAC,wBAAc,OAAG;QAClB,oBAAC,2CAAoB,OAAG;QACxB,oBAAC,8BAAiB,OAAG;QACrB,oBAAC,4BAAe,OAAG;QACnB,oBAAC,wCAAmB,OAAG;QACvB,oBAAC,4BAAa,OAAG,CACZ,CACR,CAAC;AACJ,CAAC;AArCD,sDAqCC","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 ConfigurableUi\r\n */\r\n\r\nimport \"./configurableui.scss\";\r\nimport * as React from \"react\";\r\nimport { CommonProps, Point } from \"@itwin/core-react\";\r\nimport { CursorInformation } from \"../cursor/CursorInformation\";\r\nimport { CursorPopupMenu } from \"../cursor/cursormenu/CursorMenu\";\r\nimport { CursorPopupRenderer } from \"../cursor/cursorpopup/CursorPopupManager\";\r\nimport { ModalDialogRenderer } from \"../dialog/ModalDialogManager\";\r\nimport { ModelessDialogRenderer } from \"../dialog/ModelessDialogManager\";\r\nimport { ElementTooltip } from \"../feedback/ElementTooltip\";\r\nimport { FrontstageComposer } from \"../frontstage/FrontstageComposer\";\r\nimport { useFrameworkVersion } from \"../hooks/useFrameworkVersion\";\r\nimport { KeyboardShortcutManager } from \"../keyboardshortcut/KeyboardShortcut\";\r\nimport { KeyboardShortcutMenu } from \"../keyboardshortcut/KeyboardShortcutMenu\";\r\nimport { InputFieldMessage } from \"../messages/InputField\";\r\nimport { PointerMessage } from \"../messages/Pointer\";\r\nimport { PopupRenderer } from \"../popup/PopupManager\";\r\nimport { WidgetPanelsFrontstage } from \"../widget-panels/Frontstage\";\r\nimport { ConfigurableUiManager } from \"./ConfigurableUiManager\";\r\n\r\n// cSpell:ignore cursormenu cursorpopup\r\n\r\n/** Properties for [[ConfigurableUiContent]]\r\n * @public\r\n */\r\nexport interface ConfigurableUiContentProps extends CommonProps {\r\n  /** React node of the Backstage */\r\n  appBackstage?: React.ReactNode;\r\n\r\n  /** @internal */\r\n  idleTimeout?: number;\r\n  /** @internal */\r\n  intervalTimeout?: number;\r\n}\r\n\r\n/** The ConfigurableUiContent component is the component the pages specified using ConfigurableUi\r\n * @public\r\n */\r\nexport function ConfigurableUiContent(props: ConfigurableUiContentProps) {\r\n  const version = useFrameworkVersion();\r\n  React.useEffect(() => {\r\n    KeyboardShortcutManager.setFocusToHome();\r\n  }, []);\r\n  React.useEffect(() => {\r\n    ConfigurableUiManager.activityTracker.initialize({ idleTimeout: props.idleTimeout, intervalTimeout: props.intervalTimeout });\r\n    return () => {\r\n      ConfigurableUiManager.activityTracker.terminate();\r\n    };\r\n  }, [props.idleTimeout, props.intervalTimeout]);\r\n\r\n  const handleMouseMove = React.useCallback((e: React.MouseEvent) => {\r\n    const point = new Point(e.pageX, e.pageY);\r\n    CursorInformation.handleMouseMove(point);\r\n  }, []);\r\n\r\n  return (\r\n    <main role=\"main\"\r\n      id=\"uifw-configurableui-wrapper\"\r\n      className={props.className}\r\n      style={props.style}\r\n      onMouseMove={handleMouseMove}\r\n    >\r\n      {props.appBackstage}\r\n      {version === \"1\" ? <FrontstageComposer style={{ position: \"relative\", height: \"100%\" }} /> : /* istanbul ignore next */ <WidgetPanelsFrontstage />}\r\n      <ModelessDialogRenderer />\r\n      <ModalDialogRenderer />\r\n      <ElementTooltip />\r\n      <PointerMessage />\r\n      <KeyboardShortcutMenu />\r\n      <InputFieldMessage />\r\n      <CursorPopupMenu />\r\n      <CursorPopupRenderer />\r\n      <PopupRenderer />\r\n    </main>\r\n  );\r\n}\r\n"]}

package/lib/cjs/appui-react/configurableui/ConfigurableUiControl.d.ts

@@ -0,0 +1,96 @@
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+/** Interface for a ConfigurableUi element
+ * @public
+ */
+export interface ConfigurableUiElement {
+    uniqueId: string;
+    classId: string;
+    name: string;
+}
+/** Information for creating a ConfigurableUi element
+ * @public
+ */
+export declare class ConfigurableCreateInfo {
+    readonly classId: string;
+    readonly uniqueId: string;
+    readonly id: string;
+    constructor(classId: string, uniqueId: string, id: string);
+}
+/** The base class for all ConfigurableUi elements
+ * @public
+ */
+export declare class ConfigurableBase implements ConfigurableUiElement {
+    private _uniqueId;
+    private _classId;
+    private _name;
+    protected _appDataOptions: any;
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** @internal */
+    get uniqueId(): string;
+    /** allow options set via appData to be seen by API calls */
+    get applicationData(): any;
+    /** Gets the class Id of configurable element */
+    get classId(): string;
+    /** Get internal name of configurable element. If no name is defined in configuration
+     * then the name will match the UniqueId.
+     */
+    get name(): string;
+}
+/** The type of the ConfigurableUiControl.
+ * @public
+ */
+export declare enum ConfigurableUiControlType {
+    Content = "ContentControl",
+    NavigationAid = "NavigationAidControl",
+    StatusBarWidget = "StatusBarWidgetControl",
+    ToolUiProvider = "ToolUiProvider",
+    Viewport = "ViewportContentControl",
+    Widget = "WidgetControl"
+}
+/** Prototype for ConfigurableUiControl constructor
+ * @public
+ */
+export declare type ConfigurableUiControlConstructor = new (info: ConfigurableCreateInfo, options: any) => ConfigurableUiElement;
+/** The abstract base class for all Frontstage controls.
+ * @public
+ *
+ * @note This is an abstract class which should not be derived from by the applications.
+ * Instead, applications should derive from one of
+ * [[ContentControl]],
+ * [[ViewportContentControl]],
+ * [[WidgetControl]],
+ * [[StatusBarWidgetControl]] or
+ * [[NavigationAidControl]].
+ */
+export declare abstract class ConfigurableUiControl extends ConfigurableBase {
+    private _cid;
+    /** Creates an instance of ConfigurableUiControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided to the control
+     * @note Subclasses must pass all arguments to the base class and not add themselves
+     * to any container - the control is added automatically by the [[FrontstageComposer]].
+     * @protected
+     */
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** @internal
+     */
+    initialize(): void;
+    /** Called to initialize the ConfigurableUiControl. */
+    onInitialize(): void;
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated(): void;
+    /** Called when Frontstage is ready. */
+    onFrontstageReady(): void;
+    /** Returns the ID of this ConfigurableUiControl.
+     */
+    get controlId(): string;
+    /** Get the type of this control.
+     */
+    abstract getType(): ConfigurableUiControlType;
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady(): Promise<void>;
+}
+//# sourceMappingURL=ConfigurableUiControl.d.ts.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiControl.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiControl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,sBAAsB;aACL,OAAO,EAAE,MAAM;aACzB,QAAQ,EAAE,MAAM;aAChB,EAAE,EAAE,MAAM;gBAFA,OAAO,EAAE,MAAM,EACzB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM;CAE7B;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,qBAAqB;IAC5D,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,eAAe,EAAE,GAAG,CAAC;gBAEnB,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAOtD,gBAAgB;IAChB,IAAW,QAAQ,IAAI,MAAM,CAA2B;IAExD,4DAA4D;IAC5D,IAAW,eAAe,IAAI,GAAG,CAAiC;IAElE,gDAAgD;IAChD,IAAW,OAAO,IAAI,MAAM,CAA0B;IAEtD;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAAuB;CACjD;AAED;;GAEG;AACH,oBAAY,yBAAyB;IACnC,OAAO,mBAAmB;IAC1B,aAAa,yBAAyB;IACtC,eAAe,2BAA2B;IAC1C,cAAc,mBAAmB;IACjC,QAAQ,2BAA2B;IACnC,MAAM,kBAAkB;CACzB;AAED;;GAEG;AACH,oBAAY,gCAAgC,GAAG,KAAK,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,KAAK,qBAAqB,CAAC;AAEzH;;;;;;;;;;GAUG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,OAAO,CAAC,IAAI,CAAS;IAErB;;;;;;OAMG;gBACS,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAKtD;OACG;IACI,UAAU,IAAI,IAAI;IAEzB,sDAAsD;IAC/C,YAAY,IAAI,IAAI;IAE3B,6CAA6C;IACtC,uBAAuB,IAAI,IAAI;IAEtC,uCAAuC;IAChC,iBAAiB,IAAI,IAAI;IAEhC;OACG;IACH,IAAW,SAAS,IAAI,MAAM,CAAsB;IAEpD;OACG;aACa,OAAO,IAAI,yBAAyB;IAEpD;OACG;IACH,IAAW,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAA8B;CAClE"}

package/lib/cjs/appui-react/configurableui/ConfigurableUiControl.js

@@ -0,0 +1,96 @@
+"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 ConfigurableUi
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurableUiControl = exports.ConfigurableUiControlType = exports.ConfigurableBase = exports.ConfigurableCreateInfo = void 0;
+/** Information for creating a ConfigurableUi element
+ * @public
+ */
+class ConfigurableCreateInfo {
+    constructor(classId, uniqueId, id) {
+        this.classId = classId;
+        this.uniqueId = uniqueId;
+        this.id = id;
+    }
+}
+exports.ConfigurableCreateInfo = ConfigurableCreateInfo;
+/** The base class for all ConfigurableUi elements
+ * @public
+ */
+class ConfigurableBase {
+    constructor(info, options) {
+        this._uniqueId = info.uniqueId;
+        this._classId = info.classId;
+        this._name = (options && options.hasOwnProperty("name")) ? options.name : info.uniqueId;
+        this._appDataOptions = options;
+    }
+    /** @internal */
+    get uniqueId() { return this._uniqueId; }
+    /** allow options set via appData to be seen by API calls */
+    get applicationData() { return this._appDataOptions; }
+    /** Gets the class Id of configurable element */
+    get classId() { return this._classId; }
+    /** Get internal name of configurable element. If no name is defined in configuration
+     * then the name will match the UniqueId.
+     */
+    get name() { return this._name; }
+}
+exports.ConfigurableBase = ConfigurableBase;
+/** The type of the ConfigurableUiControl.
+ * @public
+ */
+var ConfigurableUiControlType;
+(function (ConfigurableUiControlType) {
+    ConfigurableUiControlType["Content"] = "ContentControl";
+    ConfigurableUiControlType["NavigationAid"] = "NavigationAidControl";
+    ConfigurableUiControlType["StatusBarWidget"] = "StatusBarWidgetControl";
+    ConfigurableUiControlType["ToolUiProvider"] = "ToolUiProvider";
+    ConfigurableUiControlType["Viewport"] = "ViewportContentControl";
+    ConfigurableUiControlType["Widget"] = "WidgetControl";
+})(ConfigurableUiControlType = exports.ConfigurableUiControlType || (exports.ConfigurableUiControlType = {}));
+/** The abstract base class for all Frontstage controls.
+ * @public
+ *
+ * @note This is an abstract class which should not be derived from by the applications.
+ * Instead, applications should derive from one of
+ * [[ContentControl]],
+ * [[ViewportContentControl]],
+ * [[WidgetControl]],
+ * [[StatusBarWidgetControl]] or
+ * [[NavigationAidControl]].
+ */
+class ConfigurableUiControl extends ConfigurableBase {
+    /** Creates an instance of ConfigurableUiControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided to the control
+     * @note Subclasses must pass all arguments to the base class and not add themselves
+     * to any container - the control is added automatically by the [[FrontstageComposer]].
+     * @protected
+     */
+    constructor(info, options) {
+        super(info, options);
+        this._cid = info.id;
+    }
+    /** @internal
+     */
+    initialize() { this.onInitialize(); }
+    /** Called to initialize the ConfigurableUiControl. */
+    onInitialize() { }
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated() { }
+    /** Called when Frontstage is ready. */
+    onFrontstageReady() { }
+    /** Returns the ID of this ConfigurableUiControl.
+     */
+    get controlId() { return this._cid; }
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady() { return Promise.resolve(); }
+}
+exports.ConfigurableUiControl = ConfigurableUiControl;
+//# sourceMappingURL=ConfigurableUiControl.js.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiControl.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiControl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAWH;;GAEG;AACH,MAAa,sBAAsB;IACjC,YAA4B,OAAe,EACzB,QAAgB,EAChB,EAAU;QAFA,YAAO,GAAP,OAAO,CAAQ;QACzB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,OAAE,GAAF,EAAE,CAAQ;IAC5B,CAAC;CACF;AALD,wDAKC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAM3B,YAAY,IAA4B,EAAE,OAAY;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QACxF,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;IACjC,CAAC;IAED,gBAAgB;IAChB,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExD,4DAA4D;IAC5D,IAAW,eAAe,KAAU,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAElE,gDAAgD;IAChD,IAAW,OAAO,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;CACjD;AA1BD,4CA0BC;AAED;;GAEG;AACH,IAAY,yBAOX;AAPD,WAAY,yBAAyB;IACnC,uDAA0B,CAAA;IAC1B,mEAAsC,CAAA;IACtC,uEAA0C,CAAA;IAC1C,8DAAiC,CAAA;IACjC,gEAAmC,CAAA;IACnC,qDAAwB,CAAA;AAC1B,CAAC,EAPW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAOpC;AAOD;;;;;;;;;;GAUG;AACH,MAAsB,qBAAsB,SAAQ,gBAAgB;IAGlE;;;;;;OAMG;IACH,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;IACtB,CAAC;IAED;OACG;IACI,UAAU,KAAW,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAElD,sDAAsD;IAC/C,YAAY,KAAW,CAAC;IAE/B,6CAA6C;IACtC,uBAAuB,KAAW,CAAC;IAE1C,uCAAuC;IAChC,iBAAiB,KAAW,CAAC;IAEpC;OACG;IACH,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAMpD;OACG;IACH,IAAW,OAAO,KAAoB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;CAClE;AAvCD,sDAuCC","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 ConfigurableUi\r\n */\r\n\r\n/** Interface for a ConfigurableUi element\r\n * @public\r\n */\r\nexport interface ConfigurableUiElement {\r\n  uniqueId: string;\r\n  classId: string;\r\n  name: string;\r\n}\r\n\r\n/** Information for creating a ConfigurableUi element\r\n * @public\r\n */\r\nexport class ConfigurableCreateInfo {\r\n  constructor(public readonly classId: string,\r\n    public readonly uniqueId: string,\r\n    public readonly id: string) {\r\n  }\r\n}\r\n\r\n/** The base class for all ConfigurableUi elements\r\n * @public\r\n */\r\nexport class ConfigurableBase implements ConfigurableUiElement {\r\n  private _uniqueId: string;\r\n  private _classId: string;\r\n  private _name: string;\r\n  protected _appDataOptions: any;\r\n\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    this._uniqueId = info.uniqueId;\r\n    this._classId = info.classId;\r\n    this._name = (options && options.hasOwnProperty(\"name\")) ? options.name : info.uniqueId;\r\n    this._appDataOptions = options;\r\n  }\r\n\r\n  /** @internal */\r\n  public get uniqueId(): string { return this._uniqueId; }\r\n\r\n  /** allow options set via appData to be seen by API calls */\r\n  public get applicationData(): any { return this._appDataOptions; }\r\n\r\n  /** Gets the class Id of configurable element */\r\n  public get classId(): string { return this._classId; }\r\n\r\n  /** Get internal name of configurable element. If no name is defined in configuration\r\n   * then the name will match the UniqueId.\r\n   */\r\n  public get name(): string { return this._name; }\r\n}\r\n\r\n/** The type of the ConfigurableUiControl.\r\n * @public\r\n */\r\nexport enum ConfigurableUiControlType {\r\n  Content = \"ContentControl\",\r\n  NavigationAid = \"NavigationAidControl\",\r\n  StatusBarWidget = \"StatusBarWidgetControl\",\r\n  ToolUiProvider = \"ToolUiProvider\",\r\n  Viewport = \"ViewportContentControl\",\r\n  Widget = \"WidgetControl\",\r\n}\r\n\r\n/** Prototype for ConfigurableUiControl constructor\r\n * @public\r\n */\r\nexport type ConfigurableUiControlConstructor = new (info: ConfigurableCreateInfo, options: any) => ConfigurableUiElement;\r\n\r\n/** The abstract base class for all Frontstage controls.\r\n * @public\r\n *\r\n * @note This is an abstract class which should not be derived from by the applications.\r\n * Instead, applications should derive from one of\r\n * [[ContentControl]],\r\n * [[ViewportContentControl]],\r\n * [[WidgetControl]],\r\n * [[StatusBarWidgetControl]] or\r\n * [[NavigationAidControl]].\r\n */\r\nexport abstract class ConfigurableUiControl extends ConfigurableBase {\r\n  private _cid: string;\r\n\r\n  /** Creates an instance of ConfigurableUiControl.\r\n   * @param info         An object that the subclass must pass to this base class.\r\n   * @param options      Options provided to the control\r\n   * @note Subclasses must pass all arguments to the base class and not add themselves\r\n   * to any container - the control is added automatically by the [[FrontstageComposer]].\r\n   * @protected\r\n   */\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    super(info, options);\r\n    this._cid = info.id;\r\n  }\r\n\r\n  /** @internal\r\n   */\r\n  public initialize(): void { this.onInitialize(); }\r\n\r\n  /** Called to initialize the ConfigurableUiControl. */\r\n  public onInitialize(): void { }\r\n\r\n  /** Called when Frontstage is deactivated. */\r\n  public onFrontstageDeactivated(): void { }\r\n\r\n  /** Called when Frontstage is ready. */\r\n  public onFrontstageReady(): void { }\r\n\r\n  /** Returns the ID of this ConfigurableUiControl.\r\n   */\r\n  public get controlId(): string { return this._cid; }\r\n\r\n  /** Get the type of this control.\r\n   */\r\n  public abstract getType(): ConfigurableUiControlType;\r\n\r\n  /** Returns a promise that resolves when the control is ready for usage.\r\n   */\r\n  public get isReady(): Promise<void> { return Promise.resolve(); }\r\n}\r\n"]}

package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts

@@ -0,0 +1,110 @@
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import { FrontstageProvider } from "../frontstage/FrontstageProvider";
+import { KeyboardShortcutProps } from "../keyboardshortcut/KeyboardShortcut";
+import { TaskPropsList } from "../workflow/Task";
+import { WorkflowProps, WorkflowPropsList } from "../workflow/Workflow";
+import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl";
+import { ActivityTracker } from "./ActivityTracker";
+/** Ui Activity Event Args interface.
+ * @internal
+ */
+export interface UiActivityEventArgs {
+    event: Event;
+}
+/** Ui Activity Event class.
+ * @internal
+ */
+export declare class UiActivityEvent extends BeUiEvent<UiActivityEventArgs> {
+}
+/** Ui Interval Event Args interface
+ * @internal
+ */
+export interface UiIntervalEventArgs {
+    idleTimeout?: number;
+}
+/** Ui Interval Event class.
+ * @internal
+ */
+export declare class UiIntervalEvent extends BeUiEvent<UiIntervalEventArgs> {
+}
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ */
+export declare class ConfigurableUiManager {
+    private static _registeredControls;
+    private static _initialized;
+    /** @internal */
+    static readonly activityTracker: ActivityTracker;
+    /** @internal */
+    static readonly onUiActivityEvent: UiActivityEvent;
+    /** @internal */
+    static readonly onUiIntervalEvent: UiIntervalEvent;
+    /** Initializes the ConfigurableUiManager and registers core controls. */
+    static initialize(): void;
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [ToolUiProvider]($appui-react).
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     */
+    static registerControl(classId: string, constructor: ConfigurableUiControlConstructor): void;
+    /** Determines if a control has been registered based on its classId.
+     * @param classId   the class id of the control to test
+     * @returns  true if the control is registered or false if not
+     */
+    static isControlRegistered(classId: string): boolean;
+    /** Determines if a control has been registered.
+     * @internal
+     */
+    static getConstructorClassId(constructor: ConfigurableUiControlConstructor): string | undefined;
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     */
+    static unregisterControl(classId: string): void;
+    /** Creates a control registered by calling registerControl.
+     * @param classId   the class id of the control to create
+     * @param uniqueId  a unique id for the control
+     * @param options   options passed to the constructor of the control
+     * @param controlId controlId which may not be unique across all control instances.
+     * @returns  the created control
+     */
+    static createControl(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
+    /** Add a Frontstage via a provider into the [[FrontstageManager]].
+     * @param frontstageProvider  Provider of the Frontstage to add
+     */
+    static addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Loads one or more Tasks into the [[TaskManager]].
+     * @param taskPropsList  the list of Tasks to load
+     * @internal
+     * @deprecated
+     */
+    static loadTasks(taskPropsList: TaskPropsList): void;
+    /** Loads a Workflow into the [[WorkflowManager]].
+     * @param workflowProps  the Workflow to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflow(workflowProps: WorkflowProps): void;
+    /** Loads one or more Workflows into the [[WorkflowManager]].
+     * @param workflowPropsList  the list of Workflows to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflows(workflowPropsList: WorkflowPropsList): void;
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     */
+    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement(): HTMLElement;
+    /** Closes all UI popups currently open */
+    static closeUi(): void;
+}
+//# sourceMappingURL=ConfigurableUiManager.d.ts.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAA2B,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAOtG,OAAO,EAAe,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAmB,aAAa,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzF,OAAO,EAA0B,gCAAgC,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAK1H,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,KAAK,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS,CAAC,mBAAmB,CAAC;CAAI;AAEvE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS,CAAC,mBAAmB,CAAC;CAAI;AAEvE;;GAEG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAuD;IACzF,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IAEpC,gBAAgB;IAChB,gBAAuB,eAAe,kBAAyB;IAC/D,gBAAgB;IAChB,gBAAuB,iBAAiB,kBAAyB;IACjE,gBAAgB;IAChB,gBAAuB,iBAAiB,kBAAyB;IAEjE,yEAAyE;WAC3D,UAAU;IA4BxB;;;;;;;;;OASG;WACW,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,gCAAgC,GAAG,IAAI;IAQnG;;;OAGG;WACW,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAK3D;;OAEG;WACW,qBAAqB,CAAC,WAAW,EAAE,gCAAgC,GAAG,MAAM,GAAG,SAAS;IAStG;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMtD;;;;;;OAMG;WACW,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAWpI;;OAEG;WACW,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI;IAIjF;;;;OAIG;WACW,SAAS,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI3D;;;;OAIG;WACW,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI9D;;;;OAIG;WACW,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI;IAIvE;;OAEG;WACW,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAIhF,wDAAwD;WAC1C,iBAAiB,IAAI,WAAW;IAM9C,0CAA0C;WAC5B,OAAO,IAAI,IAAI;CAS9B"}

package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js

@@ -0,0 +1,186 @@
+"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 ConfigurableUi
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurableUiManager = exports.UiIntervalEvent = exports.UiActivityEvent = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const FrontstageManager_1 = require("../frontstage/FrontstageManager");
+const KeyboardShortcut_1 = require("../keyboardshortcut/KeyboardShortcut");
+const CubeNavigationAidControl_1 = require("../navigationaids/CubeNavigationAidControl");
+const DrawingNavigationAidControl_1 = require("../navigationaids/DrawingNavigationAidControl");
+const SheetNavigationAid_1 = require("../navigationaids/SheetNavigationAid");
+const StandardRotationNavigationAid_1 = require("../navigationaids/StandardRotationNavigationAid");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const UiFramework_1 = require("../UiFramework");
+const Task_1 = require("../workflow/Task");
+const Workflow_1 = require("../workflow/Workflow");
+const ToolSettingsManager_1 = require("../zones/toolsettings/ToolSettingsManager");
+const ConfigurableUiControl_1 = require("./ConfigurableUiControl");
+const ModelessDialogManager_1 = require("../dialog/ModelessDialogManager");
+const ModalDialogManager_1 = require("../dialog/ModalDialogManager");
+const MessageManager_1 = require("../messages/MessageManager");
+const PopupManager_1 = require("../popup/PopupManager");
+const ActivityTracker_1 = require("./ActivityTracker");
+/** Ui Activity Event class.
+ * @internal
+ */
+class UiActivityEvent extends core_bentley_1.BeUiEvent {
+}
+exports.UiActivityEvent = UiActivityEvent;
+/** Ui Interval Event class.
+ * @internal
+ */
+class UiIntervalEvent extends core_bentley_1.BeUiEvent {
+}
+exports.UiIntervalEvent = UiIntervalEvent;
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ */
+class ConfigurableUiManager {
+    /** Initializes the ConfigurableUiManager and registers core controls. */
+    static initialize() {
+        if (this._initialized)
+            return;
+        // Register core controls
+        ConfigurableUiManager.registerControl(StandardRotationNavigationAid_1.StandardRotationNavigationAidControl.navigationAidId, StandardRotationNavigationAid_1.StandardRotationNavigationAidControl);
+        ConfigurableUiManager.registerControl(SheetNavigationAid_1.SheetNavigationAidControl.navigationAidId, SheetNavigationAid_1.SheetNavigationAidControl);
+        ConfigurableUiManager.registerControl(DrawingNavigationAidControl_1.DrawingNavigationAidControl.navigationAidId, DrawingNavigationAidControl_1.DrawingNavigationAidControl);
+        ConfigurableUiManager.registerControl(CubeNavigationAidControl_1.CubeNavigationAidControl.navigationAidId, CubeNavigationAidControl_1.CubeNavigationAidControl);
+        // Initialize SyncUiEventDispatcher so it can register event callbacks.
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.initialize();
+        // Initialize the FrontstageManager
+        FrontstageManager_1.FrontstageManager.initialize();
+        // Initialize the ToolSettingsManager that manages Tool Settings properties.
+        ToolSettingsManager_1.ToolSettingsManager.initialize();
+        // Initialize the modeless dialog manager.
+        ModelessDialogManager_1.ModelessDialogManager.initialize();
+        // Initialize the Keyboard Shortcut manager
+        KeyboardShortcut_1.KeyboardShortcutManager.initialize();
+        this._initialized = true;
+    }
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [ToolUiProvider]($appui-react).
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     */
+    static registerControl(classId, constructor) {
+        if (this._registeredControls.get(classId) !== undefined) {
+            throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `registerControl: classId '${classId}' already registered`);
+        }
+        this._registeredControls.set(classId, constructor);
+    }
+    /** Determines if a control has been registered based on its classId.
+     * @param classId   the class id of the control to test
+     * @returns  true if the control is registered or false if not
+     */
+    static isControlRegistered(classId) {
+        const constructor = this._registeredControls.get(classId);
+        return constructor !== undefined;
+    }
+    /** Determines if a control has been registered.
+     * @internal
+     */
+    static getConstructorClassId(constructor) {
+        for (const [key, value] of this._registeredControls.entries()) {
+            if (value === constructor)
+                return key;
+        }
+        return undefined;
+    }
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     */
+    static unregisterControl(classId) {
+        const constructor = this._registeredControls.get(classId);
+        if (constructor)
+            this._registeredControls.delete(classId);
+    }
+    /** Creates a control registered by calling registerControl.
+     * @param classId   the class id of the control to create
+     * @param uniqueId  a unique id for the control
+     * @param options   options passed to the constructor of the control
+     * @param controlId controlId which may not be unique across all control instances.
+     * @returns  the created control
+     */
+    static createControl(classId, uniqueId, options, controlId) {
+        const info = new ConfigurableUiControl_1.ConfigurableCreateInfo(classId, uniqueId, controlId !== null && controlId !== void 0 ? controlId : uniqueId);
+        const constructor = this._registeredControls.get(info.classId);
+        if (!constructor) {
+            throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `createControl: classId '${classId}' not registered`);
+        }
+        const control = new constructor(info, options);
+        return control;
+    }
+    /** Add a Frontstage via a provider into the [[FrontstageManager]].
+     * @param frontstageProvider  Provider of the Frontstage to add
+     */
+    static addFrontstageProvider(frontstageProvider) {
+        FrontstageManager_1.FrontstageManager.addFrontstageProvider(frontstageProvider);
+    }
+    /** Loads one or more Tasks into the [[TaskManager]].
+     * @param taskPropsList  the list of Tasks to load
+     * @internal
+     * @deprecated
+     */
+    static loadTasks(taskPropsList) {
+        Task_1.TaskManager.loadTasks(taskPropsList); // eslint-disable-line deprecation/deprecation
+    }
+    /** Loads a Workflow into the [[WorkflowManager]].
+     * @param workflowProps  the Workflow to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflow(workflowProps) {
+        Workflow_1.WorkflowManager.loadWorkflow(workflowProps); // eslint-disable-line deprecation/deprecation
+    }
+    /** Loads one or more Workflows into the [[WorkflowManager]].
+     * @param workflowPropsList  the list of Workflows to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflows(workflowPropsList) {
+        Workflow_1.WorkflowManager.loadWorkflows(workflowPropsList); // eslint-disable-line deprecation/deprecation
+    }
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     */
+    static loadKeyboardShortcuts(shortcutList) {
+        KeyboardShortcut_1.KeyboardShortcutManager.loadKeyboardShortcuts(shortcutList);
+    }
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement() {
+        const wrapper = document.getElementById("uifw-configurableui-wrapper");
+        const htmlElement = wrapper;
+        return htmlElement;
+    }
+    /** Closes all UI popups currently open */
+    static closeUi() {
+        MessageManager_1.MessageManager.closeAllMessages();
+        ModelessDialogManager_1.ModelessDialogManager.closeAll();
+        ModalDialogManager_1.ModalDialogManager.closeAll();
+        KeyboardShortcut_1.KeyboardShortcutManager.closeShortcutsMenu();
+        UiFramework_1.UiFramework.closeCursorMenu();
+        PopupManager_1.PopupManager.clearPopups();
+    }
+}
+exports.ConfigurableUiManager = ConfigurableUiManager;
+ConfigurableUiManager._registeredControls = new Map();
+ConfigurableUiManager._initialized = false;
+/** @internal */
+ConfigurableUiManager.activityTracker = new ActivityTracker_1.ActivityTracker();
+/** @internal */
+ConfigurableUiManager.onUiActivityEvent = new UiActivityEvent();
+/** @internal */
+ConfigurableUiManager.onUiIntervalEvent = new UiIntervalEvent();
+//# sourceMappingURL=ConfigurableUiManager.js.map

package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiManager.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAChD,0DAAgD;AAChD,uEAAoE;AAEpE,2EAAsG;AACtG,yFAAsF;AACtF,+FAA4F;AAC5F,6EAAiF;AACjF,mGAAuG;AACvG,2EAAwE;AACxE,gDAA6C;AAC7C,2CAA8D;AAC9D,mDAAyF;AACzF,mFAAgF;AAChF,mEAA0H;AAC1H,2EAAwE;AACxE,qEAAkE;AAClE,+DAA4D;AAC5D,wDAAqD;AACrD,uDAAoD;AASpD;;GAEG;AACH,MAAa,eAAgB,SAAQ,wBAA8B;CAAI;AAAvE,0CAAuE;AASvE;;GAEG;AACH,MAAa,eAAgB,SAAQ,wBAA8B;CAAI;AAAvE,0CAAuE;AAEvE;;GAEG;AACH,MAAa,qBAAqB;IAWhC,yEAAyE;IAClE,MAAM,CAAC,UAAU;QACtB,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,yBAAyB;QACzB,qBAAqB,CAAC,eAAe,CAAC,oEAAoC,CAAC,eAAe,EAAE,oEAAoC,CAAC,CAAC;QAClI,qBAAqB,CAAC,eAAe,CAAC,8CAAyB,CAAC,eAAe,EAAE,8CAAyB,CAAC,CAAC;QAC5G,qBAAqB,CAAC,eAAe,CAAC,yDAA2B,CAAC,eAAe,EAAE,yDAA2B,CAAC,CAAC;QAChH,qBAAqB,CAAC,eAAe,CAAC,mDAAwB,CAAC,eAAe,EAAE,mDAAwB,CAAC,CAAC;QAE1G,uEAAuE;QACvE,6CAAqB,CAAC,UAAU,EAAE,CAAC;QAEnC,mCAAmC;QACnC,qCAAiB,CAAC,UAAU,EAAE,CAAC;QAE/B,4EAA4E;QAC5E,yCAAmB,CAAC,UAAU,EAAE,CAAC;QAEjC,0CAA0C;QAC1C,6CAAqB,CAAC,UAAU,EAAE,CAAC;QAEnC,2CAA2C;QAC3C,0CAAuB,CAAC,UAAU,EAAE,CAAC;QAErC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe,CAAC,OAAe,EAAE,WAA6C;QAC1F,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;YACvD,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6BAA6B,OAAO,sBAAsB,CAAC,CAAC;SACjH;QAED,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,OAAe;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,WAAW,KAAK,SAAS,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,WAA6C;QAC/E,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE;YAC7D,IAAI,KAAK,KAAK,WAAW;gBACvB,OAAO,GAAG,CAAC;SACd;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe;QAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,WAAW;YACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,OAAe,EAAE,QAAgB,EAAE,OAAa,EAAE,SAAkB;QAC9F,MAAM,IAAI,GAAG,IAAI,8CAAsB,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,QAAQ,CAAC,CAAC;QAClF,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,2BAA2B,OAAO,kBAAkB,CAAC,CAAC;SAC3G;QAED,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,kBAAsC;QACxE,qCAAiB,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,aAA4B;QAClD,kBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAG,8CAA8C;IACxF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,aAA4B;QACrD,0BAAe,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAI,8CAA8C;IAChG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,iBAAoC;QAC9D,0BAAe,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAG,8CAA8C;IACpG,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,YAAqC;QACvE,0CAAuB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,iBAAiB;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,OAAQ,CAAC;QAC7B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,OAAO;QACnB,+BAAc,CAAC,gBAAgB,EAAE,CAAC;QAClC,6CAAqB,CAAC,QAAQ,EAAE,CAAC;QACjC,uCAAkB,CAAC,QAAQ,EAAE,CAAC;QAC9B,0CAAuB,CAAC,kBAAkB,EAAE,CAAC;QAC7C,yBAAW,CAAC,eAAe,EAAE,CAAC;QAC9B,2BAAY,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;;AAlKH,sDAoKC;AAnKgB,yCAAmB,GAAG,IAAI,GAAG,EAA4C,CAAC;AAC1E,kCAAY,GAAG,KAAK,CAAC;AAEpC,gBAAgB;AACO,qCAAe,GAAG,IAAI,iCAAe,EAAE,CAAC;AAC/D,gBAAgB;AACO,uCAAiB,GAAG,IAAI,eAAe,EAAE,CAAC;AACjE,gBAAgB;AACO,uCAAiB,GAAG,IAAI,eAAe,EAAE,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 ConfigurableUi\r\n */\r\n\r\nimport { BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { UiError } from \"@itwin/appui-abstract\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\r\nimport { KeyboardShortcutManager, KeyboardShortcutProps } from \"../keyboardshortcut/KeyboardShortcut\";\r\nimport { CubeNavigationAidControl } from \"../navigationaids/CubeNavigationAidControl\";\r\nimport { DrawingNavigationAidControl } from \"../navigationaids/DrawingNavigationAidControl\";\r\nimport { SheetNavigationAidControl } from \"../navigationaids/SheetNavigationAid\";\r\nimport { StandardRotationNavigationAidControl } from \"../navigationaids/StandardRotationNavigationAid\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { TaskManager, TaskPropsList } from \"../workflow/Task\";\r\nimport { WorkflowManager, WorkflowProps, WorkflowPropsList } from \"../workflow/Workflow\";\r\nimport { ToolSettingsManager } from \"../zones/toolsettings/ToolSettingsManager\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlConstructor, ConfigurableUiElement } from \"./ConfigurableUiControl\";\r\nimport { ModelessDialogManager } from \"../dialog/ModelessDialogManager\";\r\nimport { ModalDialogManager } from \"../dialog/ModalDialogManager\";\r\nimport { MessageManager } from \"../messages/MessageManager\";\r\nimport { PopupManager } from \"../popup/PopupManager\";\r\nimport { ActivityTracker } from \"./ActivityTracker\";\r\n\r\n/** Ui Activity Event Args interface.\r\n * @internal\r\n */\r\nexport interface UiActivityEventArgs {\r\n  event: Event;\r\n}\r\n\r\n/** Ui Activity Event class.\r\n * @internal\r\n */\r\nexport class UiActivityEvent extends BeUiEvent<UiActivityEventArgs> { }\r\n\r\n/** Ui Interval Event Args interface\r\n * @internal\r\n */\r\nexport interface UiIntervalEventArgs {\r\n  idleTimeout?: number;\r\n}\r\n\r\n/** Ui Interval Event class.\r\n * @internal\r\n */\r\nexport class UiIntervalEvent extends BeUiEvent<UiIntervalEventArgs> { }\r\n\r\n/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.\r\n * @public\r\n */\r\nexport class ConfigurableUiManager {\r\n  private static _registeredControls = new Map<string, ConfigurableUiControlConstructor>();\r\n  private static _initialized = false;\r\n\r\n  /** @internal */\r\n  public static readonly activityTracker = new ActivityTracker();\r\n  /** @internal */\r\n  public static readonly onUiActivityEvent = new UiActivityEvent();\r\n  /** @internal */\r\n  public static readonly onUiIntervalEvent = new UiIntervalEvent();\r\n\r\n  /** Initializes the ConfigurableUiManager and registers core controls. */\r\n  public static initialize() {\r\n    if (this._initialized)\r\n      return;\r\n\r\n    // Register core controls\r\n    ConfigurableUiManager.registerControl(StandardRotationNavigationAidControl.navigationAidId, StandardRotationNavigationAidControl);\r\n    ConfigurableUiManager.registerControl(SheetNavigationAidControl.navigationAidId, SheetNavigationAidControl);\r\n    ConfigurableUiManager.registerControl(DrawingNavigationAidControl.navigationAidId, DrawingNavigationAidControl);\r\n    ConfigurableUiManager.registerControl(CubeNavigationAidControl.navigationAidId, CubeNavigationAidControl);\r\n\r\n    // Initialize SyncUiEventDispatcher so it can register event callbacks.\r\n    SyncUiEventDispatcher.initialize();\r\n\r\n    // Initialize the FrontstageManager\r\n    FrontstageManager.initialize();\r\n\r\n    // Initialize the ToolSettingsManager that manages Tool Settings properties.\r\n    ToolSettingsManager.initialize();\r\n\r\n    // Initialize the modeless dialog manager.\r\n    ModelessDialogManager.initialize();\r\n\r\n    // Initialize the Keyboard Shortcut manager\r\n    KeyboardShortcutManager.initialize();\r\n\r\n    this._initialized = true;\r\n  }\r\n\r\n  /** Registers a control implementing the [[ConfigurableUiElement]] interface.\r\n   * These controls can be a\r\n   * [[ContentControl]],\r\n   * [[NavigationAidControl]],\r\n   * [[StatusBarWidgetControl]],\r\n   * [[WidgetControl]] or\r\n   * [ToolUiProvider]($appui-react).\r\n   * @param classId the class id of the control to register\r\n   * @param constructor the constructor of the control to register\r\n   */\r\n  public static registerControl(classId: string, constructor: ConfigurableUiControlConstructor): void {\r\n    if (this._registeredControls.get(classId) !== undefined) {\r\n      throw new UiError(UiFramework.loggerCategory(this), `registerControl: classId '${classId}' already registered`);\r\n    }\r\n\r\n    this._registeredControls.set(classId, constructor);\r\n  }\r\n\r\n  /** Determines if a control has been registered based on its classId.\r\n   * @param classId   the class id of the control to test\r\n   * @returns  true if the control is registered or false if not\r\n   */\r\n  public static isControlRegistered(classId: string): boolean {\r\n    const constructor = this._registeredControls.get(classId);\r\n    return constructor !== undefined;\r\n  }\r\n\r\n  /** Determines if a control has been registered.\r\n   * @internal\r\n   */\r\n  public static getConstructorClassId(constructor: ConfigurableUiControlConstructor): string | undefined {\r\n    for (const [key, value] of this._registeredControls.entries()) {\r\n      if (value === constructor)\r\n        return key;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Unregisters a control that has been registered.\r\n   * @param classId   the class id of the control to unregister\r\n   */\r\n  public static unregisterControl(classId: string): void {\r\n    const constructor = this._registeredControls.get(classId);\r\n    if (constructor)\r\n      this._registeredControls.delete(classId);\r\n  }\r\n\r\n  /** Creates a control registered by calling registerControl.\r\n   * @param classId   the class id of the control to create\r\n   * @param uniqueId  a unique id for the control\r\n   * @param options   options passed to the constructor of the control\r\n   * @param controlId controlId which may not be unique across all control instances.\r\n   * @returns  the created control\r\n   */\r\n  public static createControl(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined {\r\n    const info = new ConfigurableCreateInfo(classId, uniqueId, controlId ?? uniqueId);\r\n    const constructor = this._registeredControls.get(info.classId);\r\n    if (!constructor) {\r\n      throw new UiError(UiFramework.loggerCategory(this), `createControl: classId '${classId}' not registered`);\r\n    }\r\n\r\n    const control = new constructor(info, options);\r\n    return control;\r\n  }\r\n\r\n  /** Add a Frontstage via a provider into the [[FrontstageManager]].\r\n   * @param frontstageProvider  Provider of the Frontstage to add\r\n   */\r\n  public static addFrontstageProvider(frontstageProvider: FrontstageProvider): void {\r\n    FrontstageManager.addFrontstageProvider(frontstageProvider);\r\n  }\r\n\r\n  /** Loads one or more Tasks into the [[TaskManager]].\r\n   * @param taskPropsList  the list of Tasks to load\r\n   * @internal\r\n   * @deprecated\r\n   */\r\n  public static loadTasks(taskPropsList: TaskPropsList): void {   // eslint-disable-line deprecation/deprecation\r\n    TaskManager.loadTasks(taskPropsList);   // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Loads a Workflow into the [[WorkflowManager]].\r\n   * @param workflowProps  the Workflow to load\r\n   * @internal\r\n   * @deprecated\r\n   */\r\n  public static loadWorkflow(workflowProps: WorkflowProps): void {    // eslint-disable-line deprecation/deprecation\r\n    WorkflowManager.loadWorkflow(workflowProps);    // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Loads one or more Workflows into the [[WorkflowManager]].\r\n   * @param workflowPropsList  the list of Workflows to load\r\n   * @internal\r\n   * @deprecated\r\n   */\r\n  public static loadWorkflows(workflowPropsList: WorkflowPropsList): void {   // eslint-disable-line deprecation/deprecation\r\n    WorkflowManager.loadWorkflows(workflowPropsList);   // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].\r\n   * @param shortcutList  the properties of the Keyboard Shortcuts to load\r\n   */\r\n  public static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void {\r\n    KeyboardShortcutManager.loadKeyboardShortcuts(shortcutList);\r\n  }\r\n\r\n  /** Gets the HTML wrapper element for Configurable UI */\r\n  public static getWrapperElement(): HTMLElement {\r\n    const wrapper = document.getElementById(\"uifw-configurableui-wrapper\");\r\n    const htmlElement = wrapper!;\r\n    return htmlElement;\r\n  }\r\n\r\n  /** Closes all UI popups currently open */\r\n  public static closeUi(): void {\r\n    MessageManager.closeAllMessages();\r\n    ModelessDialogManager.closeAll();\r\n    ModalDialogManager.closeAll();\r\n    KeyboardShortcutManager.closeShortcutsMenu();\r\n    UiFramework.closeCursorMenu();\r\n    PopupManager.clearPopups();\r\n  }\r\n\r\n}\r\n"]}