playbook_ui 13.17.0 → 13.18.0.pre.alpha.PBNTR191AdvancedTableFinalFixes2159

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

@@ -1,4 +1,4 @@
-import React from "react";
+import React, {useState} from "react";
 import { render, screen } from "../utilities/test-utils";
 
 import { AdvancedTable } from "../";
@@ -13,7 +13,25 @@ const MOCK_DATA = [
     scheduledMeetings: "10",
     children: [
       {
-        year: "2011",
+        year: "2021",
+        quarter: "Q1",
+        month: null,
+        day: null,
+        newEnrollments: "2",
+        scheduledMeetings: "35",
+      },
+    ],
+  },
+  {
+    year: "2022",
+    quarter: null,
+    month: null,
+    day: null,
+    newEnrollments: "20",
+    scheduledMeetings: "10",
+    children: [
+      {
+        year: "2022",
         quarter: "Q1",
         month: null,
         day: null,
@@ -40,9 +58,70 @@ const columnDefinitions = [
   },
 ];
 
+const subRowHeaders = ["Quarter"]
+
 const testId = "advanced_table";
 
-test("generated scaffold test", () => {
+const AdvancedTableExpandControl = () => {
+  const [expanded, setExpanded] = useState({'0': true})
+
+  const expandedControl = {
+    value: expanded,
+    onChange: setExpanded,
+  }
+
+return (
+  <div>
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        expandedControl={expandedControl}
+        tableData={MOCK_DATA}
+    />
+  </div>
+);
+}
+
+const AdvancedTableSortControl = () => {
+  const [isSortDesc, setIsSortDesc] = useState({desc: false})
+
+  const sortControl = {
+    value: isSortDesc,
+    onChange: setIsSortDesc,
+  }
+
+return (
+  <div>
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{testid: testId}}
+        sortControl={sortControl}
+        tableData={MOCK_DATA}
+      >
+        <AdvancedTable.Header enableSorting />
+        <AdvancedTable.Body />
+      </AdvancedTable>
+  </div>
+);
+}
+
+const tableOptions = {
+  initialState: {
+      sorting: [
+        {
+          id: "year",
+          desc: true,
+        },
+      ],
+    },
+}
+
+const tableProps = {
+  container: false,
+  sticky: true
+}
+
+test("Generates default kit and classname", () => {
   render(
     <AdvancedTable
         columnDefinitions={columnDefinitions}
@@ -53,4 +132,250 @@ test("generated scaffold test", () => {
 
   const kit = screen.getByTestId(testId);
   expect(kit).toBeInTheDocument();
+  expect(kit).toHaveClass('pb_advanced_table')
+});
+
+test("Generates aria label", () => {
+  render(
+    <AdvancedTable
+        aria={{label:testId}}
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  expect(kit).toHaveAttribute('aria-label', testId)
+});
+
+test("Row toggle button exists and toggles subrows open and closed", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const rowButton = kit.querySelector(".gray-icon.expand-toggle-icon")
+  expect(rowButton).toBeInTheDocument()
+  const subRow1 = kit.querySelector(".bg-white.depth-sub-row-1")
+  expect(subRow1).not.toBeInTheDocument()
+  rowButton.click()
+  const subRow = kit.querySelector(".bg-white.depth-sub-row-1")
+  expect(subRow).toBeInTheDocument()
+});
+
+test("toggleExpansionAll button exists and toggles subrows open and closed", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const toggleButton = kit.querySelector(".gray-icon.toggle-all-icon")
+  expect(toggleButton).toBeInTheDocument()
+  const subRow1 = kit.querySelector(".bg-white.depth-sub-row-1")
+  expect(subRow1).not.toBeInTheDocument()
+  toggleButton.click()
+  const subRow = kit.querySelector(".bg-white.depth-sub-row-1")
+  expect(subRow).toBeInTheDocument()
+});
+
+test("loading state + initialLoadingRowCount prop", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        initialLoadingRowsCount={13}
+        loading
+        tableData={MOCK_DATA}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const table = kit.querySelector('table')
+  expect(table).toHaveClass('pb_table table-sm table-responsive-none table-card data_table ns_tabular content-loading')
+
+  const tableBody = kit.querySelector('tbody')
+  const tableRows = tableBody.getElementsByTagName('tr')
+  expect(tableRows).toHaveLength(13)
+});
+
+test("subRowHeaders are rendered", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    >
+      <AdvancedTable.Header />
+      <AdvancedTable.Body subRowHeaders={subRowHeaders}/>
+    </AdvancedTable>
+    );
+
+  const kit = screen.getByTestId(testId);
+
+  const rowButton = kit.querySelector(".gray-icon.expand-toggle-icon")
+  rowButton.click()
+  
+  const subRowHeader = kit.querySelector(".custom-row.bg-silver")
+  expect(subRowHeader).toBeInTheDocument()
+});
+
+test("expandControl prop works as expected", () => {
+  render (<AdvancedTableExpandControl/>)
+
+  const kit = screen.getByTestId(testId);
+  const subRow = kit.querySelector(".bg-white.depth-sub-row-1")
+  expect(subRow).toBeInTheDocument()
+})
+
+test("tableOptions prop functions as expected", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+        tableOptions={tableOptions}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const row1 = kit.getElementsByTagName('tr')[1]
+  
+  expect(row1.id).toBe("1-1-0-row")
+});
+
+test("tableProps prop functions as expected", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+        tableProps={tableProps}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const table = kit.querySelector('table')
+  expect(table).toHaveClass("pb_table table-sm table-responsive-none data_table sticky-header ns_tabular")
+});
+
+test("enableExpansionIcon changes icon", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+        tableProps={tableProps}
+        toggleExpansionIcon= "chevron-up"
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const tableHead = kit.querySelector('table')
+  const toggleIcon= tableHead.querySelector(".pb_icon_kit")
+  expect(toggleIcon).toHaveClass("fa-chevron-up")
+});
+
+test("sortIcon changes icon", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+        tableProps={tableProps}
+    >
+      <AdvancedTable.Header 
+          enableSorting
+          sortIcon= {["chevron-up","chevron-down"]}
+      />
+      <AdvancedTable.Body />
+    </AdvancedTable>
+  );
+
+  const kit = screen.getByTestId(testId);
+  const sortIcon = kit.querySelector('.sort-button-icon')
+  const icon= sortIcon.querySelector(".pb_icon_kit")
+  expect(icon).toHaveClass("fa-chevron-down")
+});
+
+test("Sort icon renders with enableSorting + sortControl works as expected", () => {
+  render (<AdvancedTableSortControl/>)
+
+  const kit = screen.getByTestId(testId);
+  const sortIcon = kit.querySelector(".sort-button-icon")
+  expect(sortIcon).toBeInTheDocument()
+
+  const row1 = kit.getElementsByTagName('tr')[1]
+  
+  expect(row1.id).toBe("1-1-0-row")
+})
+
+test("sort button exists and sorts column data", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    >
+      <AdvancedTable.Header enableSorting />
+      <AdvancedTable.Body />
+    </AdvancedTable>
+  );
+
+  const kit = screen.getByTestId(testId);
+
+  const sortButton= kit.querySelector(".pb_flex_kit_orientation_row_justify_content_between_align_items_top_spacing_none.pl_xxs.cursor_pointer.header-sort-button.pb_th_link")
+  expect(sortButton).toBeInTheDocument()
+
+  const row1 = kit.getElementsByTagName('tr')[1]
+  
+  expect(row1.id).toBe("0-0-0-row")
+  sortButton.click()
+
+  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')
 });

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

