@truedat/core 4.46.5 → 4.46.6

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.46.6] 2022-06-20
+
+### Added
+
+- [TD-4858] Added CardGroupsAccordion component to aggrupate cards in different
+  groups
+
 ## [4.46.5] 2022-06-17
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/core",
-  "version": "4.46.5",
+  "version": "4.46.6",
   "description": "Truedat Web Core",
   "sideEffects": false,
   "jsnext:main": "src/index.js",
@@ -35,7 +35,7 @@
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.0.0",
     "@testing-library/user-event": "^13.2.1",
-    "@truedat/test": "4.46.5",
+    "@truedat/test": "4.46.6",
     "babel-jest": "^28.1.0",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-lodash": "^3.3.4",
@@ -112,5 +112,5 @@
     "react-dom": ">= 16.8.6 < 17",
     "semantic-ui-react": ">= 0.88.2 < 2.1"
   },
-  "gitHead": "cc6e42515345adf2926f47216622e0fc4f7a0d86"
+  "gitHead": "9eced5bbfbd39d1709c31976d3879f6c5688f83f"
 }

package/src/components/CardGroupsAccordion.js

@@ -0,0 +1,145 @@
+import React, { useState } from "react";
+import PropTypes from "prop-types";
+import _ from "lodash/fp";
+import { useIntl } from "react-intl";
+
+import { Accordion, Icon, Header, Card } from "semantic-ui-react";
+
+import "../styles/CardGroupsAccordion.less";
+
+/**
+ * Component to split Card.Groups into different folding sections
+ *
+ * If an element doesn't have a df_content.system_group, it must be appear
+ * under the "default" key.
+ *
+ * The objects that are inside the list of each group must contain the keys
+ * that will be passed as properties to cardComponent
+ *
+ * @component
+ * @example
+ *
+ * import { Card } from "semantic-ui-react";
+ *
+ *
+ * const groups = {
+ *   foo: [
+ *     {
+ *       title: "hello foo",
+ *       meta: "world foo",
+ *       description: "Test description foo 1",
+ *     },
+ *     {
+ *       title: "hello foo 2",
+ *       meta: "world foo 2",
+ *       description: "Test description foo 2",
+ *     },
+ *   ],
+ *   bar: [
+ *     {
+ *       title: "hello bar",
+ *       meta: "world bar",
+ *       description: "Test description bar 1",
+ *     },
+ *     {
+ *       title: "hello bar 2",
+ *       meta: "world bar 2",
+ *       description: "Test description bar 2",
+ *     },
+ *   ],
+ * }
+ *
+ * const CustomCard = (props) => (
+ *   <Card>
+ *     <Card.Content>
+ *       <Card.Header>{props.title}</Card.Header>
+ *       <Card.Meta>
+ *         <span>{props.meta}</span>
+ *       </Card.Meta>
+ *       <Card.Description>{props.description}</Card.Description>
+ *     </Card.Content>
+ *   </Card>
+ * );
+ *
+ * return (
+ *   <CardGroupsAccordion groups={groups} cardComponent={CustomCard} />
+ * )
+ */
+const CardGroupsAccordion = ({ groups, cardComponent: CardComponent }) => {
+  const { formatMessage } = useIntl();
+
+  // State and lifecycle methods
+
+  const [cardGroups, setCardGroups] = _.flow(
+    _.toPairs,
+    _.reduce(
+      (acc, [groupName, members]) => ({
+        ...acc,
+        [groupName]: { members, active: true },
+      }),
+      {}
+    ),
+    useState
+  )(groups);
+
+  // Handlers
+
+  const handleClick = (e, { index: groupName }) =>
+    _.flow(
+      _.set(`${groupName}.active`, !cardGroups[groupName].active),
+      setCardGroups
+    )(cardGroups);
+
+  // Renders
+
+  const renderSection = (groupName, group) => (
+    <div key={groupName}>
+      <Accordion.Title
+        active={group.active}
+        index={groupName}
+        onClick={handleClick}
+        className="CardGroupTitle"
+      >
+        <Header as="h3" dividing>
+          <Icon name="dropdown" />
+          {groupName === "default"
+            ? formatMessage({
+                id: "components.CardGroupsAccordion.withoutGroups",
+              })
+            : groupName}
+        </Header>
+      </Accordion.Title>
+      <Accordion.Content active={group.active}>
+        <Card.Group>
+          {group.members.map((cardProps) => (
+            <CardComponent key={cardProps.id} {...cardProps} />
+          ))}
+        </Card.Group>
+      </Accordion.Content>
+    </div>
+  );
+
+  return (
+    <Accordion exclusive={false}>
+      {cardGroups?.default
+        ? renderSection("default", cardGroups.default)
+        : null}
+      {_.flow(
+        _.omit(["default"]),
+        _.toPairs,
+        _.sortBy(0),
+        _.map(([groupName, group]) => renderSection(groupName, group))
+      )(cardGroups)}
+    </Accordion>
+  );
+};
+
+CardGroupsAccordion.propTypes = {
+  /** Object where the key is the name of group and the value is an array with
+   * card props that will be used in cardComponent */
+  groups: PropTypes.object,
+  /** Component to render Card content using card props passed in groups  */
+  cardComponent: PropTypes.func,
+};
+
+export default CardGroupsAccordion;

