@khanacademy/wonder-blocks-card 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @khanacademy/wonder-blocks-card
 
+## 1.2.0
+
+### Minor Changes
+
+- 607595f: Adds support for image backgrounds via the background prop
+
+### Patch Changes
+
+- @khanacademy/wonder-blocks-icon-button@10.5.3
+
 ## 1.1.0
 
 ### Minor Changes

package/dist/es/index.js

@@ -2,13 +2,13 @@ import { jsx, jsxs } from 'react/jsx-runtime';
 import * as React from 'react';
 import { StyleSheet } from 'aphrodite';
 import { View } from '@khanacademy/wonder-blocks-core';
-import { sizing, semanticColor, border, boxShadow } from '@khanacademy/wonder-blocks-tokens';
+import { sizing, semanticColor, border, boxShadow, font } from '@khanacademy/wonder-blocks-tokens';
 import xIcon from '@phosphor-icons/core/bold/x-bold.svg';
 import IconButton from '@khanacademy/wonder-blocks-icon-button';
 import { focusStyles } from '@khanacademy/wonder-blocks-styles';
 
 const DismissButton=props=>{const{onClick,style,testId}=props;return jsx(IconButton,{icon:xIcon,"aria-label":props["aria-label"]||"Close",onClick:onClick,kind:"tertiary",actionType:"neutral",style:[componentStyles.root,style],testId:testId})};const componentStyles=StyleSheet.create({root:{position:"absolute",insetInlineEnd:sizing.size_080,top:sizing.size_080,zIndex:1,":focus":focusStyles.focus[":focus-visible"]}});
 
-const Card=React.forwardRef(function Card(props,ref){const{styles,labels,tag,testId,background="base-default",borderRadius="small",paddingSize="small",elevation="none",children,onDismiss,inert}=props;const componentStyles=getComponentStyles({background,borderRadius,paddingSize,elevation});return jsxs(View,{"aria-label":labels?.cardAriaLabel,style:[componentStyles.root,styles?.root],ref:ref,tag:tag,testId:testId,inert:inert?"":undefined,children:[onDismiss?jsx(DismissButton,{"aria-label":labels?.dismissButtonAriaLabel||"Close",onClick:e=>onDismiss?.(e)}):null,children]})});const getComponentStyles=({background,borderRadius,paddingSize,elevation})=>{const styleMap={backgroundColor:{"base-subtle":semanticColor.core.background.base.subtle,"base-default":semanticColor.core.background.base.default},borderRadius:{small:border.radius.radius_080,medium:border.radius.radius_120},padding:{none:sizing.size_0,small:sizing.size_160,medium:sizing.size_240},elevation:{none:"none",low:boxShadow.low}};return StyleSheet.create({root:{backgroundColor:background&&styleMap.backgroundColor[background],borderColor:semanticColor.core.border.neutral.subtle,borderStyle:"solid",borderRadius:borderRadius&&styleMap.borderRadius[borderRadius],borderWidth:border.width.thin,boxShadow:elevation&&styleMap.elevation[elevation],padding:paddingSize&&styleMap.padding[paddingSize],minInlineSize:sizing.size_280,position:"relative"}})};
+const Card=React.forwardRef(function Card(props,ref){const{styles,labels,tag,testId,background="base-default",borderRadius="small",paddingSize="small",elevation="none",children,onDismiss,inert}=props;const isBackgroundToken=background==="base-default"||background==="base-subtle";const componentStyles=getComponentStyles({background:isBackgroundToken?background:null,borderRadius,paddingSize,elevation});return jsxs(View,{"aria-label":labels?.cardAriaLabel,style:[componentStyles.root,!isBackgroundToken&&{background:`url(${background})`,backgroundSize:"cover"},styles?.root],ref:ref,tag:tag,testId:testId,inert:inert?"":undefined,children:[onDismiss?jsx(DismissButton,{"aria-label":labels?.dismissButtonAriaLabel||"Close",onClick:e=>onDismiss?.(e)}):null,children]})});const styleMap={backgroundColor:{"base-subtle":semanticColor.core.background.base.subtle,"base-default":semanticColor.core.background.base.default},borderRadius:{small:border.radius.radius_080,medium:border.radius.radius_120},padding:{none:sizing.size_0,small:sizing.size_160,medium:sizing.size_240},elevation:{none:"none",low:boxShadow.low}};const getComponentStyles=({background="base-default",borderRadius="small",paddingSize="small",elevation="none"})=>{const bgColor=background;return StyleSheet.create({root:{backgroundColor:bgColor&&styleMap.backgroundColor[bgColor],borderColor:semanticColor.core.border.neutral.subtle,borderStyle:"solid",borderWidth:border.width.thin,fontFamily:font.family.sans,minInlineSize:sizing.size_280,position:"relative",borderRadius:styleMap.borderRadius[borderRadius],boxShadow:styleMap.elevation[elevation],padding:styleMap.padding[paddingSize]}})};
 
 export { Card };

