@hitachivantara/uikit-react-core 5.74.0 → 5.76.0

package/dist/esm/Badge/Badge.js

@@ -1,31 +1,36 @@
 import { jsxs, jsx } from "react/jsx-runtime";
+import { forwardRef } from "react";
 import { useDefaultProps } from "@hitachivantara/uikit-react-utils";
 import { useClasses } from "./Badge.styles.js";
 import { staticClasses } from "./Badge.styles.js";
 import { HvTypography } from "../Typography/Typography.js";
-const HvBadge = (props) => {
+const HvBadge = forwardRef((props, ref) => {
   const {
     classes: classesProp,
     className,
     showCount = false,
-    count = 0,
+    count: countProp = 0,
     maxCount = 99,
-    label = null,
-    icon = null,
-    text = null,
-    textVariant = void 0,
+    label,
+    icon,
+    text,
+    textVariant,
     ...others
   } = useDefaultProps("HvBadge", props);
   const { classes, cx } = useClasses(classesProp);
-  const renderedCount = count > maxCount ? `${maxCount}+` : count;
-  const renderedCountOrLabel = label || showCount && count > 0 && renderedCount || null;
-  const Component = icon || text && /* @__PURE__ */ jsx(HvTypography, { variant: textVariant, children: text });
-  return /* @__PURE__ */ jsxs("div", { className: cx(classes.root, className), ...others, children: [
-    Component,
-    /* @__PURE__ */ jsx("div", { className: Component ? classes.badgeContainer : void 0, children: /* @__PURE__ */ jsx(
+  const count = typeof label === "number" ? label : countProp;
+  const countValue = count > maxCount ? `${maxCount}+` : count;
+  const renderedCount = showCount && count > 0 ? countValue : "";
+  const renderedCountOrLabel = label && typeof label !== "number" ? label : renderedCount;
+  const children = icon || text && /* @__PURE__ */ jsx(HvTypography, { variant: textVariant, children: text });
+  return /* @__PURE__ */ jsxs("div", { ref, className: cx(classes.root, className), ...others, children: [
+    children,
+    /* @__PURE__ */ jsx("div", { className: cx({ [classes.badgeContainer]: children }), children: /* @__PURE__ */ jsx(
       "div",
       {
         className: cx(classes.badgePosition, {
+          [classes.badgeHidden]: !(count > 0 || renderedCountOrLabel),
+          // TODO: remove unnecessary classes in v6 (hoist+rename `badge` to `badgePosition`)
           [classes.badge]: !!(count > 0 || renderedCountOrLabel),
           [classes.showCount]: !!(!label && renderedCountOrLabel),
           [classes.showLabel]: !!label,
@@ -36,7 +41,7 @@ const HvBadge = (props) => {
       }
     ) })
   ] });
-};
+});
 export {
   HvBadge,
   staticClasses as badgeClasses

package/dist/esm/Badge/Badge.js.map

@@ -1 +1 @@
-{"version":3,"file":"Badge.js","sources":["../../../src/Badge/Badge.tsx"],"sourcesContent":["import {\n  useDefaultProps,\n  type ExtractNames,\n} from \"@hitachivantara/uikit-react-utils\";\n\nimport { HvBaseProps } from \"../types/generic\";\nimport { HvTypography, HvTypographyVariants } from \"../Typography\";\nimport { staticClasses, useClasses } from \"./Badge.styles\";\n\nexport { staticClasses as badgeClasses };\n\nexport type HvBadgeClasses = ExtractNames<typeof useClasses>;\n\nexport interface HvBadgeProps extends HvBaseProps {\n  /**\n   * Count is the number of unread notifications.\n   * Note count and label are mutually exclusive.\n   * count is ignored when label is specified at the same time.\n   */\n  count?: number;\n  /**\n   * True if count should be displayed.\n   * Note showCount and label are mutually exclusive.\n   * showCount is ignored when label is specified at the same time.\n   */\n  showCount?: boolean;\n  /** The maximum number of unread notifications to be displayed */\n  maxCount?: number;\n  /**\n   * Custom text to show in place of count.\n   * Note showCount and label are mutually exclusive.\n   * showCount is ignored when label is specified at the same time.\n   */\n  label?: string;\n  /** Icon which the notification will be attached. */\n  icon?: React.ReactNode;\n  /** Text which the notification will be attached. */\n  text?: string;\n  /** Text variant. */\n  textVariant?: HvTypographyVariants;\n  /** A Jss Object used to override or extend the styles applied to the component. */\n  classes?: HvBadgeClasses;\n}\n\n/**\n * The badge is a component used to notify the user that something has occurred, in the app context.\n */\nexport const HvBadge = (props: HvBadgeProps) => {\n  const {\n    classes: classesProp,\n    className,\n    showCount = false,\n    count = 0,\n    maxCount = 99,\n    label = null,\n    icon = null,\n    text = null,\n    textVariant = undefined,\n    ...others\n  } = useDefaultProps(\"HvBadge\", props);\n\n  const { classes, cx } = useClasses(classesProp);\n\n  const renderedCount = count > maxCount ? `${maxCount}+` : count;\n  // If label is specified and non-empty, render it.\n  // If showCount is specified and count > 0, render the count.\n  // Otherwise, render nothing on the badge.\n  // (Note count=0 should not be rendered to avoid ghosty 0.)\n  const renderedCountOrLabel =\n    label || (showCount && count > 0 && renderedCount) || null;\n  const Component =\n    icon || (text && <HvTypography variant={textVariant}>{text}</HvTypography>);\n\n  return (\n    <div className={cx(classes.root, className)} {...others}>\n      {Component}\n      <div className={Component ? classes.badgeContainer : undefined}>\n        <div\n          className={cx(classes.badgePosition, {\n            [classes.badge]: !!(count > 0 || renderedCountOrLabel),\n            [classes.showCount]: !!(!label && renderedCountOrLabel),\n            [classes.showLabel]: !!label,\n            [classes.badgeIcon]: !!icon,\n            [classes.badgeOneDigit]: String(renderedCountOrLabel).length === 1,\n          })}\n        >\n          {renderedCountOrLabel}\n        </div>\n      </div>\n    </div>\n  );\n};\n"],"names":[],"mappings":";;;;;AA+Ca,MAAA,UAAU,CAAC,UAAwB;AACxC,QAAA;AAAA,IACJ,SAAS;AAAA,IACT;AAAA,IACA,YAAY;AAAA,IACZ,QAAQ;AAAA,IACR,WAAW;AAAA,IACX,QAAQ;AAAA,IACR,OAAO;AAAA,IACP,OAAO;AAAA,IACP,cAAc;AAAA,IACd,GAAG;AAAA,EAAA,IACD,gBAAgB,WAAW,KAAK;AAEpC,QAAM,EAAE,SAAS,GAAG,IAAI,WAAW,WAAW;AAE9C,QAAM,gBAAgB,QAAQ,WAAW,GAAG,QAAQ,MAAM;AAK1D,QAAM,uBACJ,SAAU,aAAa,QAAQ,KAAK,iBAAkB;AACxD,QAAM,YACJ,QAAS,4BAAS,cAAa,EAAA,SAAS,aAAc,UAAK,KAAA,CAAA;AAG3D,SAAA,qBAAC,SAAI,WAAW,GAAG,QAAQ,MAAM,SAAS,GAAI,GAAG,QAC9C,UAAA;AAAA,IAAA;AAAA,wBACA,OAAI,EAAA,WAAW,YAAY,QAAQ,iBAAiB,QACnD,UAAA;AAAA,MAAC;AAAA,MAAA;AAAA,QACC,WAAW,GAAG,QAAQ,eAAe;AAAA,UACnC,CAAC,QAAQ,KAAK,GAAG,CAAC,EAAE,QAAQ,KAAK;AAAA,UACjC,CAAC,QAAQ,SAAS,GAAG,CAAC,EAAE,CAAC,SAAS;AAAA,UAClC,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC;AAAA,UACvB,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC;AAAA,UACvB,CAAC,QAAQ,aAAa,GAAG,OAAO,oBAAoB,EAAE,WAAW;AAAA,QAAA,CAClE;AAAA,QAEA,UAAA;AAAA,MAAA;AAAA,IAAA,GAEL;AAAA,EACF,EAAA,CAAA;AAEJ;"}
+{"version":3,"file":"Badge.js","sources":["../../../src/Badge/Badge.tsx"],"sourcesContent":["import { forwardRef } from \"react\";\nimport {\n  useDefaultProps,\n  type ExtractNames,\n} from \"@hitachivantara/uikit-react-utils\";\n\nimport { HvBaseProps } from \"../types/generic\";\nimport { HvTypography, HvTypographyVariants } from \"../Typography\";\nimport { staticClasses, useClasses } from \"./Badge.styles\";\n\nexport { staticClasses as badgeClasses };\n\nexport type HvBadgeClasses = ExtractNames<typeof useClasses>;\n\nexport interface HvBadgeProps extends HvBaseProps {\n  /**\n   * Count is the number of unread notifications.\n   * Note count and label are mutually exclusive.\n   * count is ignored when label is specified at the same time.\n   * @deprecated use numeric `label` instead\n   */\n  count?: number;\n  /**\n   * True if `count` should be displayed.\n   *\n   * NOTE: `showCount` is ignored when a **non-numeric** `label` is specified.\n   */\n  showCount?: boolean;\n  /** The maximum number of unread notifications to be displayed */\n  maxCount?: number;\n  /**\n   * Badge content to show in.\n   *\n   * If value is numeric, then `showCount` and `maxCount` will show or limit the value respectively.\n   */\n  label?: React.ReactNode;\n  /** Icon which the notification will be attached. */\n  icon?: React.ReactNode;\n  /** Text which the notification will be attached. */\n  text?: string;\n  /** Text variant. */\n  textVariant?: HvTypographyVariants;\n  /** A Jss Object used to override or extend the styles applied to the component. */\n  classes?: HvBadgeClasses;\n}\n\n/**\n * The badge is a component used to notify the user that something has occurred, in the app context.\n */\nexport const HvBadge = forwardRef<\n  // no-indent\n  HTMLDivElement,\n  HvBadgeProps\n>((props, ref) => {\n  const {\n    classes: classesProp,\n    className,\n    showCount = false,\n    count: countProp = 0,\n    maxCount = 99,\n    label,\n    icon,\n    text,\n    textVariant,\n    ...others\n  } = useDefaultProps(\"HvBadge\", props);\n\n  const { classes, cx } = useClasses(classesProp);\n\n  const count = typeof label === \"number\" ? label : countProp;\n  const countValue = count > maxCount ? `${maxCount}+` : count;\n  const renderedCount = showCount && count > 0 ? countValue : \"\";\n  // If label is specified and non-empty, render it.\n  // If showCount is specified and count > 0, render the count.\n  // Otherwise, render nothing on the badge.\n  // (Note count=0 should not be rendered to avoid ghosty 0.)\n  const renderedCountOrLabel =\n    label && typeof label !== \"number\" ? label : renderedCount;\n  const children =\n    icon || (text && <HvTypography variant={textVariant}>{text}</HvTypography>);\n\n  return (\n    <div ref={ref} className={cx(classes.root, className)} {...others}>\n      {children}\n      <div className={cx({ [classes.badgeContainer]: children })}>\n        <div\n          className={cx(classes.badgePosition, {\n            [classes.badgeHidden]: !(count > 0 || renderedCountOrLabel),\n            // TODO: remove unnecessary classes in v6 (hoist+rename `badge` to `badgePosition`)\n            [classes.badge]: !!(count > 0 || renderedCountOrLabel),\n            [classes.showCount]: !!(!label && renderedCountOrLabel),\n            [classes.showLabel]: !!label,\n            [classes.badgeIcon]: !!icon,\n            [classes.badgeOneDigit]: String(renderedCountOrLabel).length === 1,\n          })}\n        >\n          {renderedCountOrLabel}\n        </div>\n      </div>\n    </div>\n  );\n});\n"],"names":[],"mappings":";;;;;;AAiDO,MAAM,UAAU,WAIrB,CAAC,OAAO,QAAQ;AACV,QAAA;AAAA,IACJ,SAAS;AAAA,IACT;AAAA,IACA,YAAY;AAAA,IACZ,OAAO,YAAY;AAAA,IACnB,WAAW;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EAAA,IACD,gBAAgB,WAAW,KAAK;AAEpC,QAAM,EAAE,SAAS,GAAG,IAAI,WAAW,WAAW;AAE9C,QAAM,QAAQ,OAAO,UAAU,WAAW,QAAQ;AAClD,QAAM,aAAa,QAAQ,WAAW,GAAG,QAAQ,MAAM;AACvD,QAAM,gBAAgB,aAAa,QAAQ,IAAI,aAAa;AAK5D,QAAM,uBACJ,SAAS,OAAO,UAAU,WAAW,QAAQ;AAC/C,QAAM,WACJ,QAAS,4BAAS,cAAa,EAAA,SAAS,aAAc,UAAK,KAAA,CAAA;AAG3D,SAAA,qBAAC,OAAI,EAAA,KAAU,WAAW,GAAG,QAAQ,MAAM,SAAS,GAAI,GAAG,QACxD,UAAA;AAAA,IAAA;AAAA,IACD,oBAAC,OAAI,EAAA,WAAW,GAAG,EAAE,CAAC,QAAQ,cAAc,GAAG,UAAU,GACvD,UAAA;AAAA,MAAC;AAAA,MAAA;AAAA,QACC,WAAW,GAAG,QAAQ,eAAe;AAAA,UACnC,CAAC,QAAQ,WAAW,GAAG,EAAE,QAAQ,KAAK;AAAA;AAAA,UAEtC,CAAC,QAAQ,KAAK,GAAG,CAAC,EAAE,QAAQ,KAAK;AAAA,UACjC,CAAC,QAAQ,SAAS,GAAG,CAAC,EAAE,CAAC,SAAS;AAAA,UAClC,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC;AAAA,UACvB,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC;AAAA,UACvB,CAAC,QAAQ,aAAa,GAAG,OAAO,oBAAoB,EAAE,WAAW;AAAA,QAAA,CAClE;AAAA,QAEA,UAAA;AAAA,MAAA;AAAA,IAAA,GAEL;AAAA,EACF,EAAA,CAAA;AAEJ,CAAC;"}

package/dist/esm/Badge/Badge.styles.js

@@ -1,26 +1,37 @@
 import { createClasses } from "@hitachivantara/uikit-react-utils";
 import { theme } from "@hitachivantara/uikit-styles";
-const labelBaseStyle = {
-  ...theme.typography.caption2,
-  padding: "0 5px",
-  color: theme.colors.atmo1,
-  lineHeight: "16px"
-};
 const { staticClasses, useClasses } = createClasses("HvBadge", {
   root: { position: "relative", "&>*": { float: "left" } },
+  /** class applied to the badge container when it has content */
   badgeContainer: { width: 0 },
-  badgePosition: {},
-  badge: {
-    borderRadius: theme.space.xs,
+  /** class applied to the badge */
+  badgePosition: {
+    ...theme.typography.caption2,
+    color: theme.colors.atmo1,
+    borderRadius: theme.radii.full,
     backgroundColor: theme.colors.secondary,
+    lineHeight: "16px",
+    minWidth: 8,
+    padding: "0 5px",
     float: "left",
-    minHeight: "8px",
-    minWidth: "8px"
+    wordBreak: "keep-all",
+    textAlign: "center",
+    ":empty": {
+      height: 8,
+      width: 8,
+      padding: 0
+    }
+  },
+  /** applied to the badge when it's visible */
+  badge: {},
+  /** applied to the badge when it's hidden */
+  badgeHidden: {
+    display: "none"
   },
-  showCount: { ...labelBaseStyle, wordBreak: "keep-all" },
-  showLabel: { ...labelBaseStyle, wordBreak: "keep-all" },
+  showCount: {},
+  showLabel: {},
   badgeIcon: { position: "relative", top: "1px", left: "-7px" },
-  badgeOneDigit: { padding: 0, width: "16px", textAlign: "center" }
+  badgeOneDigit: { padding: 0, width: "16px" }
 });
 export {
   staticClasses,

package/dist/esm/Badge/Badge.styles.js.map

@@ -1 +1 @@
-{"version":3,"file":"Badge.styles.js","sources":["../../../src/Badge/Badge.styles.tsx"],"sourcesContent":["import { createClasses } from \"@hitachivantara/uikit-react-utils\";\nimport { theme } from \"@hitachivantara/uikit-styles\";\n\nconst labelBaseStyle: React.CSSProperties = {\n  ...theme.typography.caption2,\n  padding: \"0 5px\",\n  color: theme.colors.atmo1,\n  lineHeight: \"16px\",\n};\n\nexport const { staticClasses, useClasses } = createClasses(\"HvBadge\", {\n  root: { position: \"relative\", \"&>*\": { float: \"left\" } },\n  badgeContainer: { width: 0 },\n  badgePosition: {},\n  badge: {\n    borderRadius: theme.space.xs,\n    backgroundColor: theme.colors.secondary,\n    float: \"left\",\n    minHeight: \"8px\",\n    minWidth: \"8px\",\n  },\n  showCount: { ...labelBaseStyle, wordBreak: \"keep-all\" },\n  showLabel: { ...labelBaseStyle, wordBreak: \"keep-all\" },\n  badgeIcon: { position: \"relative\", top: \"1px\", left: \"-7px\" },\n  badgeOneDigit: { padding: 0, width: \"16px\", textAlign: \"center\" },\n});\n"],"names":[],"mappings":";;AAGA,MAAM,iBAAsC;AAAA,EAC1C,GAAG,MAAM,WAAW;AAAA,EACpB,SAAS;AAAA,EACT,OAAO,MAAM,OAAO;AAAA,EACpB,YAAY;AACd;AAEO,MAAM,EAAE,eAAe,eAAe,cAAc,WAAW;AAAA,EACpE,MAAM,EAAE,UAAU,YAAY,OAAO,EAAE,OAAO,SAAS;AAAA,EACvD,gBAAgB,EAAE,OAAO,EAAE;AAAA,EAC3B,eAAe,CAAC;AAAA,EAChB,OAAO;AAAA,IACL,cAAc,MAAM,MAAM;AAAA,IAC1B,iBAAiB,MAAM,OAAO;AAAA,IAC9B,OAAO;AAAA,IACP,WAAW;AAAA,IACX,UAAU;AAAA,EACZ;AAAA,EACA,WAAW,EAAE,GAAG,gBAAgB,WAAW,WAAW;AAAA,EACtD,WAAW,EAAE,GAAG,gBAAgB,WAAW,WAAW;AAAA,EACtD,WAAW,EAAE,UAAU,YAAY,KAAK,OAAO,MAAM,OAAO;AAAA,EAC5D,eAAe,EAAE,SAAS,GAAG,OAAO,QAAQ,WAAW,SAAS;AAClE,CAAC;"}
+{"version":3,"file":"Badge.styles.js","sources":["../../../src/Badge/Badge.styles.tsx"],"sourcesContent":["import { createClasses } from \"@hitachivantara/uikit-react-utils\";\nimport { theme } from \"@hitachivantara/uikit-styles\";\n\nexport const { staticClasses, useClasses } = createClasses(\"HvBadge\", {\n  root: { position: \"relative\", \"&>*\": { float: \"left\" } },\n  /** class applied to the badge container when it has content */\n  badgeContainer: { width: 0 },\n  /** class applied to the badge */\n  badgePosition: {\n    ...theme.typography.caption2,\n    color: theme.colors.atmo1,\n    borderRadius: theme.radii.full,\n    backgroundColor: theme.colors.secondary,\n    lineHeight: \"16px\",\n    minWidth: 8,\n    padding: \"0 5px\",\n    float: \"left\",\n    wordBreak: \"keep-all\",\n    textAlign: \"center\",\n\n    \":empty\": {\n      height: 8,\n      width: 8,\n      padding: 0,\n    },\n  },\n  /** applied to the badge when it's visible */\n  badge: {},\n  /** applied to the badge when it's hidden */\n  badgeHidden: {\n    display: \"none\",\n  },\n  showCount: {},\n  showLabel: {},\n  badgeIcon: { position: \"relative\", top: \"1px\", left: \"-7px\" },\n  badgeOneDigit: { padding: 0, width: \"16px\" },\n});\n"],"names":[],"mappings":";;AAGO,MAAM,EAAE,eAAe,eAAe,cAAc,WAAW;AAAA,EACpE,MAAM,EAAE,UAAU,YAAY,OAAO,EAAE,OAAO,SAAS;AAAA;AAAA,EAEvD,gBAAgB,EAAE,OAAO,EAAE;AAAA;AAAA,EAE3B,eAAe;AAAA,IACb,GAAG,MAAM,WAAW;AAAA,IACpB,OAAO,MAAM,OAAO;AAAA,IACpB,cAAc,MAAM,MAAM;AAAA,IAC1B,iBAAiB,MAAM,OAAO;AAAA,IAC9B,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,SAAS;AAAA,IACT,OAAO;AAAA,IACP,WAAW;AAAA,IACX,WAAW;AAAA,IAEX,UAAU;AAAA,MACR,QAAQ;AAAA,MACR,OAAO;AAAA,MACP,SAAS;AAAA,IACX;AAAA,EACF;AAAA;AAAA,EAEA,OAAO,CAAC;AAAA;AAAA,EAER,aAAa;AAAA,IACX,SAAS;AAAA,EACX;AAAA,EACA,WAAW,CAAC;AAAA,EACZ,WAAW,CAAC;AAAA,EACZ,WAAW,EAAE,UAAU,YAAY,KAAK,OAAO,MAAM,OAAO;AAAA,EAC5D,eAAe,EAAE,SAAS,GAAG,OAAO,OAAO;AAC7C,CAAC;"}