@@ -0,0 +1,52 @@
+import React from "react";
+import { AdvancedTable } from "../../";
+import { MOCK_DATA } from "./_mock_data";
+
+const AdvancedTableCollapsibleTrail = (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",
+    },
+  ];
+
+  return (
+    <div>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          tableData={MOCK_DATA}
+          {...props}
+      >
+        <AdvancedTable.Header />
+        <AdvancedTable.Body collapsibleTrail={false} />
+      </AdvancedTable>
+    </div>
+  );
+};
+
+export default AdvancedTableCollapsibleTrail;

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

@@ -0,0 +1 @@
+`collapsibleTrail` is an optional prop that is set to 'true' by default. If set to 'false', it will remove the trail on the left of rows when subRows are toggled open.

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

@@ -1,7 +1,12 @@
-The AdvancedTable kit takes the table data and automatically renders expandable subrows for nested items to any depth needed. In it's simplest form, the kit has two required props: 
+The AdvancedTable kit accepts tree data and automatically renders expansion controls for nested subrows, to any depth, based on the data it is given. In it's simplest form, __the kit has two required props__: 
 
-`tableData` is the data that the kit needs to consume to render the table. This data will take the structure of an array of objects where each object will be rendered as a row with the key/value pairs being the column values. If an object within that data has children, the kit will automatically create subRows with icon buttons on the parent rows to toggle the subRows open or closed. The toggleExpansionAll button in the first column header can also be used to toggle expansion for the top level parent rows. For a visual of the data structure needed for `tableData`, see [here](https://github.com/powerhome/playbook/blob/PBNTR-177-New-Advanced-Table-Kit/playbook/app/pb_kits/playbook/pb_advanced_table/README.md).
+### tableData
 
+`tableData` accepts an array of objects as the table data. Each object is a table row, and each key:value pair within an object is a column value within that row. Nested children within a data object are automatically rendered as subrows under their parent row. Each parent row is prepended with expansion controls for toggling its nested child rows. The `toggleExpansionAll` button in the first column header can also be used to toggle expansion of all parent rows within the table.
+
+For a visual of the data structure needed for `tableData`, see [here](https://github.com/powerhome/playbook/tree/master/playbook/app/pb_kits/playbook/pb_advanced_table#readme).
+
+### columnDefinitions
 
 `columnDefinitions` maps to the columns prop on the Tanstack table. Column definitions are the single most important part of building a table as they are responsible for building the underlying data model that is used for all sorting, expansion, etc. `ColumnDefinitions` in the AdvancedTable kit is a array of objects as seen in the code snippet below. Each object within the array has two REQUIRED items:
 

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

@@ -0,0 +1,59 @@
+import React, { useState } from "react";
+import { AdvancedTable } from "../../";
+import { MOCK_DATA } from "./_mock_data";
+
+const AdvancedTableExpandedControl = (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",
+    },
+  ];
+
+  //State for manually effecting what is expanded
+  const [expanded, setExpanded] = useState({'0': true, '0.0': true, '0.0.1': true})
+
+  //Passing expanded state to AdvancedTable as prop
+  const expandedControl = {
+    value: expanded,
+    onChange: setExpanded,
+  }
+
+  return (
+    <div>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          expandedControl={expandedControl}
+          tableData={MOCK_DATA}
+          {...props}
+      />
+    </div>
+  );
+};
+
+export default AdvancedTableExpandedControl;

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

