Correctly export conditional value classes from `@itwin/appui-abstrac…

…t` (#1031) * Remove ConditionalIconValue that was never exported. * Add ConditionalValue to barrel exports. * Extract API * NextVersion * rush change * PR number
iTwin · Sep 16, 2024 · 1484331 · 1484331
1 parent e4f3694
commit 1484331
Show file tree

Hide file tree

Showing 11 changed files with 142 additions and 99 deletions.
diff --git a/common/api/appui-react.api.md b/common/api/appui-react.api.md
diff --git a/common/api/summary/appui-react.exports.csv b/common/api/summary/appui-react.exports.csv
@@ -135,6 +135,10 @@ deprecated;CommandItemProps
 public;CommonBackstageItem
 public;CommonStatusBarItem
 public;CommonToolbarItem
+public;ConditionalBooleanValue = ConditionalBooleanValue_2
+public;ConditionalBooleanValue: typeof ConditionalBooleanValue_2
+public;ConditionalStringValue = ConditionalStringValue_2
+public;ConditionalStringValue: typeof ConditionalStringValue_2
 public;ConfigurableBase 
 deprecated;ConfigurableBase 
 public;ConfigurableCreateInfo
@@ -323,10 +327,10 @@ deprecated;FunctionType = (...args: any[]) => any
 beta;getFeatureOverrideSyncEventIds(): string[]
 deprecated;getFeatureOverrideSyncEventIds(): string[]
 internal;getFrontstageStateSettingName(frontstageId: WidgetPanelsFrontstageState["id"]): string
-beta;getIsHiddenIfFeatureOverridesActive(): ConditionalBooleanValue
-deprecated;getIsHiddenIfFeatureOverridesActive(): ConditionalBooleanValue
-beta;getIsHiddenIfSelectionNotActive(): ConditionalBooleanValue
-deprecated;getIsHiddenIfSelectionNotActive(): ConditionalBooleanValue
+beta;getIsHiddenIfFeatureOverridesActive(): ConditionalBooleanValue_2
+deprecated;getIsHiddenIfFeatureOverridesActive(): ConditionalBooleanValue_2
+beta;getIsHiddenIfSelectionNotActive(): ConditionalBooleanValue_2
+deprecated;getIsHiddenIfSelectionNotActive(): ConditionalBooleanValue_2
 internal;getKeyinsFromToolList(toolList: ToolList, localizedKeyinPreference?: KeyinFieldLocalization): KeyinEntry[]
 beta;getListPanel(props: ListPickerProps): React_2.ReactNode
 internal;getPanelSectionId(location: StagePanelLocation, section: StagePanelSection): PanelSectionId

diff --git a/common/changes/@itwin/appui-react/export-conditional-value_2024-09-16-12-56.json b/common/changes/@itwin/appui-react/export-conditional-value_2024-09-16-12-56.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/appui-react",
+      "comment": "Add `ConditionalBooleanValue` and `ConditionalStringValue` class re-exports.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/appui-react"
+}
diff --git a/common/changes/@itwin/core-react/export-conditional-value_2024-09-16-12-56.json b/common/changes/@itwin/core-react/export-conditional-value_2024-09-16-12-56.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-react",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-react"
+}
diff --git a/docs/changehistory/4.4.0.md b/docs/changehistory/4.4.0.md
@@ -26,7 +26,7 @@ Table of contents:
 - Fixed store reset when iModelConnection is cleared.
 - Fixed `clearHideIsolateEmphasizeElements` and `hideElements` button display when view changes happen outside AppUI's API.
 - Fixed `openCursorMenu` function so that it opens cursor menu in Strict Mode in React 18.
-- Fixed `Toolbar` and `ToolbarWithOverflow` to correctly handle `ConditionalStringValue`, `ConditionalBooleanValue` and `ConditionalIconValue` tool item properties.
+- Fixed `Toolbar` and `ToolbarWithOverflow` to correctly handle `ConditionalStringValue`, `ConditionalBooleanValue` and `ConditionalIconItem` tool item properties.
 
 ### Deprecations
 