package/src/components/__tests__/CardGroupsAccordion.spec.js

@@ -0,0 +1,142 @@
+import React from "react";
+import { waitFor, fireEvent } from "@testing-library/react";
+import { render } from "@truedat/test/render";
+import { Card } from "semantic-ui-react";
+import { CardGroupsAccordion } from "..";
+
+const groups_all_cards_grouped = {
+  foo: [
+    {
+      id: 1,
+      name: "hello foo",
+      ueueue: "world foo",
+      description: "Test description foo 1",
+    },
+    {
+      id: 2,
+      name: "hello foo 2",
+      meta: "world foo 2",
+      description: "Test description foo 2",
+    },
+  ],
+  bar: [
+    {
+      id: 3,
+      name: "hello bar",
+      meta: "world bar",
+      description: "Test description bar 1",
+    },
+    {
+      id: 4,
+      name: "hello bar 2",
+      meta: "world bar 2",
+      description: "Test description bar 2",
+    },
+  ],
+};
+
+const groups_any_cards_without_group = {
+  foo: [
+    {
+      id: 1,
+      name: "hello foo",
+      meta: "world foo",
+      description: "Test description foo 1",
+    },
+    {
+      id: 2,
+      name: "hello foo 2",
+      meta: "world foo 2",
+      description: "Test description foo 2",
+    },
+  ],
+  default: [
+    {
+      id: 3,
+      name: "hello bar",
+      meta: "world bar",
+      description: "Test description bar 1",
+    },
+    {
+      id: 4,
+      name: "hello bar 2",
+      meta: "world bar 2",
+      description: "Test description bar 2",
+    },
+  ],
+};
+
+const cardComponent = (props) => (
+  <Card>
+    <Card.Content>
+      <Card.Header>{props.name}</Card.Header>
+      <Card.Meta>
+        <span>{props.meta}</span>
+      </Card.Meta>
+      <Card.Description>{props.description}</Card.Description>
+    </Card.Content>
+  </Card>
+);
+
+describe("<CardGroupsAccordion />", () => {
+  it("matches the latest snapshot", () => {
+    const { container } = render(
+      <CardGroupsAccordion
+        groups={groups_all_cards_grouped}
+        cardComponent={cardComponent}
+      />
+    );
+    expect(container).toMatchSnapshot();
+  });
+
+  it("Data without group appear in without group section", async () => {
+    const { getByText } = render(
+      <CardGroupsAccordion
+        groups={groups_any_cards_without_group}
+        cardComponent={cardComponent}
+      />
+    );
+
+    await waitFor(() => {
+      expect(getByText("Without Groups")).toBeTruthy();
+    });
+  });
+
+  it("Data without group appear in first position", async () => {
+    const { container } = render(
+      <CardGroupsAccordion
+        groups={groups_any_cards_without_group}
+        cardComponent={cardComponent}
+      />
+    );
+
+    const firstGroup = container.getElementsByClassName("title")[0].innerHTML;
+
+    await waitFor(() => {
+      expect(firstGroup).toMatch("Without Groups");
+    });
+  });
+
+  it("CardGroupsAccordion fold and unfold when click in title", async () => {
+    const { container } = render(
+      <CardGroupsAccordion
+        groups={groups_any_cards_without_group}
+        cardComponent={cardComponent}
+      />
+    );
+
+    const firstTitle = container.querySelector(".title");
+
+    fireEvent.click(firstTitle);
+
+    await waitFor(() => {
+      expect(firstTitle.classList.contains("active")).toBeFalsy();
+    });
+
+    fireEvent.click(firstTitle);
+
+    await waitFor(() => {
+      expect(firstTitle.classList.contains("active")).toBeTruthy();
+    });
+  });
+});