package/dist/index.js

@@ -37,6 +37,6 @@ var IconButton__default = /*#__PURE__*/_interopDefaultLegacy(IconButton);
 
 const DismissButton=props=>{const{onClick,style,testId}=props;return jsxRuntime.jsx(IconButton__default["default"],{icon:xIcon__default["default"],"aria-label":props["aria-label"]||"Close",onClick:onClick,kind:"tertiary",actionType:"neutral",style:[componentStyles.root,style],testId:testId})};const componentStyles=aphrodite.StyleSheet.create({root:{position:"absolute",insetInlineEnd:wonderBlocksTokens.sizing.size_080,top:wonderBlocksTokens.sizing.size_080,zIndex:1,":focus":wonderBlocksStyles.focusStyles.focus[":focus-visible"]}});
 
-const Card=React__namespace.forwardRef(function Card(props,ref){const{styles,labels,tag,testId,background="base-default",borderRadius="small",paddingSize="small",elevation="none",children,onDismiss,inert}=props;const componentStyles=getComponentStyles({background,borderRadius,paddingSize,elevation});return jsxRuntime.jsxs(wonderBlocksCore.View,{"aria-label":labels?.cardAriaLabel,style:[componentStyles.root,styles?.root],ref:ref,tag:tag,testId:testId,inert:inert?"":undefined,children:[onDismiss?jsxRuntime.jsx(DismissButton,{"aria-label":labels?.dismissButtonAriaLabel||"Close",onClick:e=>onDismiss?.(e)}):null,children]})});const getComponentStyles=({background,borderRadius,paddingSize,elevation})=>{const styleMap={backgroundColor:{"base-subtle":wonderBlocksTokens.semanticColor.core.background.base.subtle,"base-default":wonderBlocksTokens.semanticColor.core.background.base.default},borderRadius:{small:wonderBlocksTokens.border.radius.radius_080,medium:wonderBlocksTokens.border.radius.radius_120},padding:{none:wonderBlocksTokens.sizing.size_0,small:wonderBlocksTokens.sizing.size_160,medium:wonderBlocksTokens.sizing.size_240},elevation:{none:"none",low:wonderBlocksTokens.boxShadow.low}};return aphrodite.StyleSheet.create({root:{backgroundColor:background&&styleMap.backgroundColor[background],borderColor:wonderBlocksTokens.semanticColor.core.border.neutral.subtle,borderStyle:"solid",borderRadius:borderRadius&&styleMap.borderRadius[borderRadius],borderWidth:wonderBlocksTokens.border.width.thin,boxShadow:elevation&&styleMap.elevation[elevation],padding:paddingSize&&styleMap.padding[paddingSize],minInlineSize:wonderBlocksTokens.sizing.size_280,position:"relative"}})};
+const Card=React__namespace.forwardRef(function Card(props,ref){const{styles,labels,tag,testId,background="base-default",borderRadius="small",paddingSize="small",elevation="none",children,onDismiss,inert}=props;const isBackgroundToken=background==="base-default"||background==="base-subtle";const componentStyles=getComponentStyles({background:isBackgroundToken?background:null,borderRadius,paddingSize,elevation});return jsxRuntime.jsxs(wonderBlocksCore.View,{"aria-label":labels?.cardAriaLabel,style:[componentStyles.root,!isBackgroundToken&&{background:`url(${background})`,backgroundSize:"cover"},styles?.root],ref:ref,tag:tag,testId:testId,inert:inert?"":undefined,children:[onDismiss?jsxRuntime.jsx(DismissButton,{"aria-label":labels?.dismissButtonAriaLabel||"Close",onClick:e=>onDismiss?.(e)}):null,children]})});const styleMap={backgroundColor:{"base-subtle":wonderBlocksTokens.semanticColor.core.background.base.subtle,"base-default":wonderBlocksTokens.semanticColor.core.background.base.default},borderRadius:{small:wonderBlocksTokens.border.radius.radius_080,medium:wonderBlocksTokens.border.radius.radius_120},padding:{none:wonderBlocksTokens.sizing.size_0,small:wonderBlocksTokens.sizing.size_160,medium:wonderBlocksTokens.sizing.size_240},elevation:{none:"none",low:wonderBlocksTokens.boxShadow.low}};const getComponentStyles=({background="base-default",borderRadius="small",paddingSize="small",elevation="none"})=>{const bgColor=background;return aphrodite.StyleSheet.create({root:{backgroundColor:bgColor&&styleMap.backgroundColor[bgColor],borderColor:wonderBlocksTokens.semanticColor.core.border.neutral.subtle,borderStyle:"solid",borderWidth:wonderBlocksTokens.border.width.thin,fontFamily:wonderBlocksTokens.font.family.sans,minInlineSize:wonderBlocksTokens.sizing.size_280,position:"relative",borderRadius:styleMap.borderRadius[borderRadius],boxShadow:styleMap.elevation[elevation],padding:styleMap.padding[paddingSize]}})};
 
 exports.Card = Card;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanacademy/wonder-blocks-card",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "design": "v1",
   "description": "Card component for Wonder Blocks.",
   "main": "dist/index.js",
