playbook_ui 14.10.0.pre.rc.0 → 14.10.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eeac1641692681cc2b3574b0b29cd8aada02014cef63306160e935b9ad0a395
-  data.tar.gz: 1711db522e35dd4218ec9ecb47d4316d0b58c731e4d4b95cc62a8197cb4034b8
+  metadata.gz: a26cbd63c991cfedbfa4219cb77eec222fa67ac6f81e08705a5507fff7ea902c
+  data.tar.gz: 63a8ddefb0ce22b71bfd792889947dcb0ab5591e3827e3f11605db87ad62135c
 SHA512:
-  metadata.gz: 0bacb49cde1c17d2e4afc1f69939dbdd3bd5fe3c40d20b20b26ea43c3171363eb464a54dcd6ddeb6df4a3c1a537374f362c7dfd10b274757934e3e03c300b7e5
-  data.tar.gz: 00e186fdd8852d32e48e104742c3e9e8f76da180b3fead2acd32b24067b4f5d033e8ec4fb65c25fa9ccc858b32a3766b5ae687cf042b8fc6fc5b88e18be15e70
+  metadata.gz: 3ec47c76b5d3fe00e47ec13d4a685104ba2cdf183e2d26c62f21cfe74c4bb06659efadbcc6fecb855108506f7717c7f7c5db527e89a4894233cd7b3baea55abc
+  data.tar.gz: 6896c1afdc5da0aaf7ecb261c94bb6b326388f7ed027d9220dc41d95e96fcbcc2736ad69aaa3bbf9af023e29de27099dd5e1e4da34e214e40ba6722666e0b14e

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

