@itwin/appui-react 3.6.0 → 3.7.0-dev.1

package/lib/cjs/appui-react/syncui/BooleanListener.d.ts

@@ -1,44 +1,44 @@
-/** @packageDocumentation
- * @module SyncUi
- */
-import * as React from "react";
-/**
- * Properties supported by [[BooleanSyncUiListener]] component.
- * @public @deprecated in 3.0.
- */
-export interface BooleanListenerProps {
-    /** One or more SyncUi event Ids that will trigger the function to be called. */
-    eventIds: string[];
-    /** Function to be called to return a boolean value. If the boolean value is different than the component's state value setState is
-     * called to update the value and trigger a re-render.
-     */
-    boolFunc: () => boolean;
-    /** Optional, default/initial boolean value that is saved in the components state. If
-     * not defined it will default to true.
-     */
-    defaultValue?: boolean;
-}
-/**
- * State for the [[BooleanSyncUiListener]] component.
- * @internal
- */
-interface BooleanListenerState {
-    boolValue: boolean;
-}
-/**
- * A component that expect its children to be a function that will be passed the current boolValue state.
- * @public @deprecated in 3.0.
- */
-export declare class BooleanSyncUiListener extends React.Component<BooleanListenerProps, BooleanListenerState> {
-    private _componentUnmounting;
-    /** @internal */
-    readonly state: BooleanListenerState;
-    constructor(props: BooleanListenerProps);
-    private _handleVisibilitySyncUiEvent;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    private _hasNoChildren;
-    render(): React.ReactNode;
-}
-export {};
+/** @packageDocumentation
+ * @module SyncUi
+ */
+import * as React from "react";
+/**
+ * Properties supported by [[BooleanSyncUiListener]] component.
+ * @public @deprecated in 3.0. Refactored SynchUiEventDispatcher.
+ */
+export interface BooleanListenerProps {
+    /** One or more SyncUi event Ids that will trigger the function to be called. */
+    eventIds: string[];
+    /** Function to be called to return a boolean value. If the boolean value is different than the component's state value setState is
+     * called to update the value and trigger a re-render.
+     */
+    boolFunc: () => boolean;
+    /** Optional, default/initial boolean value that is saved in the components state. If
+     * not defined it will default to true.
+     */
+    defaultValue?: boolean;
+}
+/**
+ * State for the [[BooleanSyncUiListener]] component.
+ * @internal
+ */
+interface BooleanListenerState {
+    boolValue: boolean;
+}
+/**
+ * A component that expect its children to be a function that will be passed the current boolValue state.
+ * @public @deprecated in 3.0. Refactored SynchUiEventDispatcher.
+ */
+export declare class BooleanSyncUiListener extends React.Component<BooleanListenerProps, BooleanListenerState> {
+    private _componentUnmounting;
+    /** @internal */
+    readonly state: BooleanListenerState;
+    constructor(props: BooleanListenerProps);
+    private _handleVisibilitySyncUiEvent;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _hasNoChildren;
+    render(): React.ReactNode;
+}
+export {};
 //# sourceMappingURL=BooleanListener.d.ts.map

package/lib/cjs/appui-react/syncui/BooleanListener.js

