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

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

@@ -0,0 +1,155 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NavigationWidget = exports.NavigationWidgetDef = void 0;
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const imodel_components_react_1 = require("@itwin/imodel-components-react");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const ConfigurableUiControl_1 = require("../configurableui/ConfigurableUiControl");
+const ConfigurableUiManager_1 = require("../configurableui/ConfigurableUiManager");
+const ContentViewManager_1 = require("../content/ContentViewManager");
+const FrontstageManager_1 = require("../frontstage/FrontstageManager");
+const UiFramework_1 = require("../UiFramework");
+const UiShowHideManager_1 = require("../utils/UiShowHideManager");
+const ToolbarWidgetBase_1 = require("./ToolbarWidgetBase");
+const WidgetDef_1 = require("./WidgetDef");
+/** Definition of a Navigation Widget normally displayed in the top right zone in the 9-Zone Layout system.
+ * @public
+ * @deprecated in 2.x. Use NavigationWidgetComposer instead
+ */
+class NavigationWidgetDef extends ToolbarWidgetBase_1.ToolbarWidgetDefBase {
+    constructor(props) {
+        super(props);
+        this.widgetType = WidgetDef_1.WidgetType.Navigation;
+        // eslint-disable-next-line deprecation/deprecation
+        this.verticalDirection = (props.verticalDirection !== undefined) ? props.verticalDirection : appui_layout_react_1.Direction.Left;
+        this.horizontalPanelAlignment = appui_layout_react_1.ToolbarPanelAlignment.End; // eslint-disable-line deprecation/deprecation
+        this._navigationAidId = (props.navigationAidId !== undefined) ? props.navigationAidId : "";
+        const activeStageName = FrontstageManager_1.FrontstageManager.activeFrontstageDef ? FrontstageManager_1.FrontstageManager.activeFrontstageDef.id : /* istanbul ignore next */ "";
+        this.widgetBaseName = `[${activeStageName}]NavigationWidget`;
+    }
+    get reactNode() {
+        // istanbul ignore else
+        if (!this._reactNode)
+            this._reactNode = React.createElement(NavigationWidgetWithDef, { navigationWidgetDef: this });
+        return this._reactNode;
+    }
+    renderCornerItem() {
+        // istanbul ignore if
+        if (FrontstageManager_1.FrontstageManager.isLoading)
+            return null;
+        // istanbul ignore else
+        if (!this._navigationAidControl && this._navigationAidId) {
+            const activeContentControl = ContentViewManager_1.ContentViewManager.getActiveContentControl();
+            const viewport = activeContentControl ? activeContentControl.viewport : /* istanbul ignore next */ undefined;
+            this._navigationAidControl = ConfigurableUiManager_1.ConfigurableUiManager.createControl(this._navigationAidId, this._navigationAidId, { imodel: this._imodel, viewport });
+            if (this._navigationAidControl.getType() !== ConfigurableUiControl_1.ConfigurableUiControlType.NavigationAid) {
+                throw new appui_abstract_1.UiError(UiFramework_1.UiFramework.loggerCategory(this), `renderCornerItem: navigationAidId '${this._navigationAidId}' is registered to a control that is NOT a NavigationAid`);
+            }
+            this._navigationAidControl.initialize();
+        }
+        // istanbul ignore else
+        if (this._navigationAidControl) {
+            const size = this._navigationAidControl.getSize() || "64px";
+            const divStyle = {
+                width: size,
+                height: size,
+            };
+            return (React.createElement("div", { style: divStyle }, this._navigationAidControl.reactNode));
+        }
+        // istanbul ignore next
+        return null;
+    }
+    updateNavigationAid(navigationAidId, imodel) {
+        this._navigationAidId = navigationAidId;
+        this._imodel = imodel;
+        this._navigationAidControl = undefined;
+    }
+}
+exports.NavigationWidgetDef = NavigationWidgetDef;
+/** Navigation Widget React component.
+ * @public
+ * @deprecated in 2.x. Use NavigationWidgetComposer instead
+ */
+class NavigationWidget extends React.Component {
+    constructor(props) {
+        super(props);
+        this._handleContentControlActivated = (args) => {
+            const navigationAidId = args.activeContentControl.navigationAidControl;
+            setTimeout(() => {
+                FrontstageManager_1.FrontstageManager.setActiveNavigationAid(navigationAidId, this.props.iModelConnection);
+            });
+        };
+        this._handleViewClassFullNameChange = (args) => {
+            setTimeout(() => {
+                const activeContentControl = ContentViewManager_1.ContentViewManager.getActiveContentControl();
+                // istanbul ignore else
+                if (activeContentControl && args.viewport === activeContentControl.viewport) {
+                    const navigationAidId = activeContentControl.navigationAidControl;
+                    FrontstageManager_1.FrontstageManager.setActiveNavigationAid(navigationAidId, this.props.iModelConnection);
+                }
+            });
+        };
+        this.state = { navigationWidgetDef: new NavigationWidgetDef(props) }; // eslint-disable-line deprecation/deprecation
+    }
+    /** Adds listeners */
+    componentDidMount() {
+        FrontstageManager_1.FrontstageManager.onContentControlActivatedEvent.addListener(this._handleContentControlActivated);
+        imodel_components_react_1.ViewportComponentEvents.onViewClassFullNameChangedEvent.addListener(this._handleViewClassFullNameChange);
+    }
+    /** Removes listeners */
+    componentWillUnmount() {
+        FrontstageManager_1.FrontstageManager.onContentControlActivatedEvent.removeListener(this._handleContentControlActivated);
+        imodel_components_react_1.ViewportComponentEvents.onViewClassFullNameChangedEvent.removeListener(this._handleViewClassFullNameChange);
+    }
+    componentDidUpdate(prevProps, _prevState) {
+        if (this.props !== prevProps) {
+            this.setState((_, props) => ({ navigationWidgetDef: new NavigationWidgetDef(props) })); // eslint-disable-line deprecation/deprecation
+        }
+    }
+    render() {
+        return (React.createElement(NavigationWidgetWithDef, { className: this.props.className, style: this.props.style, navigationWidgetDef: this.state.navigationWidgetDef, horizontalToolbar: this.props.horizontalToolbar, verticalToolbar: this.props.verticalToolbar }));
+    }
+}
+exports.NavigationWidget = NavigationWidget;
+/** Navigation Widget React component that's passed a NavigationWidgetDef.
+ */
+class NavigationWidgetWithDef extends React.Component {
+    constructor(props) {
+        super(props);
+        this._handleNavigationAidActivatedEvent = (args) => {
+            this.props.navigationWidgetDef.updateNavigationAid(args.navigationAidId, args.iModelConnection);
+            const navigationAid = this.props.navigationWidgetDef.renderCornerItem();
+            this.setState({ cornerItem: navigationAid });
+        };
+        const horizontalToolbar = (this.props.horizontalToolbar) ? this.props.horizontalToolbar : this.props.navigationWidgetDef.renderHorizontalToolbar();
+        const verticalToolbar = (this.props.verticalToolbar) ? this.props.verticalToolbar : this.props.navigationWidgetDef.renderVerticalToolbar();
+        this.state = { horizontalToolbar, verticalToolbar, cornerItem: null };
+    }
+    reloadToolbars() {
+        const horizontalToolbar = (this.props.horizontalToolbar) ? this.props.horizontalToolbar : /* istanbul ignore next */ this.props.navigationWidgetDef.renderHorizontalToolbar();
+        const verticalToolbar = (this.props.verticalToolbar) ? /* istanbul ignore next */ this.props.verticalToolbar : this.props.navigationWidgetDef.renderVerticalToolbar();
+        this.setState({ horizontalToolbar, verticalToolbar });
+    }
+    componentDidMount() {
+        FrontstageManager_1.FrontstageManager.onNavigationAidActivatedEvent.addListener(this._handleNavigationAidActivatedEvent);
+    }
+    componentWillUnmount() {
+        FrontstageManager_1.FrontstageManager.onNavigationAidActivatedEvent.removeListener(this._handleNavigationAidActivatedEvent);
+    }
+    componentDidUpdate(prevProps) {
+        if (this.props !== prevProps)
+            this.reloadToolbars();
+    }
+    render() {
+        return (React.createElement(appui_layout_react_1.Tools, { isNavigation: true, className: this.props.className, style: this.props.style, button: this.state.cornerItem, horizontalToolbar: this.state.horizontalToolbar, verticalToolbar: this.state.verticalToolbar, preserveSpace: true, onMouseEnter: UiShowHideManager_1.UiShowHideManager.handleWidgetMouseEnter }));
+    }
+}
+//# sourceMappingURL=NavigationWidget.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationWidget.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/NavigationWidget.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAE/B,0DAAgD;AAChD,4EAA4G;AAE5G,kEAAsG;AACtG,mFAAoF;AACpF,mFAAgF;AAEhF,sEAAmE;AACnE,uEAAoE;AAEpE,gDAA6C;AAC7C,kEAA+D;AAC/D,2DAA2D;AAC3D,2CAAgE;AAEhE;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,wCAAoB;IAM3D,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,IAAI,CAAC,UAAU,GAAG,sBAAU,CAAC,UAAU,CAAC;QACxC,mDAAmD;QACnD,IAAI,CAAC,iBAAiB,GAAG,CAAC,KAAK,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,8BAAS,CAAC,IAAI,CAAC;QAC5G,IAAI,CAAC,wBAAwB,GAAG,0CAAqB,CAAC,GAAG,CAAC,CAAC,8CAA8C;QACzG,IAAI,CAAC,gBAAgB,GAAG,CAAC,KAAK,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;QAE3F,MAAM,eAAe,GAAG,qCAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC,qCAAiB,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC;QACzI,IAAI,CAAC,cAAc,GAAG,IAAI,eAAe,mBAAmB,CAAC;IAC/D,CAAC;IAED,IAAoB,SAAS;QAC3B,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,IAAI,CAAC,UAAU,GAAG,oBAAC,uBAAuB,IAAC,mBAAmB,EAAE,IAAI,GAAI,CAAC;QAE3E,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,gBAAgB;QACrB,qBAAqB;QACrB,IAAI,qCAAiB,CAAC,SAAS;YAC7B,OAAO,IAAI,CAAC;QAEd,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACxD,MAAM,oBAAoB,GAAG,uCAAkB,CAAC,uBAAuB,EAAE,CAAC;YAC1E,MAAM,QAAQ,GAAG,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,SAAS,CAAC;YAE7G,IAAI,CAAC,qBAAqB,GAAG,6CAAqB,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAyB,CAAC;YAC3K,IAAI,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,KAAK,iDAAyB,CAAC,aAAa,EAAE;gBACpF,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,sCAAsC,IAAI,CAAC,gBAAgB,0DAA0D,CAAC,CAAC;aAC5K;YACD,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,CAAC;SACzC;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,qBAAqB,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,MAAM,CAAC;YAC5D,MAAM,QAAQ,GAAwB;gBACpC,KAAK,EAAE,IAAI;gBACX,MAAM,EAAE,IAAI;aACb,CAAC;YAEF,OAAO,CACL,6BAAK,KAAK,EAAE,QAAQ,IACjB,IAAI,CAAC,qBAAqB,CAAC,SAAS,CACjC,CACP,CAAC;SACH;QAED,uBAAuB;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,mBAAmB,CAAC,eAAuB,EAAE,MAAyB;QAC3E,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;IACzC,CAAC;CACF;AApED,kDAoEC;AAmBD;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,KAAK,CAAC,SAAyD;IAKnG,YAAY,KAA8B;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;QAiBP,mCAA8B,GAAG,CAAC,IAAsC,EAAQ,EAAE;YACxF,MAAM,eAAe,GAAG,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC;YACvE,UAAU,CAAC,GAAG,EAAE;gBACd,qCAAiB,CAAC,sBAAsB,CAAC,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAiB,CAAC,CAAC;YAC1F,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEM,mCAA8B,GAAG,CAAC,IAAuC,EAAQ,EAAE;YACzF,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,oBAAoB,GAAG,uCAAkB,CAAC,uBAAuB,EAAE,CAAC;gBAE1E,uBAAuB;gBACvB,IAAI,oBAAoB,IAAI,IAAI,CAAC,QAAQ,KAAK,oBAAoB,CAAC,QAAQ,EAAE;oBAC3E,MAAM,eAAe,GAAG,oBAAoB,CAAC,oBAAoB,CAAC;oBAClE,qCAAiB,CAAC,sBAAsB,CAAC,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAiB,CAAC,CAAC;iBACzF;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAhCA,IAAI,CAAC,KAAK,GAAG,EAAE,mBAAmB,EAAE,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,8CAA8C;IACtH,CAAC;IAED,qBAAqB;IACL,iBAAiB;QAC/B,qCAAiB,CAAC,8BAA8B,CAAC,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAClG,iDAAuB,CAAC,+BAA+B,CAAC,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC3G,CAAC;IAED,wBAAwB;IACR,oBAAoB;QAClC,qCAAiB,CAAC,8BAA8B,CAAC,cAAc,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QACrG,iDAAuB,CAAC,+BAA+B,CAAC,cAAc,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC9G,CAAC;IAqBe,kBAAkB,CAAC,SAAkC,EAAE,UAAiC;QACtG,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,8CAA8C;SACvI;IACH,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,uBAAuB,IACtB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,mBAAmB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,EACnD,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAC/C,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,GAC3C,CACH,CAAC;IACJ,CAAC;CACF;AA3DD,4CA2DC;AAgBD;GACG;AACH,MAAM,uBAAwB,SAAQ,KAAK,CAAC,SAA8C;IAExF,YAAY,KAAY;QACtB,KAAK,CAAC,KAAK,CAAC,CAAC;QAaP,uCAAkC,GAAG,CAAC,IAAqC,EAAQ,EAAE;YAC3F,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAChG,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC;YACxE,IAAI,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;QAfA,MAAM,iBAAiB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,uBAAuB,EAAE,CAAC;QACnJ,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,CAAC;QAC3I,IAAI,CAAC,KAAK,GAAG,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACxE,CAAC;IAEO,cAAc;QACpB,MAAM,iBAAiB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,uBAAuB,EAAE,CAAC;QAC9K,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,CAAC;QACtK,IAAI,CAAC,QAAQ,CAAC,EAAE,iBAAiB,EAAE,eAAe,EAAE,CAAC,CAAC;IACxD,CAAC;IAQe,iBAAiB;QAC/B,qCAAiB,CAAC,6BAA6B,CAAC,WAAW,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IACvG,CAAC;IAEe,oBAAoB;QAClC,qCAAiB,CAAC,6BAA6B,CAAC,cAAc,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IAC1G,CAAC;IAEe,kBAAkB,CAAC,SAAgB;QACjD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;YAC1B,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1B,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,0BAAc,IAAC,YAAY,QAC1B,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAC7B,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAC/C,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAC3C,aAAa,EAAE,IAAI,EACnB,YAAY,EAAE,qCAAiB,CAAC,sBAAsB,GACtD,CACH,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { UiError } from \"@itwin/appui-abstract\";\r\nimport { ViewClassFullNameChangedEventArgs, ViewportComponentEvents } from \"@itwin/imodel-components-react\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { Direction, Tools as NZ_ToolsWidget, ToolbarPanelAlignment } from \"@itwin/appui-layout-react\";\r\nimport { ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { ConfigurableUiManager } from \"../configurableui/ConfigurableUiManager\";\r\nimport { ContentControlActivatedEventArgs } from \"../content/ContentControl\";\r\nimport { ContentViewManager } from \"../content/ContentViewManager\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { NavigationAidActivatedEventArgs, NavigationAidControl } from \"../navigationaids/NavigationAidControl\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { UiShowHideManager } from \"../utils/UiShowHideManager\";\r\nimport { ToolbarWidgetDefBase } from \"./ToolbarWidgetBase\";\r\nimport { NavigationWidgetProps, WidgetType } from \"./WidgetDef\";\r\n\r\n/** Definition of a Navigation Widget normally displayed in the top right zone in the 9-Zone Layout system.\r\n * @public\r\n * @deprecated in 2.x. Use NavigationWidgetComposer instead\r\n */\r\nexport class NavigationWidgetDef extends ToolbarWidgetDefBase { // eslint-disable-line deprecation/deprecation\r\n  private _navigationAidId: string;\r\n  private _imodel: IModelConnection | undefined;\r\n  private _navigationAidControl: NavigationAidControl | undefined;\r\n  private _reactNode: React.ReactNode;\r\n\r\n  constructor(props: NavigationWidgetProps) { // eslint-disable-line deprecation/deprecation\r\n    super(props);\r\n\r\n    this.widgetType = WidgetType.Navigation;\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    this.verticalDirection = (props.verticalDirection !== undefined) ? props.verticalDirection : Direction.Left;\r\n    this.horizontalPanelAlignment = ToolbarPanelAlignment.End; // eslint-disable-line deprecation/deprecation\r\n    this._navigationAidId = (props.navigationAidId !== undefined) ? props.navigationAidId : \"\";\r\n\r\n    const activeStageName = FrontstageManager.activeFrontstageDef ? FrontstageManager.activeFrontstageDef.id : /* istanbul ignore next */ \"\";\r\n    this.widgetBaseName = `[${activeStageName}]NavigationWidget`;\r\n  }\r\n\r\n  public override get reactNode(): React.ReactNode {\r\n    // istanbul ignore else\r\n    if (!this._reactNode)\r\n      this._reactNode = <NavigationWidgetWithDef navigationWidgetDef={this} />;\r\n\r\n    return this._reactNode;\r\n  }\r\n\r\n  public renderCornerItem(): React.ReactNode {\r\n    // istanbul ignore if\r\n    if (FrontstageManager.isLoading)\r\n      return null;\r\n\r\n    // istanbul ignore else\r\n    if (!this._navigationAidControl && this._navigationAidId) {\r\n      const activeContentControl = ContentViewManager.getActiveContentControl();\r\n      const viewport = activeContentControl ? activeContentControl.viewport : /* istanbul ignore next */ undefined;\r\n\r\n      this._navigationAidControl = ConfigurableUiManager.createControl(this._navigationAidId, this._navigationAidId, { imodel: this._imodel, viewport }) as NavigationAidControl;\r\n      if (this._navigationAidControl.getType() !== ConfigurableUiControlType.NavigationAid) {\r\n        throw new UiError(UiFramework.loggerCategory(this), `renderCornerItem: navigationAidId '${this._navigationAidId}' is registered to a control that is NOT a NavigationAid`);\r\n      }\r\n      this._navigationAidControl.initialize();\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (this._navigationAidControl) {\r\n      const size = this._navigationAidControl.getSize() || \"64px\";\r\n      const divStyle: React.CSSProperties = {\r\n        width: size,\r\n        height: size,\r\n      };\r\n\r\n      return (\r\n        <div style={divStyle}>\r\n          {this._navigationAidControl.reactNode}\r\n        </div>\r\n      );\r\n    }\r\n\r\n    // istanbul ignore next\r\n    return null;\r\n  }\r\n\r\n  public updateNavigationAid(navigationAidId: string, imodel?: IModelConnection): void {\r\n    this._navigationAidId = navigationAidId;\r\n    this._imodel = imodel;\r\n    this._navigationAidControl = undefined;\r\n  }\r\n}\r\n\r\n/** Properties for the [[NavigationWidget]] React component.\r\n * @public\r\n * @deprecated in 2.x. Use NavigationWidgetComposer instead\r\n */\r\nexport interface NavigationWidgetPropsEx extends NavigationWidgetProps, CommonProps { // eslint-disable-line deprecation/deprecation\r\n  iModelConnection?: IModelConnection;\r\n  horizontalToolbar?: React.ReactNode;\r\n  verticalToolbar?: React.ReactNode;\r\n}\r\n\r\n/** State for the Navigation Widget React component.\r\n * @internal\r\n */\r\ninterface NavigationWidgetState {\r\n  navigationWidgetDef: NavigationWidgetDef; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Navigation Widget React component.\r\n * @public\r\n * @deprecated in 2.x. Use NavigationWidgetComposer instead\r\n */\r\nexport class NavigationWidget extends React.Component<NavigationWidgetPropsEx, NavigationWidgetState> { // eslint-disable-line deprecation/deprecation\r\n\r\n  /** @internal */\r\n  public override readonly state: Readonly<NavigationWidgetState>;\r\n\r\n  constructor(props: NavigationWidgetPropsEx) { // eslint-disable-line deprecation/deprecation\r\n    super(props);\r\n\r\n    this.state = { navigationWidgetDef: new NavigationWidgetDef(props) }; // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Adds listeners */\r\n  public override componentDidMount() {\r\n    FrontstageManager.onContentControlActivatedEvent.addListener(this._handleContentControlActivated);\r\n    ViewportComponentEvents.onViewClassFullNameChangedEvent.addListener(this._handleViewClassFullNameChange);\r\n  }\r\n\r\n  /** Removes listeners */\r\n  public override componentWillUnmount() {\r\n    FrontstageManager.onContentControlActivatedEvent.removeListener(this._handleContentControlActivated);\r\n    ViewportComponentEvents.onViewClassFullNameChangedEvent.removeListener(this._handleViewClassFullNameChange);\r\n  }\r\n\r\n  private _handleContentControlActivated = (args: ContentControlActivatedEventArgs): void => {\r\n    const navigationAidId = args.activeContentControl.navigationAidControl;\r\n    setTimeout(() => {\r\n      FrontstageManager.setActiveNavigationAid(navigationAidId, this.props.iModelConnection!);\r\n    });\r\n  };\r\n\r\n  private _handleViewClassFullNameChange = (args: ViewClassFullNameChangedEventArgs): void => {\r\n    setTimeout(() => {\r\n      const activeContentControl = ContentViewManager.getActiveContentControl();\r\n\r\n      // istanbul ignore else\r\n      if (activeContentControl && args.viewport === activeContentControl.viewport) {\r\n        const navigationAidId = activeContentControl.navigationAidControl;\r\n        FrontstageManager.setActiveNavigationAid(navigationAidId, this.props.iModelConnection!);\r\n      }\r\n    });\r\n  };\r\n\r\n  public override componentDidUpdate(prevProps: NavigationWidgetPropsEx, _prevState: NavigationWidgetState) { // eslint-disable-line deprecation/deprecation\r\n    if (this.props !== prevProps) {\r\n      this.setState((_, props) => ({ navigationWidgetDef: new NavigationWidgetDef(props) })); // eslint-disable-line deprecation/deprecation\r\n    }\r\n  }\r\n\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <NavigationWidgetWithDef\r\n        className={this.props.className}\r\n        style={this.props.style}\r\n        navigationWidgetDef={this.state.navigationWidgetDef}\r\n        horizontalToolbar={this.props.horizontalToolbar}\r\n        verticalToolbar={this.props.verticalToolbar}\r\n      />\r\n    );\r\n  }\r\n}\r\n\r\n/** Properties for the [[NavigationWidgetWithDef]] component.\r\n */\r\ninterface Props extends CommonProps {\r\n  navigationWidgetDef: NavigationWidgetDef; // eslint-disable-line deprecation/deprecation\r\n  horizontalToolbar?: React.ReactNode;\r\n  verticalToolbar?: React.ReactNode;\r\n}\r\n\r\ninterface NavigationWidgetWithDefState {\r\n  horizontalToolbar: React.ReactNode;\r\n  verticalToolbar: React.ReactNode;\r\n  cornerItem: React.ReactNode;\r\n}\r\n\r\n/** Navigation Widget React component that's passed a NavigationWidgetDef.\r\n */\r\nclass NavigationWidgetWithDef extends React.Component<Props, NavigationWidgetWithDefState> {\r\n\r\n  constructor(props: Props) {\r\n    super(props);\r\n\r\n    const horizontalToolbar = (this.props.horizontalToolbar) ? this.props.horizontalToolbar : this.props.navigationWidgetDef.renderHorizontalToolbar();\r\n    const verticalToolbar = (this.props.verticalToolbar) ? this.props.verticalToolbar : this.props.navigationWidgetDef.renderVerticalToolbar();\r\n    this.state = { horizontalToolbar, verticalToolbar, cornerItem: null };\r\n  }\r\n\r\n  private reloadToolbars() {\r\n    const horizontalToolbar = (this.props.horizontalToolbar) ? this.props.horizontalToolbar : /* istanbul ignore next */ this.props.navigationWidgetDef.renderHorizontalToolbar();\r\n    const verticalToolbar = (this.props.verticalToolbar) ? /* istanbul ignore next */ this.props.verticalToolbar : this.props.navigationWidgetDef.renderVerticalToolbar();\r\n    this.setState({ horizontalToolbar, verticalToolbar });\r\n  }\r\n\r\n  private _handleNavigationAidActivatedEvent = (args: NavigationAidActivatedEventArgs): void => {\r\n    this.props.navigationWidgetDef.updateNavigationAid(args.navigationAidId, args.iModelConnection);\r\n    const navigationAid = this.props.navigationWidgetDef.renderCornerItem();\r\n    this.setState({ cornerItem: navigationAid });\r\n  };\r\n\r\n  public override componentDidMount() {\r\n    FrontstageManager.onNavigationAidActivatedEvent.addListener(this._handleNavigationAidActivatedEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    FrontstageManager.onNavigationAidActivatedEvent.removeListener(this._handleNavigationAidActivatedEvent);\r\n  }\r\n\r\n  public override componentDidUpdate(prevProps: Props) {\r\n    if (this.props !== prevProps)\r\n      this.reloadToolbars();\r\n  }\r\n\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <NZ_ToolsWidget isNavigation\r\n        className={this.props.className}\r\n        style={this.props.style}\r\n        button={this.state.cornerItem}\r\n        horizontalToolbar={this.state.horizontalToolbar}\r\n        verticalToolbar={this.state.verticalToolbar}\r\n        preserveSpace={true}\r\n        onMouseEnter={UiShowHideManager.handleWidgetMouseEnter}\r\n      />\r\n    );\r\n  }\r\n}\r\n"]}

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

