@sequencing/design-system 1.0.65 → 1.0.67

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

@@ -22,34 +22,43 @@ export interface HeaderProps {
      * e.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`
      * WARNING: Do not change or modify url argument inside your callback, because you will have undocumented behavior
      * with your navigation. Your goal is only call the navigation method with the url argument.
-     * Default value is `/`.
      * Without the `onRequestHomePage` prop, the component will use the default behavior of the anchor tag.
+     * Default: `/`.
      */
     homePageUrl?: string;
     /** Displays loading skeleton animation when set to `true` */
     isLoading?: boolean;
-    /** The URL of user's account page */
-    myAccountUrl: string;
-    /** Specify number of skeleton links to display during loading. Default value is 6 */
+    /** The URL of user's account page. Default: ``/account/personal-information`` */
+    myAccountUrl?: string;
+    /** Specify number of skeleton links to display during loading. Default: 6 */
     numberOfSkeletonLinks?: number;
     /** Link clicks callback. Use it together with ``preventHardNavigation``
      * 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.
      */
-    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``
+     */
+    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 +69,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

@@ -499,34 +499,43 @@ interface HeaderProps {
      * e.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`
      * WARNING: Do not change or modify url argument inside your callback, because you will have undocumented behavior
      * with your navigation. Your goal is only call the navigation method with the url argument.
-     * Default value is `/`.
      * Without the `onRequestHomePage` prop, the component will use the default behavior of the anchor tag.
+     * Default: `/`.
      */
     homePageUrl?: string;
     /** Displays loading skeleton animation when set to `true` */
     isLoading?: boolean;
-    /** The URL of user's account page */
-    myAccountUrl: string;
-    /** Specify number of skeleton links to display during loading. Default value is 6 */
+    /** The URL of user's account page. Default: ``/account/personal-information`` */
+    myAccountUrl?: string;
+    /** Specify number of skeleton links to display during loading. Default: 6 */
     numberOfSkeletonLinks?: number;
     /** Link clicks callback. Use it together with ``preventHardNavigation``
      * 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.
      */
-    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``
+     */
+    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 +546,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.