package/src/components/__tests__/__snapshots__/CardGroupsAccordion.spec.js.snap

@@ -0,0 +1,154 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<CardGroupsAccordion /> matches the latest snapshot 1`] = `
+<div>
+  <div
+    class="accordion ui"
+  >
+    <div>
+      <div
+        class="active title CardGroupTitle"
+      >
+        <h3
+          class="ui dividing header"
+        >
+          <i
+            aria-hidden="true"
+            class="dropdown icon"
+          />
+          bar
+        </h3>
+      </div>
+      <div
+        class="content active"
+      >
+        <div
+          class="ui cards"
+        >
+          <div
+            class="ui card"
+          >
+            <div
+              class="content"
+            >
+              <div
+                class="header"
+              >
+                hello bar
+              </div>
+              <div
+                class="meta"
+              >
+                <span>
+                  world bar
+                </span>
+              </div>
+              <div
+                class="description"
+              >
+                Test description bar 1
+              </div>
+            </div>
+          </div>
+          <div
+            class="ui card"
+          >
+            <div
+              class="content"
+            >
+              <div
+                class="header"
+              >
+                hello bar 2
+              </div>
+              <div
+                class="meta"
+              >
+                <span>
+                  world bar 2
+                </span>
+              </div>
+              <div
+                class="description"
+              >
+                Test description bar 2
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+    <div>
+      <div
+        class="active title CardGroupTitle"
+      >
+        <h3
+          class="ui dividing header"
+        >
+          <i
+            aria-hidden="true"
+            class="dropdown icon"
+          />
+          foo
+        </h3>
+      </div>
+      <div
+        class="content active"
+      >
+        <div
+          class="ui cards"
+        >
+          <div
+            class="ui card"
+          >
+            <div
+              class="content"
+            >
+              <div
+                class="header"
+              >
+                hello foo
+              </div>
+              <div
+                class="meta"
+              >
+                <span />
+              </div>
+              <div
+                class="description"
+              >
+                Test description foo 1
+              </div>
+            </div>
+          </div>
+          <div
+            class="ui card"
+          >
+            <div
+              class="content"
+            >
+              <div
+                class="header"
+              >
+                hello foo 2
+              </div>
+              <div
+                class="meta"
+              >
+                <span>
+                  world foo 2
+                </span>
+              </div>
+              <div
+                class="description"
+              >
+                Test description foo 2
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;

package/src/components/index.js

@@ -4,6 +4,7 @@ import MembersMenu from "./MembersMenu";
 import Alert from "./Alert";
 import Authorized from "./Authorized";
 import AvailableFilters from "./AvailableFilters";
+import CardGroupsAccordion from "./CardGroupsAccordion";
 import CatalogMenu from "./CatalogMenu";
 import Comments from "./Comments";
 import CommentsLoader from "./CommentsLoader";
@@ -51,6 +52,7 @@ export {
   Alert,
   Authorized,
   AvailableFilters,
+  CardGroupsAccordion,
   CatalogMenu,
   Comments,
   CommentsLoader,

package/src/messages/en.js

@@ -33,6 +33,7 @@ export default {
   "alert.status.504.header": "Gateway Timeout (504)",
   "comments.actions.new": "New comment",
   "comments.header": "Comments",
+  "components.CardGroupsAccordion.withoutGroups": "Without Groups",
   "confirmation.no": "No",
   "confirmation.yes": "Yes",
   "dateFilter.since": "less than",

package/src/messages/es.js

@@ -34,6 +34,7 @@ export default {
   "alert.status.504.header": "Gateway Timeout (504)",
   "comments.actions.new": "Añadir comentario",
   "comments.header": "Comentarios",
+  "components.CardGroupsAccordion.withoutGroups": "Sin Agrupación",
   "confirmation.no": "No",
   "confirmation.yes": "Sí",
   "dateFilter.since": "hace menos de",

package/src/styles/CardGroupsAccordion.less

@@ -0,0 +1,3 @@
+.CardGroupTitle {
+    margin-top: 1rem;
+}