@@ -1,39 +1,39 @@
-/** @packageDocumentation
- * @module Widget
- */
-import * as React from "react";
-import { CommonProps } from "@itwin/core-react";
-/** Properties for the [[NavigationAidHost]] React component
- * @public
- */
-export interface NavigationAidHostProps {
-    /** Navigation Aid Host minimum width. Defaults to "64px". */
-    minWidth?: string;
-    /** Navigation Aid Host minimum height. Defaults to "64px". */
-    minHeight?: string;
-}
-/**
- * NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.
- * @public
- */
-export declare function NavigationAidHost(props: NavigationAidHostProps): JSX.Element;
-/** Properties for the [[NavigationWidgetComposer]] React components
- * @public
- */
-export interface NavigationWidgetComposerProps extends CommonProps {
-    /** Optional Horizontal Toolbar */
-    horizontalToolbar?: React.ReactNode;
-    /** Optional Vertical Toolbar */
-    verticalToolbar?: React.ReactNode;
-    /** Optional Navigation Aid host. If not specified a default host is provided which will use registered Navigation Aids and the active content control to determine which if any Navigation Aid to display. */
-    navigationAidHost?: React.ReactNode;
-    /** If true no navigation aid will be shown. Defaults to false. */
-    hideNavigationAid?: boolean;
-}
-/**
- * Component that Composes a NavigationWidget typically using toolbars generated via [[ToolbarComposer]] class. The Navigation widget is shown in the top right of the content area
- * and typically holds tools to visually navigate, orient, and zoom to specific content.
- * @public
- */
-export declare function NavigationWidgetComposer(props: NavigationWidgetComposerProps): JSX.Element;
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { CommonProps } from "@itwin/core-react";
+/** Properties for the [[NavigationAidHost]] React component
+ * @public
+ */
+export interface NavigationAidHostProps {
+    /** Navigation Aid Host minimum width. Defaults to "64px". */
+    minWidth?: string;
+    /** Navigation Aid Host minimum height. Defaults to "64px". */
+    minHeight?: string;
+}
+/**
+ * NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.
+ * @public
+ */
+export declare function NavigationAidHost(props: NavigationAidHostProps): JSX.Element;
+/** Properties for the [[NavigationWidgetComposer]] React components
+ * @public
+ */
+export interface NavigationWidgetComposerProps extends CommonProps {
+    /** Optional Horizontal Toolbar */
+    horizontalToolbar?: React.ReactNode;
+    /** Optional Vertical Toolbar */
+    verticalToolbar?: React.ReactNode;
+    /** Optional Navigation Aid host. If not specified a default host is provided which will use registered Navigation Aids and the active content control to determine which if any Navigation Aid to display. */
+    navigationAidHost?: React.ReactNode;
+    /** If true no navigation aid will be shown. Defaults to false. */
+    hideNavigationAid?: boolean;
+}
+/**
+ * Component that Composes a NavigationWidget typically using toolbars generated via [[ToolbarComposer]] class. The Navigation widget is shown in the top right of the content area
+ * and typically holds tools to visually navigate, orient, and zoom to specific content.
+ * @public
+ */
+export declare function NavigationWidgetComposer(props: NavigationWidgetComposerProps): JSX.Element;
 //# sourceMappingURL=NavigationWidgetComposer.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"NavigationWidgetComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/NavigationWidgetComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,WAAW,EAAwF,MAAM,mBAAmB,CAAC;AAuBtI;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,eAqE9D;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,WAAW;IAChE,kCAAkC;IAClC,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC,gCAAgC;IAChC,eAAe,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAClC,8MAA8M;IAC9M,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC,kEAAkE;IAClE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,6BAA6B,eA0B5E"}
