@itwin/appui-react 3.0.0-dev.100

package/lib/cjs/appui-react/zones/toolsettings/DefaultToolSettingsProvider.js

@@ -0,0 +1,76 @@
+"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 ToolSettings
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultToolSettingsProvider = void 0;
+const React = require("react");
+const core_frontend_1 = require("@itwin/core-frontend");
+// cSpell:Ignore configurableui Fronstage
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const ConfigurableUiManager_1 = require("../../configurableui/ConfigurableUiManager");
+const ComponentGenerator_1 = require("../../uiprovider/ComponentGenerator");
+const DefaultDialogGridContainer_1 = require("../../uiprovider/DefaultDialogGridContainer");
+const ToolSettingsManager_1 = require("./ToolSettingsManager");
+const ToolUiProvider_1 = require("./ToolUiProvider");
+const FrontstageManager_1 = require("../../frontstage/FrontstageManager");
+/** @internal */
+/** ToolSettingsUiDataProvider keeps tool data in sync with UI display */
+class ToolSettingsUiDataProvider extends appui_abstract_1.UiLayoutDataProvider {
+    constructor() {
+        super(...arguments);
+        // send property changes from UI back to tool
+        this.applyUiPropertyChange = (syncItem) => {
+            // istanbul ignore next
+            core_frontend_1.IModelApp.toolAdmin.activeTool && core_frontend_1.IModelApp.toolAdmin.activeTool.applyToolSettingPropertyChange(syncItem);
+        };
+    }
+    supplyDialogItems() {
+        return ToolSettingsManager_1.ToolSettingsManager.toolSettingsProperties;
+    }
+}
+/** ToolUiProvider class that informs ConfigurableUi that Tool Settings are provided for the specified tool.
+ * @internal
+ */
+class DefaultToolSettingsProvider extends ToolUiProvider_1.ToolUiProvider {
+    constructor(info, options) {
+        super(info, options);
+        this._dataProvider = new ToolSettingsUiDataProvider();
+    }
+    get uiDataProvider() { return this._dataProvider; }
+    updateToolSettingsNodes() {
+        // istanbul ignore else
+        if (this.uiDataProvider.layoutDialogRows()) {
+            const componentGenerator = new ComponentGenerator_1.ComponentGenerator(this.uiDataProvider);
+            this.toolSettingsNode = (React.createElement(DefaultDialogGridContainer_1.DefaultDialogGridContainer, { componentGenerator: componentGenerator, isToolSettings: true }));
+            this.horizontalToolSettingNodes = componentGenerator.getToolSettingsEntries();
+        }
+        else {
+            this.toolSettingsNode = null;
+            this.horizontalToolSettingNodes = [];
+        }
+        // We emit the FrontstageManager.onToolSettingsReloadEvent event here because the Fronstage Manager is a static
+        // class that UI components can easily register listeners.
+        FrontstageManager_1.FrontstageManager.onToolSettingsReloadEvent.emit();
+    }
+    reloadPropertiesFromTool() {
+        // trigger the items to be reloaded from the active tool
+        this.uiDataProvider.reloadDialogItems(false);
+        this.updateToolSettingsNodes();
+    }
+    // called when tool is activated to repopulate tool settings.
+    onInitialize() {
+        this.reloadPropertiesFromTool();
+    }
+    // called to process ToolSettingsManager.onSyncToolSettingsProperties event
+    syncToolSettingsProperties(args) {
+        this.uiDataProvider.fireSyncPropertiesEvent(args.syncProperties);
+    }
+}
+exports.DefaultToolSettingsProvider = DefaultToolSettingsProvider;
+ConfigurableUiManager_1.ConfigurableUiManager.registerControl("DefaultToolSettings", DefaultToolSettingsProvider);
+//# sourceMappingURL=DefaultToolSettingsProvider.js.map

package/lib/cjs/appui-react/zones/toolsettings/DefaultToolSettingsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultToolSettingsProvider.js","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/DefaultToolSettingsProvider.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,wDAAiD;AACjD,yCAAyC;AACzC,0DAAiG;AAEjG,sFAAmF;AACnF,4EAAyE;AACzE,4FAAyF;AACzF,+DAAiG;AACjG,qDAAkD;AAClD,0EAAuE;AAEvE,gBAAgB;AAEhB,yEAAyE;AACzE,MAAM,0BAA2B,SAAQ,qCAAoB;IAA7D;;QAKE,6CAA6C;QAC7B,0BAAqB,GAAG,CAAC,QAAgC,EAAE,EAAE;YAC3E,uBAAuB;YACvB,yBAAS,CAAC,SAAS,CAAC,UAAU,IAAI,yBAAS,CAAC,SAAS,CAAC,UAAU,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;QAC5G,CAAC,CAAC;IACJ,CAAC;IATiB,iBAAiB;QAC/B,OAAO,yCAAmB,CAAC,sBAAsB,CAAC;IACpD,CAAC;CAOF;AAED;;GAEG;AACH,MAAa,2BAA4B,SAAQ,+BAAc;IAC7D,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,IAAI,0BAA0B,EAAE,CAAC;IACxD,CAAC;IAED,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,aAA2C,CAAC,CAAC,CAAC;IAEjF,uBAAuB;QAC5B,uBAAuB;QACvB,IAAI,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,EAAE;YAC1C,MAAM,kBAAkB,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAEvE,IAAI,CAAC,gBAAgB,GAAG,CACtB,oBAAC,uDAA0B,IAAC,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,EAAE,IAAI,GAAI,CAC7F,CAAC;YACF,IAAI,CAAC,0BAA0B,GAAG,kBAAkB,CAAC,sBAAsB,EAAE,CAAC;SAC/E;aAAM;YACL,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC7B,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC;SACtC;QACD,+GAA+G;QAC/G,0DAA0D;QAC1D,qCAAiB,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAC;IACrD,CAAC;IAEe,wBAAwB;QACtC,wDAAwD;QACxD,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAED,6DAA6D;IAC7C,YAAY;QAC1B,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED,2EAA2E;IAC3D,0BAA0B,CAAC,IAAyC;QAClF,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;CACF;AAzCD,kEAyCC;AAED,6CAAqB,CAAC,eAAe,CAAC,qBAAqB,EAAE,2BAA2B,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 ToolSettings\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\n// cSpell:Ignore configurableui Fronstage\r\nimport { DialogItem, DialogPropertySyncItem, UiLayoutDataProvider } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableCreateInfo } from \"../../configurableui/ConfigurableUiControl\";\r\nimport { ConfigurableUiManager } from \"../../configurableui/ConfigurableUiManager\";\r\nimport { ComponentGenerator } from \"../../uiprovider/ComponentGenerator\";\r\nimport { DefaultDialogGridContainer } from \"../../uiprovider/DefaultDialogGridContainer\";\r\nimport { SyncToolSettingsPropertiesEventArgs, ToolSettingsManager } from \"./ToolSettingsManager\";\r\nimport { ToolUiProvider } from \"./ToolUiProvider\";\r\nimport { FrontstageManager } from \"../../frontstage/FrontstageManager\";\r\n\r\n/** @internal */\r\n\r\n/** ToolSettingsUiDataProvider keeps tool data in sync with UI display */\r\nclass ToolSettingsUiDataProvider extends UiLayoutDataProvider {\r\n  public override supplyDialogItems(): DialogItem[] | undefined {\r\n    return ToolSettingsManager.toolSettingsProperties;\r\n  }\r\n\r\n  // send property changes from UI back to tool\r\n  public override applyUiPropertyChange = (syncItem: DialogPropertySyncItem) => {\r\n    // istanbul ignore next\r\n    IModelApp.toolAdmin.activeTool && IModelApp.toolAdmin.activeTool.applyToolSettingPropertyChange(syncItem);\r\n  };\r\n}\r\n\r\n/** ToolUiProvider class that informs ConfigurableUi that Tool Settings are provided for the specified tool.\r\n * @internal\r\n */\r\nexport class DefaultToolSettingsProvider extends ToolUiProvider {\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    super(info, options);\r\n    this._dataProvider = new ToolSettingsUiDataProvider();\r\n  }\r\n\r\n  public get uiDataProvider() { return this._dataProvider as ToolSettingsUiDataProvider; }\r\n\r\n  public updateToolSettingsNodes(): void {\r\n    // istanbul ignore else\r\n    if (this.uiDataProvider.layoutDialogRows()) {\r\n      const componentGenerator = new ComponentGenerator(this.uiDataProvider);\r\n\r\n      this.toolSettingsNode = (\r\n        <DefaultDialogGridContainer componentGenerator={componentGenerator} isToolSettings={true} />\r\n      );\r\n      this.horizontalToolSettingNodes = componentGenerator.getToolSettingsEntries();\r\n    } else {\r\n      this.toolSettingsNode = null;\r\n      this.horizontalToolSettingNodes = [];\r\n    }\r\n    // We emit the FrontstageManager.onToolSettingsReloadEvent event here because the Fronstage Manager is a static\r\n    // class that UI components can easily register listeners.\r\n    FrontstageManager.onToolSettingsReloadEvent.emit();\r\n  }\r\n\r\n  public override reloadPropertiesFromTool(): void {\r\n    // trigger the items to be reloaded from the active tool\r\n    this.uiDataProvider.reloadDialogItems(false);\r\n    this.updateToolSettingsNodes();\r\n  }\r\n\r\n  // called when tool is activated to repopulate tool settings.\r\n  public override onInitialize(): void {\r\n    this.reloadPropertiesFromTool();\r\n  }\r\n\r\n  // called to process ToolSettingsManager.onSyncToolSettingsProperties event\r\n  public override syncToolSettingsProperties(args: SyncToolSettingsPropertiesEventArgs): void {\r\n    this.uiDataProvider.fireSyncPropertiesEvent(args.syncProperties);\r\n  }\r\n}\r\n\r\nConfigurableUiManager.registerControl(\"DefaultToolSettings\", DefaultToolSettingsProvider);\r\n"]}