@@ -0,0 +1,18 @@
+`expandedControl` is an optional prop that can be used to gain greater control over the expansion state of the Advanced Table. Tanstack handles expansion itself, however it does provide for a way to handle the state manually if needed. Usecases for this include needing to store the expansion state so it persists on page reload, set an initial expansion state, etc. 
+
+In this example we are showing that if initial expansion state is set, it will render the table expanded according to that state. 
+
+The expanded state must be an object with key/value pairs where the key is the row id and the value is a boolean, true or false. Tanstack by default assigns row ids based on index and depth of the row as can be seen in this example. For more information on row ids, see [here](https://tanstack.com/table/v8/docs/api/core/row#id).
+
+### Single Row Expansion
+
+By default, the click event on the row level toggleExpansion icon simply toggles the immediate sub rows open or closed. If you want to attach further logic to that button, the optional `onRowToggleClick` prop can be used. This click event provides one argument that can be hooked into: the current `row` object. Any additional functionality provided through this onClick will be applied in addition to the default.
+
+###  Multi-Row Expansion
+
+Similar to the row level click event, the default of the click event on the toggleExpansion buttons that render in the first column header (and the subRow Header rows if prop enabled) toggles all top level rows open and closed. If you want to attach further logic to that button, the optional `onToggleExpansionClick` prop can be used. This click event provides one argument that can be hooked into: the current `row` object. Any additional functionality provided through this onClick will be applied in addition to the default.
+
+### ToggleExpansionIcon
+
+`ToggleExpansionIcon` is another optional prop that can be used to customize the icon for the toggleExpansion button. This prop takes a string value with the default set to `arrows-from-line`. All strings must be valid FA icons.
+

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

@@ -0,0 +1,60 @@
+import React, { useState } from "react";
+import { AdvancedTable } from "../../";
+import { Button } from "../../"
+import { MOCK_DATA } from "./_mock_data";
+
+const AdvancedTableLoading = (props) => {
+
+const [isloading, setIsLoading] = useState(true)
+
+  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",
+    },
+  ];
+
+  return (
+    <div>
+      <Button marginBottom="md" 
+          onClick={()=> setIsLoading(!isloading)}
+          text="Toggle Loading State"
+          variant="secondary"
+          {...props}
+      />
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          loading={isloading}
+          tableData={MOCK_DATA}
+          {...props}
+      />
+    </div>
+  );
+};
+
+export default AdvancedTableLoading;

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

