@sequencing/design-system 1.0.65 → 1.0.67

package/dist/documentation.json

@@ -2771,7 +2771,7 @@
       },
       "homePageUrl": {
         "defaultValue": "/",
-        "description": "The URL of the site's home page. It will be used when the user clicks on the site's logo.\n\nPLEASE NOTE: If you want to use the SOFT navigation from your framework (React, NextJs, etc), you should\npath the `onRequestHomePage` prop and call the navigation method in the callback.\ne.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`\nWARNING: Do not change or modify url argument inside your callback, because you will have undocumented behavior\nwith your navigation. Your goal is only call the navigation method with the url argument.\nDefault value is `/`.\nWithout the `onRequestHomePage` prop, the component will use the default behavior of the anchor tag.",
+        "description": "The URL of the site's home page. It will be used when the user clicks on the site's logo.\n\nPLEASE NOTE: If you want to use the SOFT navigation from your framework (React, NextJs, etc), you should\npath the `onRequestHomePage` prop and call the navigation method in the callback.\ne.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`\nWARNING: Do not change or modify url argument inside your callback, because you will have undocumented behavior\nwith your navigation. Your goal is only call the navigation method with the url argument.\nWithout the `onRequestHomePage` prop, the component will use the default behavior of the anchor tag.\nDefault: `/`.",
         "name": "homePageUrl",
         "required": false,
         "type": "string"
@@ -2784,15 +2784,15 @@
         "type": "boolean"
       },
       "myAccountUrl": {
-        "defaultValue": null,
-        "description": "The URL of user's account page",
+        "defaultValue": "/account/personal-information",
+        "description": "The URL of user's account page. Default: ``/account/personal-information``",
         "name": "myAccountUrl",
-        "required": true,
+        "required": false,
         "type": "string"
       },
       "numberOfSkeletonLinks": {
         "defaultValue": "6",
-        "description": "Specify number of skeleton links to display during loading. Default value is 6",
+        "description": "Specify number of skeleton links to display during loading. Default: 6",
         "name": "numberOfSkeletonLinks",
         "required": false,
         "type": "number"
@@ -2802,21 +2802,21 @@
         "description": "Link clicks callback. Use it together with ``preventHardNavigation``\nto support different routers (Next, react-router-dom, etc.).\nNOTE: When ``preventHardNavigation`` is disabled, it has no effect.",
         "name": "onLinkClick",
         "required": false,
-        "type": "((url: string) => void)"
+        "type": "((linkUrl: string) => void)"
       },
       "onRequestHomePage": {
         "defaultValue": null,
         "description": "Called when a user clicks on the site's logo, provide url argument to callback.\nTypically used to make soft navigation in your framework (React, NextJs, etc).\ne.g. for NextJs `onRequestHomePage={(url) => router.push(url)}`\nurl argument is the `homePageUrl` prop value.",
         "name": "onRequestHomePage",
         "required": false,
-        "type": "((url: string) => void)"
+        "type": "((homePageUrl: string) => void)"
       },
       "onRequestMyAccount": {
         "defaultValue": null,
-        "description": "Called when an authenticated user clicks on the My Account link inside the main right HeaderChip",
+        "description": "Called when an authenticated user clicks on the My Account link inside the main right HeaderChip.\nThe url parameter is ``myAccountUrl``",
         "name": "onRequestMyAccount",
         "required": false,
-        "type": "(() => void)"
+        "type": "((myAccountUrl: string) => void)"
       },
       "onRequestSignIn": {
         "defaultValue": null,
@@ -2832,6 +2832,13 @@
         "required": false,
         "type": "(() => void)"
       },
+      "preventHardNavigation": {
+        "defaultValue": null,
+        "description": "When enabled, it avoids setting ``document.location.href`` upon link clicks and you will be\nresponsible for handling the navigation through the ``onLinkClick`` function.\nThis enables soft navigation for apps that want to support it.",
+        "name": "preventHardNavigation",
+        "required": false,
+        "type": "boolean"
+      },
       "searchComponent": {
         "defaultValue": null,
         "description": "A React node with the search component containing:\n- A button to toggle the visibility of the search bar\n- A div with the search bar implementation",
@@ -2846,13 +2853,6 @@
         "required": false,
         "type": "User"
       },
-      "preventHardNavigation": {
-        "defaultValue": null,
-        "description": "When enabled, it avoids setting ``document.location.href`` upon link clicks and you will be\nresponsible for handling the navigation through the ``onLinkClick`` function.\nThis enables soft navigation for apps that want to support it.",
-        "name": "preventHardNavigation",
-        "required": false,
-        "type": "boolean"
-      },
       "ref": {
         "defaultValue": null,
         "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}",