package/lib/cjs/appui-react/zones/toolsettings/ToolInformation.d.ts

@@ -0,0 +1,15 @@
+/** @packageDocumentation
+ * @module Item
+ */
+import { ToolUiProvider } from "./ToolUiProvider";
+/** Provides information about a tool with a given id, including the ToolUiProvider.
+ * @public
+ */
+export declare class ToolInformation {
+    toolId: string;
+    private _toolUiProvider;
+    constructor(toolId: string);
+    /** Get the ToolUiProvider registered for this tool */
+    get toolUiProvider(): ToolUiProvider | undefined;
+}
+//# sourceMappingURL=ToolInformation.d.ts.map

package/lib/cjs/appui-react/zones/toolsettings/ToolInformation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolInformation.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolInformation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAOH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,qBAAa,eAAe;IAGP,MAAM,EAAE,MAAM;IAFjC,OAAO,CAAC,eAAe,CAA6B;gBAEjC,MAAM,EAAE,MAAM;IAGjC,sDAAsD;IACtD,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAqBtD;CACF"}

package/lib/cjs/appui-react/zones/toolsettings/ToolInformation.js

@@ -0,0 +1,46 @@
+"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 Item
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolInformation = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const ConfigurableUiControl_1 = require("../../configurableui/ConfigurableUiControl");
+const ConfigurableUiManager_1 = require("../../configurableui/ConfigurableUiManager");
+const UiFramework_1 = require("../../UiFramework");
+const ToolSettingsManager_1 = require("./ToolSettingsManager");
+/** Provides information about a tool with a given id, including the ToolUiProvider.
+ * @public
+ */
+class ToolInformation {
+    constructor(toolId) {
+        this.toolId = toolId;
+    }
+    /** Get the ToolUiProvider registered for this tool */
+    get toolUiProvider() {
+        if (!this._toolUiProvider) {
+            let provider;
+            if (ConfigurableUiManager_1.ConfigurableUiManager.isControlRegistered(this.toolId)) {
+                provider = ConfigurableUiManager_1.ConfigurableUiManager.createControl(this.toolId, this.toolId);
+            }
+            else {
+                if (ToolSettingsManager_1.ToolSettingsManager.useDefaultToolSettingsProvider && this.toolId === ToolSettingsManager_1.ToolSettingsManager.toolIdForToolSettings)
+                    provider = ConfigurableUiManager_1.ConfigurableUiManager.createControl("DefaultToolSettings", this.toolId);
+            }
+            // istanbul ignore else
+            if (provider) {
+                if (provider.getType() !== ConfigurableUiControl_1.ConfigurableUiControlType.ToolUiProvider) {
+                    throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `toolUiProvider: toolId '${this.toolId}' is registered to a control that is NOT a ToolUiProvider`);
+                }
+                this._toolUiProvider = provider;
+            }
+        }
+        return this._toolUiProvider;
+    }
+}
+exports.ToolInformation = ToolInformation;
+//# sourceMappingURL=ToolInformation.js.map

package/lib/cjs/appui-react/zones/toolsettings/ToolInformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolInformation.js","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolInformation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAgD;AAChD,sFAAuF;AACvF,sFAAmF;AACnF,mDAAgD;AAChD,+DAA4D;AAG5D;;GAEG;AACH,MAAa,eAAe;IAG1B,YAAmB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IACjC,CAAC;IAED,sDAAsD;IACtD,IAAW,cAAc;QACvB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,QAAoC,CAAC;YAEzC,IAAI,6CAAqB,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAC1D,QAAQ,GAAG,6CAAqB,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAmB,CAAC;aAC5F;iBAAM;gBACL,IAAI,yCAAmB,CAAC,8BAA8B,IAAI,IAAI,CAAC,MAAM,KAAK,yCAAmB,CAAC,qBAAqB;oBACjH,QAAQ,GAAG,6CAAqB,CAAC,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAmB,CAAC;aACxG;YACD,uBAAuB;YACvB,IAAI,QAAQ,EAAE;gBACZ,IAAI,QAAQ,CAAC,OAAO,EAAE,KAAK,iDAAyB,CAAC,cAAc,EAAE;oBACnE,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,2BAA2B,IAAI,CAAC,MAAM,2DAA2D,CAAC,CAAC;iBACxJ;gBAED,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;aACjC;SACF;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CACF;AA7BD,0CA6BC","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 Item\r\n */\r\n\r\nimport { UiError } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableUiControlType } from \"../../configurableui/ConfigurableUiControl\";\r\nimport { ConfigurableUiManager } from \"../../configurableui/ConfigurableUiManager\";\r\nimport { UiFramework } from \"../../UiFramework\";\r\nimport { ToolSettingsManager } from \"./ToolSettingsManager\";\r\nimport { ToolUiProvider } from \"./ToolUiProvider\";\r\n\r\n/** Provides information about a tool with a given id, including the ToolUiProvider.\r\n * @public\r\n */\r\nexport class ToolInformation {\r\n  private _toolUiProvider: ToolUiProvider | undefined;\r\n\r\n  constructor(public toolId: string) {\r\n  }\r\n\r\n  /** Get the ToolUiProvider registered for this tool */\r\n  public get toolUiProvider(): ToolUiProvider | undefined {\r\n    if (!this._toolUiProvider) {\r\n      let provider: ToolUiProvider | undefined;\r\n\r\n      if (ConfigurableUiManager.isControlRegistered(this.toolId)) {\r\n        provider = ConfigurableUiManager.createControl(this.toolId, this.toolId) as ToolUiProvider;\r\n      } else {\r\n        if (ToolSettingsManager.useDefaultToolSettingsProvider && this.toolId === ToolSettingsManager.toolIdForToolSettings)\r\n          provider = ConfigurableUiManager.createControl(\"DefaultToolSettings\", this.toolId) as ToolUiProvider;\r\n      }\r\n      // istanbul ignore else\r\n      if (provider) {\r\n        if (provider.getType() !== ConfigurableUiControlType.ToolUiProvider) {\r\n          throw new UiError(UiFramework.loggerCategory(this), `toolUiProvider: toolId '${this.toolId}' is registered to a control that is NOT a ToolUiProvider`);\r\n        }\r\n\r\n        this._toolUiProvider = provider;\r\n      }\r\n    }\r\n\r\n    return this._toolUiProvider;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsManager.d.ts

