playbook_ui 14.23.0.pre.alpha.PLAY2205atborderbug9085 → 14.23.0.pre.alpha.PLAY2283multiheaderverticalbordersdoc9335

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7910284d54e19a7de3b5dc301a6c329aa75442f647dee38abf49b2e08ed7c9e8
-  data.tar.gz: e4dc343888e79edcf515894e20dbdd17b32a278e190be0b54bd91ed4e52d826e
+  metadata.gz: 8139114c4c2408005bbcefb07dcd6822fd88ea9d7f26e2b03b7c0bd3ec16d329
+  data.tar.gz: 7299fe01d10983473ca28781b053295e94b51dfb665c12da294910f74f636e1e
 SHA512:
-  metadata.gz: 1cbe316f1055a872f415b745323b15423193c3ebed6d778429631886657eb3b81867e9d8d39d8100a897efbf0e79fd89684067797464c75b216dccefb008b681
-  data.tar.gz: 06faadeca41137228c2271230f914540add4169d9f9003ca460918a60bd3951206f552b657012efb1e4c6fd54f67d54a993004ae7be9574604f11343cf88b205
+  metadata.gz: a8bccc7b982a31fd8a4287021af07a9ab10ccb1613413a05b2ac77c818147ccd329585ed29ca78fc1f47fc1a32ee8b1bf1fb045675e67adb2e0e77b1a304f645
+  data.tar.gz: c5ce85fb28afb5f6b058f067ef6d86c9f7114c4d5e9534c94577786f9733eea41d7ab94907a6bd75197dd35b7f55dc8fbecebd26dbb94c4af4835bdda9eb1eee

data/app/pb_kits/playbook/_playbook.scss

@@ -107,7 +107,6 @@
 @import 'pb_typeahead/typeahead';
 @import 'pb_user/user';
 @import 'pb_user_badge/user_badge';
-@import 'pb_walkthrough/walkthrough';
 @import 'pb_weekday_stacked/weekday_stacked';
 @import 'pb_empty_state/empty_state';
 @import 'utilities/mixins';

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

