@sequencing/design-system 1.0.66 → 1.0.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2802,21 +2802,21 @@
2802
2802
  "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.",
2803
2803
  "name": "onLinkClick",
2804
2804
  "required": false,
2805
- "type": "((url: string) => void)"
2805
+ "type": "((linkUrl: string) => void)"
2806
2806
  },
2807
2807
  "onRequestHomePage": {
2808
2808
  "defaultValue": null,
2809
- "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.",
2809
+ "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.\nNOTE: When ``preventHardNavigation`` is disabled, it has no effect and the user will be hard redirected\nto ``homePageUrl``.",
2810
2810
  "name": "onRequestHomePage",
2811
2811
  "required": false,
2812
- "type": "((url: string) => void)"
2812
+ "type": "((homePageUrl: string) => void)"
2813
2813
  },
2814
2814
  "onRequestMyAccount": {
2815
2815
  "defaultValue": null,
2816
- "description": "Called when an authenticated user clicks on the My Account link inside the main right HeaderChip",
2816
+ "description": "Called when an authenticated user clicks on the My Account link inside the main right HeaderChip.\nThe url parameter is ``myAccountUrl``.\nNOTE: When ``preventHardNavigation`` is disabled, it has no effect and the user will be hard redirected\nto ``myAccountUrl``.",
2817
2817
  "name": "onRequestMyAccount",
2818
2818
  "required": false,
2819
- "type": "(() => void)"
2819
+ "type": "((myAccountUrl: string) => void)"
2820
2820
  },
2821
2821
  "onRequestSignIn": {
2822
2822
  "defaultValue": null,
@@ -2832,6 +2832,13 @@
2832
2832
  "required": false,
2833
2833
  "type": "(() => void)"
2834
2834
  },
2835
+ "preventHardNavigation": {
2836
+ "defaultValue": null,
2837
+ "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.",
2838
+ "name": "preventHardNavigation",
2839
+ "required": false,
2840
+ "type": "boolean"
2841
+ },
2835
2842
  "searchComponent": {
2836
2843
  "defaultValue": null,
2837
2844
  "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 @@
2846
2853
  "required": false,
2847
2854
  "type": "User"
2848
2855
  },
2849
- "preventHardNavigation": {
2850
- "defaultValue": null,
2851
- "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.",
2852
- "name": "preventHardNavigation",
2853
- "required": false,
2854
- "type": "boolean"
2855
- },
2856
2856
  "ref": {
2857
2857
  "defaultValue": null,
2858
2858
  "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}",