@@ -1,70 +1,70 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/* eslint-disable deprecation/deprecation */
-/** @packageDocumentation
- * @module SyncUi
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BooleanSyncUiListener = void 0;
-const React = require("react");
-const SyncUiEventDispatcher_1 = require("./SyncUiEventDispatcher");
-// cSpell:Ignore Unmounting
-/**
- * A component that expect its children to be a function that will be passed the current boolValue state.
- * @public @deprecated in 3.0.
- */
-class BooleanSyncUiListener extends React.Component {
-    constructor(props) {
-        super(props);
-        this._componentUnmounting = false;
-        this._handleVisibilitySyncUiEvent = (args) => {
-            /* istanbul ignore next */
-            if (this._componentUnmounting)
-                return;
-            /* istanbul ignore else */
-            if (this.props.eventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
-                const boolValue = this.props.boolFunc();
-                /* istanbul ignore else */
-                if (this.state.boolValue !== boolValue) {
-                    this.setState({ boolValue });
-                }
-            }
-        };
-        // istanbul ignore next
-        this._hasNoChildren = (children) => React.Children.count(children) === 0;
-        this.state = {
-            boolValue: undefined !== props.defaultValue ? props.defaultValue : true,
-        };
-    }
-    componentDidMount() {
-        /* istanbul ignore else */
-        if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0)
-            SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleVisibilitySyncUiEvent);
-    }
-    componentWillUnmount() {
-        /* istanbul ignore else */
-        if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0) {
-            this._componentUnmounting = true;
-            SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleVisibilitySyncUiEvent);
-        }
-    }
-    render() {
-        const { 
-        // do not bleed our props
-        children, eventIds, boolFunc, defaultValue, // eslint-disable-line @typescript-eslint/no-unused-vars
-        // eslint-disable-next-line comma-dangle
-        ...otherProps // pass-through props
-         } = this.props;
-        const boolValue = this.state.boolValue;
-        return (typeof children === "function" ?
-            children(boolValue, otherProps)
-            : /* istanbul ignore next */ !this._hasNoChildren(children)
-                ? React.Children.only(children)
-                : null);
-    }
-}
-exports.BooleanSyncUiListener = BooleanSyncUiListener;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module SyncUi
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BooleanSyncUiListener = void 0;
+const React = require("react");
+const SyncUiEventDispatcher_1 = require("./SyncUiEventDispatcher");
+// cSpell:Ignore Unmounting
+/**
+ * A component that expect its children to be a function that will be passed the current boolValue state.
+ * @public @deprecated in 3.0. Refactored SynchUiEventDispatcher.
+ */
+class BooleanSyncUiListener extends React.Component {
+    constructor(props) {
+        super(props);
+        this._componentUnmounting = false;
+        this._handleVisibilitySyncUiEvent = (args) => {
+            /* istanbul ignore next */
+            if (this._componentUnmounting)
+                return;
+            /* istanbul ignore else */
+            if (this.props.eventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
+                const boolValue = this.props.boolFunc();
+                /* istanbul ignore else */
+                if (this.state.boolValue !== boolValue) {
+                    this.setState({ boolValue });
+                }
+            }
+        };
+        // istanbul ignore next
+        this._hasNoChildren = (children) => React.Children.count(children) === 0;
+        this.state = {
+            boolValue: undefined !== props.defaultValue ? props.defaultValue : true,
+        };
+    }
+    componentDidMount() {
+        /* istanbul ignore else */
+        if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0)
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleVisibilitySyncUiEvent);
+    }
+    componentWillUnmount() {
+        /* istanbul ignore else */
+        if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0) {
+            this._componentUnmounting = true;
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleVisibilitySyncUiEvent);
+        }
+    }
+    render() {
+        const { 
+        // do not bleed our props
+        children, eventIds, boolFunc, defaultValue, // eslint-disable-line @typescript-eslint/no-unused-vars
+        // eslint-disable-next-line comma-dangle
+        ...otherProps // pass-through props
+         } = this.props;
+        const boolValue = this.state.boolValue;
+        return (typeof children === "function" ?
+            children(boolValue, otherProps)
+            : /* istanbul ignore next */ !this._hasNoChildren(children)
+                ? React.Children.only(children)
+                : null);
+    }
+}
+exports.BooleanSyncUiListener = BooleanSyncUiListener;
 //# sourceMappingURL=BooleanListener.js.map

package/lib/cjs/appui-react/syncui/BooleanListener.js.map

