[LG-5747] feat: Card - update styles, deprecate clickability

.changeset/vast-facts-press.md

@@ -0,0 +1,6 @@
+---
+'@leafygreen-ui/card': minor
+'@leafygreen-ui/tokens': minor
+---
+
+deprecated clickable styling and functionality, updated styles (removed shadows and added border). Added Tertiary Border color token

packages/card/README.md

@@ -38,11 +38,28 @@ import Card from '@leafygreen-ui/card';
 
 Card is a styled wrapper for the Box component. Any properties you would pass to Box can also be passed to Card.
 
-| Prop           | Type                    | Description                                                       | Default                                                                 |
-| -------------- | ----------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| `children`     | `React.ReactNode`       | Content rendered inside of the `<Card />` component               |                                                                         |
-| `className`    | `string`                | Adds a className to the class attribute                           |                                                                         |
-| `contentStyle` | `'none'`, `'clickable'` | Whether the card should display as a visually clickable element.  | `'clickable'` when a valid `onClick` handler or `href` link is provided |
-| `darkMode`     | `boolean`               | Determines whether or not the component will appear in dark mode. | `false`                                                                 |
+| Prop        | Type              | Description                                                       | Default |
+| ----------- | ----------------- | ----------------------------------------------------------------- | ------- |
+| `children`  | `React.ReactNode` | Content rendered inside of the `<Card />` component               |         |
+| `className` | `string`          | Adds a className to the class attribute                           |         |
+| `darkMode`  | `boolean`         | Determines whether or not the component will appear in dark mode. | `false` |
 
 _Any other properties will be spread on the Box element._
+
+## Usage and Interactivity
+
+This component is designed to be a container for other elements and content. Adding `onClick` or `href` directly to the component is discouraged. Instead, we recommend adding interactive elements inside the component.
+
+### DON'T
+
+```js
+<Card onClick={handleOnClick}>This is my card component</Card>
+```
+
+### DO
+
+```js
+<Card>
+  <CustomCardHeader onClick={handleOnClick} />
+</Card>
+```

packages/card/src/Card.stories.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import { storybookArgTypes, StoryMetaType } from '@lg-tools/storybook-utils';
 import { StoryFn } from '@storybook/react';
 
-import { Card, CardProps, ContentStyle } from '.';
+import { Card, CardProps } from '.';
 
 const loremIpsum = `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy children ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.`;
 
@@ -14,7 +14,6 @@ const meta: StoryMetaType<typeof Card> = {
     generate: {
       combineArgs: {
         darkMode: [false, true],
-        contentStyle: ['none', 'clickable'],
       },
     },
   },
@@ -27,11 +26,6 @@ const meta: StoryMetaType<typeof Card> = {
     as: storybookArgTypes.as,
     darkMode: storybookArgTypes.darkMode,
     children: storybookArgTypes.children,
-    contentStyle: {
-      options: Object.values(ContentStyle),
-      control: { type: 'radio' },
-      defaultValue: ContentStyle.None,
-    },
   },
 };
 export default meta;

packages/card/src/Card/Card.tsx

@@ -1,14 +1,13 @@
 import React from 'react';
 
-import { cx } from '@leafygreen-ui/emotion';
 import { useDarkMode } from '@leafygreen-ui/leafygreen-provider';
 import {
   InferredPolymorphic,
   PolymorphicAs,
   useInferredPolymorphic,
 } from '@leafygreen-ui/polymorphic';
 
