docs: add some types and renmae supportedSearchParams

SpecterOps · Feb 28, 2025 · 3420138 · 3420138
1 parent d49b5cb
commit 3420138
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 12 deletions.
diff --git a/packages/javascript/bh-shared-ui/src/components/Navigation/MainNav.test.tsx b/packages/javascript/bh-shared-ui/src/components/Navigation/MainNav.test.tsx
@@ -42,15 +42,15 @@ const MainNavLogoData: MainNavLogoDataObject = {
             altText: 'BHE Text Logo',
         },
     },
-    persistentSearchParams: GloballySupportedSearchParams,
+    supportedSearchParams: GloballySupportedSearchParams,
 };
 const MainNavPrimaryListData: MainNavDataListItem[] = [
     {
         label: 'Link Item',
         icon: <AppIcon.LineChart size={24} />,
         route: '/test',
         testId: 'global_nav-test-link',
-        persistentSearchParams: GloballySupportedSearchParams,
+        supportedSearchParams: GloballySupportedSearchParams,
     },
 ];
 
@@ -62,7 +62,7 @@ const MainNavSecondaryListData: MainNavDataListItem[] = [
         icon: <AppIcon.LineChart size={24} />,
         functionHandler: handleClick,
         testId: 'global_nav-test-action',
-        persistentSearchParams: GloballySupportedSearchParams,
+        supportedSearchParams: GloballySupportedSearchParams,
     },
 ];
 

diff --git a/packages/javascript/bh-shared-ui/src/components/Navigation/MainNav.tsx b/packages/javascript/bh-shared-ui/src/components/Navigation/MainNav.tsx
@@ -86,9 +86,9 @@ const MainNavItemLink: FC<{
     children: ReactNode;
     hoverActive: boolean;
     testId: string;
-    persistentSearchParams: MainNavDataListItem['persistentSearchParams'];
-}> = ({ route, children, hoverActive, testId, persistentSearchParams }) => {
-    const search = persistentSearchParams ? persistSearchParams(persistentSearchParams).toString() : undefined;
+    supportedSearchParams: MainNavDataListItem['supportedSearchParams'];
+}> = ({ route, children, hoverActive, testId, supportedSearchParams }) => {
+    const search = supportedSearchParams ? persistSearchParams(supportedSearchParams).toString() : undefined;
 
     return (
         // Note: The w-full is to avoid the hover area to overflow out of the nav when its collapsed
@@ -192,7 +192,7 @@ const MainNav: FC<{ mainNavData: MainNavData }> = ({ mainNavData }) => {
             )}>
             <MainNavItemLink
                 route={mainNavData.logo.project.route}
-                persistentSearchParams={mainNavData.logo.persistentSearchParams}
+                supportedSearchParams={mainNavData.logo.supportedSearchParams}
                 testId='global_nav-home'
                 hoverActive={!isMouseDragging}>
                 <MainNavItemLabel
@@ -213,7 +213,7 @@ const MainNav: FC<{ mainNavData: MainNavData }> = ({ mainNavData }) => {
                                 route={listDataItem.route as string}
                                 hoverActive={!isMouseDragging}
                                 testId={listDataItem.testId}
-                                persistentSearchParams={listDataItem.persistentSearchParams}>
+                                supportedSearchParams={listDataItem.supportedSearchParams}>
                                 <MainNavItemLabel
                                     icon={listDataItem.icon}
                                     label={listDataItem.label}
@@ -234,7 +234,7 @@ const MainNav: FC<{ mainNavData: MainNavData }> = ({ mainNavData }) => {
                                     route={listDataItem.route as string}
                                     hoverActive={!isMouseDragging}
                                     testId={listDataItem.testId}
-                                    persistentSearchParams={listDataItem.persistentSearchParams}>
+                                    supportedSearchParams={listDataItem.supportedSearchParams}>
                                     <MainNavItemLabel
                                         icon={listDataItem.icon}
                                         label={listDataItem.label}

diff --git a/packages/javascript/bh-shared-ui/src/components/Navigation/index.ts b/packages/javascript/bh-shared-ui/src/components/Navigation/index.ts
@@ -16,5 +16,6 @@
 
 import MainNav from './MainNav';
 import SubNav from './SubNav';
+import { MainNavData } from './types';
 
-export { MainNav, SubNav };
+export { MainNav, SubNav, type MainNavData };
diff --git a/packages/javascript/bh-shared-ui/src/components/Navigation/types.ts b/packages/javascript/bh-shared-ui/src/components/Navigation/types.ts
@@ -32,14 +32,14 @@ export type MainNavLogoDataObject = {
     specterOps: {
         image: MainNavLogoImage;
     };
-    persistentSearchParams?: string[];
+    supportedSearchParams?: string[];
 };
 
 export type MainNavDataListItem = {
     label: string | ReactNode;
     icon: ReactNode;
     route?: string;
-    persistentSearchParams?: string[];
+    supportedSearchParams?: string[];
     functionHandler?: () => void;
     testId: string;
 };