@@ -0,0 +1,3 @@
+the optional `loading` prop takes a boolean value that can be managed using state. If loading is true, the table will display the loading skeleton and once loading is false, the table will render with the data provided. 
+
+By default, the inital row count of the loading skeleton is set to 10. If you want more control over this initial row count, the optional `initialLoadingRowCount` prop can be used to to pass in a number. __NOTE__: This is only for the first render of the table, subsequent loading skeleton row count logic is handled within the kit itself.

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

@@ -35,20 +35,15 @@ const AdvancedTableSort = (props) => {
     },
   ];
 
-    //Render the subRow header rows
-    const subRowHeaders = ["Quarter", "Month", "Day"]
-
-
   return (
     <div>
       <AdvancedTable
           columnDefinitions={columnDefinitions}
-          enableToggleExpansion="all"
           tableData={MOCK_DATA}
           {...props}
       >
         <AdvancedTable.Header enableSorting />
-        <AdvancedTable.Body subRowHeaders={subRowHeaders} />
+        <AdvancedTable.Body />
       </AdvancedTable>
     </div>
   );

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

@@ -0,0 +1,5 @@
+the `enableSorting` prop is a boolean prop set to false by default. If true, the table will add sort logic linked to the sort button in the header. Clicking the sort button will toggle sort between ascending and descending. Currently this sort functionality is only available on the first column.
+
+### sortIcon
+
+An optional prop, `sortIcon` allows you to customize your icon sets by passing it an array of any comma-separated pair of icon values. The first icon value will replace the kit's default icon when sort direction is desc, and the second value will replace the default icon when sort direction is asc. `sortIcon` also allows you to pass it a single icon as a string, in which case the icon will not toggle with the sort state. Default for this prop is `["arrow-up-short-wide", "arrow-down-short-wide"]`. All strings must be valid FA icons.

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

@@ -0,0 +1,63 @@
+import React, { useState } from "react";
+import { AdvancedTable } from "../..";
+import { MOCK_DATA } from "./_mock_data";
+
+const AdvancedTableSortControl = (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",
+    },
+  ];
+
+  //State for sort direction
+  const [isSortDesc, setIsSortDesc] = useState({desc: false})
+
+  // //Passing sort state to AdvancedTable as prop
+  const sortControl = {
+    value: isSortDesc,
+    onChange: setIsSortDesc,
+  }
+
+
+  return (
+    <div>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          sortControl={sortControl}
+          tableData={MOCK_DATA}
+          {...props}
+      >
+        <AdvancedTable.Header enableSorting />
+        <AdvancedTable.Body />
+      </AdvancedTable>
+    </div>
+  );
+};
+
+export default AdvancedTableSortControl;

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

@@ -0,0 +1,3 @@
+`sortControl` is an optional prop that can be used to gain greater control over the sort state of the Advanced Table. Tanstack handles sort itself, however it does provide for a way to handle the state manually if needed. Usecases for this include needing to store the sort state so it persists on page reload, set an initial sort state, etc. 
+
+The sort state must be an object with a single key/value pair, with the key being "desc" and the value being a boolean. The default for sort directino is `desc: true`.