Card full height

.changeset/stupid-pianos-brake.md

@@ -0,0 +1,6 @@
+---
+"@twilio-paste/card": minor
+"@twilio-paste/core": minor
+---
+
+[Card]: add `fillHeight` prop to make card height stretch to the container height

packages/paste-core/components/card/src/Card.tsx

@@ -14,6 +14,15 @@ export interface CardProps extends HTMLPasteProps<"article">, PaddingProps {
    * @memberof CardProps
    */
   element?: BoxProps["element"];
+
+  /**
+   * Overrides the default element name to apply unique styles with the Customization Provider
+   *
+   * @default false
+   * @type {boolean}
+   * @memberof CardProps
+   */
+  fillHeight?: boolean;
 }
 
 const Card = React.forwardRef<HTMLElement, CardProps>(
@@ -26,6 +35,7 @@ const Card = React.forwardRef<HTMLElement, CardProps>(
       paddingLeft,
       paddingRight,
       paddingTop,
+      fillHeight,
       ...props
     },
     ref,
@@ -46,6 +56,7 @@ const Card = React.forwardRef<HTMLElement, CardProps>(
         paddingRight={paddingRight}
         paddingTop={paddingTop}
         backgroundColor="colorBackgroundWeakest"
+        height={fillHeight ? "100%" : undefined}
       >
         {children}
       </Box>

packages/paste-core/components/card/stories/index.stories.tsx

@@ -1,5 +1,7 @@
 import type { StoryFn } from "@storybook/react";
+import { Box } from "@twilio-paste/box";
 import { CustomizationProvider } from "@twilio-paste/customization";
+import { Column, Grid } from "@twilio-paste/grid";
 import { Heading } from "@twilio-paste/heading";
 import { Paragraph } from "@twilio-paste/paragraph";
 import { Stack } from "@twilio-paste/stack";
@@ -62,6 +64,49 @@ export const PropPassthrough = (): React.ReactNode => (
   </Card>
 );
 
+export const FillHeight = (): React.ReactNode => (
+  <Box>
+    <Grid gutter="space30">
+      <Column>
+        <Card>
+          <Paragraph>Without fillHeight, the card will only be as tall as its content.</Paragraph>
+        </Card>
+      </Column>
+      <Column>
+        <Card>
+          <Paragraph>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
+            ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat
+            nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa
+          </Paragraph>
+        </Card>
+      </Column>
+    </Grid>
+
+    <Grid gutter="space30" marginTop="space100">
+      <Column>
+        <Card fillHeight>
+          <Paragraph>
+            With fillHeight, the card will stretch to fill the height of the container. This can be useful when you need
+            to align multiple cards in a row.
+          </Paragraph>
+        </Card>
+      </Column>
+      <Column>
+        <Card>
+          <Paragraph>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
+            ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat
+            nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa
+          </Paragraph>
+        </Card>
+      </Column>
+    </Grid>
+  </Box>
+);
+
 export const CustomCard: StoryFn = (_args, { parameters: { isTestEnvironment } }) => {
   const currentTheme = useTheme();
   return (

packages/paste-core/components/card/type-docs.json

@@ -473,6 +473,13 @@
       "required": false,
       "externalProp": true
     },
+    "fillHeight": {
+      "type": "boolean",
+      "defaultValue": false,
+      "required": false,
+      "externalProp": false,
+      "description": "Overrides the default element name to apply unique styles with the Customization Provider"
+    },
     "hidden": {
       "type": "boolean",
       "defaultValue": null,

packages/paste-website/src/component-examples/CardExamples.ts

@@ -99,6 +99,30 @@ export const TitleBodyButtonExample = `const CardExample = () => {
 
 render(<CardExample />);`.trim();
 
+export const FillHeightExample = `const CardExample = () => {
+  return (
+    <Grid gutter="space30">
+      <Column>
+        <Card fillHeight>
+          <Paragraph>
+            With fillHeight, the card will stretch to fill the height of the container.
+          </Paragraph>
+        </Card>
+      </Column>
+      <Column>
+        <Card>
+          <Paragraph>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex.
+          </Paragraph>
+        </Card>
+      </Column>
+    </Grid>
+  );
+};
+
+render(<CardExample />);`.trim();
+
 export const MarketingOneExample = `const CardExample = () => {
   return (
     <Card>

packages/paste-website/src/pages/components/card/index.mdx

@@ -27,7 +27,7 @@ import MultipleDont from '../../../assets/images/dont2-multiple-primary.png';
 import packageJson from '@twilio-paste/card/package.json';
 import ComponentPageLayout from '../../../layouts/ComponentPageLayout';
 import {getFeature, getNavigationData} from '../../../utils/api';
-import {AdjustingPaddingExample, DefaultExample, TitleBodyButtonExample, MarketingOneExample, MarketingTwoExample, MarketingThreeExample, MarketingFourExample} from '../../../component-examples/CardExamples'
+import {AdjustingPaddingExample, DefaultExample, TitleBodyButtonExample, MarketingOneExample, MarketingTwoExample, MarketingThreeExample, MarketingFourExample, FillHeightExample} from '../../../component-examples/CardExamples'
 
 export default ComponentPageLayout;
 
@@ -113,6 +113,17 @@ digest and provides a clear call to action.
   code={TitleBodyButtonExample}
 />
 
+#### Fill height
+
+In scenarios where there is a requirement for the card to fill the height of the parent container, you can use the `fillHeight` prop.
+
+<StoryPreview
+  height="350px"
+  title="Card examples - Fill height"
+  storyID="website-cardexamples--fill-height-example"
+  code={FillHeightExample}
+/>
+
 #### Marketing Card
 
 Use these layouts when you need to draw customers’ attention to upsell and cross-sell opportunities. Use them sparingly, mainly when they’ll help customers solve immediate problems.

packages/paste-website/stories/Card.stories.tsx

@@ -5,6 +5,7 @@ import { Box } from "@twilio-paste/box";
 import { Button } from "@twilio-paste/button";
 import { ButtonGroup } from "@twilio-paste/button-group";
 import { Card } from "@twilio-paste/card";
+import { Column, Grid } from "@twilio-paste/grid";
 import { Heading } from "@twilio-paste/heading";
 import { AcceptIcon } from "@twilio-paste/icons/esm/AcceptIcon";
 import { ArrowForwardIcon } from "@twilio-paste/icons/esm/ArrowForwardIcon";
@@ -135,6 +136,28 @@ TitleBodyButtonExample.parameters = {
   padding: false,
 };
 
+export const FillHeightExample = (): JSX.Element => (
+  <Grid gutter="space30">
+    <Column>
+      <Card fillHeight>
+        <Paragraph>With fillHeight, the card will stretch to fill the height of the container.</Paragraph>
+      </Card>
+    </Column>
+    <Column>
+      <Card>
+        <Paragraph>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex.
+        </Paragraph>
+      </Card>
+    </Column>
+  </Grid>
+);
+
+FillHeightExample.parameters = {
+  padding: false,
+};
+
 export const MarketingOneExample = (): JSX.Element => {
   return (
     <Card>