playbook_ui 13.18.0 → 13.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f629448a4cd0208c365ff8cd0c7c18a3fb911bdc118497843b76279f9309b7c9
-  data.tar.gz: 466dd0df9bd42b611106524156fc473ad518fbe78ae1bb586a3e8715317586f3
+  metadata.gz: 5e7f392fc3d4bc8c6c896b4b54fd0cf5fcb4953fc1de2ee8bd59f14e223462a5
+  data.tar.gz: 71904fc8f23cb411b2022643cb08167a3c8a882a9f1bd135dbbeb980674c0bf4
 SHA512:
-  metadata.gz: 5f1d56aa0e2398edd4c6f97ea258e7d2f4d71f11b18a5410c82a9a142c4a3324ec0dd71dca84c7554dc0a7aee273e6e56c936c80351a241ce49157ef76806e36
-  data.tar.gz: 216199bebe300338129cda84ff8c4d0765231c1aecfa2bbfec3f008012ee39e019aac578b88926d06f5e7823d593f177ba699b4ae43091a6648cf1b77c4d24b0
+  metadata.gz: 85f2629ac4ad220d2c39ca406eb422a9ae0d04052f6bb893b3feceb1b909b281d19faa7a47e2f09a2003fb5ac2f2aa42bddabcf337b54ee345841d96be308ec3
+  data.tar.gz: cb38c42e015efbec6d56ed5d6cb4bdfe8c0cdeb91f4c8baeb02679348380c4dbca08f1a6d977bc3c23f0e761b43f1e9578ee1d4c1600cd94048fbe2970d6a27d

data/app/pb_kits/playbook/_reset.scss

@@ -39,4 +39,4 @@ body {
 a {
   text-decoration: none;
   color: $primary;
-}
+}

data/app/pb_kits/playbook/pb_advanced_table/Components/CustomCell.tsx