@@ -0,0 +1,60 @@
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+import { InteractiveTool } from "@itwin/core-frontend";
+import { DialogItem, DialogPropertySyncItem } from "@itwin/appui-abstract";
+import { UiEvent } from "@itwin/core-react";
+/** Sync Tool Settings Properties Event Args interface.
+ * @public
+ */
+export interface SyncToolSettingsPropertiesEventArgs {
+    toolId: string;
+    syncProperties: DialogPropertySyncItem[];
+}
+/** Sync Tool Settings Properties Event class.
+ * @public
+ */
+export declare class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> {
+}
+/** Tool Settings Manager class. Used to generate UI components for Tool Settings.
+ * @public
+ */
+export declare class ToolSettingsManager {
+    private static _useDefaultToolSettingsProvider;
+    private static _toolIdForToolSettings;
+    private static _activeToolLabel;
+    private static _activeToolDescription;
+    private static syncToolSettingsProperties;
+    private static reloadToolSettingsProperties;
+    private static dispatchSyncUiEvent;
+    /** Initializes the ToolSettingsManager */
+    static initialize(): void;
+    /** clear cached Tool Settings properties. */
+    static clearToolSettingsData(): void;
+    /** Cache Tool Settings properties */
+    static initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;
+    /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
+     */
+    static initializeDataForTool(tool: InteractiveTool): void;
+    /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
+    static get toolSettingsProperties(): DialogItem[];
+    /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
+     * The setter is chiefly for testing.
+     */
+    static get useDefaultToolSettingsProvider(): boolean;
+    static set useDefaultToolSettingsProvider(useDefaultToolSettings: boolean);
+    /** The name of the active tool. This is typically the flyover text specified for the tool. */
+    static get activeToolLabel(): string;
+    static set activeToolLabel(label: string);
+    /** Returns the description of the active tool. */
+    static get activeToolDescription(): string;
+    /** Get ToolSettings Properties sync event. */
+    static readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;
+    static readonly onReloadToolSettingsProperties: UiEvent<void>;
+    /** Gets the Id of the active tool. If a tool is not active, blank is returned.
+     * @return  Id of the active tool, or blank if one is not active.
+     */
+    static get toolIdForToolSettings(): string;
+    static focusIntoToolSettings(): boolean;
+}
+//# sourceMappingURL=ToolSettingsManager.d.ts.map

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolSettingsManager.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolSettingsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAa,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAsB,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAOhE;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,sBAAsB,EAAE,CAAC;CAC1C;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,OAAO,CAAC,mCAAmC,CAAC;CAAI;AAMrG;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAS;IACvD,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAc;IACnD,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAc;IAC7C,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAc;IAGnD,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAKzC,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAI3C,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAOlC,0CAA0C;WAC5B,UAAU;IASxB,6CAA6C;WAC/B,qBAAqB;IAOnC,qCAAqC;WACvB,0BAA0B,CAAC,sBAAsB,EAAE,UAAU,EAAE,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO;IAsBlK;OACG;WACW,qBAAqB,CAAC,IAAI,EAAE,eAAe;IAIzD,iGAAiG;IACjG,WAAkB,sBAAsB,IAAI,UAAU,EAAE,CASvD;IAED;;OAEG;IACH,WAAkB,8BAA8B,IAAI,OAAO,CAAgE;IAC3H,WAAkB,8BAA8B,CAAC,sBAAsB,EAAE,OAAO,EAAmF;IAEnK,8FAA8F;IAC9F,WAAkB,eAAe,IAAI,MAAM,CAAiD;IAC5F,WAAkB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAmD;IAElG,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAAuD;IAExG,8CAA8C;IAC9C,gBAAuB,4BAA4B,kCAAyC;IAC5F,gBAAuB,8BAA8B,gBAAuB;IAE5E;;OAEG;IACH,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;WAEa,qBAAqB,IAAI,OAAO;CAe/C"}

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsManager.js

