Merge pull request #1824 from atmire/w2p-94242_Add-optional-NavigationExtras-argument-to-PaginationService-methods

Add an optional `NavigationExtras` argument to `PaginationService.updateRoute`

Author: tdonohue

src/app/core/pagination/pagination.service.spec.ts

@@ -120,6 +120,17 @@ describe('PaginationService', () => {
 
       expect(router.navigate).toHaveBeenCalledWith([], {queryParams: navigateParams, queryParamsHandling: 'merge'});
     });
+    it('should pass on navigationExtras to router.navigate', () => {
+      service.updateRoute('test', {page: 2}, undefined, undefined, { queryParamsHandling: 'preserve', replaceUrl: true, preserveFragment: true });
+
+      const navigateParams = {};
+      navigateParams[`test.page`] = `2`;
+      navigateParams[`test.rpp`] = `10`;
+      navigateParams[`test.sf`] = `score`;
+      navigateParams[`test.sd`] = `ASC`;
+
+      expect(router.navigate).toHaveBeenCalledWith([], {queryParams: navigateParams, queryParamsHandling: 'preserve', replaceUrl: true, preserveFragment: true });
+    });
   });
   describe('updateRouteWithUrl', () => {
     it('should update the route with the provided page params and url', () => {
@@ -144,7 +155,17 @@ describe('PaginationService', () => {
 
       expect(router.navigate).toHaveBeenCalledWith(['someUrl'], {queryParams: navigateParams, queryParamsHandling: 'merge'});
     });
+    it('should pass on navigationExtras to router.navigate', () => {
+      service.updateRouteWithUrl('test',['someUrl'], {page: 2}, undefined, undefined, { queryParamsHandling: 'preserve', replaceUrl: true, preserveFragment: true });
 
+      const navigateParams = {};
+      navigateParams[`test.page`] = `2`;
+      navigateParams[`test.rpp`] = `10`;
+      navigateParams[`test.sf`] = `score`;
+      navigateParams[`test.sd`] = `ASC`;
+
+      expect(router.navigate).toHaveBeenCalledWith(['someUrl'], {queryParams: navigateParams, queryParamsHandling: 'preserve', replaceUrl: true, preserveFragment: true });
+    });
   });
   describe('clearPagination', () => {
     it('should clear the pagination next time the updateRoute/updateRouteWithUrl method is called', () => {

src/app/core/pagination/pagination.service.ts

@@ -1,5 +1,5 @@
 import { Injectable } from '@angular/core';
-import { Router } from '@angular/router';
+import { NavigationExtras, Router } from '@angular/router';
 import { RouteService } from '../services/route.service';
 import { PaginationComponentOptions } from '../../shared/pagination/pagination-component-options.model';
 import { combineLatest as observableCombineLatest, Observable } from 'rxjs';
@@ -117,15 +117,22 @@ export class PaginationService {
    * @param params - The page related params to update in the route
    * @param extraParams - Addition params unrelated to the pagination that need to be added to the route
    * @param retainScrollPosition - Scroll to the pagination component after updating the route instead of the top of the page
+   * @param navigationExtras - Extra parameters to pass on to `router.navigate`. Can be used to override values set by this service.
    */
-  updateRoute(paginationId: string, params: {
-    page?: number
-    pageSize?: number
-    sortField?: string
-    sortDirection?: SortDirection
-  }, extraParams?, retainScrollPosition?: boolean) {
+  updateRoute(
+    paginationId: string,
+    params: {
+      page?: number
+      pageSize?: number
+      sortField?: string
+      sortDirection?: SortDirection
+    },
+    extraParams?,
+    retainScrollPosition?: boolean,
+    navigationExtras?: NavigationExtras,
+  ) {
 
-    this.updateRouteWithUrl(paginationId, [], params, extraParams, retainScrollPosition);
+    this.updateRouteWithUrl(paginationId, [], params, extraParams, retainScrollPosition, navigationExtras);
   }
 
   /**
@@ -135,13 +142,21 @@ export class PaginationService {
    * @param params - The page related params to update in the route
    * @param extraParams - Addition params unrelated to the pagination that need to be added to the route
    * @param retainScrollPosition - Scroll to the pagination component after updating the route instead of the top of the page
+   * @param navigationExtras - Extra parameters to pass on to `router.navigate`. Can be used to override values set by this service.
    */
-  updateRouteWithUrl(paginationId: string, url: string[], params: {
-    page?: number
-    pageSize?: number
-    sortField?: string
-    sortDirection?: SortDirection
-  }, extraParams?, retainScrollPosition?: boolean) {
+  updateRouteWithUrl(
+    paginationId: string,
+    url: string[],
+    params: {
+      page?: number
+      pageSize?: number
+      sortField?: string
+      sortDirection?: SortDirection
+    },
+    extraParams?,
+    retainScrollPosition?: boolean,
+    navigationExtras?: NavigationExtras,
+  ) {
     this.getCurrentRouting(paginationId).subscribe((currentFindListOptions) => {
       const currentParametersWithIdName = this.getParametersWithIdName(paginationId, currentFindListOptions);
       const parametersWithIdName = this.getParametersWithIdName(paginationId, params);
@@ -152,12 +167,14 @@ export class PaginationService {
           this.router.navigate(url, {
             queryParams: queryParams,
             queryParamsHandling: 'merge',
-            fragment: `p-${paginationId}`
+            fragment: `p-${paginationId}`,
+            ...navigationExtras,
           });
         } else {
           this.router.navigate(url, {
             queryParams: queryParams,
-            queryParamsHandling: 'merge'
+            queryParamsHandling: 'merge',
+            ...navigationExtras,
           });
         }
         this.clearParams = {};