@@ -7,6 +7,7 @@ import {
   createColumnHelper,
   getCoreRowModel,
   getExpandedRowModel,
+  getPaginationRowModel,
   getSortedRowModel,
   Row,
   useReactTable,
@@ -25,6 +26,7 @@ import { updateExpandAndCollapseState } from "./Utilities/ExpansionControlHelper
 import { CustomCell } from "./Components/CustomCell"
 import { TableHeader } from "./SubKits/TableHeader"
 import { TableBody } from "./SubKits/TableBody"
+import Pagination from "../pb_pagination/_pagination"
 
 type AdvancedTableProps = {
   aria?: { [key: string]: string }
@@ -42,6 +44,8 @@ type AdvancedTableProps = {
   loading?: boolean | string
   onRowToggleClick?: (arg: Row<GenericObject>) => void
   onToggleExpansionClick?: (arg: Row<GenericObject>) => void
+  pagination?: boolean,
+  paginationProps?: GenericObject
   responsive?: "scroll" | "none",
   sortControl?: GenericObject
   tableData: GenericObject[]
@@ -67,6 +71,8 @@ const AdvancedTable = (props: AdvancedTableProps) => {
     loading,
     onRowToggleClick,
     onToggleExpansionClick,
+    pagination = false,
+    paginationProps,
     responsive = "scroll",
     sortControl,
     tableData,
@@ -177,6 +183,17 @@ const AdvancedTable = (props: AdvancedTableProps) => {
     }
   }
 
+  const paginationInitializer = pagination ? {
+    getPaginationRowModel: getPaginationRowModel(),
+    paginateExpandedRows: false,
+    initialState: {
+        pagination: {
+            pageIndex: paginationProps?.pageIndex ?? 0,
+            pageSize: paginationProps?.pageSize ??  20,
+        },
+    },
+} : {}
+
 //initialize table
   const table = useReactTable({
     data: loading ? Array(loadingStateRowCount).fill({}) : tableData,
@@ -189,6 +206,7 @@ const AdvancedTable = (props: AdvancedTableProps) => {
     enableSortingRemoval: false,
     sortDescFirst: true,
     ...expandAndSortState(),
+    ... paginationInitializer,
     ...tableOptions,
   })
 
@@ -227,6 +245,10 @@ const AdvancedTable = (props: AdvancedTableProps) => {
     className
   )
 
+  const onPageChange = (page: number) => {
+    table.setPageIndex(page - 1)
+  }
+
   return (
     <div {...ariaProps} 
         {...dataProps} 
@@ -250,23 +272,45 @@ const AdvancedTable = (props: AdvancedTableProps) => {
             toggleExpansionIcon,
           }}
       >
-        <Table
-            className={`${loading ? "content-loading" : ""}`}
-            dark={dark}
-            dataTable
-            numberSpacing="tabular"
-            responsive="none"
-            {...tableProps}
-        >
-          {children ? (
-            children
-          ) : (
-            <>
-              <TableHeader />
-              <TableBody />
-            </>
-          )}
-        </Table>
+        <>
+          {pagination &&
+              <Pagination
+                  current={table.getState().pagination.pageIndex + 1}
+                  key={`pagination-top-${table.getState().pagination.pageIndex + 1}`}
+                  marginBottom="xs"
+                  onChange={onPageChange}
+                  range={paginationProps?.range ? paginationProps?.range : 5}
+                  total={table.getPageCount()}
+                  />
+          }
+          <Table
+              className={`${loading ? "content-loading" : ""}`}
+              dark={dark}
+              dataTable
+              numberSpacing="tabular"
+              responsive="none"
+              {...tableProps}
+          >
+            {children ? (
+              children
+            ) : (
+              <>
+                <TableHeader />
+                <TableBody />
+              </>
+            )}
+          </Table>
+          {pagination &&
+            <Pagination
+                current={table.getState().pagination.pageIndex + 1}
+                key={`pagination-bottom-${table.getState().pagination.pageIndex + 1}`}
+                marginTop="xs"
+                onChange={onPageChange}
+                range={paginationProps?.range ? paginationProps?.range : 5}
+                total={table.getPageCount()}
+            />
+          }
+        </>
       </AdvancedTableContext.Provider>
     </div>
   )

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

@@ -0,0 +1,50 @@
+import React from "react"
+import { AdvancedTable } from "playbook-ui"
+import PAGINATION_MOCK_DATA from "./advanced_table_pagination_mock_data.json"
+
+const AdvancedTablePagination = (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 (
+    <>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          pagination
+          tableData={PAGINATION_MOCK_DATA}
+          {...props}
+      />
+    </>
+  )
+}
+
+export default AdvancedTablePagination

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

@@ -0,0 +1 @@
+`pagination` is an optional prop that can be used to add pagination to the AdvancedTable. If present, it will add pagination with default values for pageSize, etc. To customize pagination, you can also use `paginationProps` shown in the next example.

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

@@ -0,0 +1,57 @@
+import React from "react"
+import { AdvancedTable } from "playbook-ui"
+import PAGINATION_MOCK_DATA from "./advanced_table_pagination_mock_data.json"
+
+const AdvancedTablePaginationWithProps = (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",
+    },
+  ]
+
+  const paginationProps = {
+    pageIndex: 1,
+    pageSize: 10,
+    range: 2
+  }
+  
+  return (
+    <>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          pagination
+          paginationProps={paginationProps}
+          tableData={PAGINATION_MOCK_DATA}
+          {...props}
+      />
+    </>
+  )
+}
+
+export default AdvancedTablePaginationWithProps

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

@@ -0,0 +1,5 @@
+`paginationProps` is an optional prop that can be used to further customize pagination for the AdvancedTable. This prop is an object with 2 optional items:
+
+- `pageIndex`: An optional prop to set which page is set to open on initial load. Default is '0'
+- `pageSize`: An optional prop to set total number of rows for each page before the Table paginates. Default is '20'
+- `range`: The range prop determines how many pages to display in the Pagination component. Regardless of this value, the first two and last two pages are always visible to facilitate navigation to the beginning and end of the pagination. If these always-visible pages fall within the specified range, they are included in the display. If they fall outside the range, the pagination will show additional pages up to the number defined by the range prop. See [here for more details](https://playbook.powerapp.cloud/kits/pagination/react#default). Default is set to '5'