@@ -0,0 +1,129 @@
+"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 ToolSettings
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolSettingsManager = exports.SyncToolSettingsPropertiesEvent = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const core_react_1 = require("@itwin/core-react");
+const SyncUiEventDispatcher_1 = require("../../syncui/SyncUiEventDispatcher");
+/** Sync Tool Settings Properties Event class.
+ * @public
+ */
+class SyncToolSettingsPropertiesEvent extends core_react_1.UiEvent {
+}
+exports.SyncToolSettingsPropertiesEvent = SyncToolSettingsPropertiesEvent;
+// -----------------------------------------------------------------------------
+// ToolSettingsManager class
+// -----------------------------------------------------------------------------
+/** Tool Settings Manager class. Used to generate UI components for Tool Settings.
+ * @public
+ */
+class ToolSettingsManager {
+    // istanbul ignore next
+    static syncToolSettingsProperties(toolId, syncProperties) {
+        ToolSettingsManager.onSyncToolSettingsProperties.emit({ toolId, syncProperties });
+    }
+    // istanbul ignore next
+    static reloadToolSettingsProperties() {
+        ToolSettingsManager.onReloadToolSettingsProperties.emit();
+    }
+    static dispatchSyncUiEvent(syncEventId, useImmediateDispatch) {
+        if (useImmediateDispatch)
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(syncEventId);
+        else
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchSyncUiEvent(syncEventId);
+    }
+    /** Initializes the ToolSettingsManager */
+    static initialize() {
+        // istanbul ignore else
+        if (core_frontend_1.IModelApp && core_frontend_1.IModelApp.toolAdmin) {
+            core_frontend_1.IModelApp.toolAdmin.toolSettingsChangeHandler = ToolSettingsManager.syncToolSettingsProperties;
+            core_frontend_1.IModelApp.toolAdmin.reloadToolSettingsHandler = ToolSettingsManager.reloadToolSettingsProperties;
+            core_frontend_1.IModelApp.toolAdmin.toolSyncUiEventDispatcher = ToolSettingsManager.dispatchSyncUiEvent;
+        }
+    }
+    /** clear cached Tool Settings properties. */
+    static clearToolSettingsData() {
+        ToolSettingsManager.useDefaultToolSettingsProvider = false;
+        ToolSettingsManager._activeToolLabel = "";
+        ToolSettingsManager._activeToolDescription = "";
+        ToolSettingsManager._toolIdForToolSettings = "";
+    }
+    /** Cache Tool Settings properties */
+    static initializeToolSettingsData(toolSettingsProperties, toolId, toolLabel, toolDescription) {
+        ToolSettingsManager.clearToolSettingsData();
+        // istanbul ignore else
+        if (toolLabel)
+            ToolSettingsManager._activeToolLabel = toolLabel;
+        // istanbul ignore else
+        if (toolDescription)
+            ToolSettingsManager._activeToolDescription = toolDescription;
+        /* istanbul ignore else */
+        if (toolSettingsProperties && toolSettingsProperties.length > 0) {
+            // istanbul ignore else
+            if (toolId)
+                ToolSettingsManager._toolIdForToolSettings = toolId;
+            ToolSettingsManager._useDefaultToolSettingsProvider = true;
+            return true;
+        }
+        return false;
+    }
+    /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
+     */
+    static initializeDataForTool(tool) {
+        ToolSettingsManager.initializeToolSettingsData(tool.supplyToolSettingsProperties(), tool.toolId, tool.flyover, tool.description);
+    }
+    /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
+    static get toolSettingsProperties() {
+        if (core_frontend_1.IModelApp.toolAdmin && core_frontend_1.IModelApp.toolAdmin.activeTool && core_frontend_1.IModelApp.toolAdmin.activeTool.toolId === ToolSettingsManager._toolIdForToolSettings) {
+            const properties = core_frontend_1.IModelApp.toolAdmin.activeTool.supplyToolSettingsProperties();
+            // istanbul ignore else
+            if (properties)
+                return properties;
+        }
+        return [];
+    }
+    /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
+     * The setter is chiefly for testing.
+     */
+    static get useDefaultToolSettingsProvider() { return ToolSettingsManager._useDefaultToolSettingsProvider; }
+    static set useDefaultToolSettingsProvider(useDefaultToolSettings) { ToolSettingsManager._useDefaultToolSettingsProvider = useDefaultToolSettings; }
+    /** The name of the active tool. This is typically the flyover text specified for the tool. */
+    static get activeToolLabel() { return ToolSettingsManager._activeToolLabel; }
+    static set activeToolLabel(label) { ToolSettingsManager._activeToolLabel = label; }
+    /** Returns the description of the active tool. */
+    static get activeToolDescription() { return ToolSettingsManager._activeToolDescription; }
+    /** Gets the Id of the active tool. If a tool is not active, blank is returned.
+     * @return  Id of the active tool, or blank if one is not active.
+     */
+    static get toolIdForToolSettings() {
+        return ToolSettingsManager._toolIdForToolSettings;
+    }
+    static focusIntoToolSettings() {
+        let divElement = document.querySelector("div.nz-toolSettings-docked");
+        if (divElement) {
+            if ((0, core_react_1.focusIntoContainer)(divElement))
+                return true;
+        }
+        divElement = document.querySelector("div.uifw-tool-settings-grid-container");
+        if (divElement) {
+            if ((0, core_react_1.focusIntoContainer)(divElement))
+                return true;
+        }
+        return false;
+    }
+}
+exports.ToolSettingsManager = ToolSettingsManager;
+ToolSettingsManager._useDefaultToolSettingsProvider = false;
+ToolSettingsManager._toolIdForToolSettings = "";
+ToolSettingsManager._activeToolLabel = "";
+ToolSettingsManager._activeToolDescription = "";
+/** Get ToolSettings Properties sync event. */
+ToolSettingsManager.onSyncToolSettingsProperties = new SyncToolSettingsPropertiesEvent();
+ToolSettingsManager.onReloadToolSettingsProperties = new core_react_1.UiEvent();
+//# sourceMappingURL=ToolSettingsManager.js.map

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolSettingsManager.js","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolSettingsManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAkE;AAElE,kDAAgE;AAChE,8EAA2E;AAc3E;;GAEG;AACH,MAAa,+BAAgC,SAAQ,oBAA4C;CAAI;AAArG,0EAAqG;AAErG,gFAAgF;AAChF,4BAA4B;AAC5B,gFAAgF;AAEhF;;GAEG;AACH,MAAa,mBAAmB;IAM9B,uBAAuB;IACf,MAAM,CAAC,0BAA0B,CAAC,MAAc,EAAE,cAAwC;QAChG,mBAAmB,CAAC,4BAA4B,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,4BAA4B;QACzC,mBAAmB,CAAC,8BAA8B,CAAC,IAAI,EAAE,CAAC;IAC5D,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAmB,EAAE,oBAA8B;QACpF,IAAI,oBAAoB;YACtB,6CAAqB,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC;;YAEhE,6CAAqB,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,UAAU;QACtB,uBAAuB;QACvB,IAAI,yBAAS,IAAI,yBAAS,CAAC,SAAS,EAAE;YACpC,yBAAS,CAAC,SAAS,CAAC,yBAAyB,GAAG,mBAAmB,CAAC,0BAA0B,CAAC;YAC/F,yBAAS,CAAC,SAAS,CAAC,yBAAyB,GAAG,mBAAmB,CAAC,4BAA4B,CAAC;YACjG,yBAAS,CAAC,SAAS,CAAC,yBAAyB,GAAG,mBAAmB,CAAC,mBAAmB,CAAC;SACzF;IACH,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,mBAAmB,CAAC,8BAA8B,GAAG,KAAK,CAAC;QAC3D,mBAAmB,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC1C,mBAAmB,CAAC,sBAAsB,GAAG,EAAE,CAAC;QAChD,mBAAmB,CAAC,sBAAsB,GAAG,EAAE,CAAC;IAClD,CAAC;IAED,qCAAqC;IAC9B,MAAM,CAAC,0BAA0B,CAAC,sBAAgD,EAAE,MAAe,EAAE,SAAkB,EAAE,eAAwB;QACtJ,mBAAmB,CAAC,qBAAqB,EAAE,CAAC;QAC5C,uBAAuB;QACvB,IAAI,SAAS;YACX,mBAAmB,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAEnD,uBAAuB;QACvB,IAAI,eAAe;YACjB,mBAAmB,CAAC,sBAAsB,GAAG,eAAe,CAAC;QAE/D,0BAA0B;QAC1B,IAAI,sBAAsB,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/D,uBAAuB;YACvB,IAAI,MAAM;gBACR,mBAAmB,CAAC,sBAAsB,GAAG,MAAM,CAAC;YAEtD,mBAAmB,CAAC,+BAA+B,GAAG,IAAI,CAAC;YAC3D,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;OACG;IACI,MAAM,CAAC,qBAAqB,CAAC,IAAqB;QACvD,mBAAmB,CAAC,0BAA0B,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACnI,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,sBAAsB;QACtC,IAAI,yBAAS,CAAC,SAAS,IAAI,yBAAS,CAAC,SAAS,CAAC,UAAU,IAAI,yBAAS,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,mBAAmB,CAAC,sBAAsB,EAAE;YACjJ,MAAM,UAAU,GAAG,yBAAS,CAAC,SAAS,CAAC,UAAU,CAAC,4BAA4B,EAAE,CAAC;YACjF,uBAAuB;YACvB,IAAI,UAAU;gBACZ,OAAO,UAAU,CAAC;SACrB;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,8BAA8B,KAAc,OAAO,mBAAmB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACpH,MAAM,KAAK,8BAA8B,CAAC,sBAA+B,IAAI,mBAAmB,CAAC,+BAA+B,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAEnK,8FAA8F;IACvF,MAAM,KAAK,eAAe,KAAa,OAAO,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrF,MAAM,KAAK,eAAe,CAAC,KAAa,IAAI,mBAAmB,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC;IAElG,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB,KAAa,OAAO,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAMxG;;OAEG;IACI,MAAM,KAAK,qBAAqB;QACrC,OAAO,mBAAmB,CAAC,sBAAsB,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,qBAAqB;QACjC,IAAI,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QACtE,IAAI,UAAU,EAAE;YACd,IAAI,IAAA,+BAAkB,EAAC,UAA4B,CAAC;gBAClD,OAAO,IAAI,CAAC;SACf;QAED,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,uCAAuC,CAAC,CAAC;QAC7E,IAAI,UAAU,EAAE;YACd,IAAI,IAAA,+BAAkB,EAAC,UAA4B,CAAC;gBAClD,OAAO,IAAI,CAAC;SACf;QAED,OAAO,KAAK,CAAC;IACf,CAAC;;AAxHH,kDAyHC;AAxHgB,mDAA+B,GAAG,KAAK,CAAC;AACxC,0CAAsB,GAAW,EAAE,CAAC;AACpC,oCAAgB,GAAW,EAAE,CAAC;AAC9B,0CAAsB,GAAW,EAAE,CAAC;AA2FnD,8CAA8C;AACvB,gDAA4B,GAAG,IAAI,+BAA+B,EAAE,CAAC;AACrE,kDAA8B,GAAG,IAAI,oBAAO,EAAQ,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 ToolSettings\r\n */\r\n\r\nimport { IModelApp, InteractiveTool } from \"@itwin/core-frontend\";\r\nimport { DialogItem, DialogPropertySyncItem } from \"@itwin/appui-abstract\";\r\nimport { focusIntoContainer, UiEvent } from \"@itwin/core-react\";\r\nimport { SyncUiEventDispatcher } from \"../../syncui/SyncUiEventDispatcher\";\r\n\r\n// -----------------------------------------------------------------------------\r\n// Events\r\n// -----------------------------------------------------------------------------\r\n\r\n/** Sync Tool Settings Properties Event Args interface.\r\n * @public\r\n */\r\nexport interface SyncToolSettingsPropertiesEventArgs {\r\n  toolId: string;\r\n  syncProperties: DialogPropertySyncItem[];\r\n}\r\n\r\n/** Sync Tool Settings Properties Event class.\r\n * @public\r\n */\r\nexport class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> { }\r\n\r\n// -----------------------------------------------------------------------------\r\n// ToolSettingsManager class\r\n// -----------------------------------------------------------------------------\r\n\r\n/** Tool Settings Manager class. Used to generate UI components for Tool Settings.\r\n * @public\r\n */\r\nexport class ToolSettingsManager {\r\n  private static _useDefaultToolSettingsProvider = false;\r\n  private static _toolIdForToolSettings: string = \"\";\r\n  private static _activeToolLabel: string = \"\";\r\n  private static _activeToolDescription: string = \"\";\r\n\r\n  // istanbul ignore next\r\n  private static syncToolSettingsProperties(toolId: string, syncProperties: DialogPropertySyncItem[]): void {\r\n    ToolSettingsManager.onSyncToolSettingsProperties.emit({ toolId, syncProperties });\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private static reloadToolSettingsProperties(): void {\r\n    ToolSettingsManager.onReloadToolSettingsProperties.emit();\r\n  }\r\n\r\n  private static dispatchSyncUiEvent(syncEventId: string, useImmediateDispatch?: boolean): void {\r\n    if (useImmediateDispatch)\r\n      SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(syncEventId);\r\n    else\r\n      SyncUiEventDispatcher.dispatchSyncUiEvent(syncEventId);\r\n  }\r\n\r\n  /** Initializes the ToolSettingsManager */\r\n  public static initialize() {\r\n    // istanbul ignore else\r\n    if (IModelApp && IModelApp.toolAdmin) {\r\n      IModelApp.toolAdmin.toolSettingsChangeHandler = ToolSettingsManager.syncToolSettingsProperties;\r\n      IModelApp.toolAdmin.reloadToolSettingsHandler = ToolSettingsManager.reloadToolSettingsProperties;\r\n      IModelApp.toolAdmin.toolSyncUiEventDispatcher = ToolSettingsManager.dispatchSyncUiEvent;\r\n    }\r\n  }\r\n\r\n  /** clear cached Tool Settings properties. */\r\n  public static clearToolSettingsData() {\r\n    ToolSettingsManager.useDefaultToolSettingsProvider = false;\r\n    ToolSettingsManager._activeToolLabel = \"\";\r\n    ToolSettingsManager._activeToolDescription = \"\";\r\n    ToolSettingsManager._toolIdForToolSettings = \"\";\r\n  }\r\n\r\n  /** Cache Tool Settings properties */\r\n  public static initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean {\r\n    ToolSettingsManager.clearToolSettingsData();\r\n    // istanbul ignore else\r\n    if (toolLabel)\r\n      ToolSettingsManager._activeToolLabel = toolLabel;\r\n\r\n    // istanbul ignore else\r\n    if (toolDescription)\r\n      ToolSettingsManager._activeToolDescription = toolDescription;\r\n\r\n    /* istanbul ignore else */\r\n    if (toolSettingsProperties && toolSettingsProperties.length > 0) {\r\n      // istanbul ignore else\r\n      if (toolId)\r\n        ToolSettingsManager._toolIdForToolSettings = toolId;\r\n\r\n      ToolSettingsManager._useDefaultToolSettingsProvider = true;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** Set of data used in Tool Settings for the specified tool. The tool specified should be the \"active\" tool.\r\n   */\r\n  public static initializeDataForTool(tool: InteractiveTool) {\r\n    ToolSettingsManager.initializeToolSettingsData(tool.supplyToolSettingsProperties(), tool.toolId, tool.flyover, tool.description);\r\n  }\r\n\r\n  /** Returns the toolSettings properties that can be used to populate the tool settings widget. */\r\n  public static get toolSettingsProperties(): DialogItem[] {\r\n    if (IModelApp.toolAdmin && IModelApp.toolAdmin.activeTool && IModelApp.toolAdmin.activeTool.toolId === ToolSettingsManager._toolIdForToolSettings) {\r\n      const properties = IModelApp.toolAdmin.activeTool.supplyToolSettingsProperties();\r\n      // istanbul ignore else\r\n      if (properties)\r\n        return properties;\r\n    }\r\n\r\n    return [];\r\n  }\r\n\r\n  /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.\r\n   * The setter is chiefly for testing.\r\n   */\r\n  public static get useDefaultToolSettingsProvider(): boolean { return ToolSettingsManager._useDefaultToolSettingsProvider; }\r\n  public static set useDefaultToolSettingsProvider(useDefaultToolSettings: boolean) { ToolSettingsManager._useDefaultToolSettingsProvider = useDefaultToolSettings; }\r\n\r\n  /** The name of the active tool. This is typically the flyover text specified for the tool. */\r\n  public static get activeToolLabel(): string { return ToolSettingsManager._activeToolLabel; }\r\n  public static set activeToolLabel(label: string) { ToolSettingsManager._activeToolLabel = label; }\r\n\r\n  /** Returns the description of the active tool. */\r\n  public static get activeToolDescription(): string { return ToolSettingsManager._activeToolDescription; }\r\n\r\n  /** Get ToolSettings Properties sync event. */\r\n  public static readonly onSyncToolSettingsProperties = new SyncToolSettingsPropertiesEvent();\r\n  public static readonly onReloadToolSettingsProperties = new UiEvent<void>();\r\n\r\n  /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n   * @return  Id of the active tool, or blank if one is not active.\r\n   */\r\n  public static get toolIdForToolSettings(): string {\r\n    return ToolSettingsManager._toolIdForToolSettings;\r\n  }\r\n\r\n  public static focusIntoToolSettings(): boolean {\r\n    let divElement = document.querySelector(\"div.nz-toolSettings-docked\");\r\n    if (divElement) {\r\n      if (focusIntoContainer(divElement as HTMLDivElement))\r\n        return true;\r\n    }\r\n\r\n    divElement = document.querySelector(\"div.uifw-tool-settings-grid-container\");\r\n    if (divElement) {\r\n      if (focusIntoContainer(divElement as HTMLDivElement))\r\n        return true;\r\n    }\r\n\r\n    return false;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsZone.d.ts

