@sequencing/design-system 1.0.24 → 1.0.26

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

@@ -47,8 +47,25 @@ export interface HeaderProps {
     onLinkClick?: (url: string) => void;
     /** Called when an authenticated user clicks on the Sign Out button inside the main right HeaderChip */
     onRequestSignOut?: () => void;
-    /** Called when a user clicks on the site's logo */
-    onRequestHomePage?: () => 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;
+    /**
+     * The URL of the site's home page. It will be used when the user clicks on the site's logo.
+     *
+     * PLEASE NOTE: If you want to use the SOFT navigation from your framework (React, NextJs, etc), you should
+     * path the `onRequestHomePage` prop and call the navigation method in the callback.
+     * 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.
+     */
+    homePageUrl?: string;
     /** Called when an authenticated user clicks on the My Account link inside the main right HeaderChip */
     onRequestMyAccount?: () => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sequencing/design-system",
-	"version": "1.0.24",
+	"version": "1.0.26",
 	"description": "Sequencing Design System",
 	"scripts": {
 		"test": "echo \"Error: no test specified\"",