@@ -22,13 +22,14 @@ export const CustomCell = ({
   row,
   value,
 }: CustomCellProps & GlobalProps) => {
-  const { setExpanded, expanded } = useContext(AdvancedTableContext);
-  const RowWithoutChildren = row.originalSubRows === undefined;
+  const { setExpanded, expanded, inlineRowLoading } = useContext(AdvancedTableContext);
 
   const handleOnExpand = (row: Row<DataType>) => {
     onRowToggleClick && onRowToggleClick(row);
     setExpanded({ ...expanded, [row.id]: !row.getIsExpanded() });
   };
+  const RowHasChildren = row.original.children ? true : false
+  const renderButton = inlineRowLoading ? RowHasChildren : row.getCanExpand()
 
   return (
     <div style={{ paddingLeft: `${row.depth * 1.25}em` }}>
@@ -36,7 +37,7 @@ export const CustomCell = ({
           columnGap="xs"
           orientation="row"
       >
-        {!RowWithoutChildren ? (
+        {renderButton ? (
           <button
               className="gray-icon expand-toggle-icon"
               onClick={() => handleOnExpand(row)}
@@ -53,7 +54,7 @@ export const CustomCell = ({
             )}
           </button>
         ) : null}
-        <FlexItem paddingLeft={!RowWithoutChildren ? "none" : "xs"}>
+        <FlexItem paddingLeft={renderButton? "none" : "xs"}>
           {row.depth === 0 ? getValue() : value}
         </FlexItem>
       </Flex>

data/app/pb_kits/playbook/pb_advanced_table/Components/SubRowHeaderRow.tsx

@@ -1,8 +1,9 @@
-import React from "react"
+import React, { useContext } from "react"
 import Flex from "../../pb_flex/_flex"
 import Caption from "../../pb_caption/_caption"
 import { Row, Table } from "@tanstack/react-table"
 
+import AdvancedTableContext from "../Context/AdvancedTableContext";
 import { ToggleIconButton } from "./ToggleIconButton"
 import { renderCollapsibleTrail } from "./CollapsibleTrail"
 
@@ -12,7 +13,7 @@ import { GlobalProps } from "../../utilities/globalProps"
 
 interface SubRowHeaderRowProps {
   collapsibleTrail?: boolean
-  enableToggleExpansion?: "all" | "header"
+  enableToggleExpansion?: "all" | "header" | "none"
   onClick: (row: Row<DataType>) => void
   row: Row<DataType>
   subRowHeaders?: string[]
@@ -27,7 +28,11 @@ export const SubRowHeaderRow = ({
   subRowHeaders,
   table,
 }: SubRowHeaderRowProps & GlobalProps) => {
+  const { inlineRowLoading } = useContext(AdvancedTableContext);
+
   const numberOfColumns = table.getAllFlatColumns().length
+  const rowHasChildren = row.original.children ? true : false
+  const canExpand = inlineRowLoading ? rowHasChildren : row.getCanExpand()
 
   return (
     <tr className="custom-row bg-silver">
@@ -42,13 +47,13 @@ export const SubRowHeaderRow = ({
           <Flex align="center" 
               columnGap="xs"
           >
-            {enableToggleExpansion === "all" && row.getCanExpand() ? (
+            {enableToggleExpansion === "all" && canExpand ? (
               <ToggleIconButton onClick={onClick} 
                   row={row}
               />
             ) : null}
             <Caption
-                marginLeft={row.getCanExpand() ? "none" : "xs"}
+                marginLeft={canExpand ? "none" : "xs"}
                 text={subRowHeaders[row.depth - 1]}
             />
           </Flex>

data/app/pb_kits/playbook/pb_advanced_table/Components/TableHeaderCell.tsx

@@ -12,11 +12,10 @@ import { GlobalProps } from "../../utilities/globalProps"
 
 type TableHeaderCellProps = {
   enableSorting?: boolean
-  enableToggleExpansion?: "all" | "header"
+  enableToggleExpansion?: "all" | "header" | "none"
   handleExpandOrCollapse?: () => void
   header?: Header<DataType, unknown>
   headerChildren?: React.ReactNode | React.ReactNode[]
-  headerId?: string
   loading?: boolean
   sortIcon?: string | string[]
 } & GlobalProps
@@ -27,7 +26,6 @@ export const TableHeaderCell = ({
   handleExpandOrCollapse,
   header,
   headerChildren,
-  headerId,
   loading,
   sortIcon,
 }: TableHeaderCellProps) => {
@@ -50,10 +48,22 @@ const cellClassName = classnames("table-header-cells",
 );
 
 const cellId = `${loading ? 
-    `loading-${header.id}${headerId ? `-${headerId}` : ""}`
-    : `${header.id}${headerId ? `-${headerId}` : ""}`
+    `loading-${header.id}`
+    : `${header.id}`
 }`;
 
+const isToggleExpansionEnabledLoading =
+  header.index === 0 &&
+  loading &&
+  (enableToggleExpansion === "all" || "header") &&
+  enableToggleExpansion !== "none";
+  
+const isToggleExpansionEnabled =
+  header.index === 0 &&
+  !loading &&
+  (enableToggleExpansion === "all" || "header") &&
+  enableToggleExpansion !== "none";
+
   return (
     <th
         align="right"
@@ -73,15 +83,11 @@ const cellId = `${loading ?
             alignItems="center"
             justify={header.index === 0 && enableSorting ? "between" : header.index === 0 && !enableSorting ? "start" : "end"}
         >
-          {header.index === 0 &&
-            !loading &&
-            (enableToggleExpansion === "all" || "header") && (
+          {isToggleExpansionEnabled && (
               <ToggleIconButton onClick={handleExpandOrCollapse} />
             )}
 
-          {header.index === 0 &&
-            loading &&
-            (enableToggleExpansion === "all" || "header") && (
+          {isToggleExpansionEnabledLoading &&(
               <div className="loading-toggle-icon header-toggle-icon" />
             )}
 

data/app/pb_kits/playbook/pb_advanced_table/SubKits/TableBody.tsx

@@ -1,4 +1,7 @@
 import React, { useContext } from "react"
+import classnames from "classnames";
+import { buildCss } from "../../utilities/props";
+import { globalProps } from "../../utilities/globalProps";
 import LoadingInline from "../../pb_loading_inline/_loading_inline"
 import { flexRender, Row } from "@tanstack/react-table"
 
@@ -10,28 +13,47 @@ import { isChrome } from "../Utilities/BrowserCheck"
 import { DataType } from "../Utilities/types"
 
 type TableBodyProps = {
+  className?: string;
   collapsibleTrail?: boolean
+  id?: string;
   subRowHeaders?: string[]
 }
 
 export const TableBody = ({
+  className,
   collapsibleTrail = true,
+  id,
   subRowHeaders,
+  ...props
 }: TableBodyProps) => {
+
   const {
+    columnDefinitions,
     enableToggleExpansion,
     handleExpandOrCollapse,
+    inlineRowLoading,
     loading,
     table,
   } = useContext(AdvancedTableContext)
+
+  const classes = classnames(
+    buildCss("pb_advanced_table_body"),
+    globalProps(props),
+    className
+  );
+
   return (
     <>
-      <tbody>
+      <tbody className={classes} 
+          id={id}
+      >
         {table.getRowModel().rows.map((row: Row<DataType>) => {
           const isExpandable = row.getIsExpanded()
           const isFirstChildofSubrow = row.depth > 0 && row.index === 0
-          const rowHasNoChildren = !row.original.children?.length
+          const rowHasNoChildren = row.original.children && !row.original.children.length ? true : false
           const numberOfColumns = table.getAllFlatColumns().length
+          const isDataLoading = isExpandable && (inlineRowLoading && rowHasNoChildren) && (row.depth < columnDefinitions[0].cellAccessors?.length)
+          const rowBackground = isExpandable && ((!inlineRowLoading && row.getCanExpand()) || (inlineRowLoading && rowHasNoChildren))
 
           return (
             <React.Fragment key={`${row.index}-${row.id}-${row.depth}-row`}>
@@ -47,7 +69,7 @@ export const TableBody = ({
               )}
 
               <tr
-                  className={`${isExpandable ? "bg-silver" : "bg-white"} ${
+                  className={`${rowBackground ? "bg-silver" : "bg-white"} ${
                     row.depth > 0 ? `depth-sub-row-${row.depth}` : ""
                   }`}
                   id={`${row.index}-${row.id}-${row.depth}-row`}
@@ -79,9 +101,11 @@ export const TableBody = ({
               </tr>
 
               {/* Display LoadingInline if Row Data is querying and there are no children already */}
-              {isExpandable && rowHasNoChildren && row.depth === 0 ? (
+              {isDataLoading ? (
                 <tr key={`${row.id}-row`}>
-                  <td colSpan={numberOfColumns}>
+                  <td colSpan={numberOfColumns}
+                      style={{ paddingLeft: `${row.depth === 0 ? 0.5 : (row.depth * 2)}em` }}
+                  >
                     <LoadingInline />
                   </td>
                 </tr>

data/app/pb_kits/playbook/pb_advanced_table/SubKits/TableHeader.tsx

@@ -1,4 +1,7 @@
 import React, { useContext } from "react"
+import classnames from "classnames";
+import { buildCss } from "../../utilities/props";
+import { globalProps } from "../../utilities/globalProps";
 import { HeaderGroup } from "@tanstack/react-table"
 import AdvancedTableContext from "../Context/AdvancedTableContext"
 import { TableHeaderCell } from "../Components/TableHeaderCell"
@@ -6,16 +9,19 @@ import { DataType } from "../Utilities/types"
 
 type TableHeaderProps = {
   children?: React.ReactNode | React.ReactNode[]
+  className?: string
   enableSorting?: boolean
-  headerId?: string
+  id?: string;
   sortIcon?: string | string[]
 }
 
 export const TableHeader = ({
   children,
+  className,
   enableSorting = false,
-  headerId,
+  id,
   sortIcon = ["arrow-up-short-wide", "arrow-down-short-wide"],
+  ...props
 }: TableHeaderProps) => {
   const {
     enableToggleExpansion,
@@ -24,9 +30,18 @@ export const TableHeader = ({
     table,
   } = useContext(AdvancedTableContext)
 
+  const classes = classnames(
+    buildCss("pb_advanced_table_header"),
+    globalProps(props),
+    className
+  );
+
+
   return (
     <>
-      <thead>
+      <thead className={classes}
+          id={id}
+      >
         {/* Get the header groups (only one in this example) */}
         {table.getHeaderGroups().map((headerGroup: HeaderGroup<DataType>) => (
           <tr key={`${headerGroup.id}-headerGroup`}>
@@ -37,7 +52,6 @@ export const TableHeader = ({
                   handleExpandOrCollapse={handleExpandOrCollapse}
                   header={header}
                   headerChildren={children}
-                  headerId={headerId}
                   key={`${header.id}-header`}
                   loading={loading}
                   sortIcon={sortIcon}

data/app/pb_kits/playbook/pb_advanced_table/Utilities/ExpansionControlHelpers.tsx

@@ -24,10 +24,9 @@ export const updateExpandAndCollapseState = (
   // Update isExpansionConsistent variable
   for (const row of rows) {
     if (
-      row.getCanExpand() &&
-      (targetParent === undefined
+      targetParent === undefined
         ? row.depth === 0
-        : targetParent === row.parentId)
+        : targetParent === row.parentId
     ) {
       areRowsExpanded.add(row.getIsExpanded())
       if (areRowsExpanded.size > 1) {
@@ -48,7 +47,7 @@ export const updateExpandAndCollapseState = (
     })
   } else {
     for (const row of rows) {
-      if (row.getCanExpand() && targetParent === row.parentId) {
+      if (targetParent === row.parentId) {
         updateExpandedRows[row.id] = !isExpansionConsistent
           ? true
           : !row.getIsExpanded()

data/app/pb_kits/playbook/pb_advanced_table/_advanced_table.tsx

@@ -1,6 +1,6 @@
 import React, { useState, useEffect, useCallback } from "react";
 import classnames from "classnames";
-import { buildAriaProps, buildCss, buildDataProps } from "../utilities/props";
+import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from "../utilities/props";
 import { globalProps, GlobalProps } from "../utilities/globalProps";
 import Table from "../pb_table/_table";
 import {
@@ -28,10 +28,12 @@ type AdvancedTableProps = {
   className?: string;
   columnDefinitions: DataType[];
   data?: { [key: string]: string };
-  enableToggleExpansion?: "all" | "header";
+  enableToggleExpansion?: "all" | "header" | "none";
   expandedControl?: DataType;
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string;
   initialLoadingRowsCount?: number;
+  inlineRowLoading?: boolean;
   loading?: boolean | string;
   onRowToggleClick?: (arg: Row<DataType>) => void;
   onToggleExpansionClick?: (arg: Row<DataType>) => void;
@@ -51,8 +53,10 @@ const AdvancedTable = (props: AdvancedTableProps) => {
     data = {},
     enableToggleExpansion = "header",
     expandedControl,
+    htmlOptions = {},
     id,
     initialLoadingRowsCount = 10,
+    inlineRowLoading = false,
     loading,
     onRowToggleClick,
     onToggleExpansionClick,
@@ -104,7 +108,9 @@ const AdvancedTable = (props: AdvancedTableProps) => {
           const depthAccessor = cellAccessors[row.depth - 1]; // Adjust index for depth
           const accessorValue = rowData[depthAccessor];
           return accessorValue ? (
-            <CustomCell row={row} 
+            <CustomCell
+                onRowToggleClick={onRowToggleClick}
+                row={row} 
                 value={accessorValue} 
             />
           ) : (
@@ -195,6 +201,7 @@ const AdvancedTable = (props: AdvancedTableProps) => {
 
   const ariaProps = buildAriaProps(aria);
   const dataProps = buildDataProps(data);
+  const htmlProps = buildHtmlProps(htmlOptions);
   const classes = classnames(
     buildCss("pb_advanced_table"),
     globalProps(props),
@@ -204,19 +211,22 @@ const AdvancedTable = (props: AdvancedTableProps) => {
   return (
     <div {...ariaProps} 
         {...dataProps} 
+        {...htmlProps}
         className={classes} 
         id={id}
     >
       <AdvancedTableContext.Provider
           value={{
-            table,
+            columnDefinitions,
+            enableToggleExpansion,
+            expanded,
             handleExpandOrCollapse,
+            inlineRowLoading,
             loading,
-            enableToggleExpansion,
-            toggleExpansionIcon,
             setExpanded,
-            expanded,
             sortControl,
+            table,
+            toggleExpansionIcon,
           }}
       >
         <Table

data/app/pb_kits/playbook/pb_advanced_table/advanced_table.test.jsx

@@ -42,6 +42,36 @@ const MOCK_DATA = [
   },
 ];
 
+const MOCK_DATA_LOADING = [
+  {
+    year: "2021",
+    quarter: null,
+    month: null,
+    day: null,
+    newEnrollments: "20",
+    scheduledMeetings: "10",
+    children: [],
+  },
+  {
+    year: "2022",
+    quarter: null,
+    month: null,
+    day: null,
+    newEnrollments: "20",
+    scheduledMeetings: "10",
+    children: [
+      {
+        year: "2022",
+        quarter: "Q1",
+        month: null,
+        day: null,
+        newEnrollments: "2",
+        scheduledMeetings: "35",
+      },
+    ],
+  },
+];
+
 const columnDefinitions = [
   {
     accessor: "year",
@@ -343,3 +373,57 @@ test("sort button exists and sorts column data", () => {
   const row2 = kit.getElementsByTagName('tr')[2]
   expect(row2.id).toBe("0-0-0-row")
 }); 
+
+test("Generates Table.Header default + custom classname", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    >
+      <AdvancedTable.Header className="custom-header" />
+      <AdvancedTable.Body />
+
+    </AdvancedTable>
+  );
+
+  const kit = screen.getByTestId(testId);
+  const tableHeader = kit.querySelector('thead')
+  expect(tableHeader).toHaveClass('pb_advanced_table_header custom-header')
+});
+
+test("Generates Table.Body default + custom classname", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    >
+      <AdvancedTable.Header />
+      <AdvancedTable.Body className="custom-body-classname"/>
+
+    </AdvancedTable>
+  );
+
+  const kit = screen.getByTestId(testId);
+  const tableHeader = kit.querySelector('tbody')
+  expect(tableHeader).toHaveClass('pb_advanced_table_body custom-body-classname')
+});
+
+test("inlineRowLoading prop renders inline loading if true", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        inlineRowLoading
+        tableData={MOCK_DATA_LOADING}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const rowButton = kit.querySelector(".gray-icon.expand-toggle-icon")
+  expect(rowButton).toBeInTheDocument()
+  rowButton.click()
+  const inlineLoading = kit.querySelector(".fa-spinner")
+  expect(inlineLoading).toBeInTheDocument()
+});

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_inline_row_loading.jsx

@@ -0,0 +1,58 @@
+import React from "react";
+import { AdvancedTable } from "../..";
+import { MOCK_DATA_INLINE_LOADING } from "./_mock_data_inline_loading";
+
+const AdvancedTableInlineRowLoading = (props) => {
+  const columnDefinitions = [
+    {
+      accessor: "year",
+      label: "Year",
+      cellAccessors: ["quarter", "month", "day"],
+    },
+    {
+      accessor: "newEnrollments",
+      label: "New Enrollments",
+    },
+    {
+      accessor: "scheduledMeetings",
+      label: "Scheduled Meetings",
+    },
+    {
+      accessor: "attendanceRate",
+      label: "Attendance Rate",
+    },
+    {
+      accessor: "completedClasses",
+      label: "Completed Classes",
+    },
+    {
+      accessor: "classCompletionRate",
+      label: "Class Completion Rate",
+    },
+    {
+      accessor: "graduatedStudents",
+      label: "Graduated Students",
+    },
+  ];
+
+  //Render the subRow header rows
+  const subRowHeaders = ["Quarter", "Month", "Day"]
+
+
+  return (
+    <div>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          enableToggleExpansion="all"
+          inlineRowLoading
+          tableData={MOCK_DATA_INLINE_LOADING}
+          {...props}
+      >
+        <AdvancedTable.Header />
+        <AdvancedTable.Body subRowHeaders={subRowHeaders}/>
+      </AdvancedTable>
+    </div>
+  );
+};
+
+export default AdvancedTableInlineRowLoading;

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_inline_row_loading.md

@@ -0,0 +1,5 @@
+As a default, the kit assumes that the initial dataset is complete, and it renders all expansion buttons/controls based on that data; if no children are present, no expansion controls are rendered. If, however, you want to change the initial dataset to omit some or all of its children (to improve load times of a complex dataset, perhaps), and you implement a querying logic that loads children only when its parent is expanded, then you must use the `inlineRowLoading` prop to ensure your expansion controls are rendered even though your child data is not yet loaded. You must also pass an empty `children` array to any node that will have children to ensure its parent maintains its ability to expand. If this prop is called AND your data contains empty `children` arrays, the kit will render expansion controls on any row with empty children, and then add an inline loading state within the expanded subrow until those child row(s) are returned to the page [by your query logic]. 
+
+In this code example, 2021 has an empty children array. Toggle it open to see the inline loading state. Once the correct data loads, this state will be replaced with the correct data rows. 
+
+This prop is set to `false` by default.