@@ -14,8 +14,8 @@
   },
   "dependencies": {
     "@khanacademy/wonder-blocks-core": "12.4.0",
-    "@khanacademy/wonder-blocks-tokens": "14.0.0",
-    "@khanacademy/wonder-blocks-icon-button": "10.5.2"
+    "@khanacademy/wonder-blocks-icon-button": "10.5.3",
+    "@khanacademy/wonder-blocks-tokens": "14.0.0"
   },
   "peerDependencies": {
     "aphrodite": "^1.2.5",

package/src/__tests__/components/card.typestest.tsx

@@ -64,6 +64,9 @@ import Card from "../../components/card";
     Content
 </Card>;
 
+// @ts-expect-error - onClick is not allowed on Card wrapper
+<Card onClick={() => {}}>Content</Card>;
+
 /**
  * Card with different HTML tags
  */

package/src/components/card.tsx

@@ -8,6 +8,7 @@ import {
     border,
     semanticColor,
     sizing,
+    font,
 } from "@khanacademy/wonder-blocks-tokens";
 
 import {DismissButton} from "./dismiss-button";
@@ -79,10 +80,13 @@ type StyleProps = {
      * This can be one of:
      * - `"base-subtle"` (color), `semanticColor.core.background.base.subtle`: a light gray background.
      * - `"base-default"` (color), `semanticColor.core.background.base.default`: a white background.
+     * - `Image` (image), a URL string for a background image. Can be an imported image file or a URL string.
+     *
+     * For additional background styling such as repeat or size, use the `styles.root` prop to pass in custom styles.
      *
      * Default: `"base-default"`
      */
-    background?: "base-subtle" | "base-default";
+    background?: "base-subtle" | "base-default" | typeof Image | null;
     /**
      * The border radius of the card, as a string identifier that matches a border.radius token.
      * This can be one of:
@@ -141,7 +145,7 @@ type Props = BaseCardProps & TagProps & DismissProps;
  *
  * When the `onDismiss` prop is provided, a dismiss button will be rendered. In this case, the `labels.dismissButtonAriaLabel` prop is required to provide an accessible label for the dismiss button.
  *
- * See additional [Accessibility docs](./?path=/docs/packages-card-card-accessibility--docs).
+ * See additional Accessibility docs.
  */
 
 const Card = React.forwardRef(function Card(
@@ -162,16 +166,26 @@ const Card = React.forwardRef(function Card(
         inert,
     } = props;
 
+    const isBackgroundToken =
+        background === "base-default" || background === "base-subtle";
     const componentStyles = getComponentStyles({
-        background,
+        background: isBackgroundToken ? background : null,
         borderRadius,
         paddingSize,
         elevation,
     });
+
     return (
         <View
             aria-label={labels?.cardAriaLabel}
-            style={[componentStyles.root, styles?.root]}
+            style={[
+                componentStyles.root,
+                !isBackgroundToken && {
+                    background: `url(${background})`,
+                    backgroundSize: "cover",
+                },
+                styles?.root,
+            ]}
             ref={ref}
             tag={tag}
             testId={testId}
@@ -188,44 +202,52 @@ const Card = React.forwardRef(function Card(
     );
 });
 
+// Map prop values to tokens
+const styleMap = {
+    backgroundColor: {
+        "base-subtle": semanticColor.core.background.base.subtle,
+        "base-default": semanticColor.core.background.base.default,
+    },
+    borderRadius: {
+        small: border.radius.radius_080,
+        medium: border.radius.radius_120,
+    },
+    padding: {
+        none: sizing.size_0,
+        small: sizing.size_160,
+        medium: sizing.size_240,
+    },
+    elevation: {
+        none: "none",
+        low: boxShadow.low,
+    },
+} as const;
+
+/**
+ * Gets the styles for the card based on its props
+ */
 const getComponentStyles = ({
-    background,
-    borderRadius,
-    paddingSize,
-    elevation,
+    background = "base-default",
+    borderRadius = "small",
+    paddingSize = "small",
+    elevation = "none",
 }: StyleProps) => {
-    // Map prop values to tokens
-    const styleMap = {
-        backgroundColor: {
-            "base-subtle": semanticColor.core.background.base.subtle,
-            "base-default": semanticColor.core.background.base.default,
-        },
-        borderRadius: {
-            small: border.radius.radius_080,
-            medium: border.radius.radius_120,
-        },
-        padding: {
-            none: sizing.size_0,
-            small: sizing.size_160,
-            medium: sizing.size_240,
-        },
-        elevation: {
-            none: "none",
-            low: boxShadow.low,
-        },
-    } as const;
-
+    const bgColor = background as keyof typeof styleMap.backgroundColor;
     return StyleSheet.create({
         root: {
-            backgroundColor: background && styleMap.backgroundColor[background],
+            backgroundColor: bgColor && styleMap.backgroundColor[bgColor],
+            // Common styles
             borderColor: semanticColor.core.border.neutral.subtle,
             borderStyle: "solid",
-            borderRadius: borderRadius && styleMap.borderRadius[borderRadius],
             borderWidth: border.width.thin,
-            boxShadow: elevation && styleMap.elevation[elevation],
-            padding: paddingSize && styleMap.padding[paddingSize],
+            // Apply the system font to cards by default
+            fontFamily: font.family.sans,
             minInlineSize: sizing.size_280,
             position: "relative",
+            // Optional styles based on props
+            borderRadius: styleMap.borderRadius[borderRadius],
+            boxShadow: styleMap.elevation[elevation],
+            padding: styleMap.padding[paddingSize],
         },
     });
 };