playbook_ui 14.25.0.pre.rc.0 → 14.25.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7acc2e53df8398198aa9fed4b39f2dc04a954918e790a904220898da123e15e8
-  data.tar.gz: 606391f77a95f67235606bdf5113c7f2fb1c749ff7bb99999fff120f358f7d85
+  metadata.gz: f40a6c3f571115d04deb79b25929f5db0e7d3574b3e8621748c799c197478e6e
+  data.tar.gz: 149c9509d0200a66d3f0523e57a2d75ed6254b90ad54e8b98a7c8ed8fbb21faa
 SHA512:
-  metadata.gz: 4f381cbe31526cc2e7fe5c0f90402e169e88d6bca29b6257a200460ca24539db770651df305094d9ac4b0db2ffb39d435308f0b4af4e91ce3a57fa69c51a78a6
-  data.tar.gz: b2d994c35bd502f6221e469c7a65da5911222b835672bbfa955d8b12f9612e47dd4bd9b20c4f08e6e57a2c2163e0b4c415f1ac516b62eef772ca9540487cb7fb
+  metadata.gz: 25afeb9d1bb9418e5e2e4ce343d8899bd2a546f9e2e67384359b1315db270d674044c6f6ef0997bc19978f40f8000afc335fee6d446331905d426799a435cb99
+  data.tar.gz: 0baf6140f040646b25171d0150fe074c54af0a3bd276eab0ea925c8eb99ca0ad5a061c836100f16bf6699f4de3d86d37d91d654267cedde5ad6a7ba1702be98e

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