-import { colorSet, containerStyle } from './styles';
+import { getCardStyles } from './styles';
 import { ContentStyle, InternalCardProps } from './types';
 
 /**
@@ -40,15 +39,7 @@ export const Card = InferredPolymorphic<InternalCardProps, 'div'>(
     return (
       <Component
         ref={ref}
-        className={cx(
-          containerStyle,
-          colorSet[theme].containerStyle,
-          {
-            [colorSet[theme].clickableStyle]:
-              contentStyle === ContentStyle.Clickable,
-          },
-          className,
-        )}
+        className={getCardStyles({ theme, contentStyle, className })}
         {...rest}
       />
     );

packages/card/src/Card/styles.ts

@@ -3,6 +3,7 @@ import { Theme } from '@leafygreen-ui/lib';
 import { palette } from '@leafygreen-ui/palette';
 import {
   boxShadows,
+  color,
   focusRing,
   fontFamilies,
   transitionDuration,
@@ -24,11 +25,10 @@ const darkHoverBoxShadow = boxShadows[Theme.Dark][2];
 const lightFocusBoxShadow = focusRing.light.default;
 const darkFocusBoxShadow = focusRing.dark.default;
 
-export const colorSet: Record<Theme, ColorSet> = {
+const colorSet: Record<Theme, ColorSet> = {
   [Theme.Light]: {
     containerStyle: css`
-      border: 1px solid ${palette.gray.light2};
-      box-shadow: ${lightBaseBoxShadow};
+      border: 1px solid ${color[Theme.Light].border.tertiary.default};
       background-color: ${palette.white};
       color: ${palette.gray.dark3};
     `,
@@ -53,8 +53,7 @@ export const colorSet: Record<Theme, ColorSet> = {
   },
   [Theme.Dark]: {
     containerStyle: css`
-      border: 1px solid ${palette.gray.dark2};
-      box-shadow: ${darkBaseBoxShadow};
+      border: 1px solid ${color[Theme.Dark].border.tertiary.default};
       background-color: ${palette.black};
       color: ${palette.white};
     `,
@@ -77,7 +76,7 @@ export const colorSet: Record<Theme, ColorSet> = {
   },
 };
 
-export const containerStyle = css`
+const containerStyle = css`
   position: relative;
   transition: ${transitionDuration.default}ms ease-in-out;
   transition-property: border, box-shadow;
@@ -95,13 +94,13 @@ export const getCardStyles = ({
   className,
 }: {
   theme: Theme;
-  contentStyle: ContentStyle;
+  contentStyle?: ContentStyle;
   className?: string;
 }) =>
   cx(
     containerStyle,
+    colorSet[theme].containerStyle,
     {
-      [colorSet[theme].containerStyle]: true,
       [colorSet[theme].clickableStyle]: contentStyle === ContentStyle.Clickable,
     },
     className,

packages/card/src/Card/types.ts

@@ -4,11 +4,17 @@ import {
   PolymorphicAs,
 } from '@leafygreen-ui/polymorphic';
 
+/**
+ * @deprecated No longer supported. We don't want card to be clickable from a root level.
+ */
 export const ContentStyle = {
   None: 'none',
   Clickable: 'clickable',
 } as const;
 
+/**
+ * @deprecated No longer supported. We don't want card to be clickable from a root level.
+ */
 export type ContentStyle = (typeof ContentStyle)[keyof typeof ContentStyle];
 
 export interface InternalCardProps extends DarkModeProps {
@@ -23,6 +29,7 @@ export interface InternalCardProps extends DarkModeProps {
    * Defaults to `'clickable'` (when a valid `onClick` handler or `href` link is provided
    *
    * @default 'clickable' | 'none'
+   * @deprecated No longer supported. We don't want card to be clickable from a root level. Use interactive elements inside the card instead.
    */
   contentStyle?: ContentStyle;
 
@@ -31,6 +38,20 @@ export interface InternalCardProps extends DarkModeProps {
    *
    */
   title?: string;
+
+  /**
+   * Click handler for the Card component.
+   *
+   * @deprecated No longer supported. We don't want card to be clickable from a root level. Use interactive elements inside the card instead.
+   */
+  onClick?: React.MouseEventHandler<any>;
+
+  /**
+   * Link for the Card component.
+   *
+   * @deprecated No longer supported. We don't want card to be clickable from a root level. Use interactive elements inside the card instead.
+   */
+  href?: string;
 }
 
 // External only