@@ -0,0 +1,54 @@
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+import * as React from "react";
+import { PointProps } from "@itwin/appui-abstract";
+import { CommonProps, RectangleProps } from "@itwin/core-react";
+import { WidgetZoneId, ZoneManagerProps, ZoneTargetType } from "@itwin/appui-layout-react";
+import { TargetChangeHandler, WidgetChangeHandler } from "../../frontstage/FrontstageComposer";
+/** State for the ToolSettingsZone content.
+ */
+declare enum ToolSettingsZoneContent {
+    Closed = 0,
+    ToolSettings = 1
+}
+/** State for the [[ToolSettingsZone]].
+ */
+interface ToolSettingsZoneState {
+    toolSettingsZoneContent: ToolSettingsZoneContent;
+    title: string;
+}
+/** Properties for the [[ToolSettingsZone]] React component.
+ * @internal
+ */
+export interface ToolSettingsZoneProps extends CommonProps {
+    dropTarget: ZoneTargetType | undefined;
+    getWidgetContentRef: (id: WidgetZoneId) => React.Ref<HTMLDivElement>;
+    isHidden: boolean;
+    isClosed: boolean;
+    lastPosition: PointProps | undefined;
+    targetChangeHandler: TargetChangeHandler;
+    targetedBounds: RectangleProps | undefined;
+    widgetChangeHandler: WidgetChangeHandler;
+    zone: ZoneManagerProps;
+}
+/** Tool Settings Zone React component.
+ * @internal
+ */
+export declare class ToolSettingsZone extends React.PureComponent<ToolSettingsZoneProps, ToolSettingsZoneState> {
+    private _hiddenVisibility;
+    private _widget;
+    /** @internal */
+    readonly state: Readonly<ToolSettingsZoneState>;
+    constructor(props: ToolSettingsZoneProps);
+    private _handleToolActivatedEvent;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): React.ReactNode;
+    private _processClick;
+    private getToolSettingsWidget;
+    private _handleDragStart;
+    private _handleResize;
+}
+export {};
+//# sourceMappingURL=ToolSettingsZone.d.ts.map

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsZone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolSettingsZone.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolSettingsZone.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EACwD,YAAY,EAAQ,gBAAgB,EAAE,cAAc,EAClH,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAa/F;GACG;AACH,aAAK,uBAAuB;IAC1B,MAAM,IAAA;IACN,YAAY,IAAA;CACb;AAED;GACG;AACH,UAAU,qBAAqB;IAC7B,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD,UAAU,EAAE,cAAc,GAAG,SAAS,CAAC;IACvC,mBAAmB,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACrE,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,UAAU,GAAG,SAAS,CAAC;IACrC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IAC3C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK,CAAC,aAAa,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;IACrG,OAAO,CAAC,iBAAiB,CAEvB;IACF,OAAO,CAAC,OAAO,CAAmC;IAElD,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;gBAEpD,KAAK,EAAE,qBAAqB;IAWxC,OAAO,CAAC,yBAAyB,CAI/B;IAEc,iBAAiB,IAAI,IAAI;IAIzB,oBAAoB,IAAI,IAAI;IAI5B,MAAM,IAAI,KAAK,CAAC,SAAS;IAoCzC,OAAO,CAAC,aAAa,CAUnB;IAEF,OAAO,CAAC,qBAAqB;IAyC7B,OAAO,CAAC,gBAAgB,CAKtB;IAEF,OAAO,CAAC,aAAa,CAEnB;CACH"}

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsZone.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 ToolSettings
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolSettingsZone = void 0;
+const React = require("react");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const FrontstageManager_1 = require("../../frontstage/FrontstageManager");
+const SafeAreaContext_1 = require("../../safearea/SafeAreaContext");
+const UiFramework_1 = require("../../UiFramework");
+const UiShowHideManager_1 = require("../../utils/UiShowHideManager");
+const FrameworkZone_1 = require("../FrameworkZone");
+const Outline_1 = require("../Outline");
+const ToolSettingsManager_1 = require("./ToolSettingsManager");
+const useEscapeSetFocusToHome_1 = require("../../hooks/useEscapeSetFocusToHome");
+const ZoneTargets_1 = require("../../dragdrop/ZoneTargets");
+// cSpell:ignore safearea
+/** State for the ToolSettingsZone content.
+ */
+var ToolSettingsZoneContent;
+(function (ToolSettingsZoneContent) {
+    ToolSettingsZoneContent[ToolSettingsZoneContent["Closed"] = 0] = "Closed";
+    ToolSettingsZoneContent[ToolSettingsZoneContent["ToolSettings"] = 1] = "ToolSettings";
+})(ToolSettingsZoneContent || (ToolSettingsZoneContent = {}));
+/** Tool Settings Zone React component.
+ * @internal
+ */
+class ToolSettingsZone extends React.PureComponent {
+    constructor(props) {
+        super(props);
+        this._hiddenVisibility = {
+            visibility: "hidden",
+        };
+        this._widget = React.createRef();
+        this._handleToolActivatedEvent = () => {
+            // Update tool settings title when active tool changes.
+            const title = `${ToolSettingsManager_1.ToolSettingsManager.activeToolLabel}`;
+            this.setState({ title });
+        };
+        this._processClick = () => {
+            this.setState((prevState) => {
+                let toolSettingsZoneContent = ToolSettingsZoneContent.Closed;
+                if (prevState.toolSettingsZoneContent === ToolSettingsZoneContent.Closed)
+                    toolSettingsZoneContent = ToolSettingsZoneContent.ToolSettings;
+                return {
+                    toolSettingsZoneContent,
+                };
+            });
+        };
+        this._handleDragStart = (initialPosition) => {
+            if (!this._widget.current)
+                return;
+            const bounds = this._widget.current.getBounds();
+            this.props.widgetChangeHandler.handleTabDragStart(this.props.zone.id, 0, initialPosition, bounds);
+        };
+        this._handleResize = (resizeBy, handle) => {
+            this.props.widgetChangeHandler.handleResize(this.props.zone.id, resizeBy, handle, 0);
+        };
+        const title = `${ToolSettingsManager_1.ToolSettingsManager.activeToolLabel}`;
+        this.state = {
+            toolSettingsZoneContent: this.props.isClosed ? ToolSettingsZoneContent.Closed : ToolSettingsZoneContent.ToolSettings,
+            title,
+        };
+    }
+    componentDidMount() {
+        FrontstageManager_1.FrontstageManager.onToolActivatedEvent.addListener(this._handleToolActivatedEvent);
+    }
+    componentWillUnmount() {
+        FrontstageManager_1.FrontstageManager.onToolActivatedEvent.removeListener(this._handleToolActivatedEvent);
+    }
+    render() {
+        const bounds = (0, FrameworkZone_1.getFloatingZoneBounds)(this.props.zone);
+        const zIndexStyle = (0, FrameworkZone_1.getFloatingZoneStyle)(this.props.zone);
+        return (React.createElement(SafeAreaContext_1.SafeAreaContext.Consumer, null, (safeAreaInsets) => (React.createElement("span", { style: zIndexStyle },
+            React.createElement(appui_layout_react_1.Zone, { bounds: bounds, className: this.props.className, id: this.props.zone.id, isFloating: !!this.props.zone.floating, isHidden: this.props.isHidden, safeAreaInsets: safeAreaInsets, style: this.props.style }, this.getToolSettingsWidget()),
+            React.createElement(appui_layout_react_1.Zone, { bounds: this.props.zone.bounds, id: this.props.zone.id, safeAreaInsets: safeAreaInsets },
+                React.createElement(ZoneTargets_1.ZoneTargets, { zoneId: this.props.zone.id, dropTarget: this.props.dropTarget, targetChangeHandler: this.props.targetChangeHandler })),
+            React.createElement(Outline_1.Outline, { bounds: this.props.targetedBounds })))));
+    }
+    getToolSettingsWidget() {
+        if (this.state.toolSettingsZoneContent === ToolSettingsZoneContent.Closed) {
+            return (React.createElement(appui_layout_react_1.ToolSettingsTab, { onClick: this._processClick, onKeyDown: useEscapeSetFocusToHome_1.onEscapeSetFocusToHome, title: this.state.title, onMouseEnter: UiShowHideManager_1.UiShowHideManager.handleWidgetMouseEnter },
+                React.createElement("i", { className: "icon icon-settings" })));
+        }
+        return (React.createElement(appui_layout_react_1.ToolSettings, { buttons: React.createElement("div", { style: this.props.zone.floating && this._hiddenVisibility },
+                React.createElement(appui_layout_react_1.TitleBarButton, { onClick: this._processClick, title: UiFramework_1.UiFramework.translate("general.minimize") },
+                    React.createElement("i", { className: "icon icon-chevron-up" }))), contentRef: this.props.getWidgetContentRef(this.props.zone.id), fillZone: this.props.zone.isLayoutChanged && !!this.props.zone.floating, lastPosition: this.props.lastPosition, onDrag: this.props.zone.allowsMerging ? this.props.widgetChangeHandler.handleTabDrag : undefined, onDragEnd: this.props.widgetChangeHandler.handleTabDragEnd, onDragStart: this._handleDragStart, onResize: this.props.zone.floating && this._handleResize, onMouseEnter: UiShowHideManager_1.UiShowHideManager.handleWidgetMouseEnter, ref: this._widget, title: this.state.title }));
+    }
+}
+exports.ToolSettingsZone = ToolSettingsZone;
+//# sourceMappingURL=ToolSettingsZone.js.map

