From 8bfd5251cc149960bf5bb874143ad675980270e9 Mon Sep 17 00:00:00 2001
From: Eric Olkowski <thatblindgeye@gmail.com>
Date: Thu, 28 Mar 2024 09:40:57 -0400
Subject: [PATCH] Updated API to have isSelected control selectable card state

---
 .../react-core/src/components/Card/Card.tsx   |  7 +++++--
 .../src/components/Card/CardHeader.tsx        |  9 ++++++---
 .../src/components/Card/examples/Card.md      |  2 +-
 .../Card/examples/CardClickableSelectable.tsx | 19 +++++++++++--------
 .../Card/examples/CardSelectable.tsx          |  9 +++------
 .../Card/examples/CardSingleSelectable.tsx    |  9 +++------
 6 files changed, 29 insertions(+), 26 deletions(-)

diff --git a/packages/react-core/src/components/Card/Card.tsx b/packages/react-core/src/components/Card/Card.tsx
index 6ada27a1a29..3cf8b760cc5 100644
--- a/packages/react-core/src/components/Card/Card.tsx
+++ b/packages/react-core/src/components/Card/Card.tsx
@@ -20,8 +20,8 @@ export interface CardProps extends React.HTMLProps<HTMLElement>, OUIAProps {
   isSelectableRaised?: boolean;
   /** Flag indicating that the card is clickable and contains some action that triggers on click. */
   isClickable?: boolean;
-  /** Flag indicating whether a card that is both clickable and selectable is currently selected and has selected styling.
-   * This will not determine the card's actual selected state.
+  /** Flag indicating whether a card that is either selectable only or both clickable and selectable is
+   * currently selected and has selected styling.
    */
   isSelected?: boolean;
   /** Flag indicating whether a card that is either only clickable or that is both clickable and selectable
@@ -62,6 +62,7 @@ interface CardContextProps {
   isExpanded: boolean;
   isClickable: boolean;
   isSelectable: boolean;
+  isSelected: boolean;
   isClicked: boolean;
   isDisabled: boolean;
   // TODO: Remove hasSelectableInput when deprecated prop is removed
@@ -79,6 +80,7 @@ export const CardContext = React.createContext<Partial<CardContextProps>>({
   isExpanded: false,
   isClickable: false,
   isSelectable: false,
+  isSelected: false,
   isClicked: false,
   isDisabled: false
 });
@@ -175,6 +177,7 @@ export const Card: React.FunctionComponent<CardProps> = ({
         isExpanded,
         isClickable,
         isSelectable,
+        isSelected,
         isClicked,
         isDisabled,
         // TODO: Remove hasSelectableInput when deprecated prop is removed
diff --git a/packages/react-core/src/components/Card/CardHeader.tsx b/packages/react-core/src/components/Card/CardHeader.tsx
index 8bb7407fc0d..d368bf47109 100644
--- a/packages/react-core/src/components/Card/CardHeader.tsx
+++ b/packages/react-core/src/components/Card/CardHeader.tsx
@@ -44,7 +44,9 @@ export interface CardHeaderSelectableActionsObject {
   isExternalLink?: boolean;
   /** Name for the input element of a clickable or selectable card. */
   name?: string;
-  /** Flag indicating whether the selectable card input is checked */
+  /** @deprecated Flag indicating whether the selectable card input is checked. We recommend using
+   * the isSelected prop on the card component instead.
+   */
   isChecked?: boolean;
 }
 