+{"version":3,"file":"NavigationWidgetComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/NavigationWidgetComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,WAAW,EAAwF,MAAM,mBAAmB,CAAC;AAwBtI;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,eAqE9D;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,WAAW;IAChE,kCAAkC;IAClC,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC,gCAAgC;IAChC,eAAe,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAClC,8MAA8M;IAC9M,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC,kEAAkE;IAClE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,6BAA6B,eA0B5E"}

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

@@ -1,110 +1,111 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Widget
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NavigationWidgetComposer = exports.NavigationAidHost = void 0;
-const React = require("react");
-const imodel_components_react_1 = require("@itwin/imodel-components-react");
-const core_react_1 = require("@itwin/core-react");
-const appui_layout_react_1 = require("@itwin/appui-layout-react");
-const ConfigurableUiManager_1 = require("../configurableui/ConfigurableUiManager");
-const ContentViewManager_1 = require("../content/ContentViewManager");
-const FrontstageManager_1 = require("../frontstage/FrontstageManager");
-const UiFramework_1 = require("../UiFramework");
-const UiShowHideManager_1 = require("../utils/UiShowHideManager");
-function createNavigationAidControl(activeContentControl, navigationAidId, activeViewport) {
-    // istanbul ignore else
-    if (!activeContentControl || !navigationAidId || (activeViewport !== activeContentControl.viewport))
-        return undefined;
-    const viewport = activeContentControl.viewport;
-    const imodel = viewport ? viewport.iModel : /* istanbul ignore next */ UiFramework_1.UiFramework.getIModelConnection();
-    const navigationAidControl = ConfigurableUiManager_1.ConfigurableUiManager.createControl(navigationAidId, navigationAidId, { imodel, viewport });
-    navigationAidControl.initialize();
-    return navigationAidControl;
-}
-/**
- * NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.
- * @public
- */
-function NavigationAidHost(props) {
-    const [activeContentControl, setActiveContentControl] = React.useState(() => ContentViewManager_1.ContentViewManager.getActiveContentControl());
-    const [activeContentViewport, setActiveContentViewport] = React.useState(() => /* istanbul ignore next */ activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport);
-    const [navigationAidId, setNavigationAidId] = React.useState(() => activeContentControl ? activeContentControl.navigationAidControl : /* istanbul ignore next */ "");
-    React.useEffect(() => {
-        // istanbul ignore next
-        const handleContentControlActivated = (args) => {
-            setActiveContentControl(args.activeContentControl);
-            setActiveContentViewport(args.activeContentControl.viewport);
-            setNavigationAidId(args.activeContentControl.navigationAidControl);
-        };
-        FrontstageManager_1.FrontstageManager.onContentControlActivatedEvent.addListener(handleContentControlActivated);
-        return () => {
-            FrontstageManager_1.FrontstageManager.onContentControlActivatedEvent.removeListener(handleContentControlActivated);
-        };
-    }, []);
-    const [activeViewClass, setActiveViewClass] = React.useState(() => {
-        const content = ContentViewManager_1.ContentViewManager.getActiveContentControl();
-        if (content && content.viewport)
-            return content.viewport.view.classFullName;
-        return "";
-    });
-    React.useEffect(() => {
-        // istanbul ignore next
-        const handleViewClassFullNameChange = (args) => {
-            setActiveViewClass(args.newName);
-        };
-        imodel_components_react_1.ViewportComponentEvents.onViewClassFullNameChangedEvent.addListener(handleViewClassFullNameChange);
-        return () => {
-            imodel_components_react_1.ViewportComponentEvents.onViewClassFullNameChangedEvent.removeListener(handleViewClassFullNameChange);
-        };
-    }, [activeViewClass]);
-    const navigationAidControl = React.useMemo(() => createNavigationAidControl(activeContentControl, navigationAidId, activeContentViewport), [activeContentControl, navigationAidId, activeContentViewport]);
-    const ref = React.useRef(null);
-    const isInitialMount = React.useRef(true);
-    const { onElementRef, proximityScale } = (0, core_react_1.useWidgetOpacityContext)();
-    React.useEffect(() => {
-        // istanbul ignore else
-        if (isInitialMount.current) {
-            isInitialMount.current = false;
-            onElementRef(ref);
-        }
-    }, [onElementRef]);
-    const divStyle = {
-        minWidth: props.minWidth ? /* istanbul ignore next */ props.minWidth : "64px",
-        minHeight: props.minHeight ? /* istanbul ignore next */ props.minHeight : "64px",
-    };
-    // istanbul ignore else
-    if (UiShowHideManager_1.UiShowHideManager.useProximityOpacity && !UiFramework_1.UiFramework.isMobile()) {
-        const navigationAidOpacity = (0.30 * proximityScale) + 0.70;
-        divStyle.opacity = `${navigationAidOpacity}`;
-    }
-    return (React.createElement("div", { style: divStyle, ref: ref }, navigationAidControl && navigationAidControl.reactNode));
-}
-exports.NavigationAidHost = NavigationAidHost;
-/**
- * Component that Composes a NavigationWidget typically using toolbars generated via [[ToolbarComposer]] class. The Navigation widget is shown in the top right of the content area
- * and typically holds tools to visually navigate, orient, and zoom to specific content.
- * @public
- */
-function NavigationWidgetComposer(props) {
-    const { navigationAidHost, horizontalToolbar, verticalToolbar, hideNavigationAid, ...otherProps } = props;
-    const [elementSet] = React.useState(new core_react_1.WidgetElementSet());
-    const handleChildRef = React.useCallback((elementRef) => {
-        elementSet.add(elementRef);
-    }, [elementSet]);
-    const proximityScale = (0, core_react_1.useProximityToMouse)(elementSet, UiShowHideManager_1.UiShowHideManager.snapWidgetOpacity);
-    /* istanbul ignore next */
-    const navigationAid = hideNavigationAid ? undefined : navigationAidHost !== null && navigationAidHost !== void 0 ? navigationAidHost : React.createElement(NavigationAidHost, null);
-    return (React.createElement(core_react_1.WidgetOpacityContext.Provider, { value: {
-            onElementRef: handleChildRef,
-            proximityScale,
-        } },
-        React.createElement(appui_layout_react_1.NavigationArea, { navigationAid: navigationAid, horizontalToolbar: horizontalToolbar, verticalToolbar: verticalToolbar, ...otherProps, onMouseEnter: UiShowHideManager_1.UiShowHideManager.handleWidgetMouseEnter })));
-}
-exports.NavigationWidgetComposer = NavigationWidgetComposer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NavigationWidgetComposer = exports.NavigationAidHost = void 0;
+const React = require("react");
+const imodel_components_react_1 = require("@itwin/imodel-components-react");
+const core_react_1 = require("@itwin/core-react");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const ConfigurableUiManager_1 = require("../configurableui/ConfigurableUiManager");
+const ContentViewManager_1 = require("../content/ContentViewManager");
+const FrontstageManager_1 = require("../frontstage/FrontstageManager");
+const useFrameworkVersion_1 = require("../hooks/useFrameworkVersion");
+const UiFramework_1 = require("../UiFramework");
+const UiShowHideManager_1 = require("../utils/UiShowHideManager");
+function createNavigationAidControl(activeContentControl, navigationAidId, activeViewport) {
+    // istanbul ignore else
+    if (!activeContentControl || !navigationAidId || (activeViewport !== activeContentControl.viewport))
+        return undefined;
+    const viewport = activeContentControl.viewport;
+    const imodel = viewport ? viewport.iModel : /* istanbul ignore next */ UiFramework_1.UiFramework.getIModelConnection();
+    const navigationAidControl = ConfigurableUiManager_1.ConfigurableUiManager.createControl(navigationAidId, navigationAidId, { imodel, viewport });
+    navigationAidControl.initialize();
+    return navigationAidControl;
+}
+/**
+ * NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.
+ * @public
+ */
+function NavigationAidHost(props) {
+    const [activeContentControl, setActiveContentControl] = React.useState(() => ContentViewManager_1.ContentViewManager.getActiveContentControl());
+    const [activeContentViewport, setActiveContentViewport] = React.useState(() => /* istanbul ignore next */ activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport);
+    const [navigationAidId, setNavigationAidId] = React.useState(() => activeContentControl ? activeContentControl.navigationAidControl : /* istanbul ignore next */ "");
+    React.useEffect(() => {
+        // istanbul ignore next
+        const handleContentControlActivated = (args) => {
+            setActiveContentControl(args.activeContentControl);
+            setActiveContentViewport(args.activeContentControl.viewport);
+            setNavigationAidId(args.activeContentControl.navigationAidControl);
+        };
+        FrontstageManager_1.FrontstageManager.onContentControlActivatedEvent.addListener(handleContentControlActivated);
+        return () => {
+            FrontstageManager_1.FrontstageManager.onContentControlActivatedEvent.removeListener(handleContentControlActivated);
+        };
+    }, []);
+    const [activeViewClass, setActiveViewClass] = React.useState(() => {
+        const content = ContentViewManager_1.ContentViewManager.getActiveContentControl();
+        if (content && content.viewport)
+            return content.viewport.view.classFullName;
+        return "";
+    });
+    React.useEffect(() => {
+        // istanbul ignore next
+        const handleViewClassFullNameChange = (args) => {
+            setActiveViewClass(args.newName);
+        };
+        imodel_components_react_1.ViewportComponentEvents.onViewClassFullNameChangedEvent.addListener(handleViewClassFullNameChange);
+        return () => {
+            imodel_components_react_1.ViewportComponentEvents.onViewClassFullNameChangedEvent.removeListener(handleViewClassFullNameChange);
+        };
+    }, [activeViewClass]);
+    const navigationAidControl = React.useMemo(() => createNavigationAidControl(activeContentControl, navigationAidId, activeContentViewport), [activeContentControl, navigationAidId, activeContentViewport]);
+    const ref = React.useRef(null);
+    const isInitialMount = React.useRef(true);
+    const { onElementRef, proximityScale } = (0, core_react_1.useWidgetOpacityContext)();
+    React.useEffect(() => {
+        // istanbul ignore else
+        if (isInitialMount.current) {
+            isInitialMount.current = false;
+            onElementRef(ref);
+        }
+    }, [onElementRef]);
+    const divStyle = {
+        minWidth: props.minWidth ? /* istanbul ignore next */ props.minWidth : "64px",
+        minHeight: props.minHeight ? /* istanbul ignore next */ props.minHeight : "64px",
+    };
+    // istanbul ignore else
+    if ("1" !== (0, useFrameworkVersion_1.useFrameworkVersion)() && UiShowHideManager_1.UiShowHideManager.useProximityOpacity && !UiFramework_1.UiFramework.isMobile()) { // eslint-disable-line deprecation/deprecation
+        const navigationAidOpacity = (0.30 * proximityScale) + 0.70;
+        divStyle.opacity = `${navigationAidOpacity}`;
+    }
+    return (React.createElement("div", { style: divStyle, ref: ref }, navigationAidControl && navigationAidControl.reactNode));
+}
+exports.NavigationAidHost = NavigationAidHost;
+/**
+ * Component that Composes a NavigationWidget typically using toolbars generated via [[ToolbarComposer]] class. The Navigation widget is shown in the top right of the content area
+ * and typically holds tools to visually navigate, orient, and zoom to specific content.
+ * @public
+ */
+function NavigationWidgetComposer(props) {
+    const { navigationAidHost, horizontalToolbar, verticalToolbar, hideNavigationAid, ...otherProps } = props;
+    const [elementSet] = React.useState(new core_react_1.WidgetElementSet());
+    const handleChildRef = React.useCallback((elementRef) => {
+        elementSet.add(elementRef);
+    }, [elementSet]);
+    const proximityScale = (0, core_react_1.useProximityToMouse)(elementSet, UiShowHideManager_1.UiShowHideManager.snapWidgetOpacity);
+    /* istanbul ignore next */
+    const navigationAid = hideNavigationAid ? undefined : navigationAidHost !== null && navigationAidHost !== void 0 ? navigationAidHost : React.createElement(NavigationAidHost, null);
+    return (React.createElement(core_react_1.WidgetOpacityContext.Provider, { value: {
+            onElementRef: handleChildRef,
+            proximityScale,
+        } },
+        React.createElement(appui_layout_react_1.NavigationArea, { navigationAid: navigationAid, horizontalToolbar: horizontalToolbar, verticalToolbar: verticalToolbar, ...otherProps, onMouseEnter: UiShowHideManager_1.UiShowHideManager.handleWidgetMouseEnter })));
+}
+exports.NavigationWidgetComposer = NavigationWidgetComposer;
 //# sourceMappingURL=NavigationWidgetComposer.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"NavigationWidgetComposer.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/NavigationWidgetComposer.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAE/B,4EAA4G;AAC5G,kDAAsI;AACtI,kEAA2D;AAC3D,mFAAgF;AAEhF,sEAAmE;AACnE,uEAAoE;AAEpE,gDAA6C;AAC7C,kEAA+D;AAE/D,SAAS,0BAA0B,CAAC,oBAAgD,EAAE,eAAuB,EAAE,cAA0C;IACvJ,uBAAuB;IACvB,IAAI,CAAC,oBAAoB,IAAI,CAAC,eAAe,IAAI,CAAC,cAAc,KAAK,oBAAoB,CAAC,QAAQ,CAAC;QACjG,OAAO,SAAS,CAAC;IAEnB,MAAM,QAAQ,GAAG,oBAAoB,CAAC,QAAQ,CAAC;IAC/C,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,yBAAW,CAAC,mBAAmB,EAAE,CAAC;IACzG,MAAM,oBAAoB,GAAG,6CAAqB,CAAC,aAAa,CAAC,eAAe,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAyB,CAAC;IAEjJ,oBAAoB,CAAC,UAAU,EAAE,CAAC;IAClC,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAYD;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAA6B;IAC7D,MAAM,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,uCAAkB,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAC3H,MAAM,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,QAAQ,CAAC,CAAC;IAC1I,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAErK,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,6BAA6B,GAAG,CAAC,IAAsC,EAAE,EAAE;YAC/E,uBAAuB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACnD,wBAAwB,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;YAC7D,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QACrE,CAAC,CAAC;QAEF,qCAAiB,CAAC,8BAA8B,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;QAC5F,OAAO,GAAG,EAAE;YACV,qCAAiB,CAAC,8BAA8B,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACjG,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;QAChE,MAAM,OAAO,GAAG,uCAAkB,CAAC,uBAAuB,EAAE,CAAC;QAC7D,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ;YAC7B,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,6BAA6B,GAAG,CAAC,IAAuC,EAAE,EAAE;YAChF,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,iDAAuB,CAAC,+BAA+B,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;QACnG,OAAO,GAAG,EAAE;YACV,iDAAuB,CAAC,+BAA+B,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACxG,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IAEtB,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,oBAAoB,EAAE,eAAe,EAAE,qBAAqB,CAAC,EAAE,CAAC,oBAAoB,EAAE,eAAe,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAE3M,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,IAAA,oCAAuB,GAAE,CAAC;IAEnE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1B,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;YAC/B,YAAY,CAAC,GAAG,CAAC,CAAC;SACnB;IACH,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,MAAM,QAAQ,GAAwB;QACpC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM;QAC7E,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,0BAA0B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;KACjF,CAAC;IAEF,uBAAuB;IACvB,IAAI,qCAAiB,CAAC,mBAAmB,IAAI,CAAC,yBAAW,CAAC,QAAQ,EAAE,EAAE;QACpE,MAAM,oBAAoB,GAAG,CAAC,IAAI,GAAG,cAAc,CAAC,GAAG,IAAI,CAAC;QAC5D,QAAQ,CAAC,OAAO,GAAG,GAAG,oBAAoB,EAAE,CAAC;KAC9C;IAED,OAAO,CACL,6BAAK,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,IAC3B,oBAAoB,IAAI,oBAAoB,CAAC,SAAS,CACnD,CACP,CAAC;AACJ,CAAC;AArED,8CAqEC;AAgBD;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,KAAoC;IAC3E,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe,EAAE,iBAAiB,EAAE,GAAG,UAAU,EAAE,GAAG,KAAK,CAAC;IAC1G,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAgB,EAAE,CAAC,CAAC;IAC5D,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,UAAoC,EAAE,EAAE;QAChF,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACjB,MAAM,cAAc,GAAG,IAAA,gCAAmB,EAAC,UAAU,EAAE,qCAAiB,CAAC,iBAAiB,CAAC,CAAC;IAC5F,0BAA0B;IAC1B,MAAM,aAAa,GAAG,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,oBAAC,iBAAiB,OAAG,CAAC;IAEjG,OAAO,CACL,oBAAC,iCAAoB,CAAC,QAAQ,IAC5B,KAAK,EAAE;YACL,YAAY,EAAE,cAAc;YAC5B,cAAc;SACf;QAED,oBAAC,mCAAc,IACb,aAAa,EAAE,aAAa,EAC5B,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,EAAE,eAAe,KAC5B,UAAU,EACd,YAAY,EAAE,qCAAiB,CAAC,sBAAsB,GACtD,CAC4B,CACjC,CAAC;AACJ,CAAC;AA1BD,4DA0BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Widget\n */\n\nimport * as React from \"react\";\nimport { ScreenViewport } from \"@itwin/core-frontend\";\nimport { ViewClassFullNameChangedEventArgs, ViewportComponentEvents } from \"@itwin/imodel-components-react\";\nimport { CommonProps, useProximityToMouse, useWidgetOpacityContext, WidgetElementSet, WidgetOpacityContext } from \"@itwin/core-react\";\nimport { NavigationArea } from \"@itwin/appui-layout-react\";\nimport { ConfigurableUiManager } from \"../configurableui/ConfigurableUiManager\";\nimport { ContentControl, ContentControlActivatedEventArgs } from \"../content/ContentControl\";\nimport { ContentViewManager } from \"../content/ContentViewManager\";\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\nimport { NavigationAidControl } from \"../navigationaids/NavigationAidControl\";\nimport { UiFramework } from \"../UiFramework\";\nimport { UiShowHideManager } from \"../utils/UiShowHideManager\";\n\nfunction createNavigationAidControl(activeContentControl: ContentControl | undefined, navigationAidId: string, activeViewport: ScreenViewport | undefined): NavigationAidControl | undefined {\n  // istanbul ignore else\n  if (!activeContentControl || !navigationAidId || (activeViewport !== activeContentControl.viewport))\n    return undefined;\n\n  const viewport = activeContentControl.viewport;\n  const imodel = viewport ? viewport.iModel : /* istanbul ignore next */ UiFramework.getIModelConnection();\n  const navigationAidControl = ConfigurableUiManager.createControl(navigationAidId, navigationAidId, { imodel, viewport }) as NavigationAidControl;\n\n  navigationAidControl.initialize();\n  return navigationAidControl;\n}\n\n/** Properties for the [[NavigationAidHost]] React component\n * @public\n */\nexport interface NavigationAidHostProps {\n  /** Navigation Aid Host minimum width. Defaults to \"64px\". */\n  minWidth?: string;\n  /** Navigation Aid Host minimum height. Defaults to \"64px\". */\n  minHeight?: string;\n}\n\n/**\n * NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.\n * @public\n */\nexport function NavigationAidHost(props: NavigationAidHostProps) {\n  const [activeContentControl, setActiveContentControl] = React.useState(() => ContentViewManager.getActiveContentControl());\n  const [activeContentViewport, setActiveContentViewport] = React.useState(() => /* istanbul ignore next */ activeContentControl?.viewport);\n  const [navigationAidId, setNavigationAidId] = React.useState(() => activeContentControl ? activeContentControl.navigationAidControl : /* istanbul ignore next */ \"\");\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleContentControlActivated = (args: ContentControlActivatedEventArgs) => {\n      setActiveContentControl(args.activeContentControl);\n      setActiveContentViewport(args.activeContentControl.viewport);\n      setNavigationAidId(args.activeContentControl.navigationAidControl);\n    };\n\n    FrontstageManager.onContentControlActivatedEvent.addListener(handleContentControlActivated);\n    return () => {\n      FrontstageManager.onContentControlActivatedEvent.removeListener(handleContentControlActivated);\n    };\n  }, []);\n\n  const [activeViewClass, setActiveViewClass] = React.useState(() => {\n    const content = ContentViewManager.getActiveContentControl();\n    if (content && content.viewport)\n      return content.viewport.view.classFullName;\n    return \"\";\n  });\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleViewClassFullNameChange = (args: ViewClassFullNameChangedEventArgs) => {\n      setActiveViewClass(args.newName);\n    };\n\n    ViewportComponentEvents.onViewClassFullNameChangedEvent.addListener(handleViewClassFullNameChange);\n    return () => {\n      ViewportComponentEvents.onViewClassFullNameChangedEvent.removeListener(handleViewClassFullNameChange);\n    };\n  }, [activeViewClass]);\n\n  const navigationAidControl = React.useMemo(() => createNavigationAidControl(activeContentControl, navigationAidId, activeContentViewport), [activeContentControl, navigationAidId, activeContentViewport]);\n\n  const ref = React.useRef<HTMLDivElement>(null);\n\n  const isInitialMount = React.useRef(true);\n  const { onElementRef, proximityScale } = useWidgetOpacityContext();\n\n  React.useEffect(() => {\n    // istanbul ignore else\n    if (isInitialMount.current) {\n      isInitialMount.current = false;\n      onElementRef(ref);\n    }\n  }, [onElementRef]);\n\n  const divStyle: React.CSSProperties = {\n    minWidth: props.minWidth ? /* istanbul ignore next */ props.minWidth : \"64px\",\n    minHeight: props.minHeight ? /* istanbul ignore next */ props.minHeight : \"64px\",\n  };\n\n  // istanbul ignore else\n  if (UiShowHideManager.useProximityOpacity && !UiFramework.isMobile()) {\n    const navigationAidOpacity = (0.30 * proximityScale) + 0.70;\n    divStyle.opacity = `${navigationAidOpacity}`;\n  }\n\n  return (\n    <div style={divStyle} ref={ref}>\n      {navigationAidControl && navigationAidControl.reactNode}\n    </div>\n  );\n}\n\n/** Properties for the [[NavigationWidgetComposer]] React components\n * @public\n */\nexport interface NavigationWidgetComposerProps extends CommonProps {\n  /** Optional Horizontal Toolbar */\n  horizontalToolbar?: React.ReactNode;\n  /** Optional Vertical Toolbar */\n  verticalToolbar?: React.ReactNode;\n  /** Optional Navigation Aid host. If not specified a default host is provided which will use registered Navigation Aids and the active content control to determine which if any Navigation Aid to display. */\n  navigationAidHost?: React.ReactNode;\n  /** If true no navigation aid will be shown. Defaults to false. */\n  hideNavigationAid?: boolean;\n}\n\n/**\n * Component that Composes a NavigationWidget typically using toolbars generated via [[ToolbarComposer]] class. The Navigation widget is shown in the top right of the content area\n * and typically holds tools to visually navigate, orient, and zoom to specific content.\n * @public\n */\nexport function NavigationWidgetComposer(props: NavigationWidgetComposerProps) {\n  const { navigationAidHost, horizontalToolbar, verticalToolbar, hideNavigationAid, ...otherProps } = props;\n  const [elementSet] = React.useState(new WidgetElementSet());\n  const handleChildRef = React.useCallback((elementRef: React.RefObject<Element>) => {\n    elementSet.add(elementRef);\n  }, [elementSet]);\n  const proximityScale = useProximityToMouse(elementSet, UiShowHideManager.snapWidgetOpacity);\n  /* istanbul ignore next */\n  const navigationAid = hideNavigationAid ? undefined : navigationAidHost ?? <NavigationAidHost />;\n\n  return (\n    <WidgetOpacityContext.Provider\n      value={{\n        onElementRef: handleChildRef,\n        proximityScale,\n      }}\n    >\n      <NavigationArea\n        navigationAid={navigationAid}\n        horizontalToolbar={horizontalToolbar}\n        verticalToolbar={verticalToolbar}\n        {...otherProps}\n        onMouseEnter={UiShowHideManager.handleWidgetMouseEnter}\n      />\n    </WidgetOpacityContext.Provider>\n  );\n}\n"]}