@@ -1 +1 @@
-{"version":3,"file":"BooleanListener.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/BooleanListener.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA+B;AAC/B,mEAAiF;AA2BjF,2BAA2B;AAC3B;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,KAAK,CAAC,SAAqD;IAMpG,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;QANP,yBAAoB,GAAG,KAAK,CAAC;QAY7B,iCAA4B,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACrE,0BAA0B;YAC1B,IAAI,IAAI,CAAC,oBAAoB;gBAC3B,OAAO;YAET,0BAA0B;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBAChG,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxC,0BAA0B;gBAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE;oBACtC,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;iBAC9B;aACF;QACH,CAAC,CAAC;QAgBF,uBAAuB;QACf,mBAAc,GAAG,CAAC,QAAa,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAnC/E,IAAI,CAAC,KAAK,GAAG;YACX,SAAS,EAAE,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;SACxE,CAAC;IACJ,CAAC;IAiBe,iBAAiB;QAC/B,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YACvE,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACvF,CAAC;IAEe,oBAAoB;QAClC,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACzE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;YACjC,6CAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;SACvF;IACH,CAAC;IAKe,MAAM;QACpB,MAAM;QACJ,yBAAyB;QACzB,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,wDAAwD;QACpG,wCAAwC;QACxC,GAAG,UAAU,CAAC,qBAAqB;UACpC,GAAG,IAAI,CAAC,KAAK,CAAC;QACf,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QAEvC,OAAO,CACL,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC;YAC9B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;YAC/B,CAAC,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBACzD,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC/B,CAAC,CAAC,IAAI,CACX,CAAC;IACJ,CAAC;CACF;AA9DD,sDA8DC","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/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module SyncUi\n */\n\nimport * as React from \"react\";\nimport { SyncUiEventArgs, SyncUiEventDispatcher } from \"./SyncUiEventDispatcher\";\n\n/**\n * Properties supported by [[BooleanSyncUiListener]] component.\n * @public @deprecated in 3.0.\n */\nexport interface BooleanListenerProps {\n  /** One or more SyncUi event Ids that will trigger the function to be called. */\n  eventIds: string[];\n  /** Function to be called to return a boolean value. If the boolean value is different than the component's state value setState is\n   * called to update the value and trigger a re-render.\n   */\n  boolFunc: () => boolean;\n  /** Optional, default/initial boolean value that is saved in the components state. If\n   * not defined it will default to true.\n   */\n  defaultValue?: boolean;\n}\n\n/**\n * State for the [[BooleanSyncUiListener]] component.\n * @internal\n */\ninterface BooleanListenerState {\n  boolValue: boolean;\n}\n\n// cSpell:Ignore Unmounting\n/**\n * A component that expect its children to be a function that will be passed the current boolValue state.\n * @public @deprecated in 3.0.\n */\nexport class BooleanSyncUiListener extends React.Component<BooleanListenerProps, BooleanListenerState> {\n  private _componentUnmounting = false;\n\n  /** @internal */\n  public override readonly state: BooleanListenerState;\n\n  constructor(props: BooleanListenerProps) {\n    super(props);\n    this.state = {\n      boolValue: undefined !== props.defaultValue ? props.defaultValue : true,\n    };\n  }\n\n  private _handleVisibilitySyncUiEvent = (args: SyncUiEventArgs): void => {\n    /* istanbul ignore next */\n    if (this._componentUnmounting)\n      return;\n\n    /* istanbul ignore else */\n    if (this.props.eventIds.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\n      const boolValue = this.props.boolFunc();\n      /* istanbul ignore else */\n      if (this.state.boolValue !== boolValue) {\n        this.setState({ boolValue });\n      }\n    }\n  };\n\n  public override componentDidMount() {\n    /* istanbul ignore else */\n    if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0)\n      SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleVisibilitySyncUiEvent);\n  }\n\n  public override componentWillUnmount() {\n    /* istanbul ignore else */\n    if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0) {\n      this._componentUnmounting = true;\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleVisibilitySyncUiEvent);\n    }\n  }\n\n  // istanbul ignore next\n  private _hasNoChildren = (children: any) => React.Children.count(children) === 0;\n\n  public override render(): React.ReactNode {\n    const {\n      // do not bleed our props\n      children, eventIds, boolFunc, defaultValue, // eslint-disable-line @typescript-eslint/no-unused-vars\n      // eslint-disable-next-line comma-dangle\n      ...otherProps // pass-through props\n    } = this.props;\n    const boolValue = this.state.boolValue;\n\n    return (\n      typeof children === \"function\" ?\n        children(boolValue, otherProps)\n        : /* istanbul ignore next */ !this._hasNoChildren(children)\n          ? React.Children.only(children)\n          : null\n    );\n  }\n}\n"]}
+{"version":3,"file":"BooleanListener.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/BooleanListener.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA+B;AAC/B,mEAAiF;AA2BjF,2BAA2B;AAC3B;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,KAAK,CAAC,SAAqD;IAMpG,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;QANP,yBAAoB,GAAG,KAAK,CAAC;QAY7B,iCAA4B,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACrE,0BAA0B;YAC1B,IAAI,IAAI,CAAC,oBAAoB;gBAC3B,OAAO;YAET,0BAA0B;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBAChG,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxC,0BAA0B;gBAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE;oBACtC,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;iBAC9B;aACF;QACH,CAAC,CAAC;QAgBF,uBAAuB;QACf,mBAAc,GAAG,CAAC,QAAa,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAnC/E,IAAI,CAAC,KAAK,GAAG;YACX,SAAS,EAAE,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;SACxE,CAAC;IACJ,CAAC;IAiBe,iBAAiB;QAC/B,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YACvE,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACvF,CAAC;IAEe,oBAAoB;QAClC,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACzE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;YACjC,6CAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;SACvF;IACH,CAAC;IAKe,MAAM;QACpB,MAAM;QACJ,yBAAyB;QACzB,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,wDAAwD;QACpG,wCAAwC;QACxC,GAAG,UAAU,CAAC,qBAAqB;UACpC,GAAG,IAAI,CAAC,KAAK,CAAC;QACf,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QAEvC,OAAO,CACL,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC;YAC9B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;YAC/B,CAAC,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBACzD,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC/B,CAAC,CAAC,IAAI,CACX,CAAC;IACJ,CAAC;CACF;AA9DD,sDA8DC","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module SyncUi\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { SyncUiEventArgs, SyncUiEventDispatcher } from \"./SyncUiEventDispatcher\";\r\n\r\n/**\r\n * Properties supported by [[BooleanSyncUiListener]] component.\r\n * @public @deprecated in 3.0. Refactored SynchUiEventDispatcher.\r\n */\r\nexport interface BooleanListenerProps {\r\n  /** One or more SyncUi event Ids that will trigger the function to be called. */\r\n  eventIds: string[];\r\n  /** Function to be called to return a boolean value. If the boolean value is different than the component's state value setState is\r\n   * called to update the value and trigger a re-render.\r\n   */\r\n  boolFunc: () => boolean;\r\n  /** Optional, default/initial boolean value that is saved in the components state. If\r\n   * not defined it will default to true.\r\n   */\r\n  defaultValue?: boolean;\r\n}\r\n\r\n/**\r\n * State for the [[BooleanSyncUiListener]] component.\r\n * @internal\r\n */\r\ninterface BooleanListenerState {\r\n  boolValue: boolean;\r\n}\r\n\r\n// cSpell:Ignore Unmounting\r\n/**\r\n * A component that expect its children to be a function that will be passed the current boolValue state.\r\n * @public @deprecated in 3.0. Refactored SynchUiEventDispatcher.\r\n */\r\nexport class BooleanSyncUiListener extends React.Component<BooleanListenerProps, BooleanListenerState> {\r\n  private _componentUnmounting = false;\r\n\r\n  /** @internal */\r\n  public override readonly state: BooleanListenerState;\r\n\r\n  constructor(props: BooleanListenerProps) {\r\n    super(props);\r\n    this.state = {\r\n      boolValue: undefined !== props.defaultValue ? props.defaultValue : true,\r\n    };\r\n  }\r\n\r\n  private _handleVisibilitySyncUiEvent = (args: SyncUiEventArgs): void => {\r\n    /* istanbul ignore next */\r\n    if (this._componentUnmounting)\r\n      return;\r\n\r\n    /* istanbul ignore else */\r\n    if (this.props.eventIds.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\r\n      const boolValue = this.props.boolFunc();\r\n      /* istanbul ignore else */\r\n      if (this.state.boolValue !== boolValue) {\r\n        this.setState({ boolValue });\r\n      }\r\n    }\r\n  };\r\n\r\n  public override componentDidMount() {\r\n    /* istanbul ignore else */\r\n    if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0)\r\n      SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleVisibilitySyncUiEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    /* istanbul ignore else */\r\n    if ((this.props.boolFunc !== undefined) && this.props.eventIds.length > 0) {\r\n      this._componentUnmounting = true;\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleVisibilitySyncUiEvent);\r\n    }\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private _hasNoChildren = (children: any) => React.Children.count(children) === 0;\r\n\r\n  public override render(): React.ReactNode {\r\n    const {\r\n      // do not bleed our props\r\n      children, eventIds, boolFunc, defaultValue, // eslint-disable-line @typescript-eslint/no-unused-vars\r\n      // eslint-disable-next-line comma-dangle\r\n      ...otherProps // pass-through props\r\n    } = this.props;\r\n    const boolValue = this.state.boolValue;\r\n\r\n    return (\r\n      typeof children === \"function\" ?\r\n        children(boolValue, otherProps)\r\n        : /* istanbul ignore next */ !this._hasNoChildren(children)\r\n          ? React.Children.only(children)\r\n          : null\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/syncui/SyncUiEventDispatcher.d.ts

@@ -1,103 +1,103 @@
-/** @packageDocumentation
- * @module SyncUi
- */
-import { UiSyncEvent, UiSyncEventArgs } from "@itwin/appui-abstract";
-import { IModelConnection } from "@itwin/core-frontend";
-/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.
- * @public
- */
-export declare enum SyncUiEventId {
-    /** AccuDraw compass mode has changed. */
-    AccuDrawCompassModeChanged = "accudrawcompassmodechanged",
-    /** AccuDraw rotation has changed. */
-    AccuDrawRotationChanged = "accudrawrotationchanged",
-    /** The active content as maintained by the ContentViewManager has changed. */
-    ActiveContentChanged = "activecontentchanged",
-    /** The active view maintained by the ViewManager has changed. */
-    ActiveViewportChanged = "activeviewportchanged",
-    /** Backstage has been closed.
-     * @deprecated in 1.x. Use BackstageEvent instead
-     */
-    BackstageCloseEvent = "backstagecloseevent",
-    /** Backstage has been closed. */
-    BackstageEvent = "backstageevent",
-    /** A Content Layout has been activated.  */
-    ContentLayoutActivated = "contentlayoutactivated",
-    /** A Content Control maintained by FrontstageManager has been activated. */
-    ContentControlActivated = "contentcontrolactivated",
-    /** A Frontstage is activating. */
-    FrontstageActivating = "frontstageactivating",
-    /** A Frontstage has been activated and the content has been assigned. */
-    FrontstageReady = "frontstageready",
-    /** A Modal Frontstage has been opened or closed. */
-    ModalFrontstageChanged = "modalfrontstagechanged",
-    /** A Modal Dialog has been opened or closed. */
-    ModalDialogChanged = "modaldialogchanged",
-    /** A NavigationAid has been activated. */
-    NavigationAidActivated = "navigationaidactivated",
-    /** An InteractiveTool has been activated via the ToolAdmin. */
-    ToolActivated = "toolactivated",
-    /** A Task has been activated.
-     * @deprecated in 3.0. */
-    TaskActivated = "taskactivated",
-    /** The state of a Widget has changed. */
-    WidgetStateChanged = "widgetstatechanged",
-    /** A Workflow has been activated.
-     * @deprecated in 3.0. */
-    WorkflowActivated = "workflowactivated",
-    /** The SelectionSet for the active IModelConnection has changed. */
-    SelectionSetChanged = "selectionsetchanged",
-    /** The list of settings providers registered with SettingsManager has changed. */
-    SettingsProvidersChanged = "settingsproviderschanged",
-    /** The current view state has changed (used by view undo/redo toolbar buttons). */
-    ViewStateChanged = "viewstatechanged",
-    /** The current object the reads and write UI State has changed. */
-    UiStateStorageChanged = "uistatestoragechanged",
-    ShowHideManagerSettingChange = "show-hide-setting-change",
-    /** The list of feature overrides applied has been changed
-     * @alpha
-    */
-    FeatureOverridesChanged = "featureoverrideschanged"
-}
-/** SyncUi Event arguments. Contains a set of lower case event Ids.
- * @public @deprecated in 3.0. Use UiSyncEventArgs in appui-abstract instead
- */
-export declare type SyncUiEventArgs = UiSyncEventArgs;
-/** SyncUi Event class.
- * @public @deprecated in 3.0. Use UiSyncEvent in appui-abstract instead
- */
-export declare type SyncUiEvent = UiSyncEvent;
-/** This class is used to send eventIds to interested UI components so the component can determine if it needs
- * to refresh its display by calling setState on itself.
- * @public
- */
-export declare class SyncUiEventDispatcher {
-    private static _uiEventDispatcher;
-    private static _unregisterListenerFunc?;
-    private static _unregisterListenerFuncs;
-    private static initialized;
-    /** @internal - used for testing only */
-    static setTimeoutPeriod(period: number): void;
-    /** Return set of event ids that will be sent to listeners/. */
-    static get syncEventIds(): Set<string>;
-    /** Return SyncUiEvent so callers can register an event callback. */
-    static get onSyncUiEvent(): SyncUiEvent;
-    /** Immediately trigger sync event processing. */
-    static dispatchImmediateSyncUiEvent(eventId: string): void;
-    /** Save eventId in Set for processing. */
-    static dispatchSyncUiEvent(eventId: string): void;
-    /** Save multiple eventIds in Set for processing. */
-    static dispatchSyncUiEvents(eventIds: string[]): void;
-    /** Checks to see if an eventId of interest is contained in the set of eventIds */
-    static hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]): boolean;
-    private static _dispatchViewChange;
-    private static _dispatchFeatureOverridesChange;
-    /** Initializes the Monitoring of Events that trigger dispatching sync events */
-    static initialize(): void;
-    private static selectionChangedHandler;
-    /** This should be called by IModelApp when the active IModelConnection is closed. */
-    static clearConnectionEvents(iModelConnection: IModelConnection): void;
-    /** This should be called by IModelApp when the active IModelConnection is established. */
-    static initializeConnectionEvents(iModelConnection: IModelConnection): void;
-}
+/** @packageDocumentation
+ * @module SyncUi
+ */
+import { UiSyncEvent, UiSyncEventArgs } from "@itwin/appui-abstract";
+import { IModelConnection } from "@itwin/core-frontend";
+/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.
+ * @public
+ */
+export declare enum SyncUiEventId {
+    /** AccuDraw compass mode has changed. */
+    AccuDrawCompassModeChanged = "accudrawcompassmodechanged",
+    /** AccuDraw rotation has changed. */
+    AccuDrawRotationChanged = "accudrawrotationchanged",
+    /** The active content as maintained by the ContentViewManager has changed. */
+    ActiveContentChanged = "activecontentchanged",
+    /** The active view maintained by the ViewManager has changed. */
+    ActiveViewportChanged = "activeviewportchanged",
+    /** Backstage has been closed.
+     * @deprecated in 3.7. Use BackstageEvent instead
+     */
+    BackstageCloseEvent = "backstagecloseevent",
+    /** Backstage has been closed. */
+    BackstageEvent = "backstageevent",
+    /** A Content Layout has been activated.  */
+    ContentLayoutActivated = "contentlayoutactivated",
+    /** A Content Control maintained by FrontstageManager has been activated. */
+    ContentControlActivated = "contentcontrolactivated",
+    /** A Frontstage is activating. */
+    FrontstageActivating = "frontstageactivating",
+    /** A Frontstage has been activated and the content has been assigned. */
+    FrontstageReady = "frontstageready",
+    /** A Modal Frontstage has been opened or closed. */
+    ModalFrontstageChanged = "modalfrontstagechanged",
+    /** A Modal Dialog has been opened or closed. */
+    ModalDialogChanged = "modaldialogchanged",
+    /** A NavigationAid has been activated. */
+    NavigationAidActivated = "navigationaidactivated",
+    /** An InteractiveTool has been activated via the ToolAdmin. */
+    ToolActivated = "toolactivated",
+    /** A Task has been activated.
+     * @deprecated in 3.0. Task is obsolete. */
+    TaskActivated = "taskactivated",
+    /** The state of a Widget has changed. */
+    WidgetStateChanged = "widgetstatechanged",
+    /** A Workflow has been activated.
+     * @deprecated in 3.0. Workflow is obsolete. */
+    WorkflowActivated = "workflowactivated",
+    /** The SelectionSet for the active IModelConnection has changed. */
+    SelectionSetChanged = "selectionsetchanged",
+    /** The list of settings providers registered with SettingsManager has changed. */
+    SettingsProvidersChanged = "settingsproviderschanged",
+    /** The current view state has changed (used by view undo/redo toolbar buttons). */
+    ViewStateChanged = "viewstatechanged",
+    /** The current object the reads and write UI State has changed. */
+    UiStateStorageChanged = "uistatestoragechanged",
+    ShowHideManagerSettingChange = "show-hide-setting-change",
+    /** The list of feature overrides applied has been changed
+     * @alpha
+    */
+    FeatureOverridesChanged = "featureoverrideschanged"
+}
+/** SyncUi Event arguments. Contains a set of lower case event Ids.
+ * @public @deprecated in 3.7, use UiSyncEventArgs in appui-abstract instead
+ */
+export declare type SyncUiEventArgs = UiSyncEventArgs;
+/** SyncUi Event class.
+ * @public @deprecated in 3.7, use UiSyncEvent in appui-abstract instead
+ */
+export declare type SyncUiEvent = UiSyncEvent;
+/** This class is used to send eventIds to interested UI components so the component can determine if it needs
+ * to refresh its display by calling setState on itself.
+ * @public
+ */
+export declare class SyncUiEventDispatcher {
+    private static _uiEventDispatcher;
+    private static _unregisterListenerFunc?;
+    private static _unregisterListenerFuncs;
+    private static initialized;
+    /** @internal - used for testing only */
+    static setTimeoutPeriod(period: number): void;
+    /** Return set of event ids that will be sent to listeners/. */
+    static get syncEventIds(): Set<string>;
+    /** Return SyncUiEvent so callers can register an event callback. */
+    static get onSyncUiEvent(): SyncUiEvent;
+    /** Immediately trigger sync event processing. */
+    static dispatchImmediateSyncUiEvent(eventId: string): void;
+    /** Save eventId in Set for processing. */
+    static dispatchSyncUiEvent(eventId: string): void;
+    /** Save multiple eventIds in Set for processing. */
+    static dispatchSyncUiEvents(eventIds: string[]): void;
+    /** Checks to see if an eventId of interest is contained in the set of eventIds */
+    static hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]): boolean;
+    private static _dispatchViewChange;
+    private static _dispatchFeatureOverridesChange;
+    /** Initializes the Monitoring of Events that trigger dispatching sync events */
+    static initialize(): void;
+    private static selectionChangedHandler;
+    /** This should be called by IModelApp when the active IModelConnection is closed. */
+    static clearConnectionEvents(iModelConnection: IModelConnection): void;
+    /** This should be called by IModelApp when the active IModelConnection is established. */
+    static initializeConnectionEvents(iModelConnection: IModelConnection): void;
+}
 //# sourceMappingURL=SyncUiEventDispatcher.d.ts.map

