@sequencing/design-system 1.0.66 → 1.0.68

package/dist/esm/types/components/Organisms/Header/Header.d.ts

@@ -36,20 +36,33 @@ export interface HeaderProps {
      * to support different routers (Next, react-router-dom, etc.).
      * NOTE: When ``preventHardNavigation`` is disabled, it has no effect.
      */
-    onLinkClick?: (url: string) => void;
+    onLinkClick?: (linkUrl: string) => void;
     /**
      * Called when a user clicks on the site's logo, provide url argument to callback.
      * Typically used to make soft navigation in your framework (React, NextJs, etc).
      * e.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`
      * url argument is the `homePageUrl` prop value.
+     * NOTE: When ``preventHardNavigation`` is disabled, it has no effect and the user will be hard redirected
+     * to ``homePageUrl``.
      */
-    onRequestHomePage?: (url: string) => void;
-    /** Called when an authenticated user clicks on the My Account link inside the main right HeaderChip */
-    onRequestMyAccount?: () => void;
+    onRequestHomePage?: (homePageUrl: string) => void;
+    /**
+     * Called when an authenticated user clicks on the My Account link inside the main right HeaderChip.
+     * The url parameter is ``myAccountUrl``.
+     * NOTE: When ``preventHardNavigation`` is disabled, it has no effect and the user will be hard redirected
+     * to ``myAccountUrl``.
+     */
+    onRequestMyAccount?: (myAccountUrl: string) => void;
     /** Called when an anonymous user clicks on the Sign In button inside the auxiliary links section */
     onRequestSignIn?: () => void;
     /** Called when an authenticated user clicks on the Sign Out button inside the main right HeaderChip */
     onRequestSignOut?: () => void;
+    /**
+     * When enabled, it avoids setting ``document.location.href`` upon link clicks and you will be
+     * responsible for handling the navigation through the ``onLinkClick`` function.
+     * This enables soft navigation for apps that want to support it.
+     */
+    preventHardNavigation?: boolean;
     /**
      * A React node with the search component containing:
      * - A button to toggle the visibility of the search bar
@@ -60,12 +73,6 @@ export interface HeaderProps {
      * If the user is authenticated, pass their name and avatar image here
      */
     user?: User;
-    /**
-     * When enabled, it avoids setting ``document.location.href`` upon link clicks and you will be
-     * responsible for handling the navigation through the ``onLinkClick`` function.
-     * This enables soft navigation for apps that want to support it.
-     */
-    preventHardNavigation?: boolean;
 }
 /**
  * This is the default header for Sequencing.

package/dist/index.d.ts

@@ -513,20 +513,33 @@ interface HeaderProps {
      * to support different routers (Next, react-router-dom, etc.).
      * NOTE: When ``preventHardNavigation`` is disabled, it has no effect.
      */
-    onLinkClick?: (url: string) => void;
+    onLinkClick?: (linkUrl: string) => void;
     /**
      * Called when a user clicks on the site's logo, provide url argument to callback.
      * Typically used to make soft navigation in your framework (React, NextJs, etc).
      * e.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`
      * url argument is the `homePageUrl` prop value.
+     * NOTE: When ``preventHardNavigation`` is disabled, it has no effect and the user will be hard redirected
+     * to ``homePageUrl``.
      */
-    onRequestHomePage?: (url: string) => void;
-    /** Called when an authenticated user clicks on the My Account link inside the main right HeaderChip */
-    onRequestMyAccount?: () => void;
+    onRequestHomePage?: (homePageUrl: string) => void;
+    /**
+     * Called when an authenticated user clicks on the My Account link inside the main right HeaderChip.
+     * The url parameter is ``myAccountUrl``.
+     * NOTE: When ``preventHardNavigation`` is disabled, it has no effect and the user will be hard redirected
+     * to ``myAccountUrl``.
+     */
+    onRequestMyAccount?: (myAccountUrl: string) => void;
     /** Called when an anonymous user clicks on the Sign In button inside the auxiliary links section */
     onRequestSignIn?: () => void;
     /** Called when an authenticated user clicks on the Sign Out button inside the main right HeaderChip */
     onRequestSignOut?: () => void;
+    /**
+     * When enabled, it avoids setting ``document.location.href`` upon link clicks and you will be
+     * responsible for handling the navigation through the ``onLinkClick`` function.
+     * This enables soft navigation for apps that want to support it.
+     */
+    preventHardNavigation?: boolean;
     /**
      * A React node with the search component containing:
      * - A button to toggle the visibility of the search bar
@@ -537,12 +550,6 @@ interface HeaderProps {
      * If the user is authenticated, pass their name and avatar image here
      */
     user?: User;
-    /**
-     * When enabled, it avoids setting ``document.location.href`` upon link clicks and you will be
-     * responsible for handling the navigation through the ``onLinkClick`` function.
-     * This enables soft navigation for apps that want to support it.
-     */
-    preventHardNavigation?: boolean;
 }
 /**
  * This is the default header for Sequencing.