+{"version":3,"file":"NavigationWidgetComposer.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/NavigationWidgetComposer.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAE/B,4EAA4G;AAC5G,kDAAsI;AACtI,kEAA2D;AAC3D,mFAAgF;AAEhF,sEAAmE;AACnE,uEAAoE;AACpE,sEAAmE;AAEnE,gDAA6C;AAC7C,kEAA+D;AAE/D,SAAS,0BAA0B,CAAC,oBAAgD,EAAE,eAAuB,EAAE,cAA0C;IACvJ,uBAAuB;IACvB,IAAI,CAAC,oBAAoB,IAAI,CAAC,eAAe,IAAI,CAAC,cAAc,KAAK,oBAAoB,CAAC,QAAQ,CAAC;QACjG,OAAO,SAAS,CAAC;IAEnB,MAAM,QAAQ,GAAG,oBAAoB,CAAC,QAAQ,CAAC;IAC/C,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,yBAAW,CAAC,mBAAmB,EAAE,CAAC;IACzG,MAAM,oBAAoB,GAAG,6CAAqB,CAAC,aAAa,CAAC,eAAe,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAyB,CAAC;IAEjJ,oBAAoB,CAAC,UAAU,EAAE,CAAC;IAClC,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAYD;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAA6B;IAC7D,MAAM,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,uCAAkB,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAC3H,MAAM,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,QAAQ,CAAC,CAAC;IAC1I,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAErK,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,6BAA6B,GAAG,CAAC,IAAsC,EAAE,EAAE;YAC/E,uBAAuB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACnD,wBAAwB,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;YAC7D,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QACrE,CAAC,CAAC;QAEF,qCAAiB,CAAC,8BAA8B,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;QAC5F,OAAO,GAAG,EAAE;YACV,qCAAiB,CAAC,8BAA8B,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACjG,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;QAChE,MAAM,OAAO,GAAG,uCAAkB,CAAC,uBAAuB,EAAE,CAAC;QAC7D,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ;YAC7B,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,6BAA6B,GAAG,CAAC,IAAuC,EAAE,EAAE;YAChF,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,iDAAuB,CAAC,+BAA+B,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAAC;QACnG,OAAO,GAAG,EAAE;YACV,iDAAuB,CAAC,+BAA+B,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACxG,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IAEtB,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,oBAAoB,EAAE,eAAe,EAAE,qBAAqB,CAAC,EAAE,CAAC,oBAAoB,EAAE,eAAe,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAE3M,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,IAAA,oCAAuB,GAAE,CAAC;IAEnE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1B,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;YAC/B,YAAY,CAAC,GAAG,CAAC,CAAC;SACnB;IACH,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,MAAM,QAAQ,GAAwB;QACpC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM;QAC7E,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,0BAA0B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;KACjF,CAAC;IAEF,uBAAuB;IACvB,IAAI,GAAG,KAAK,IAAA,yCAAmB,GAAE,IAAI,qCAAiB,CAAC,mBAAmB,IAAI,CAAC,yBAAW,CAAC,QAAQ,EAAE,EAAE,EAAE,8CAA8C;QACrJ,MAAM,oBAAoB,GAAG,CAAC,IAAI,GAAG,cAAc,CAAC,GAAG,IAAI,CAAC;QAC5D,QAAQ,CAAC,OAAO,GAAG,GAAG,oBAAoB,EAAE,CAAC;KAC9C;IAED,OAAO,CACL,6BAAK,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,IAC3B,oBAAoB,IAAI,oBAAoB,CAAC,SAAS,CACnD,CACP,CAAC;AACJ,CAAC;AArED,8CAqEC;AAgBD;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,KAAoC;IAC3E,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe,EAAE,iBAAiB,EAAE,GAAG,UAAU,EAAE,GAAG,KAAK,CAAC;IAC1G,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAgB,EAAE,CAAC,CAAC;IAC5D,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,UAAoC,EAAE,EAAE;QAChF,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACjB,MAAM,cAAc,GAAG,IAAA,gCAAmB,EAAC,UAAU,EAAE,qCAAiB,CAAC,iBAAiB,CAAC,CAAC;IAC5F,0BAA0B;IAC1B,MAAM,aAAa,GAAG,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,oBAAC,iBAAiB,OAAG,CAAC;IAEjG,OAAO,CACL,oBAAC,iCAAoB,CAAC,QAAQ,IAC5B,KAAK,EAAE;YACL,YAAY,EAAE,cAAc;YAC5B,cAAc;SACf;QAED,oBAAC,mCAAc,IACb,aAAa,EAAE,aAAa,EAC5B,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,EAAE,eAAe,KAC5B,UAAU,EACd,YAAY,EAAE,qCAAiB,CAAC,sBAAsB,GACtD,CAC4B,CACjC,CAAC;AACJ,CAAC;AA1BD,4DA0BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { ScreenViewport } from \"@itwin/core-frontend\";\r\nimport { ViewClassFullNameChangedEventArgs, ViewportComponentEvents } from \"@itwin/imodel-components-react\";\r\nimport { CommonProps, useProximityToMouse, useWidgetOpacityContext, WidgetElementSet, WidgetOpacityContext } from \"@itwin/core-react\";\r\nimport { NavigationArea } from \"@itwin/appui-layout-react\";\r\nimport { ConfigurableUiManager } from \"../configurableui/ConfigurableUiManager\";\r\nimport { ContentControl, ContentControlActivatedEventArgs } from \"../content/ContentControl\";\r\nimport { ContentViewManager } from \"../content/ContentViewManager\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { useFrameworkVersion } from \"../hooks/useFrameworkVersion\";\r\nimport { NavigationAidControl } from \"../navigationaids/NavigationAidControl\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { UiShowHideManager } from \"../utils/UiShowHideManager\";\r\n\r\nfunction createNavigationAidControl(activeContentControl: ContentControl | undefined, navigationAidId: string, activeViewport: ScreenViewport | undefined): NavigationAidControl | undefined {\r\n  // istanbul ignore else\r\n  if (!activeContentControl || !navigationAidId || (activeViewport !== activeContentControl.viewport))\r\n    return undefined;\r\n\r\n  const viewport = activeContentControl.viewport;\r\n  const imodel = viewport ? viewport.iModel : /* istanbul ignore next */ UiFramework.getIModelConnection();\r\n  const navigationAidControl = ConfigurableUiManager.createControl(navigationAidId, navigationAidId, { imodel, viewport }) as NavigationAidControl;\r\n\r\n  navigationAidControl.initialize();\r\n  return navigationAidControl;\r\n}\r\n\r\n/** Properties for the [[NavigationAidHost]] React component\r\n * @public\r\n */\r\nexport interface NavigationAidHostProps {\r\n  /** Navigation Aid Host minimum width. Defaults to \"64px\". */\r\n  minWidth?: string;\r\n  /** Navigation Aid Host minimum height. Defaults to \"64px\". */\r\n  minHeight?: string;\r\n}\r\n\r\n/**\r\n * NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.\r\n * @public\r\n */\r\nexport function NavigationAidHost(props: NavigationAidHostProps) {\r\n  const [activeContentControl, setActiveContentControl] = React.useState(() => ContentViewManager.getActiveContentControl());\r\n  const [activeContentViewport, setActiveContentViewport] = React.useState(() => /* istanbul ignore next */ activeContentControl?.viewport);\r\n  const [navigationAidId, setNavigationAidId] = React.useState(() => activeContentControl ? activeContentControl.navigationAidControl : /* istanbul ignore next */ \"\");\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore next\r\n    const handleContentControlActivated = (args: ContentControlActivatedEventArgs) => {\r\n      setActiveContentControl(args.activeContentControl);\r\n      setActiveContentViewport(args.activeContentControl.viewport);\r\n      setNavigationAidId(args.activeContentControl.navigationAidControl);\r\n    };\r\n\r\n    FrontstageManager.onContentControlActivatedEvent.addListener(handleContentControlActivated);\r\n    return () => {\r\n      FrontstageManager.onContentControlActivatedEvent.removeListener(handleContentControlActivated);\r\n    };\r\n  }, []);\r\n\r\n  const [activeViewClass, setActiveViewClass] = React.useState(() => {\r\n    const content = ContentViewManager.getActiveContentControl();\r\n    if (content && content.viewport)\r\n      return content.viewport.view.classFullName;\r\n    return \"\";\r\n  });\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore next\r\n    const handleViewClassFullNameChange = (args: ViewClassFullNameChangedEventArgs) => {\r\n      setActiveViewClass(args.newName);\r\n    };\r\n\r\n    ViewportComponentEvents.onViewClassFullNameChangedEvent.addListener(handleViewClassFullNameChange);\r\n    return () => {\r\n      ViewportComponentEvents.onViewClassFullNameChangedEvent.removeListener(handleViewClassFullNameChange);\r\n    };\r\n  }, [activeViewClass]);\r\n\r\n  const navigationAidControl = React.useMemo(() => createNavigationAidControl(activeContentControl, navigationAidId, activeContentViewport), [activeContentControl, navigationAidId, activeContentViewport]);\r\n\r\n  const ref = React.useRef<HTMLDivElement>(null);\r\n\r\n  const isInitialMount = React.useRef(true);\r\n  const { onElementRef, proximityScale } = useWidgetOpacityContext();\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore else\r\n    if (isInitialMount.current) {\r\n      isInitialMount.current = false;\r\n      onElementRef(ref);\r\n    }\r\n  }, [onElementRef]);\r\n\r\n  const divStyle: React.CSSProperties = {\r\n    minWidth: props.minWidth ? /* istanbul ignore next */ props.minWidth : \"64px\",\r\n    minHeight: props.minHeight ? /* istanbul ignore next */ props.minHeight : \"64px\",\r\n  };\r\n\r\n  // istanbul ignore else\r\n  if (\"1\" !== useFrameworkVersion() && UiShowHideManager.useProximityOpacity && !UiFramework.isMobile()) { // eslint-disable-line deprecation/deprecation\r\n    const navigationAidOpacity = (0.30 * proximityScale) + 0.70;\r\n    divStyle.opacity = `${navigationAidOpacity}`;\r\n  }\r\n\r\n  return (\r\n    <div style={divStyle} ref={ref}>\r\n      {navigationAidControl && navigationAidControl.reactNode}\r\n    </div>\r\n  );\r\n}\r\n\r\n/** Properties for the [[NavigationWidgetComposer]] React components\r\n * @public\r\n */\r\nexport interface NavigationWidgetComposerProps extends CommonProps {\r\n  /** Optional Horizontal Toolbar */\r\n  horizontalToolbar?: React.ReactNode;\r\n  /** Optional Vertical Toolbar */\r\n  verticalToolbar?: React.ReactNode;\r\n  /** Optional Navigation Aid host. If not specified a default host is provided which will use registered Navigation Aids and the active content control to determine which if any Navigation Aid to display. */\r\n  navigationAidHost?: React.ReactNode;\r\n  /** If true no navigation aid will be shown. Defaults to false. */\r\n  hideNavigationAid?: boolean;\r\n}\r\n\r\n/**\r\n * Component that Composes a NavigationWidget typically using toolbars generated via [[ToolbarComposer]] class. The Navigation widget is shown in the top right of the content area\r\n * and typically holds tools to visually navigate, orient, and zoom to specific content.\r\n * @public\r\n */\r\nexport function NavigationWidgetComposer(props: NavigationWidgetComposerProps) {\r\n  const { navigationAidHost, horizontalToolbar, verticalToolbar, hideNavigationAid, ...otherProps } = props;\r\n  const [elementSet] = React.useState(new WidgetElementSet());\r\n  const handleChildRef = React.useCallback((elementRef: React.RefObject<Element>) => {\r\n    elementSet.add(elementRef);\r\n  }, [elementSet]);\r\n  const proximityScale = useProximityToMouse(elementSet, UiShowHideManager.snapWidgetOpacity);\r\n  /* istanbul ignore next */\r\n  const navigationAid = hideNavigationAid ? undefined : navigationAidHost ?? <NavigationAidHost />;\r\n\r\n  return (\r\n    <WidgetOpacityContext.Provider\r\n      value={{\r\n        onElementRef: handleChildRef,\r\n        proximityScale,\r\n      }}\r\n    >\r\n      <NavigationArea\r\n        navigationAid={navigationAid}\r\n        horizontalToolbar={horizontalToolbar}\r\n        verticalToolbar={verticalToolbar}\r\n        {...otherProps}\r\n        onMouseEnter={UiShowHideManager.handleWidgetMouseEnter}\r\n      />\r\n    </WidgetOpacityContext.Provider>\r\n  );\r\n}\r\n"]}

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

