@govtechsg/sgds-web-component 3.21.2-rc.2 → 3.21.2-rc.4

package/types/react.d.ts

@@ -171,20 +171,6 @@ Variants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `
   "onsgds-after-hide"?: SgdsEventHandler;
 }
 
-// ── BreadcrumbItem ─────────────────────────────────────────────────────────────
-
-export interface SgdsBreadcrumbItemProps extends SgdsBaseProps {
-  /** Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item */
-  active?: boolean;
-}
-
-// ── Breadcrumb ─────────────────────────────────────────────────────────────
-
-export interface SgdsBreadcrumbProps extends SgdsBaseProps {
-  /** The aria-label of nav element within breadcrumb component. */
-  ariaLabel?: string;
-}
-
 // ── Button ─────────────────────────────────────────────────────────────
 
 export interface SgdsButtonProps extends SgdsBaseProps {
@@ -215,7 +201,7 @@ value of this attribute must be an id of a form in the same document or shadow r
   hasLeftIconSlot?: boolean;
   /** Used only for SSR to indicate the presence of the `rightIcon` slot. */
   hasRightIconSlot?: boolean;
-  /** Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6 */
+  /** Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant="primary"` with `tone="danger"` instead. */
   variant?: "primary" | "outline" | "ghost" | "danger";
   /** Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral` */
   tone?: "brand" | "danger" | "fixed-light" | "neutral";
@@ -239,6 +225,20 @@ value of this attribute must be an id of a form in the same document or shadow r
   "onsgds-focus"?: SgdsEventHandler;
 }
 
+// ── BreadcrumbItem ─────────────────────────────────────────────────────────────
+
+export interface SgdsBreadcrumbItemProps extends SgdsBaseProps {
+  /** Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item */
+  active?: boolean;
+}
+
+// ── Breadcrumb ─────────────────────────────────────────────────────────────
+
+export interface SgdsBreadcrumbProps extends SgdsBaseProps {
+  /** The aria-label of nav element within breadcrumb component. */
+  ariaLabel?: string;
+}
+
 // ── Card ─────────────────────────────────────────────────────────────
 
 export interface SgdsCardProps extends SgdsBaseProps {
@@ -674,7 +674,7 @@ export interface SgdsIconProps extends SgdsBaseProps {
 export interface SgdsIconButtonProps extends SgdsBaseProps {
   /** The name of the icon from sgds icon library */
   name?: string;
-  /** Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6 */
+  /** Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant="primary"` with `tone="danger"` instead. */
   variant?: "primary" | "outline" | "ghost" | "danger";
   /** Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral` */
   tone?: "brand" | "danger" | "fixed-light" | "neutral";
@@ -1562,9 +1562,9 @@ declare module "react" {
       "sgds-alert-link": React.DetailedHTMLProps<SgdsAlertLinkProps, HTMLElement>;
       "sgds-alert": React.DetailedHTMLProps<SgdsAlertProps, HTMLElement>;
       "sgds-badge": React.DetailedHTMLProps<SgdsBadgeProps, HTMLElement>;
+      "sgds-button": React.DetailedHTMLProps<SgdsButtonProps, HTMLElement>;
       "sgds-breadcrumb-item": React.DetailedHTMLProps<SgdsBreadcrumbItemProps, HTMLElement>;
       "sgds-breadcrumb": React.DetailedHTMLProps<SgdsBreadcrumbProps, HTMLElement>;
-      "sgds-button": React.DetailedHTMLProps<SgdsButtonProps, HTMLElement>;
       "sgds-card": React.DetailedHTMLProps<SgdsCardProps, HTMLElement>;
       "sgds-checkbox-group": React.DetailedHTMLProps<SgdsCheckboxGroupProps, HTMLElement>;
       "sgds-checkbox": React.DetailedHTMLProps<SgdsCheckboxProps, HTMLElement>;
@@ -1645,9 +1645,9 @@ declare global {
     "sgds-alert-link": HTMLElement;
     "sgds-alert": HTMLElement;
     "sgds-badge": HTMLElement;
+    "sgds-button": HTMLElement;
     "sgds-breadcrumb-item": HTMLElement;
     "sgds-breadcrumb": HTMLElement;
-    "sgds-button": HTMLElement;
     "sgds-card": HTMLElement;
     "sgds-checkbox-group": HTMLElement;
     "sgds-checkbox": HTMLElement;