package/lib/cjs/appui-react/zones/toolsettings/ToolSettingsZone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolSettingsZone.js","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolSettingsZone.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAG/B,kEAEmC;AAEnC,0EAAuE;AACvE,oEAAiE;AACjE,mDAAgD;AAChD,qEAAkE;AAClE,oDAA+E;AAC/E,wCAAqC;AACrC,+DAA4D;AAC5D,iFAA6E;AAC7E,4DAAyD;AAEzD,yBAAyB;AAEzB;GACG;AACH,IAAK,uBAGJ;AAHD,WAAK,uBAAuB;IAC1B,yEAAM,CAAA;IACN,qFAAY,CAAA;AACd,CAAC,EAHI,uBAAuB,KAAvB,uBAAuB,QAG3B;AAwBD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,KAAK,CAAC,aAA2D;IASrG,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QATP,sBAAiB,GAAwB;YAC/C,UAAU,EAAE,QAAQ;SACrB,CAAC;QACM,YAAO,GAAG,KAAK,CAAC,SAAS,EAAgB,CAAC;QAgB1C,8BAAyB,GAAG,GAAS,EAAE;YAC7C,uDAAuD;YACvD,MAAM,KAAK,GAAG,GAAG,yCAAmB,CAAC,eAAe,EAAE,CAAC;YACvD,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC;QA8CM,kBAAa,GAAG,GAAG,EAAE;YAC3B,IAAI,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC1B,IAAI,uBAAuB,GAAG,uBAAuB,CAAC,MAAM,CAAC;gBAE7D,IAAI,SAAS,CAAC,uBAAuB,KAAK,uBAAuB,CAAC,MAAM;oBACtE,uBAAuB,GAAG,uBAAuB,CAAC,YAAY,CAAC;gBACjE,OAAO;oBACL,uBAAuB;iBACxB,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QA2CM,qBAAgB,GAAG,CAAC,eAA2B,EAAE,EAAE;YACzD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO;gBACvB,OAAO;YACT,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAChD,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;QACpG,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,QAAgB,EAAE,MAAoB,EAAE,EAAE;YACjE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC;QAxHA,MAAM,KAAK,GAAG,GAAG,yCAAmB,CAAC,eAAe,EAAE,CAAC;QAEvD,IAAI,CAAC,KAAK,GAAG;YACX,uBAAuB,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC,uBAAuB,CAAC,YAAY;YACpH,KAAK;SACN,CAAC;IACJ,CAAC;IAQe,iBAAiB;QAC/B,qCAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACrF,CAAC;IAEe,oBAAoB;QAClC,qCAAiB,CAAC,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACxF,CAAC;IAEe,MAAM;QACpB,MAAM,MAAM,GAAG,IAAA,qCAAqB,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,IAAA,oCAAoB,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1D,OAAO,CACL,oBAAC,iCAAe,CAAC,QAAQ,QACtB,CAAC,cAAc,EAAE,EAAE,CAAC,CACnB,8BAAM,KAAK,EAAE,WAAW;YACtB,oBAAC,yBAAI,IACH,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EACtB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EACtC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAC7B,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,IAEtB,IAAI,CAAC,qBAAqB,EAAE,CACxB;YACP,oBAAC,yBAAI,IACH,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAC9B,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EACtB,cAAc,EAAE,cAAc;gBAE9B,oBAAC,yBAAW,IACV,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAC1B,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EACjC,mBAAmB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,GACnD,CACG;YACP,oBAAC,iBAAO,IAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAI,CACzC,CACR,CACwB,CAC5B,CAAC;IACJ,CAAC;IAcO,qBAAqB;QAC3B,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,KAAK,uBAAuB,CAAC,MAAM,EAAE;YAEzE,OAAO,CACL,oBAAC,oCAAe,IACd,OAAO,EAAE,IAAI,CAAC,aAAa,EAC3B,SAAS,EAAE,gDAAsB,EACjC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,YAAY,EAAE,qCAAiB,CAAC,sBAAsB;gBAEtD,2BAAG,SAAS,EAAC,oBAAoB,GAAG,CACpB,CACnB,CAAC;SACH;QAED,OAAO,CACL,oBAAC,iCAAY,IACX,OAAO,EACL,6BAAK,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,iBAAiB;gBAC5D,oBAAC,mCAAc,IACb,OAAO,EAAE,IAAI,CAAC,aAAa,EAC3B,KAAK,EAAE,yBAAW,CAAC,SAAS,CAAC,kBAAkB,CAAC;oBAEhD,2BAAG,SAAS,EAAE,sBAAsB,GAAI,CACzB,CACb,EAER,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAC9D,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EACvE,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EACrC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,EAChG,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,EAC1D,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAClC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,aAAa,EACxD,YAAY,EAAE,qCAAiB,CAAC,sBAAsB,EACtD,GAAG,EAAE,IAAI,CAAC,OAAO,EACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GACvB,CACH,CAAC;IACJ,CAAC;CAYF;AArID,4CAqIC","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 ToolSettings\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { PointProps } from \"@itwin/appui-abstract\";\r\nimport { CommonProps, RectangleProps } from \"@itwin/core-react\";\r\nimport {\r\n  ResizeHandle, TitleBarButton, ToolSettings, ToolSettingsTab, WidgetZoneId, Zone, ZoneManagerProps, ZoneTargetType,\r\n} from \"@itwin/appui-layout-react\";\r\nimport { TargetChangeHandler, WidgetChangeHandler } from \"../../frontstage/FrontstageComposer\";\r\nimport { FrontstageManager } from \"../../frontstage/FrontstageManager\";\r\nimport { SafeAreaContext } from \"../../safearea/SafeAreaContext\";\r\nimport { UiFramework } from \"../../UiFramework\";\r\nimport { UiShowHideManager } from \"../../utils/UiShowHideManager\";\r\nimport { getFloatingZoneBounds, getFloatingZoneStyle } from \"../FrameworkZone\";\r\nimport { Outline } from \"../Outline\";\r\nimport { ToolSettingsManager } from \"./ToolSettingsManager\";\r\nimport { onEscapeSetFocusToHome } from \"../../hooks/useEscapeSetFocusToHome\";\r\nimport { ZoneTargets } from \"../../dragdrop/ZoneTargets\";\r\n\r\n// cSpell:ignore safearea\r\n\r\n/** State for the ToolSettingsZone content.\r\n */\r\nenum ToolSettingsZoneContent {\r\n  Closed,\r\n  ToolSettings, // eslint-disable-line @typescript-eslint/no-shadow\r\n}\r\n\r\n/** State for the [[ToolSettingsZone]].\r\n */\r\ninterface ToolSettingsZoneState {\r\n  toolSettingsZoneContent: ToolSettingsZoneContent;\r\n  title: string;\r\n}\r\n\r\n/** Properties for the [[ToolSettingsZone]] React component.\r\n * @internal\r\n */\r\nexport interface ToolSettingsZoneProps extends CommonProps {\r\n  dropTarget: ZoneTargetType | undefined;\r\n  getWidgetContentRef: (id: WidgetZoneId) => React.Ref<HTMLDivElement>;\r\n  isHidden: boolean;\r\n  isClosed: boolean;\r\n  lastPosition: PointProps | undefined;\r\n  targetChangeHandler: TargetChangeHandler;\r\n  targetedBounds: RectangleProps | undefined;\r\n  widgetChangeHandler: WidgetChangeHandler;\r\n  zone: ZoneManagerProps;\r\n}\r\n\r\n/** Tool Settings Zone React component.\r\n * @internal\r\n */\r\nexport class ToolSettingsZone extends React.PureComponent<ToolSettingsZoneProps, ToolSettingsZoneState> {\r\n  private _hiddenVisibility: React.CSSProperties = {\r\n    visibility: \"hidden\",\r\n  };\r\n  private _widget = React.createRef<ToolSettings>();\r\n\r\n  /** @internal */\r\n  public override readonly state: Readonly<ToolSettingsZoneState>;\r\n\r\n  constructor(props: ToolSettingsZoneProps) {\r\n    super(props);\r\n\r\n    const title = `${ToolSettingsManager.activeToolLabel}`;\r\n\r\n    this.state = {\r\n      toolSettingsZoneContent: this.props.isClosed ? ToolSettingsZoneContent.Closed : ToolSettingsZoneContent.ToolSettings,\r\n      title,\r\n    };\r\n  }\r\n\r\n  private _handleToolActivatedEvent = (): void => {\r\n    // Update tool settings title when active tool changes.\r\n    const title = `${ToolSettingsManager.activeToolLabel}`;\r\n    this.setState({ title });\r\n  };\r\n\r\n  public override componentDidMount(): void {\r\n    FrontstageManager.onToolActivatedEvent.addListener(this._handleToolActivatedEvent);\r\n  }\r\n\r\n  public override componentWillUnmount(): void {\r\n    FrontstageManager.onToolActivatedEvent.removeListener(this._handleToolActivatedEvent);\r\n  }\r\n\r\n  public override render(): React.ReactNode {\r\n    const bounds = getFloatingZoneBounds(this.props.zone);\r\n    const zIndexStyle = getFloatingZoneStyle(this.props.zone);\r\n    return (\r\n      <SafeAreaContext.Consumer>\r\n        {(safeAreaInsets) => (\r\n          <span style={zIndexStyle}>\r\n            <Zone\r\n              bounds={bounds}\r\n              className={this.props.className}\r\n              id={this.props.zone.id}\r\n              isFloating={!!this.props.zone.floating}\r\n              isHidden={this.props.isHidden}\r\n              safeAreaInsets={safeAreaInsets}\r\n              style={this.props.style}\r\n            >\r\n              {this.getToolSettingsWidget()}\r\n            </Zone>\r\n            <Zone\r\n              bounds={this.props.zone.bounds}\r\n              id={this.props.zone.id}\r\n              safeAreaInsets={safeAreaInsets}\r\n            >\r\n              <ZoneTargets\r\n                zoneId={this.props.zone.id}\r\n                dropTarget={this.props.dropTarget}\r\n                targetChangeHandler={this.props.targetChangeHandler}\r\n              />\r\n            </Zone>\r\n            <Outline bounds={this.props.targetedBounds} />\r\n          </span>\r\n        )}\r\n      </SafeAreaContext.Consumer>\r\n    );\r\n  }\r\n\r\n  private _processClick = () => {\r\n    this.setState((prevState) => {\r\n      let toolSettingsZoneContent = ToolSettingsZoneContent.Closed;\r\n\r\n      if (prevState.toolSettingsZoneContent === ToolSettingsZoneContent.Closed)\r\n        toolSettingsZoneContent = ToolSettingsZoneContent.ToolSettings;\r\n      return {\r\n        toolSettingsZoneContent,\r\n      };\r\n    });\r\n  };\r\n\r\n  private getToolSettingsWidget(): React.ReactNode {\r\n    if (this.state.toolSettingsZoneContent === ToolSettingsZoneContent.Closed) {\r\n\r\n      return (\r\n        <ToolSettingsTab\r\n          onClick={this._processClick}\r\n          onKeyDown={onEscapeSetFocusToHome}\r\n          title={this.state.title}\r\n          onMouseEnter={UiShowHideManager.handleWidgetMouseEnter}\r\n        >\r\n          <i className=\"icon icon-settings\" />\r\n        </ToolSettingsTab>\r\n      );\r\n    }\r\n\r\n    return (\r\n      <ToolSettings\r\n        buttons={\r\n          <div style={this.props.zone.floating && this._hiddenVisibility}>\r\n            <TitleBarButton\r\n              onClick={this._processClick}\r\n              title={UiFramework.translate(\"general.minimize\")}\r\n            >\r\n              <i className={\"icon icon-chevron-up\"} />\r\n            </TitleBarButton>\r\n          </div>\r\n        }\r\n        contentRef={this.props.getWidgetContentRef(this.props.zone.id)}\r\n        fillZone={this.props.zone.isLayoutChanged && !!this.props.zone.floating}\r\n        lastPosition={this.props.lastPosition}\r\n        onDrag={this.props.zone.allowsMerging ? this.props.widgetChangeHandler.handleTabDrag : undefined}\r\n        onDragEnd={this.props.widgetChangeHandler.handleTabDragEnd}\r\n        onDragStart={this._handleDragStart}\r\n        onResize={this.props.zone.floating && this._handleResize}\r\n        onMouseEnter={UiShowHideManager.handleWidgetMouseEnter}\r\n        ref={this._widget}\r\n        title={this.state.title}\r\n      />\r\n    );\r\n  }\r\n\r\n  private _handleDragStart = (initialPosition: PointProps) => {\r\n    if (!this._widget.current)\r\n      return;\r\n    const bounds = this._widget.current.getBounds();\r\n    this.props.widgetChangeHandler.handleTabDragStart(this.props.zone.id, 0, initialPosition, bounds);\r\n  };\r\n\r\n  private _handleResize = (resizeBy: number, handle: ResizeHandle) => {\r\n    this.props.widgetChangeHandler.handleResize(this.props.zone.id, resizeBy, handle, 0);\r\n  };\r\n}\r\n"]}

