fix: switch showLabel to hideLabel for backwards compatibility

Esri · Aug 29, 2023 · 1667a23 · 1667a23
1 parent 4bf3c92
commit 1667a23
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 15 deletions.
diff --git a/packages/common/src/core/types/IHubCardViewModel.ts b/packages/common/src/core/types/IHubCardViewModel.ts
@@ -26,9 +26,10 @@ export interface IBadgeConfig {
   /**
    * whether the label or translated i18nKey
    * should actually render or just be used
-   * for a11y purposes
+   * for a11y purposes. By default, the label
+   * IS rendered
    */
-  showLabel?: boolean;
+  hideLabel?: boolean;
   icon?: string;
   color: string;
   tooltip?: {

diff --git a/packages/common/src/users/view.ts b/packages/common/src/users/view.ts
@@ -1,6 +1,7 @@
 import { IHubSearchResult } from "..";
 import { ResultToCardModelFn } from "../core";
 import {
+  IBadgeConfig,
   IConvertToCardModelOpts,
   IHubCardViewModel,
 } from "../core/types/IHubCardViewModel";
@@ -44,7 +45,7 @@ export const userResultToCardModel: ResultToCardModelFn = (
  * @param locale internationalization locale
  */
 const getSharedUserCardModel = (user: IHubSearchResult): IHubCardViewModel => {
-  const badges = [];
+  const badges = [] as IBadgeConfig[];
   const memberType = user.memberType;
 
   /**
@@ -57,22 +58,25 @@ const getSharedUserCardModel = (user: IHubSearchResult): IHubCardViewModel => {
       badges.push({
         icon: "user-key",
         color: "gray",
-        showLabel: false,
-        tooltip: { i18nKey: "memberBadges.owner" },
+        i18nKey: "badges.members.owner",
+        hideLabel: true,
+        tooltip: { i18nKey: "badges.members.owner" },
       });
     } else if (memberType === "admin") {
       badges.push({
         icon: "user-up",
         color: "gray",
-        showLabel: false,
-        tooltip: { i18nKey: "memberBadges.admin" },
+        i18nKey: "badges.members.admin",
+        hideLabel: true,
+        tooltip: { i18nKey: "badges.members.admin" },
       });
     } else {
       badges.push({
         icon: "user",
         color: "gray",
-        showLabel: false,
-        tooltip: { i18nKey: "memberBadges.member" },
+        i18nKey: "badges.members.member",
+        hideLabel: true,
+        tooltip: { i18nKey: "badges.members.member" },
       });
     }
   }

diff --git a/packages/common/test/users/view.test.ts b/packages/common/test/users/view.test.ts
@@ -70,8 +70,9 @@ describe("user view module:", () => {
           {
             icon: "user-key",
             color: "gray",
-            showLabel: false,
-            tooltip: { i18nKey: "memberBadges.owner" },
+            i18nKey: "badges.members.owner",
+            hideLabel: true,
+            tooltip: { i18nKey: "badges.members.owner" },
           },
         ]);
       });
@@ -85,8 +86,9 @@ describe("user view module:", () => {
           {
             icon: "user-up",
             color: "gray",
-            showLabel: false,
-            tooltip: { i18nKey: "memberBadges.admin" },
+            i18nKey: "badges.members.admin",
+            hideLabel: true,
+            tooltip: { i18nKey: "badges.members.admin" },
           },
         ]);
       });
@@ -100,8 +102,9 @@ describe("user view module:", () => {
           {
             icon: "user",
             color: "gray",
-            showLabel: false,
-            tooltip: { i18nKey: "memberBadges.member" },
+            i18nKey: "badges.members.member",
+            hideLabel: true,
+            tooltip: { i18nKey: "badges.members.member" },
           },
         ]);
       });