feat: add Pagination to UI

starpit · starpit · commit e5b9d0bc2844 · 2025-03-06T13:25:54.000-05:00
Signed-off-by: Nick Mitchell &lt;nickm@us.ibm.com&gt;
diff --git a/pdl-live-react/src/view/masonry/Masonry.tsx b/pdl-live-react/src/view/masonry/Masonry.tsx
@@ -3,12 +3,21 @@ import MasonryTile from "./MasonryTile"
 import "./Masonry.css"
 
 type Props = import("react").PropsWithChildren<{
+  page: number
+  perPage: number
   run: import("./MasonryCombo").Runner
   sml: import("./Toolbar").SML
   model: import("./Tile").default[]
 }>
 
-export default function Masonry({ run, sml, model, children }: Props) {
+export default function Masonry({
+  run,
+  sml,
+  model,
+  children,
+  page,
+  perPage,
+}: Props) {
   return (
     <div className="pdl-masonry-view" data-padding={sml}>
       {(!children ? [] : Array.isArray(children) ? children : [children])
@@ -23,11 +32,11 @@ export default function Masonry({ run, sml, model, children }: Props) {
             {child}
           </div>
         ))}
-      {model.map((props, idx) => (
+      {model.slice((page - 1) * perPage, page * perPage).map((props, idx) => (
         <MasonryTile
           key={props.id + "." + idx}
           {...props}
-          idx={idx + 1}
+          idx={(page - 1) * perPage + idx + 1}
           sml={sml}
           run={run}
         />
diff --git a/pdl-live-react/src/view/masonry/MasonryCombo.tsx b/pdl-live-react/src/view/masonry/MasonryCombo.tsx
@@ -39,6 +39,9 @@ import RunningIcon from "@patternfly/react-icons/dist/esm/icons/running-icon"
 
 import "./Masonry.css"
 
+/** Initial number of masonry tiles to show per page */
+const initialPerPage = 20
+
 export type Runner = (
   block?: import("../../helpers").NonScalarPdlBlock,
   async?: boolean,
@@ -76,6 +79,9 @@ export default function MasonryCombo({ value, setValue }: Props) {
   const [sml, setSML] = useState<SML>(getSMLUserSetting())
   useEffect(() => setSMLUserSetting(sml), [sml])
 
+  const [page, setPage] = useState(1)
+  const [perPage, setPerPage] = useState(initialPerPage)
+
   const [modalIsDone, setModalIsDone] = useState(-1)
   const [modalContent, setModalContent] = useState<null | {
     header: string
@@ -102,10 +108,11 @@ export default function MasonryCombo({ value, setValue }: Props) {
     },
     [setModalIsDone, modalContent],
   )
-  useEffect(
-    () => setModalIsDone(modalContent === null ? -1 : -2),
-    [modalContent],
-  )
+  useEffect(() => {
+    setModalIsDone(modalContent === null ? -1 : -2)
+    setPage(1)
+    setPerPage(initialPerPage)
+  }, [modalContent])
 
   // special form of setModalContent for running a PDL program
   const run = useCallback<Runner>(
@@ -206,6 +213,11 @@ export default function MasonryCombo({ value, setValue }: Props) {
           run={run}
           isRunning={modalIsDone === -2}
           block={block}
+          itemCount={masonry.length < initialPerPage ? -1 : masonry.length}
+          page={page}
+          perPage={perPage}
+          setPage={setPage}
+          setPerPage={setPerPage}
         />
       </PageSection>
       <PageSection
@@ -214,7 +226,13 @@ export default function MasonryCombo({ value, setValue }: Props) {
         className="pdl-masonry-page-section"
         aria-label="PDL Viewer main section"
       >
-        <Masonry model={masonry} sml={sml} run={run}>
+        <Masonry
+          model={masonry}
+          sml={sml}
+          run={run}
+          page={page}
+          perPage={perPage}
+        >
           <MasonryTileWrapper sml={sml} variant="plain">
             <Timeline model={base} numbering={numbering} />
           </MasonryTileWrapper>
diff --git a/pdl-live-react/src/view/masonry/Toolbar.tsx b/pdl-live-react/src/view/masonry/Toolbar.tsx
@@ -1,6 +1,7 @@
 import { Toolbar, ToolbarGroup, ToolbarContent } from "@patternfly/react-core"
 
 import DarkModeToggle from "../../page/DarkModeToggle"
+import ToolbarPaginator from "./ToolbarPaginator"
 import ToolbarSMLToggle from "./ToolbarSMLToggle"
 import ToolbarReplayButton from "./ToolbarReplayButton"
 import ToolbarShowSourceButton from "./ToolbarShowSourceButton"
@@ -11,7 +12,7 @@ const alignEnd = { default: "alignEnd" as const }
 
 export type SML = "s" | "m" | "l" | "xl"
 
-export type Props = {
+export type Props = import("./ToolbarPaginator").Props & {
   run: import("./MasonryCombo").Runner
   isRunning: boolean
   block: import("../../pdl_ast").PdlBlock
@@ -26,6 +27,12 @@ export default function MasonryToolbar({
   isRunning,
   sml,
   setSML,
+
+  itemCount,
+  page,
+  perPage,
+  setPage,
+  setPerPage,
 }: Props) {
   return (
     <Toolbar className="pdl-masonry-toolbar">
@@ -34,6 +41,14 @@ export default function MasonryToolbar({
           <ToolbarReplayButton run={run} isRunning={isRunning} />
         </ToolbarGroup>
         <ToolbarGroup align={alignEnd} variant="action-group">
+          <ToolbarPaginator
+            itemCount={itemCount}
+            perPage={perPage}
+            page={page}
+            setPage={setPage}
+            setPerPage={setPerPage}
+          />
+
           {isNonScalarPdlBlock(block) && (
             <ToolbarShowSourceButton root={block.pdl__id ?? ""} />
           )}
diff --git a/pdl-live-react/src/view/masonry/ToolbarPaginator.tsx b/pdl-live-react/src/view/masonry/ToolbarPaginator.tsx
@@ -0,0 +1,53 @@
+import { Pagination, type PaginationProps } from "@patternfly/react-core"
+
+export type Props = Pick<
+  Required<PaginationProps>,
+  "itemCount" | "perPage" | "page"
+> & {
+  setPage(n: number): void
+  setPerPage(n: number): void
+}
+
+export default function ToolbarPaginator({
+  itemCount,
+  perPage,
+  page,
+  setPage,
+  setPerPage,
+}: Props) {
+  const onPerPageSelect = (
+    _event:
+      | import("react").MouseEvent
+      | import("react").KeyboardEvent
+      | MouseEvent,
+    newPerPage: number,
+    newPage: number,
+  ) => {
+    setPerPage(newPerPage)
+    setPage(newPage)
+  }
+
+  const onSetPage = (
+    _event:
+      | import("react").MouseEvent
+      | import("react").KeyboardEvent
+      | MouseEvent,
+    newPage: number,
+  ) => {
+    setPage(newPage)
+  }
+
+  return (
+    itemCount > 1 && (
+      <Pagination
+        itemCount={itemCount}
+        perPage={perPage}
+        page={page}
+        onSetPage={onSetPage}
+        widgetId="masonry-paginator"
+        onPerPageSelect={onPerPageSelect}
+        ouiaId="PaginationTop"
+      />
+    )
+  )
+}