package/lib/cjs/appui-react/zones/toolsettings/ToolUiProvider.d.ts

@@ -0,0 +1,36 @@
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+import * as React from "react";
+import { UiDataProvider } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from "../../configurableui/ConfigurableUiControl";
+import { ToolSettingsEntry } from "../../widget-panels/ToolSettings";
+import { SyncToolSettingsPropertiesEventArgs } from "./ToolSettingsManager";
+/**
+ * ToolUiProvider provides the Tool Settings and/or Tool Assistance UI for a tool.
+ * The ToolUiProvider is registered for the tool id via ConfigurableUiManager.registerControl.
+ * @public
+ */
+export declare class ToolUiProvider extends ConfigurableUiControl {
+    private _toolSettingsNode;
+    private _horizontalToolSettingNodes;
+    protected _dataProvider: UiDataProvider | undefined;
+    constructor(info: ConfigurableCreateInfo, options: any);
+    get uniqueId(): string;
+    /** A React node that holds tool settings when shown in a rectangular area (i.e. not in Horizontal area at top of application window.) */
+    get toolSettingsNode(): React.ReactNode;
+    set toolSettingsNode(r: React.ReactNode);
+    /** An array of entries to load into the horizontal tool settings
+     * @public
+     */
+    get horizontalToolSettingNodes(): ToolSettingsEntry[] | undefined;
+    set horizontalToolSettingNodes(r: ToolSettingsEntry[] | undefined);
+    /** The UiDataProvider class */
+    get dataProvider(): UiDataProvider | undefined;
+    set dataProvider(d: UiDataProvider | undefined);
+    /** Gets the type of ConfigurableUiControl, which is 'ToolUiProvider' in this case */
+    getType(): ConfigurableUiControlType;
+    syncToolSettingsProperties(_args: SyncToolSettingsPropertiesEventArgs): void;
+    reloadPropertiesFromTool(): void;
+}
+//# sourceMappingURL=ToolUiProvider.d.ts.map

package/lib/cjs/appui-react/zones/toolsettings/ToolUiProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolUiProvider.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/zones/toolsettings/ToolUiProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACtI,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAE5E;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,qBAAqB;IACvD,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,2BAA2B,CAAkC;IACrE,SAAS,CAAC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;gBACxC,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAItD,IAAoB,QAAQ,IAAI,MAAM,CAA0D;IAEhG,yIAAyI;IACzI,IAAW,gBAAgB,IAAI,KAAK,CAAC,SAAS,CAAmC;IACjF,IAAW,gBAAgB,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAAiC;IAE/E;;OAEG;IACH,IAAW,0BAA0B,IAAI,iBAAiB,EAAE,GAAG,SAAS,CAA6C;IACrH,IAAW,0BAA0B,CAAC,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAS,EAA2C;IAEnH,+BAA+B;IAC/B,IAAW,YAAY,IAAI,cAAc,GAAG,SAAS,CAA+B;IACpF,IAAW,YAAY,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,EAA6B;IAElF,qFAAqF;IAC9E,OAAO,IAAI,yBAAyB;IAEpC,0BAA0B,CAAC,KAAK,EAAE,mCAAmC,GAAG,IAAI;IAC5E,wBAAwB,IAAI,IAAI;CACxC"}