CC-6362: pass route info to pagination (#65)

* Add model/models/replace to Cut::List::Pagination * Fix docs pagination query parameters
hashicorp · Sep 13, 2023 · 19cecc9 · 19cecc9 · vercel · Sep 13, 2023
1 parent 6c25544
commit 19cecc9
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 7 deletions.
diff --git a/.changeset/tall-windows-allow.md b/.changeset/tall-windows-allow.md
@@ -0,0 +1,6 @@
+---
+'@hashicorp/consul-ui-toolkit': minor
+---
+
+Add model/models/replace to `Cut::List::Pagination`
+Update type for replace & query
diff --git a/documentation/app/routes/components/list.js b/documentation/app/routes/components/list.js
@@ -7,7 +7,10 @@ import { v4 as uuidv4 } from 'uuid';
 
 export default class ListRoute extends Route {
   queryParams = {
-    page: {
+    nextPage: {
+      refreshModel: true,
+    },
+    previousPage: {
       refreshModel: true,
     },
     pageSize: {

diff --git a/toolkit/src/components/cut/list-item/types.ts b/toolkit/src/components/cut/list-item/types.ts
@@ -8,8 +8,8 @@ export interface ListItemSignature {
     isHrefExternal?: boolean;
     route?: string;
     isRouteExternal?: boolean;
-    query?: object;
-    replace?: string;
+    query?: unknown;
+    replace?: boolean;
     model?: string | unknown;
     models?: string[] | unknown[];
     onClick(): void;
@@ -23,8 +23,8 @@ export interface ServiceInstanceListItemSignature {
     isHrefExternal?: boolean;
     route?: string;
     isRouteExternal?: boolean;
-    query?: object;
-    replace?: string;
+    query?: unknown;
+    replace?: boolean;
     model?: string | unknown;
     models?: string[] | unknown[];
     onClick(): void;
@@ -41,8 +41,8 @@ export interface ServiceListItemSignature {
     isHrefExternal?: boolean;
     route?: string;
     isRouteExternal?: boolean;
-    query?: object;
-    replace?: string;
+    query?: unknown;
+    replace?: boolean;
     model?: string | unknown;
     models?: string[] | unknown[];
     onClick(): void;

diff --git a/toolkit/src/components/cut/list/pagination.hbs b/toolkit/src/components/cut/list/pagination.hbs
@@ -17,6 +17,9 @@
       @showLabels={{true}}
       @queryFunction={{this.queryFunction}}
       @route={{or @route this.router.currentRouteName}}
+      @model={{@model}}
+      @models={{@models}}
+      @replace={{@replace}}
       @isDisabledPrev={{not @prevCursor}}
       @isDisabledNext={{not @nextCursor}}
     />

diff --git a/toolkit/src/components/cut/list/types.ts b/toolkit/src/components/cut/list/types.ts
@@ -8,6 +8,9 @@ export interface PaginationSignature {
     prevCursor?: string;
     pageSizes?: number[];
     currentPageSize?: number;
+    model?: string | unknown;
+    models?: string[] | unknown[];
+    replace?: boolean;
     queryFunction?: (page: string) => {
       [key: string]: string | number | unknown;
     };