@@ -80,7 +82,7 @@ export const CardHeader: React.FunctionComponent<CardHeaderProps> = ({
 }: CardHeaderProps) => (
   <CardContext.Consumer>
     {/* TODO: Remove hasSelectableInput when deprecated props are removed */}
-    {({ cardId, isClickable, isSelectable, isClicked, isDisabled: isCardDisabled, hasSelectableInput }) => {
+    {({ cardId, isClickable, isSelectable, isSelected, isClicked, isDisabled: isCardDisabled, hasSelectableInput }) => {
       const cardHeaderToggle = (
         <div className={css(styles.cardHeaderToggle)}>
           <Button
@@ -130,12 +132,13 @@ export const CardHeader: React.FunctionComponent<CardHeaderProps> = ({
           name: selectableActions.name,
           isDisabled: isCardDisabled
         };
+        const isSelectableInputChecked = selectableActions.isChecked ?? isSelected;
 
         if (isClickable && !isSelectable) {
           return { ...baseProps, onClick: handleActionClick, isChecked: isClicked };
         }
         if (isSelectable) {
-          return { ...baseProps, onChange: selectableActions.onChange, isChecked: selectableActions.isChecked };
+          return { ...baseProps, onChange: selectableActions.onChange, isChecked: isSelectableInputChecked };
         }
 
         return baseProps;
diff --git a/packages/react-core/src/components/Card/examples/Card.md b/packages/react-core/src/components/Card/examples/Card.md
index a4dd7f047d8..a5ce91abcf3 100644
--- a/packages/react-core/src/components/Card/examples/Card.md
+++ b/packages/react-core/src/components/Card/examples/Card.md
@@ -127,7 +127,7 @@ When a group of single selectable cards are related, you must pass the same `nam
 
 ### Actionable
 
-An actionable card can perform an action or navigate to a link by clicking anywhere within the card. You can also pass in the `isExternalLink` property to `selectableActions` if you want an actionable card's link to open in a new tab or window.
+An actionable card can perform an action or navigate to a link by clicking anywhere within the card. To open a link in a new tab or window, pass the `isExternalLink` property to `selectableActions`.
 
 You can pass the `isClicked` property to `<Card>` to convey that a card is the currently clicked one, such as when clicking a card would open a [primary-detail view](/patterns/primary-detail). This must not be used simply for "selection" of a card, and you should instead use our [selectable card](#selectable) or [single selectable card](#single-selectable).
 
diff --git a/packages/react-core/src/components/Card/examples/CardClickableSelectable.tsx b/packages/react-core/src/components/Card/examples/CardClickableSelectable.tsx
index 193257cbbc7..67e64bf1336 100644
--- a/packages/react-core/src/components/Card/examples/CardClickableSelectable.tsx
+++ b/packages/react-core/src/components/Card/examples/CardClickableSelectable.tsx
@@ -5,14 +5,14 @@ export const CardClickable: React.FunctionComponent = () => {
   const [isChecked1, setIsChecked1] = React.useState(false);
   const [isChecked2, setIsChecked2] = React.useState(false);
   const [isChecked3, setIsChecked3] = React.useState(false);
-  const [isSelected1, setIsSelected1] = React.useState(false);
+  const [isClicked, setIsClicked] = React.useState(false);
 
   const id1 = 'clickable-selectable-card-input-1';
   const id2 = 'clickable-selectable-card-input-2';
   const id3 = 'clickable-selectable-card-input-3';
 
   const onClick = () => {
-    setIsSelected1((prevState) => !prevState);
+    setIsClicked((prevState) => !prevState);
   };
 
   const onChange = (event: React.FormEvent<HTMLInputElement>, checked: boolean) => {
@@ -33,13 +33,18 @@ export const CardClickable: React.FunctionComponent = () => {
 
   return (
     <React.Fragment>
-      <Card id="clickable-selectable-card-example-1" isClickable isSelectable isSelected={isSelected1}>
+      <Card
+        id="clickable-selectable-card-example-1"
+        isClickable
+        isClicked={isClicked}
+        isSelectable
+        isSelected={isChecked1}
+      >
         <CardHeader
           selectableActions={{
             selectableActionId: id1,
             selectableActionAriaLabelledby: 'clickable-selectable-card-example-1',
             name: id1,
-            isChecked: isChecked1,
             onChange
           }}
         >
@@ -51,13 +56,12 @@ export const CardClickable: React.FunctionComponent = () => {
         </CardHeader>
         <CardBody>This card performs an action upon clicking the card title and is selectable.</CardBody>
       </Card>
-      <Card id="clickable-selectable-card-example-2" isClickable isSelectable>
+      <Card id="clickable-selectable-card-example-2" isClickable isSelectable isSelected={isChecked2}>
         <CardHeader
           selectableActions={{
             selectableActionId: id2,
             selectableActionAriaLabelledby: 'clickable-selectable-card-example-2',
             name: id2,
-            isChecked: isChecked2,
             onChange
           }}
         >
@@ -71,13 +75,12 @@ export const CardClickable: React.FunctionComponent = () => {
           .
         </CardBody>
       </Card>
-      <Card id="clickable-selectable-card-example-3" isClickable isSelectable isDisabled>
+      <Card id="clickable-selectable-card-example-3" isClickable isSelectable isDisabled isSelected={isChecked3}>
         <CardHeader
           selectableActions={{
             selectableActionId: id3,
             selectableActionAriaLabelledby: 'clickable-selectable-card-example-3',
             name: id3,
-            isChecked: isChecked3,
             onChange
           }}
         >
diff --git a/packages/react-core/src/components/Card/examples/CardSelectable.tsx b/packages/react-core/src/components/Card/examples/CardSelectable.tsx
index a9de63b669d..02a5dffe580 100644
--- a/packages/react-core/src/components/Card/examples/CardSelectable.tsx
+++ b/packages/react-core/src/components/Card/examples/CardSelectable.tsx
@@ -28,13 +28,12 @@ export const SelectableCard: React.FunctionComponent = () => {
 
   return (
     <React.Fragment>
-      <Card id="selectable-card-example-1" isSelectable>
+      <Card id="selectable-card-example-1" isSelectable isSelected={isChecked1}>
         <CardHeader
           selectableActions={{
             selectableActionId: id1,
             selectableActionAriaLabelledby: 'selectable-card-example-1',
             name: id1,
-            isChecked: isChecked1,
             onChange
           }}
         >
@@ -42,13 +41,12 @@ export const SelectableCard: React.FunctionComponent = () => {
         </CardHeader>
         <CardBody>This card is selectable.</CardBody>
       </Card>
-      <Card id="selectable-card-example-2" isSelectable>
+      <Card id="selectable-card-example-2" isSelectable isSelected={isChecked2}>
         <CardHeader
           selectableActions={{
             selectableActionId: id2,
             selectableActionAriaLabelledby: 'selectable-card-example-2',
             name: id2,
-            isChecked: isChecked2,
             onChange
           }}
         >
@@ -56,13 +54,12 @@ export const SelectableCard: React.FunctionComponent = () => {
         </CardHeader>
         <CardBody>This card is selectable.</CardBody>
       </Card>
-      <Card id="selectable-card-example-3" isSelectable isDisabled>
+      <Card id="selectable-card-example-3" isSelectable isDisabled isSelected={isChecked3}>
         <CardHeader
           selectableActions={{
             selectableActionId: id3,
             selectableActionAriaLabelledby: 'selectable-card-example-3',
             name: id3,
-            isChecked: isChecked3,
             onChange
           }}
         >
diff --git a/packages/react-core/src/components/Card/examples/CardSingleSelectable.tsx b/packages/react-core/src/components/Card/examples/CardSingleSelectable.tsx
index 4984dd6918c..5a1a8a62495 100644
--- a/packages/react-core/src/components/Card/examples/CardSingleSelectable.tsx
+++ b/packages/react-core/src/components/Card/examples/CardSingleSelectable.tsx
@@ -13,14 +13,13 @@ export const SingleSelectableCard: React.FunctionComponent = () => {
 
   return (
     <React.Fragment>
-      <Card id="single-selectable-card-example-1" isSelectable>
+      <Card id="single-selectable-card-example-1" isSelectable isSelected={isChecked === id1}>
         <CardHeader
           selectableActions={{
             selectableActionId: id1,
             selectableActionAriaLabelledby: 'single-selectable-card-example-1',
             name: 'single-selectable-card-example',
             variant: 'single',
-            isChecked: isChecked === id1,
             onChange
           }}
         >
@@ -28,14 +27,13 @@ export const SingleSelectableCard: React.FunctionComponent = () => {
         </CardHeader>
         <CardBody>This card is single selectable.</CardBody>
       </Card>
-      <Card id="single-selectable-card-example-2" isSelectable>
+      <Card id="single-selectable-card-example-2" isSelectable isSelected={isChecked === id2}>
         <CardHeader
           selectableActions={{
             selectableActionId: id2,
             selectableActionAriaLabelledby: 'single-selectable-card-example-2',
             name: 'single-selectable-card-example',
             variant: 'single',
-            isChecked: isChecked === id2,
             onChange
           }}
         >
@@ -43,14 +41,13 @@ export const SingleSelectableCard: React.FunctionComponent = () => {
         </CardHeader>
         <CardBody>This card is single selectable.</CardBody>
       </Card>
-      <Card id="single-selectable-card-example-3" isSelectable isDisabled>
+      <Card id="single-selectable-card-example-3" isSelectable isDisabled isSelected={isChecked === id3}>
         <CardHeader
           selectableActions={{
             selectableActionId: id3,
             selectableActionAriaLabelledby: 'single-selectable-card-example-3',
             name: 'single-selectable-card-example',
             variant: 'single',
-            isChecked: isChecked === id3,
             onChange
           }}
         >