package/lib/cjs/appui-react/syncui/SyncUiEventDispatcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SyncUiEventDispatcher.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqB,WAAW,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExF,OAAO,EAAa,gBAAgB,EAAkD,MAAM,sBAAsB,CAAC;AAiBnH;;GAEG;AACH,oBAAY,aAAa;IACvB,yCAAyC;IACzC,0BAA0B,+BAA+B;IACzD,qCAAqC;IACrC,uBAAuB,4BAA4B;IACnD,8EAA8E;IAC9E,oBAAoB,yBAAyB;IAC7C,iEAAiE;IACjE,qBAAqB,0BAA0B;IAC/C;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C,iCAAiC;IACjC,cAAc,mBAAmB;IACjC,4CAA4C;IAC5C,sBAAsB,2BAA2B;IACjD,4EAA4E;IAC5E,uBAAuB,4BAA4B;IACnD,kCAAkC;IAClC,oBAAoB,yBAAyB;IAC7C,yEAAyE;IACzE,eAAe,oBAAoB;IACnC,oDAAoD;IACpD,sBAAsB,2BAA2B;IACjD,gDAAgD;IAChD,kBAAkB,uBAAuB;IACzC,0CAA0C;IAC1C,sBAAsB,2BAA2B;IACjD,+DAA+D;IAC/D,aAAa,kBAAkB;IAC/B;6BACyB;IACzB,aAAa,kBAAkB;IAC/B,yCAAyC;IACzC,kBAAkB,uBAAuB;IACzC;6BACyB;IACzB,iBAAiB,sBAAsB;IACvC,oEAAoE;IACpE,mBAAmB,wBAAwB;IAC3C,kFAAkF;IAClF,wBAAwB,6BAA6B;IACrD,mFAAmF;IACnF,gBAAgB,qBAAqB;IACrC,mEAAmE;IACnE,qBAAqB,0BAA0B;IAC/C,4BAA4B,6BAA6B;IACzD;;MAEE;IACF,uBAAuB,4BAA4B;CACpD;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,CAAC;AAE9C;;GAEG;AACH,oBAAY,WAAW,GAAG,WAAW,CAAC;AAEtC;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA2B;IAC5D,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAa;IACpD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAyB;IAChE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAS;IAEnC,wCAAwC;WAE1B,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpD,+DAA+D;IAC/D,WAAkB,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,CAE5C;IAED,oEAAoE;IAEpE,WAAkB,aAAa,IAAI,WAAW,CAE7C;IAED,iDAAiD;WACnC,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIjE,0CAA0C;WAC5B,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQxD,oDAAoD;WACtC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAQ5D,kFAAkF;WACpE,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE;IAK/E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAKlC,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAI9C,gFAAgF;WAClE,UAAU;IAgFxB,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAItC,qFAAqF;WACvE,qBAAqB,CAAC,gBAAgB,EAAE,gBAAgB;IAKtE,0FAA0F;WAC5E,0BAA0B,CAAC,gBAAgB,EAAE,gBAAgB;CA+C5E"}
+{"version":3,"file":"SyncUiEventDispatcher.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqB,WAAW,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExF,OAAO,EAAa,gBAAgB,EAAkD,MAAM,sBAAsB,CAAC;AAenH;;GAEG;AACH,oBAAY,aAAa;IACvB,yCAAyC;IACzC,0BAA0B,+BAA+B;IACzD,qCAAqC;IACrC,uBAAuB,4BAA4B;IACnD,8EAA8E;IAC9E,oBAAoB,yBAAyB;IAC7C,iEAAiE;IACjE,qBAAqB,0BAA0B;IAC/C;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C,iCAAiC;IACjC,cAAc,mBAAmB;IACjC,4CAA4C;IAC5C,sBAAsB,2BAA2B;IACjD,4EAA4E;IAC5E,uBAAuB,4BAA4B;IACnD,kCAAkC;IAClC,oBAAoB,yBAAyB;IAC7C,yEAAyE;IACzE,eAAe,oBAAoB;IACnC,oDAAoD;IACpD,sBAAsB,2BAA2B;IACjD,gDAAgD;IAChD,kBAAkB,uBAAuB;IACzC,0CAA0C;IAC1C,sBAAsB,2BAA2B;IACjD,+DAA+D;IAC/D,aAAa,kBAAkB;IAC/B;+CAC2C;IAC3C,aAAa,kBAAkB;IAC/B,yCAAyC;IACzC,kBAAkB,uBAAuB;IACzC;mDAC+C;IAC/C,iBAAiB,sBAAsB;IACvC,oEAAoE;IACpE,mBAAmB,wBAAwB;IAC3C,kFAAkF;IAClF,wBAAwB,6BAA6B;IACrD,mFAAmF;IACnF,gBAAgB,qBAAqB;IACrC,mEAAmE;IACnE,qBAAqB,0BAA0B;IAC/C,4BAA4B,6BAA6B;IACzD;;MAEE;IACF,uBAAuB,4BAA4B;CACpD;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,CAAC;AAE9C;;GAEG;AACH,oBAAY,WAAW,GAAG,WAAW,CAAC;AAEtC;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA2B;IAC5D,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAa;IACpD,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAyB;IAChE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAS;IAEnC,wCAAwC;WAE1B,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpD,+DAA+D;IAC/D,WAAkB,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,CAE5C;IAED,oEAAoE;IAEpE,WAAkB,aAAa,IAAI,WAAW,CAE7C;IAED,iDAAiD;WACnC,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIjE,0CAA0C;WAC5B,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQxD,oDAAoD;WACtC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAQ5D,kFAAkF;WACpE,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE;IAK/E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAKlC,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAI9C,gFAAgF;WAClE,UAAU;IAgFxB,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAItC,qFAAqF;WACvE,qBAAqB,CAAC,gBAAgB,EAAE,gBAAgB;IAKtE,0FAA0F;WAC5E,0BAA0B,CAAC,gBAAgB,EAAE,gBAAgB;CA+C5E"}