@@ -0,0 +1,33 @@
+/** @packageDocumentation
+ * @module Widget
+ */
+import * as React from "react";
+import { IconSpec } from "@itwin/core-react";
+import { ItemList } from "../shared/ItemMap";
+/** Properties that can be used to append items to the default set of toolbar items of [[ReviewToolWidget]].
+ * @beta
+ */
+export interface ReviewToolWidgetProps {
+    /** Item to add before the default items in the horizontal toolbar */
+    prefixHorizontalItems?: ItemList;
+    /** Item to add after the default items in the horizontal toolbar */
+    suffixHorizontalItems?: ItemList;
+    /** Item to add before the default items in the vertical toolbar */
+    prefixVerticalItems?: ItemList;
+    /** Item to add after the default items in the vertical toolbar */
+    suffixVerticalItems?: ItemList;
+    /** Controls visibility of hide/isolate tools that act on a selection set's categories/models */
+    showCategoryAndModelsContextTools?: boolean;
+    /** Icon specification for application button */
+    iconSpec?: IconSpec;
+}
+/** Default Tool Widget for standard "review" applications. Provides standard tools to review, and measure elements.
+ * This definition will also show a overflow button if there is not enough room to display all the toolbar buttons.
+ * @beta
+ */
+export declare class ReviewToolWidget extends React.Component<ReviewToolWidgetProps, any> {
+    private _horizontalToolbarItems;
+    private _verticalToolbarItems;
+    render(): JSX.Element;
+}
+//# sourceMappingURL=ReviewToolWidget.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ReviewToolWidget.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widgets/ReviewToolWidget.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAI7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,qEAAqE;IACrE,qBAAqB,CAAC,EAAE,QAAQ,CAAC;IACjC,oEAAoE;IACpE,qBAAqB,CAAC,EAAE,QAAQ,CAAC;IACjC,mEAAmE;IACnE,mBAAmB,CAAC,EAAE,QAAQ,CAAC;IAC/B,kEAAkE;IAClE,mBAAmB,CAAC,EAAE,QAAQ,CAAC;IAC/B,gGAAgG;IAChG,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAC5C,gDAAgD;IAChD,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,KAAK,CAAC,SAAS,CAAC,qBAAqB,EAAE,GAAG,CAAC;IAE/E,OAAO,CAAC,uBAAuB,CAa1B;IAEL,OAAO,CAAC,qBAAqB,CAI1B;IAEa,MAAM;CA8BvB"}