@butternutbox/pawprint-native 1.0.0 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@butternutbox/pawprint-native",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "description": "ButternutBox Pawprint Design System - React Native Components",
   "main": "./dist/index.cjs",

package/src/components/molecules/ProductDisplayCard/ProductDisplayCard.stories.tsx

@@ -38,7 +38,12 @@ export default {
     quantityBadge: {
       control: { type: "boolean" },
       description:
-        "Show a quantity badge over the image instead of the picker (mutually exclusive with the quantity picker)"
+        "@deprecated — use `thumbnailBadge`. Show a legacy quantity badge over the image instead of the picker."
+    },
+    thumbnailBadge: {
+      control: false,
+      description:
+        "Render a Badge over the image (accepts any BadgeProps). Mutually exclusive with the quantity picker."
     },
     disableQuantityButtons: {
       control: { type: "boolean" },
@@ -277,10 +282,42 @@ export const WithCustomBanner = () => (
   </View>
 )
 
+export const WithThumbnailBadge = () => (
+  <View style={styles.column}>
+    {/* Consumer controls the badge content and variant. */}
+    <ProductDisplayCard
+      title="Recipe Name"
+      subtext="+£0.00/pouch"
+      showSubtext
+      thumbnailBadge={{ variant: "primary", size: "large", children: "New" }}
+      image={placeholderImageUrl}
+    />
+    <ProductDisplayCard
+      title="Recipe Name"
+      subtext="+£0.00/pouch"
+      showSubtext
+      thumbnailBadge={{ variant: "promo", size: "large", children: "Popular" }}
+      image={placeholderImageUrl}
+    />
+    {/* Suppresses the picker even when showQuantityPicker is set. */}
+    <ProductDisplayCard
+      title="Recipe Name"
+      subtext="+£0.00/pouch"
+      showSubtext
+      quantity={2}
+      showQuantityPicker
+      thumbnailBadge={{ variant: "primary", size: "large", children: "2" }}
+      image={placeholderImageUrl}
+    />
+  </View>
+)
+
+/**
+ * @deprecated Prefer `thumbnailBadge`. This story documents the legacy
+ * `quantityBadge` prop behaviour during the deprecation window.
+ */
 export const WithQuantityBadge = () => (
   <View style={styles.column}>
-    {/* OOB recipe / Extras card: quantity shown as a badge over the image
-        instead of the picker. The two are mutually exclusive. */}
     <ProductDisplayCard
       title="Recipe Name"
       subtext="+£0.00/pouch"
@@ -289,8 +326,6 @@ export const WithQuantityBadge = () => (
       quantityBadge
       image={placeholderImageUrl}
     />
-    {/* Even with showQuantityPicker set, the badge wins and the picker is
-        suppressed. */}
     <ProductDisplayCard
       title="Recipe Name"
       subtext="+£0.00/pouch"

package/src/components/molecules/ProductDisplayCard/ProductDisplayCard.test.tsx

@@ -242,4 +242,59 @@ describe("ProductDisplayCard (Native)", () => {
     // ...and the picker input is not rendered.
     expect(screen.queryByDisplayValue("3")).toBeFalsy()
   })
+
+  it("renders a thumbnailBadge from BadgeProps", () => {
+    renderWithTheme(
+      <ProductDisplayCard
+        title="Test Product"
+        thumbnailBadge={{ variant: "primary", size: "large", children: "New" }}
+        image={
+          <View>
+            <Text>Image</Text>
+          </View>
+        }
+      />
+    )
+
+    expect(screen.getByText("New")).toBeTruthy()
+  })
+
+  it("suppresses the quantity picker when thumbnailBadge is set", () => {
+    renderWithTheme(
+      <ProductDisplayCard
+        title="Test Product"
+        quantity={2}
+        thumbnailBadge={{ children: "New" }}
+        showQuantityPicker
+        image={
+          <View>
+            <Text>Image</Text>
+          </View>
+        }
+      />
+    )
+
+    expect(screen.getByText("New")).toBeTruthy()
+    expect(screen.queryByDisplayValue("2")).toBeFalsy()
+  })
+
+  it("prefers thumbnailBadge over the deprecated quantityBadge when both are set", () => {
+    renderWithTheme(
+      <ProductDisplayCard
+        title="Test Product"
+        quantity={9}
+        quantityBadge
+        thumbnailBadge={{ children: "Popular" }}
+        image={
+          <View>
+            <Text>Image</Text>
+          </View>
+        }
+      />
+    )
+
+    expect(screen.getByText("Popular")).toBeTruthy()
+    // The legacy quantity badge should not render alongside it.
+    expect(screen.queryByText("9")).toBeFalsy()
+  })
 })

package/src/components/molecules/ProductDisplayCard/ProductDisplayCard.tsx

@@ -3,7 +3,7 @@ import { View, ViewProps, Image, Pressable } from "react-native"
 import styled from "@emotion/native"
 import { useTheme } from "@emotion/react"
 import { Typography } from "../../atoms/Typography"
-import { Badge } from "../../atoms/Badge"
+import { Badge, type BadgeProps } from "../../atoms/Badge"
 import { NumberField } from "../../molecules/NumberField"
 import { Notification } from "../Notification"
 import { parseTokenValue } from "../../../utils"
@@ -16,12 +16,25 @@ export type ProductDisplayCardProps = ViewProps & {
   onQuantityChange?: (quantity: number) => void
   showQuantityPicker?: boolean
   /**
+   * @deprecated Use `thumbnailBadge` instead. When both are set, `thumbnailBadge`
+   * wins. This prop will be removed in a future major release.
+   *
    * Show a quantity badge overlaid on the top-right of the image (rendering the
    * current `quantity`) instead of the quantity picker. Defaults to `false`.
    * The badge and the quantity picker are mutually exclusive — only one shows
    * at a time; when `quantityBadge` is true the picker is never rendered.
    */
   quantityBadge?: boolean
+  /**
+   * Render a `Badge` overlaid on the top-right of the image. Accepts any
+   * `BadgeProps` (variant, size, icon, children, etc.) — pass them as an object.
+   * Mutually exclusive with the quantity picker: when set, the picker is never
+   * rendered.
+   *
+   * @example
+   * thumbnailBadge={{ variant: "primary", size: "large", children: "New" }}
+   */
+  thumbnailBadge?: BadgeProps
   disableQuantityButtons?: boolean
   hideQuantityButtons?: boolean
   incrementDisabled?: boolean
@@ -194,9 +207,14 @@ const StyledNoneBanner = styled(View)(({ theme }) => {
  * @param quantity - *(optional)* Current quantity value
  * @param onQuantityChange - *(optional)* Callback when quantity changes
  * @param showQuantityPicker - *(optional)* Show/hide quantity picker
- * @param quantityBadge - *(optional)* Show a quantity badge over the image instead
- *   of the picker (renders the current `quantity`). Mutually exclusive with the
- *   quantity picker; defaults to `false`. Used on OOB recipe and Extras cards.
+ * @param quantityBadge - *(optional)* **@deprecated** — use `thumbnailBadge` instead.
+ *   Show a legacy quantity badge over the image (renders the current `quantity`
+ *   as a primary/large Badge). Mutually exclusive with the picker; defaults to
+ *   `false`. When both `thumbnailBadge` and `quantityBadge` are set, `thumbnailBadge`
+ *   wins.
+ * @param thumbnailBadge - *(optional)* Render a `Badge` overlaid on the top-right
+ *   of the image. Accepts any `BadgeProps` (`variant`, `size`, `icon`, `children`, …).
+ *   Mutually exclusive with the quantity picker.
  * @param quantityStep - *(optional)* Increment/decrement amount (default: 1)
  * @param image - *(optional)* Image URL string or React element
  * @param banner - *(optional)* Banner content string or React element to show below card
@@ -217,6 +235,7 @@ export const ProductDisplayCard = React.forwardRef<
       onQuantityChange,
       showQuantityPicker = false,
       quantityBadge = false,
+      thumbnailBadge,
       disableQuantityButtons = false,
       hideQuantityButtons = false,
       incrementDisabled = false,
@@ -241,6 +260,15 @@ export const ProductDisplayCard = React.forwardRef<
       }
     }
 
+    // `thumbnailBadge` supersedes the deprecated `quantityBadge`. When set,
+    // consumers control the entire badge; when unset, the legacy `quantityBadge`
+    // boolean falls back to the previous hardcoded quantity chip.
+    const resolvedBadgeProps: BadgeProps | undefined =
+      thumbnailBadge ??
+      (quantityBadge
+        ? { variant: "primary", size: "large", children: String(quantity) }
+        : undefined)
+
     const cardContent = (
       <StyledCardContainer
         ref={ref}
@@ -262,11 +290,9 @@ export const ProductDisplayCard = React.forwardRef<
               ) : (
                 image
               )}
-              {quantityBadge && (
+              {resolvedBadgeProps && (
                 <StyledBadgeOverlay pointerEvents="none">
-                  <Badge variant="primary" size="large">
-                    {String(quantity)}
-                  </Badge>
+                  <Badge {...resolvedBadgeProps} />
                 </StyledBadgeOverlay>
               )}
             </StyledImage>
@@ -286,7 +312,7 @@ export const ProductDisplayCard = React.forwardRef<
             )}
           </StyledTextContainer>
 
-          {showQuantityPicker && !quantityBadge && (
+          {showQuantityPicker && !resolvedBadgeProps && (
             <View style={{ marginLeft: "auto" }}>
               <NumberField
                 size="sm"