@@ -20,7 +20,7 @@ interface CustomCellProps {
   customRenderer?: (row: Row<GenericObject>, value: string | undefined) => React.ReactNode
   selectableRows?: boolean
   customStyle?: GenericObject
-}
+} 
 
 export const CustomCell = ({
   getValue,
@@ -35,7 +35,7 @@ export const CustomCell = ({
 
   const handleOnExpand = (row: Row<GenericObject>) => {
     onRowToggleClick && onRowToggleClick(row);
-
+    
     if (!expandedControl) {
       setExpanded({ ...expanded, [row.id]: !row.getIsExpanded() });
     }
@@ -46,8 +46,8 @@ export const CustomCell = ({
 
   return (
     <div style={{ paddingLeft: `${row.depth * 1.25}em`}}>
-      <Flex
-          alignItems="center"
+      <Flex 
+          alignItems="center" 
           columnGap="xs"
           justify="start"
           orientation="row"
@@ -71,11 +71,12 @@ export const CustomCell = ({
           >
             {row.getIsExpanded() ? (
               <Icon cursor="pointer"
-                  icon="circle-play-down"
+                  icon="circle-play"
+                  rotation={90}
               />
             ) : (
               <Icon cursor="pointer"
-                  icon="circle-play"
+                  icon="circle-play"    
                />
             )}
           </button>

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

@@ -4,49 +4,48 @@ import { Header } from "@tanstack/react-table"
 import { GenericObject } from "../../types"
 
 import Icon from "../../pb_icon/_icon"
-import { getAllIcons } from "../../utilities/icons/allicons"
 
 import { displayIcon } from "../Utilities/IconHelpers"
 
 type SortIconButtonProps = {
   header: Header<GenericObject, unknown>
   sortIcon?: string | string[]
+  enableSortingRemoval?: boolean
 }
 
-export const SortIconButton = ({ header, sortIcon }: SortIconButtonProps) => {
-
-const firstIcon = displayIcon(sortIcon)[0] 
-const secondIcon = displayIcon(sortIcon)[1] 
-const upIcon = getAllIcons()["arrowUpShortWide"].icon as unknown as { [key: string]: SVGElement }
-const downIcon = getAllIcons()["arrowDownShortWide"].icon as unknown as { [key: string]: SVGElement }
+export const SortIconButton = ({ header, sortIcon, enableSortingRemoval }: SortIconButtonProps) => {
+  const firstIcon = displayIcon(sortIcon)[0]
+  const secondIcon = displayIcon(sortIcon)[1]
 
   return (
     <>
-      {header.column.getIsSorted() === "desc" ? (
-        <div className="sort-button-icon" 
+      {header.column.getIsSorted() === "desc" && (
+        <div
+            className="sort-button-icon"
             key={firstIcon}
+            style={{ paddingLeft: `${header?.index === 0 ? "2px" : "4px"}` }}
         >
-        { firstIcon === "arrow-up-short-wide" ? (
-          <Icon 
-              className="svg-inline--fa"
-              customIcon={upIcon}
-          /> ) : (
           <Icon icon={firstIcon} />
-        )}
         </div>
-      ) : (
-        <div className="sort-button-icon" 
+      )}
+      {header.column.getIsSorted() === "asc" && (
+        <div
+            className="sort-button-icon"
             key={secondIcon}
+            style={{ paddingLeft: `${header?.index === 0 ? "2px" : "4px"}` }}
         >
-        { secondIcon === "arrow-down-short-wide" ? (
-          <Icon 
-              className="svg-inline--fa"
-              customIcon={downIcon}
-          /> ) : (
           <Icon icon={secondIcon} />
-        )}
+        </div>
+      )}
+      {header.column.getIsSorted() === false && (
+        <div
+            className="sort-button-icon"
+            key={enableSortingRemoval ? "arrow-up-arrow-down" : secondIcon}
+            style={{ paddingLeft: `${header?.index === 0 ? "2px" : "4px"}` }}
+        >
+          <Icon icon={enableSortingRemoval ? "arrow-up-arrow-down" : secondIcon} />
         </div>
       )}
     </>
-  )
-}
+  );
+};

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

@@ -50,6 +50,7 @@ export const TableHeaderCell = ({
     expanded,
     setExpanded,
     expandByDepth,
+    enableSortingRemoval,
     onExpandByDepthClick,
     toggleExpansionIcon,
     sortControl,
@@ -64,6 +65,7 @@ export const TableHeaderCell = ({
 
   type justifyTypes = "none" | "center" | "start" | "end" | "between" | "around" | "evenly"
   
+  
   const toggleSortButton = (event: React.SyntheticEvent) => {
     if (sortControl) {
       const sortIsDesc = header?.column.getIsSorted() === "desc"
@@ -101,7 +103,6 @@ export const TableHeaderCell = ({
     if (!header) return false;
   
     if (header.colSpan > 1 && header.column.parent !== undefined) return true;
-  
     const parent = header.column.parent;
   
     if (!parent) {
@@ -111,7 +112,8 @@ export const TableHeaderCell = ({
     const visibleSiblings = parent.columns.filter(columnHasVisibleLeaf);
     return visibleSiblings.at(-1) === header.column;
   })();
- 
+
+
 const cellClassName = classnames(
   "table-header-cells",
   `${showActionsBar && isActionBarVisible && "header-cells-with-actions"}`,
@@ -257,12 +259,9 @@ const isToggleExpansionEnabled =
             )}
 
           <Flex
-              className={`${header?.index === 0 &&
-                enableSorting &&
-                "header-sort-button pb_th_link"}`}
-              cursor={header?.index === 0 && enableSorting ? "pointer" : "default"}
-              {...(header?.index === 0 &&
-                enableSorting && {
+              className={`${header?.index === 0 && enableSorting && "header-sort-button pb_th_link"} ${header?.index !== 0 && header?.column.getCanSort() && "header-sort-secondary-columns"}`}
+              cursor={((header?.index !== 0 && header?.column.getCanSort()) || (header?.index === 0 && enableSorting) ? "pointer" : "default")}
+              {...(((header?.index !== 0 && header?.column.getCanSort()) || (header?.index === 0 && enableSorting)) && {
                   htmlOptions: {
                     onClick: (event: React.MouseEvent) => toggleSortButton(event),
                     onKeyDown: (event: React.KeyboardEvent) => {
@@ -280,13 +279,13 @@ const isToggleExpansionEnabled =
               {flexRender(header?.column.columnDef.header, header?.getContext())}
             </div>
 
-            {header?.index === 0 &&
-              header.column.getCanSort() &&
-              enableSorting &&
+            {((header?.index !== 0 && header?.column.getCanSort()) || (header?.index === 0 && enableSorting)) &&
               (loading ? (
                 <div className="loading-toggle-icon" />
               ) : (
-                <SortIconButton header={header} 
+                <SortIconButton 
+                    enableSortingRemoval={enableSortingRemoval}
+                    header={header} 
                     sortIcon={sortIcon} 
                 />
               ))}

data/app/pb_kits/playbook/pb_advanced_table/Hooks/useTableState.ts

@@ -16,8 +16,10 @@ import { createCellFunction } from "../Utilities/CellRendererUtils";
 interface UseTableStateProps {
   tableData: GenericObject[];
   columnDefinitions: GenericObject[];
+  enableSortingRemoval?: boolean;
   expandedControl?: GenericObject;
   sortControl?: GenericObject;
+  firstColumnSort?: boolean;
   onRowToggleClick?: (arg: Row<GenericObject>) => void;
   selectableRows?: boolean;
   initialLoadingRowsCount?: number;
@@ -38,6 +40,7 @@ interface UseTableStateProps {
 export function useTableState({
   tableData,
   columnDefinitions,
+  enableSortingRemoval,
   expandedControl,
   sortControl,
   onRowToggleClick,
@@ -83,19 +86,19 @@ export function useTableState({
   const buildColumns = useCallback((columnDefinitions: GenericObject[], isRoot = true): any[] => {
     return columnDefinitions?.map((column, index) => {
       const isFirstColumn = isRoot && index === 0;
-
       // Handle grouped columns
       if (column.columns && column.columns.length > 0) {
         return {
-          header: column.header || column.label || "",
+          header: column.header ?? column.label ?? "",
+          id: column.id ?? column.label ?? `group-${index}`,
           columns: buildColumns(column.columns, false),
         };
       }
-
       // Define the base column structure
       const columnStructure = {
         ...columnHelper.accessor(column.accessor, {
           header: column.header ?? column.label ?? "",
+          enableSorting: isFirstColumn || column.enableSort === true,
         }),
       };
 
@@ -166,7 +169,7 @@ export function useTableState({
     getCoreRowModel: getCoreRowModel(),
     getExpandedRowModel: getExpandedRowModel(),
     getSortedRowModel: getSortedRowModel(),
-    enableSortingRemoval: false,
+    enableSortingRemoval: enableSortingRemoval,
     sortDescFirst: true,
     onRowSelectionChange: setRowSelection,
     onRowPinningChange,

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

@@ -28,7 +28,7 @@ export const TableHeader = ({
   dark = false,
   enableSorting = false,
   id,
-  sortIcon = ["arrow-up-short-wide", "arrow-down-short-wide"],
+  sortIcon = ["arrow-up-wide-short", "arrow-down-short-wide"],
   ...props
 }: TableHeaderProps) => {
   const {

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

@@ -422,6 +422,15 @@
     padding: 2px;
   }
 
+  .header-sort-secondary-columns {
+    color: $primary !important;
+
+    &:hover {
+      background-color: rgba($primary, 0.03);
+      border-radius: $border_radius_md;
+    }
+  }
+
   .toggle-all-icon {
     @extend .button-icon;
     @extend %primary-color-pseudo;
@@ -967,4 +976,19 @@
 // Outside of the pb_advanced_table class for popover
 .pb-advanced-table-popover-option:hover {
   background-color: $bg_light;
-}
+}
+// Removes borders when Wrapped inside the Card Kit
+[class^=pb_card_kit] > .pb_advanced_table .pb_advanced_table_body .last-cell,
+[class^=pb_card_kit] > .pb_advanced_table .pb_advanced_table_header .last-header-cell,
+[class^=pb_card_kit] > .pb_advanced_table .pb_advanced_table_body tr td:last-child,
+[class^=pb_card_kit] > .pb_advanced_table .pb_advanced_table_header tr th:last-child {
+    border-right: none !important;
+}
+
+//  Removes borders when Wrapped inside the Card Kit
+[class^=pb_card_kit] > .pb_advanced_table tr:last-child, 
+[class^=pb_card_kit] > .pb_advanced_table .last-row-cell {
+  td {
+    border-bottom: none !important; 
+  }
+}

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

@@ -40,6 +40,7 @@ type AdvancedTableProps = {
   dark?: boolean
   data?: { [key: string]: string }
   enableToggleExpansion?: "all" | "header" | "none"
+  enableSortingRemoval?: boolean
   expandedControl?: GenericObject
   expandByDepth?: { [key: string]: string | number }
   onExpandByDepthClick?: (arg: number, arg1: any) => void
@@ -87,6 +88,7 @@ const AdvancedTable = (props: AdvancedTableProps) => {
     dark = false,
     data = {},
     enableToggleExpansion = "header",
+    enableSortingRemoval = false,
     expandedControl,
     expandByDepth,
     onExpandByDepthClick,
@@ -122,7 +124,6 @@ const AdvancedTable = (props: AdvancedTableProps) => {
   // Component refs
   const tableWrapperRef = useRef<HTMLDivElement>(null);
 
-  // Initialize table state
   const {
     table,
     expanded,
@@ -137,6 +138,7 @@ const AdvancedTable = (props: AdvancedTableProps) => {
   } = useTableState({
     tableData,
     columnDefinitions,
+    enableSortingRemoval,
     expandedControl,
     sortControl,
     onRowToggleClick,
@@ -333,6 +335,7 @@ const AdvancedTable = (props: AdvancedTableProps) => {
             columnGroupBorderColor={columnGroupBorderColor}
             columnVisibilityControl={columnVisibilityControl}
             customSort={customSort}
+            enableSortingRemoval={enableSortingRemoval}
             enableToggleExpansion={enableToggleExpansion}
             enableVirtualization={virtualizedRows}
             expandByDepth={expandByDepth}

data/app/pb_kits/playbook/pb_advanced_table/advanced_table.html.erb

@@ -11,7 +11,7 @@
     <% if content.present? %>
       <% content.presence %>
     <% else %>
-      <%= pb_rails("advanced_table/table_header", props: { column_definitions: object.column_definitions, enable_toggle_expansion: object.enable_toggle_expansion, responsive: object.responsive, loading: object.loading, selectable_rows: object.selectable_rows, show_actions_bar: object.show_actions_bar }) %>
+      <%= pb_rails("advanced_table/table_header", props: { id: object.id, column_definitions: object.column_definitions, enable_toggle_expansion: object.enable_toggle_expansion, responsive: object.responsive, loading: object.loading, selectable_rows: object.selectable_rows, show_actions_bar: object.show_actions_bar }) %>
       <%= pb_rails("advanced_table/table_body", props: { id: object.id, table_data: object.table_data, column_definitions: object.column_definitions, responsive: object.responsive, loading: object.loading, selectable_rows: object.selectable_rows, enable_toggle_expansion: object.enable_toggle_expansion, row_styling: object.row_styling }) %>
     <% end %>
   <% end %>

data/app/pb_kits/playbook/pb_advanced_table/advanced_table.rb

@@ -54,7 +54,7 @@ module Playbook
       end
 
       def hide_scroll_bar_class
-        scroll_bar_none ? "advanced-table-hide-scrollbar " : ""
+        scroll_bar_none ? "advanced-table-hide-scrollbar" : ""
       end
 
       def hidden_action_bar_class

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

@@ -124,6 +124,23 @@ const columnDefinitions = [
   },
 ]
 
+const columnDefinitionsSort = [
+  {
+    accessor: "year",
+    label: "Year",
+    cellAccessors: ["quarter", "month", "day"],
+  },
+  {
+    accessor: "newEnrollments",
+    label: "New Enrollments",
+    enableSort: true,
+  },
+  {
+    accessor: "scheduledMeetings",
+    label: "Scheduled Meetings",
+  },
+];
+
 const columnDefinitionsCustomRenderer = [
   {
     accessor: "year",
@@ -676,3 +693,20 @@ test("rowStyling prop works as expected", () => {
   const row1 = tableBody.querySelector('tr:nth-child(1)') 
   expect(row1).toHaveStyle({backgroundColor: colors.white, color: colors.black})
 })
+
+test("Sort icon renders with enableSort on individual columns", () => {
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitionsSort}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    />
+  );
+
+  const kit = screen.getByTestId(testId);
+  const sortIcon = kit.querySelector(".sort-button-icon");
+  expect(sortIcon).toBeInTheDocument();
+  const sortButton = kit.querySelector(".header-sort-secondary-columns");
+  expect(sortButton).toBeInTheDocument();
+});
+

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers_vertical_border.html.erb

@@ -0,0 +1,43 @@
+<% column_definitions = [
+  {
+    accessor: "year",
+    label: "Year",
+    cellAccessors: ["quarter", "month", "day"],
+  },
+  {
+    label: "Enrollment Data",
+    columns: [
+      {
+        accessor: "newEnrollments",
+        label: "New Enrollments",
+      },
+      {
+        accessor: "scheduledMeetings",
+        label: "Scheduled Meetings",
+      },
+    ],
+  },
+  {
+    label: "Performance Data",
+    columns: [
+      {
+        accessor: "attendanceRate",
+        label: "Attendance Rate",
+      },
+      {
+        accessor: "completedClasses",
+        label: "Completed Classes",
+      },
+      {
+        accessor: "classCompletionRate",
+        label: "Class Completion Rate",
+      },
+      {
+        accessor: "graduatedStudents",
+        label: "Graduated Students",
+      },
+    ],
+  },
+] %>
+
+<%= pb_rails("advanced_table", props: { id: "table_multi_headers_vertical_borders", table_data: @table_data, column_definitions: column_definitions, table_props: { vertical_border: true } }) %>

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

@@ -0,0 +1,64 @@
+import React from "react"
+import AdvancedTable from '../../pb_advanced_table/_advanced_table'
+import MOCK_DATA from "./advanced_table_mock_data.json"
+
+const AdvancedTableColumnHeadersVerticalBorder = (props) => {
+  const columnDefinitions = [
+    {
+      accessor: "year",
+      label: "Year",
+      cellAccessors: ["quarter", "month", "day"],
+    },
+    {
+      label: "Enrollment Data",
+      columns: [
+        {
+          accessor: "newEnrollments",
+          label: "New Enrollments",
+        },
+        {
+          accessor: "scheduledMeetings",
+          label: "Scheduled Meetings",
+        },
+      ],
+    },
+    {
+      label: "Performance Data",
+      columns: [
+        {
+          accessor: "attendanceRate",
+          label: "Attendance Rate",
+        },
+        {
+          accessor: "completedClasses",
+          label: "Completed Classes",
+        },
+        {
+          accessor: "classCompletionRate",
+          label: "Class Completion Rate",
+        },
+        {
+          accessor: "graduatedStudents",
+          label: "Graduated Students",
+        },
+      ],
+    },
+  ];
+  
+  const tableProps = {
+    verticalBorder: true
+  }
+
+  return (
+    <>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          tableData={MOCK_DATA}
+          tableProps={tableProps}
+          {...props}
+      />
+    </>
+  )
+}
+
+export default AdvancedTableColumnHeadersVerticalBorder

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_selectable_rows_header_rails.html.erb

@@ -31,7 +31,7 @@
 ] %>
 
 <%= pb_rails("advanced_table", props: {
-  id: "selectable_rows_with_actions",
+  id: "selectable_rows_with_header_no_action_bar",
   table_data: @table_data_no_subrows,
   column_definitions: column_definitions,
   selectable_rows: true,

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_selectable_rows_rails.html.erb

@@ -34,6 +34,6 @@
 %>
 
 <%= pb_rails("advanced_table", props: { id: "selectable_rows", table_data: @table_data_with_id, column_definitions: column_definitions, selectable_rows: true }) do %>
-  <%= pb_rails("advanced_table/table_header", props: { column_definitions: column_definitions, selectable_rows: true }) %>
+  <%= pb_rails("advanced_table/table_header", props: { id: "selectable_rows", column_definitions: column_definitions, selectable_rows: true }) %>
   <%= pb_rails("advanced_table/table_body", props: { id: "selectable_rows", table_data: @table_data_with_id, column_definitions: column_definitions, subrow_headers: subrow_headers, enable_toggle_expansion: "all", selectable_rows: true }) %>
 <% end %>

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

@@ -0,0 +1,55 @@
+import React from "react"
+import AdvancedTable from '../../pb_advanced_table/_advanced_table'
+import MOCK_DATA from "./advanced_table_mock_data.json"
+
+const AdvancedTableSortPerColumn = (props) => {
+  const columnDefinitions = [
+    {
+      accessor: "year",
+      label: "Year",
+      cellAccessors: ["quarter", "month", "day"],
+    },
+    {
+      accessor: "newEnrollments",
+      label: "New Enrollments",
+      enableSort: true,
+    },
+    {
+      accessor: "scheduledMeetings",
+      label: "Scheduled Meetings",
+    },
+    {
+      accessor: "attendanceRate",
+      label: "Attendance Rate",
+      enableSort: true,
+    },
+    {
+      accessor: "completedClasses",
+      label: "Completed Classes",
+    },
+    {
+      accessor: "classCompletionRate",
+      label: "Class Completion Rate",
+    },
+    {
+      accessor: "graduatedStudents",
+      label: "Graduated Students",
+    },
+  ]
+
+  return (
+    <div>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          enableSortingRemoval
+          tableData={MOCK_DATA}
+          {...props}
+      >
+        <AdvancedTable.Header />
+        <AdvancedTable.Body />
+      </AdvancedTable>
+    </div>
+  )
+}
+
+export default AdvancedTableSortPerColumn;

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

@@ -0,0 +1,6 @@
+Sorting can now be enabled on any of the columns. To do this, add `enableSort:true` to the columnDefinition of the column you want sorting enabled on. Once enabled, clicking on the header will toggle sort between ascending and descending.
+
+The optional `enableSortingRemoval` prop can also be used in conjunction with sorting functionality. This prop is set to 'false' by default but if set to 'true' sorting order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...
+It is recommended that `enableSortingRemoval` be set to 'true' when sort is enabled on mutiple columns so that sorting direction is always clear via the sort icon. 
+
+__NOTE:__ For sort on the first column, continue to use the separate `enableSorting` prop on AdvancedTable.Header as [shown here](https://playbook.powerapp.cloud/kits/advanced_table/sorting/react#enable-sorting).