@@ -58,7 +58,9 @@ const TableCellRenderer = ({
         // Find the “owning” colDefinition by accessor. Needed for multi column logic
         const colDef = findColumnDefByAccessor(columnDefinitions ?? [], column.id)
         const cellAlignment = colDef?.columnStyling?.cellAlignment ?? "right"
-
+        const paddingValue = colDef?.columnStyling?.cellPadding ?? customRowStyle?.cellPadding
+        const paddingClass = paddingValue ? `p_${paddingValue}` : undefined
+        
         return (
           <td
               align={cellAlignment}
@@ -68,6 +70,7 @@ const TableCellRenderer = ({
                 isPinnedLeft && 'pinned-left',
                 stickyLeftColumn && stickyLeftColumn.length > 0 && isPinnedLeft && 'sticky-left',
                 isLastCell && 'last-cell',
+                paddingClass
               )}
               key={`${cell.id}-data`}
               style={{

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

@@ -113,7 +113,6 @@ export const TableHeaderCell = ({
     return visibleSiblings.at(-1) === header.column;
   })();
 
-
 const cellClassName = classnames(
   "table-header-cells",
   `${showActionsBar && isActionBarVisible && "header-cells-with-actions"}`,
@@ -122,7 +121,7 @@ const cellClassName = classnames(
   { "pinned-left": responsive === "scroll" && isPinnedLeft },
    isLastHeaderCell ? "last-header-cell" : "",
   stickyLeftColumn && stickyLeftColumn.length > 0 && isPinnedLeft ? 'sticky-left' : "",
-
+  colDef?.columnStyling?.headerPadding && `p_${colDef?.columnStyling?.headerPadding}`
 ); 
 
 const cellId = `${loading ? 

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

@@ -651,6 +651,36 @@ test("columnStyling.cellAlignment sets each <td> align attribute as expected", (
   expect(firstEnrollmentCell).toHaveAttribute("align", "left");
 });
 
+test("columnStyling.cellPadding sets cell padding", () => {
+  const styledColumnDefs = [
+    {
+      accessor: "year",
+      label: "Year",
+      cellAccessors: ["quarter", "month", "day"],
+    },
+    {
+      accessor: "newEnrollments",
+      label: "New Enrollments",
+      columnStyling: { cellPadding: "none" },
+    },
+    {
+      accessor: "scheduledMeetings",
+      label: "Scheduled Meetings",
+    },
+  ];
+
+  render(
+    <AdvancedTable
+        columnDefinitions={styledColumnDefs}
+        data={{ testid: testId }}
+        tableData={MOCK_DATA}
+    />
+  );
+
+  const firstEnrollmentCell = screen.getAllByText("20")[0].closest("td");
+  expect(firstEnrollmentCell).toHaveClass('p_none')
+});
+
 test("renders virtualized table rows and header", () => {
   render(
     <AdvancedTable
@@ -694,6 +724,32 @@ test("rowStyling prop works as expected", () => {
   expect(row1).toHaveStyle({backgroundColor: colors.white, color: colors.black})
 })
 
+test("rowStyling prop to allow padding control", () => {
+  const rowStyling = [
+  {
+    rowId: "1",
+    cellPadding: "lg"
+  },
+];
+
+  render(
+    <AdvancedTable
+        columnDefinitions={columnDefinitions}
+        data={{ testid: testId }}
+        rowStyling={rowStyling}
+        tableData={MOCK_DATA_WITH_ID}
+    />
+  )
+
+  const kit = screen.getByTestId(testId)
+  const tableBody = kit.querySelector('tbody')
+  const row1 = tableBody.querySelector('tr:nth-child(1)') 
+   const cells = row1.querySelectorAll("td");
+  cells.forEach((cell) => {
+    expect(cell.classList.contains("p_lg")).toBe(true);
+  });
+})
+
 test("Sort icon renders with enableSort on individual columns", () => {
   render(
     <AdvancedTable

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

@@ -0,0 +1,60 @@
+import React from "react"
+import AdvancedTable from '../_advanced_table'
+import Background from '../../pb_background/_background'
+import MOCK_DATA from "./advanced_table_mock_data_with_id.json"
+
+const AdvancedTablePaddingControl = (props) => {
+  const columnDefinitions = [
+    {
+      accessor: "year",
+      label: "Year",
+      cellAccessors: ["quarter", "month", "day"],
+    },
+    {
+      accessor: "newEnrollments",
+      label: "New Enrollments",
+      columnStyling:{cellPadding: "none"},
+      customRenderer: (row, value) => (
+        <Background 
+            backgroundColor={row.original.newEnrollments > 20 ? "success_secondary" : "warning_secondary"}
+            padding="xs" 
+        >
+         {value}
+        </Background>
+      ), 
+
+    },
+    {
+      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}
+      />
+    </div>
+  )
+}
+
+export default AdvancedTablePaddingControl

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

@@ -0,0 +1,3 @@
+`columnStyling` can also be used to control padding on all cells in a given column via the use of the `cellPadding` key/value pair. `cellPadding` lets you use 'xxs', 'xs', 'sm', 'md', 'lg', 'xl' and 'none'.  
+
+This control can be used in conjunction with the `customRenderer` item within each columnDefinition to achieve custom background colors for individual cells as seen here. 

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

@@ -0,0 +1,57 @@
+import React from "react"
+import AdvancedTable from '../_advanced_table'
+import MOCK_DATA from "./advanced_table_mock_data_with_id.json"
+
+const AdvancedTablePaddingControlPerRow = (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 rowStyling = [
+  {
+    rowId: "1",
+    cellPadding:"md"
+  },
+];
+
+  return (
+    <div>
+      <AdvancedTable
+          columnDefinitions={columnDefinitions}
+          rowStyling={rowStyling}
+          tableData={MOCK_DATA}
+          {...props}
+      />
+    </div>
+  )
+}
+
+export default AdvancedTablePaddingControlPerRow

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

@@ -0,0 +1 @@
+`rowStyling` can also be used to control padding on all cells in a given row via the use of the `cellPadding` key/value pair as shown here. `cellPadding` lets you use 'xxs', 'xs', 'sm', 'md', 'lg', 'xl' and 'none'.

data/app/pb_kits/playbook/pb_advanced_table/docs/example.yml

@@ -68,8 +68,10 @@ examples:
   - advanced_table_column_visibility_multi: Column Visibility Control with Multi-Header Columns
   - advanced_table_scrollbar_none: Advanced Table Scrollbar None
   - advanced_table_row_styling: Row Styling
+  - advanced_table_padding_control_per_row: Padding Control using Row Styling
   - advanced_table_column_styling: Column Styling
   - advanced_table_column_styling_column_headers: Column Styling with Multiple Headers
+  - advanced_table_padding_control: Padding Control using Column Styling
   - advanced_table_column_border_color: Column Group Border Color
   - advanced_table_fullscreen: Fullscreen
   - advanced_table_infinite_scroll: Infinite Scroll

data/app/pb_kits/playbook/pb_advanced_table/docs/index.js

@@ -43,4 +43,6 @@ export {default as AdvancedTableWithCustomHeader} from './_advanced_table_with_c
 export { default as AdvancedTableCustomSort } from './_advanced_table_custom_sort.jsx'
 export { default as AdvancedTableWithCustomHeaderMultiHeader } from './_advanced_table_with_custom_header_multi_header.jsx'
 export { default as AdvancedTableSortPerColumn } from './_advanced_table_sort_per_column.jsx'
-export { default as AdvancedTableSortPerColumnForMultiColumn } from './_advanced_table_sort_per_column_for_multi_column.jsx'
+export { default as AdvancedTableSortPerColumnForMultiColumn } from './_advanced_table_sort_per_column_for_multi_column.jsx'
+export { default as AdvancedTablePaddingControl } from './_advanced_table_padding_control.jsx'
+export { default as AdvancedTablePaddingControlPerRow } from './_advanced_table_padding_control_per_row.jsx'

data/app/pb_kits/playbook/pb_pagination/_pagination.test.jsx

@@ -0,0 +1,212 @@
+import React from 'react'
+import { ensureAccessible, renderKit, render, fireEvent, screen } from '../utilities/test-utils'
+import Pagination from './_pagination'
+
+const defaultProps = {
+  data: { testid: 'pagination-test' },
+  total: 10,
+  current: 1,
+  range: 5,
+}
+
+describe('Pagination Component', () => {
+  test('returns namespaced class name', () => {
+    const kit = renderKit(Pagination, defaultProps)
+    expect(kit).toBeInTheDocument()
+    expect(kit).toHaveClass('pb_paginate')
+  })
+
+  it("should be accessible", async () => {
+    ensureAccessible(Pagination, defaultProps)
+  })
+
+  test('renders with default props', () => {
+    render(<Pagination {...defaultProps} />)
+    
+    const pagination = screen.getByTestId('pagination-test')
+    expect(pagination).toBeInTheDocument()
+    expect(pagination).toHaveClass('pb_paginate')
+  })
+
+  test('renders pagination buttons correctly', () => {
+    render(<Pagination {...defaultProps} />)
+    
+    expect(screen.getByText('1')).toBeInTheDocument()
+    expect(screen.getByText('2')).toBeInTheDocument()
+    expect(screen.getByText('3')).toBeInTheDocument()
+    expect(screen.getByText('4')).toBeInTheDocument()
+    expect(screen.getByText('5')).toBeInTheDocument()
+    
+    // Check for navigation arrows by looking for the li elements with specific classes
+    const leftArrow = document.querySelector('.pagination-left')
+    const rightArrow = document.querySelector('.pagination-right')
+    expect(leftArrow).toBeInTheDocument()
+    expect(rightArrow).toBeInTheDocument()
+  })
+
+  test('highlights current page as active', () => {
+    render(<Pagination {...defaultProps}
+        current={3} 
+           />)
+    
+    const activePage = screen.getByText('3')
+    expect(activePage).toHaveClass('active')
+  })
+
+  test('calls onChange when page is clicked', () => {
+    const mockOnChange = jest.fn()
+    render(<Pagination {...defaultProps} 
+        onChange={mockOnChange}
+           />)
+    
+    const pageButton = screen.getByText('3')
+    fireEvent.click(pageButton)
+    
+    expect(mockOnChange).toHaveBeenCalledWith(3)
+  })
+
+  test('disables left arrow on first page', () => {
+    render(<Pagination {...defaultProps}
+        current={1}
+           />)
+    
+    const leftArrow = document.querySelector('.pagination-left')
+    expect(leftArrow).toHaveClass('disabled')
+  })
+
+  test('disables right arrow on last page', () => {
+    render(<Pagination {...defaultProps}
+        current={10}
+           />)
+    
+    const rightArrow = document.querySelector('.pagination-right')
+    expect(rightArrow).toHaveClass('disabled')
+  })
+
+  test('does not render when total is 1 or less', () => {
+    const { container } = render(<Pagination {...defaultProps} 
+        total={1}
+                                 />)
+    
+    expect(container.firstChild).toBeNull()
+  })
+
+  test('renders with custom className', () => {
+    render(<Pagination {...defaultProps}
+        className="custom-class" 
+           />)
+    
+    const pagination = screen.getByTestId('pagination-test')
+    expect(pagination).toHaveClass('custom-class')
+  })
+
+  test('renders with custom id', () => {
+    render(<Pagination {...defaultProps}
+        id="custom-id" 
+           />)
+    
+    const pagination = screen.getByTestId('pagination-test')
+    expect(pagination).toHaveAttribute('id', 'custom-id')
+  })
+
+  test('renders with custom range', () => {
+    render(<Pagination {...defaultProps}
+        range={3} 
+           />)
+    
+    expect(screen.getByText('1')).toBeInTheDocument()
+    expect(screen.getByText('2')).toBeInTheDocument()
+    expect(screen.getByText('3')).toBeInTheDocument()
+    expect(screen.getByText('9')).toBeInTheDocument()
+    expect(screen.getByText('10')).toBeInTheDocument()
+  })
+
+  test('handles large number of pages correctly', () => {
+    render(<Pagination {...defaultProps}
+        current={50}
+        range={5}
+        total={100}
+           />)
+
+    const pagination = screen.getByTestId('pagination-test')
+    expect(pagination).toBeInTheDocument()
+    expect(pagination).toHaveClass('pb_paginate')
+
+    
+    expect(screen.getByText('48')).toBeInTheDocument()
+    expect(screen.getByText('49')).toBeInTheDocument()
+    expect(screen.getByText('50')).toBeInTheDocument()
+    expect(screen.getByText('51')).toBeInTheDocument()
+    expect(screen.getByText('52')).toBeInTheDocument()
+  })
+
+  test('syncs with external current prop changes', () => {
+    const { rerender } = render(<Pagination {...defaultProps} 
+        current={1}
+                                />)
+    
+    expect(screen.getByText('1')).toHaveClass('active')
+    
+    rerender(<Pagination {...defaultProps} 
+        current={3} 
+             />)
+    
+    expect(screen.getByText('3')).toHaveClass('active')
+    expect(screen.getByText('1')).not.toHaveClass('active')
+  })
+
+  test('validates current prop is within valid range', () => {
+    const { rerender } = render(<Pagination {...defaultProps} 
+        current={1} 
+                                />)
+    
+    rerender(<Pagination {...defaultProps} 
+        current={0} 
+            />)
+    
+    expect(screen.getByText('1')).toHaveClass('active')
+    
+    rerender(<Pagination {...defaultProps} 
+        current={15}
+             />)
+    
+    expect(screen.getByText('1')).toHaveClass('active')
+  })
+
+  test('handles htmlOptions props', () => {
+    const htmlOptions = { 'data-test': 'test-value' }
+    render(<Pagination {...defaultProps}
+        htmlOptions={htmlOptions}
+           />)
+    
+    const pagination = screen.getByTestId('pagination-test')
+    expect(pagination).toHaveAttribute('data-test', 'test-value')
+  })
+
+  test('renders first and last page buttons when range is small', () => {
+    render(<Pagination {...defaultProps}
+        current={10}
+        range={3}
+        total={20}
+           />)
+    
+    expect(screen.getByText('1')).toBeInTheDocument()
+    expect(screen.getByText('20')).toBeInTheDocument()
+    
+    expect(screen.getByText('9')).toBeInTheDocument()
+    expect(screen.getByText('10')).toBeInTheDocument()
+    expect(screen.getByText('11')).toBeInTheDocument()
+  })
+
+  test('renders second and second-to-last page buttons when needed', () => {
+    render(<Pagination {...defaultProps} 
+        current={10}
+        range={3}
+        total={20}
+           />)
+    
+    expect(screen.getByText('2')).toBeInTheDocument()
+    
+    expect(screen.getByText('19')).toBeInTheDocument()
+  })
+}) 

data/app/pb_kits/playbook/pb_pagination/_pagination.tsx

@@ -1,4 +1,4 @@
-import React, { useState } from "react";
+import React, { useState, useEffect } from "react";
 import classnames from 'classnames'
 import { GlobalProps, globalProps } from '../utilities/globalProps'
 import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from '../utilities/props'
@@ -123,6 +123,13 @@ const Pagination = ( props: PaginationProps) => {
     
     return buttons;
   };
+
+  // Sync internal state with external current prop
+  useEffect(() => {
+    if (current >= 1 && current <= total) {
+      setCurrentPage(current);
+    }
+  }, [current, total]);
   
 
   const ariaProps = buildAriaProps(aria)

data/app/pb_kits/playbook/pb_pagination/docs/_pagination_external_control.jsx

@@ -0,0 +1,112 @@
+import React, { useState } from "react";
+import Flex from '../../pb_flex/_flex'
+import Pagination from '../../pb_pagination/_pagination'
+import Select from '../../pb_select/_select'
+import Table from '../../pb_table/_table'
+
+import { data } from "./data";
+
+const PaginationExternalControl = (props) => {
+  const [totalItems, setTotalItems] = useState(20);
+  const [itemsPerPage, setItemsPerPage] = useState(5);
+  const [currentPage, setCurrentPage] = useState(1);
+
+  const totalPages = Math.ceil(totalItems / itemsPerPage);
+
+  const handlePageChange = (page) => {
+    setCurrentPage(page);
+  };
+
+  const limitedData = data.slice(0, totalItems);
+  const startIndex = (currentPage - 1) * itemsPerPage;
+  const paginatedItems = limitedData.slice(startIndex, startIndex + itemsPerPage);
+
+  const handleTotalItemsChange = (event) => {
+    const value = Number(event.target.value);
+    setTotalItems(value);
+    setCurrentPage(1);
+  };
+
+  const handleItemsPerPageChange = (event) => {
+    const value = Number(event.target.value);
+    setItemsPerPage(value);
+    setCurrentPage(1);
+  };
+
+  return (
+    <>
+        <Flex gap="sm">
+            <Select
+                label="Total Items"
+                onChange={handleTotalItemsChange}
+                options={[
+                    { value: "5", text: "5" },
+                    { value: "10", text: "10" },
+                    { value: "20", text: "20" }
+                ]}
+                size="sm"
+                value={String(totalItems)}
+                {...props}
+            />
+
+            <Select
+                label="Items per Page"
+                onChange={handleItemsPerPageChange}
+                options={[
+                    { value: "3", text: "3" },
+                    { value: "5", text: "5" },
+                    { value: "10", text: "10" }
+                ]}
+                size="sm"
+                value={String(itemsPerPage)}
+                {...props}
+            />
+        </Flex>
+
+        <Pagination
+            current={currentPage}
+            key={`pagination-top-${currentPage}`}
+            marginBottom="xs"
+            onChange={handlePageChange}
+            range={5}
+            total={totalPages}
+            {...props}
+        />
+        <Table 
+            marginBottom="xs"
+            responsive="none" 
+            size="sm" 
+            {...props}
+        >
+            <Table.Head>
+            <Table.Row>
+                <Table.Header>{"Column 1"}</Table.Header>
+                <Table.Header>{"Column 2"}</Table.Header>
+                <Table.Header>{"Column 3"}</Table.Header>
+                <Table.Header>{"Column 4"}</Table.Header>
+                <Table.Header>{"Column 5"}</Table.Header>
+            </Table.Row>
+            </Table.Head>
+            <Table.Body>
+            {paginatedItems.map((row, index) => (
+                <Table.Row key={index}>
+                {row.map((cell, cellIndex) => (
+                    <Table.Cell key={cellIndex}>{cell}</Table.Cell>
+                ))}
+                </Table.Row>
+            ))}
+            </Table.Body>
+        </Table>
+        <Pagination
+            current={currentPage}
+            key={`pagination-bottom-${currentPage}`}
+            onChange={handlePageChange}
+            range={5}
+            total={totalPages}
+            {...props}
+        />
+    </>
+  )
+}
+
+export default PaginationExternalControl 

data/app/pb_kits/playbook/pb_pagination/docs/_pagination_external_control_react.md

@@ -0,0 +1,3 @@
+The Pagination component supports external control of the current page. This allows for programmatically reseting or changing the current page when filters or other criteria change, without needing to unmount and remount the component.
+
+In this example, changing the "Total Items" or "Items per Page" dropdowns will automatically reset the pagination to page 1, demonstrating how external control works. The pagination component will update its internal state to reflect the new `current` prop value.

data/app/pb_kits/playbook/pb_pagination/docs/example.yml

@@ -6,3 +6,4 @@ examples:
   react:
   - pagination_default: Default
   - pagination_page_change: Page Change
+  - pagination_external_control: External Control

data/app/pb_kits/playbook/pb_pagination/docs/index.js

@@ -1,2 +1,3 @@
 export { default as PaginationDefault } from './_pagination_default.jsx'
 export { default as PaginationPageChange } from './_pagination_page_change.jsx'
+export { default as PaginationExternalControl } from './_pagination_external_control.jsx'