diff --git a/docs/changehistory/NextVersion.md b/docs/changehistory/NextVersion.md
@@ -6,10 +6,11 @@ Table of contents:
   - [Deprecations](#deprecations)
 - [@itwin/appui-react](#itwinappui-react)
   - [Deprecations](#deprecations-1)
+  - [Additions](#additions)
   - [Changes](#changes)
 - [@itwin/components-react](#itwincomponents-react)
   - [Deprecations](#deprecations-2)
-  - [Additions](#additions)
+  - [Additions](#additions-1)
 
 ## @itwin/core-react
 
@@ -108,6 +109,10 @@ Table of contents:
 - Deprecated `DefaultContentToolsAppData` interface that is a remnant of discontinued frontstage APIs. [#1024](https://github.com/iTwin/appui/pull/1024)
 - Deprecated `StandardContentToolsUiItemsProvider.provideStatusBarItems`, `StandardContentToolsUiItemsProvider.provideToolbarItems`, `StandardNavigationToolsUiItemsProvider.provideToolbarItems`, `StandardStatusbarUiItemsProvider.provideStatusBarItems` methods. Use `get*` variants instead. [#1024](https://github.com/iTwin/appui/pull/1024)
 
+### Additions
+
+- Added `ConditionalBooleanValue` and `ConditionalStringValue` class re-exports from `@itwin/appui-abstract` package. [#1031](https://github.com/iTwin/appui/pull/1031)
+
 ### Changes
 
 - Allow to set the available snap modes in `SnapModeField` component. [#974](https://github.com/iTwin/appui/pull/974)

diff --git a/ui/appui-react/src/appui-react.ts b/ui/appui-react/src/appui-react.ts
@@ -156,6 +156,7 @@ export * from "./appui-react/shared/ActionButtonItemDef";
 export * from "./appui-react/shared/AnyItemDef";
 export * from "./appui-react/shared/AnyToolbarItemDef";
 export * from "./appui-react/shared/CommandItemDef";
+export * from "./appui-react/shared/ConditionalValue";
 export * from "./appui-react/shared/CustomItemDef";
 export * from "./appui-react/shared/CustomItemProps";
 export * from "./appui-react/shared/GroupItemProps";

diff --git a/ui/appui-react/src/appui-react/shared/ConditionalValue.ts b/ui/appui-react/src/appui-react/shared/ConditionalValue.ts
@@ -16,6 +16,7 @@ import { ConditionalIconItem as _ConditionalIconItem } from "@itwin/core-react";
  * @public
  */
 export type ConditionalBooleanValue = _ConditionalBooleanValue;
+/** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ConditionalBooleanValue = _ConditionalBooleanValue;
 
@@ -24,14 +25,6 @@ export const ConditionalBooleanValue = _ConditionalBooleanValue;
  * @public
  */
 export type ConditionalStringValue = _ConditionalStringValue;
+/** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ConditionalStringValue = _ConditionalStringValue;
-
-/** Class used to return an icon value. The value is refreshed by using the specified function. The `syncEventIds` define
- * events that would require the `iconGetter` function to be rerun.
- * @public
- */
-// eslint-disable-next-line deprecation/deprecation
-export type ConditionalIconValue = _ConditionalIconItem;
-// eslint-disable-next-line @typescript-eslint/no-redeclare, deprecation/deprecation
-export const ConditionalIconValue = _ConditionalIconItem;
diff --git a/ui/appui-react/src/appui-react/toolbar/ToolbarItemsManager.ts b/ui/appui-react/src/appui-react/toolbar/ToolbarItemsManager.ts
@@ -11,13 +11,13 @@ import {
   ConditionalStringValue,
 } from "@itwin/appui-abstract";
 import { BeEvent } from "@itwin/core-bentley";
+import { ConditionalIconItem } from "@itwin/core-react";
 import type {
   ToolbarActionItem,
   ToolbarGroupItem,
   ToolbarItem,
 } from "./ToolbarItem";
 import { isToolbarGroupItem } from "./ToolbarItem";
-import { ConditionalIconValue } from "../shared/ConditionalValue";
 
 function isInstance<T>(args: T | ReadonlyArray<T>): args is T {
   return !Array.isArray(args);
@@ -136,7 +136,8 @@ export class ToolbarItemsManager {
           entry.syncEventIds.forEach((eventId: string) =>
             eventIds.add(eventId.toLowerCase())
           );
-        } else if (entry instanceof ConditionalIconValue) {
+          // eslint-disable-next-line deprecation/deprecation
+        } else if (entry instanceof ConditionalIconItem) {
           entry.syncEventIds.forEach((eventId: string) =>
             eventIds.add(eventId.toLowerCase())
           );
@@ -187,8 +188,10 @@ export class ToolbarItemsManager {
         } else if (entry instanceof ConditionalStringValue) {
           if (ConditionalStringValue.refreshValue(entry, eventIds))
             itemsUpdated = true;
-        } else if (entry instanceof ConditionalIconValue) {
-          if (ConditionalIconValue.refreshValue(entry, eventIds))
+          // eslint-disable-next-line deprecation/deprecation
+        } else if (entry instanceof ConditionalIconItem) {
+          // eslint-disable-next-line deprecation/deprecation
+          if (ConditionalIconItem.refreshValue(entry, eventIds))
             itemsUpdated = true;
         }
       }
@@ -229,8 +232,10 @@ export class ToolbarItemsManager {
         } else if (entry instanceof ConditionalStringValue) {
           if (ConditionalStringValue.refreshValue(entry, eventIds))
             updateRequired = true;
-        } else if (entry instanceof ConditionalIconValue) {
-          if (ConditionalIconValue.refreshValue(entry, eventIds))
+          // eslint-disable-next-line deprecation/deprecation
+        } else if (entry instanceof ConditionalIconItem) {
+          // eslint-disable-next-line deprecation/deprecation
+          if (ConditionalIconItem.refreshValue(entry, eventIds))
             updateRequired = true;
         }
       }

diff --git a/ui/appui-react/src/test/shared/ConditionalValue.test.ts b/ui/appui-react/src/test/shared/ConditionalValue.test.ts
@@ -2,17 +2,20 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { ConditionalIconItem } from "@itwin/core-react";
-import { ConditionalIconValue } from "../../appui-react/shared/ConditionalValue";
+import { ConditionalStringValue as AbstractConditionalStringValue } from "@itwin/appui-abstract";
+import { ConditionalStringValue } from "../../appui-react/shared/ConditionalValue";
 
-describe("ConditionalIconValue", () => {
+describe("ConditionalStringValue", () => {
   it("should use the same type for instanceof check", () => {
-    const item = new ConditionalIconItem(() => "item", []);
-    const value = new ConditionalIconValue(() => "value", []);
+    const abstractValue = new AbstractConditionalStringValue(
+      () => "abstractValue",
+      []
+    );
+    const value = new ConditionalStringValue(() => "value", []);
 
-    expect(item instanceof ConditionalIconItem).toBe(true);
-    expect(value instanceof ConditionalIconItem).toBe(true);
-    expect(item instanceof ConditionalIconValue).toBe(true);
-    expect(value instanceof ConditionalIconValue).toBe(true);
+    expect(abstractValue instanceof AbstractConditionalStringValue).toBe(true);
+    expect(value instanceof AbstractConditionalStringValue).toBe(true);
+    expect(value instanceof ConditionalStringValue).toBe(true);
+    expect(value instanceof ConditionalStringValue).toBe(true);
   });
 });
diff --git a/ui/core-react/src/core-react/icons/ConditionalIconItem.tsx b/ui/core-react/src/core-react/icons/ConditionalIconItem.tsx
@@ -12,7 +12,7 @@ import type { IconSpec } from "./IconComponent";
 
 /** Class used to return an icon. The icon is variable and can be changed in response to subscribed event ids.
  * @public
- * @deprecated in 4.16.0. Use {@link @itwin/appui-react#ConditionalIconValue} instead.
+ * @deprecated in 4.16.0. Uses a deprecated {@link IconSpec} type. Use conditional rendering to render different icons.
  */
 export class ConditionalIconItem {
   private _value?: IconSpec;