UrlCreationOptions — Angular

Параметры, изменяющие URL Router. Передайте объект с любыми из этих свойств в функцию навигации Router, чтобы управлять формированием целевого URL.

API

interface UrlCreationOptions {
  relativeTo?: ActivatedRoute | null | undefined;
  queryParams?: Params | null | undefined;
  fragment?: string | undefined;
  queryParamsHandling?: QueryParamsHandling | null | undefined;
  preserveFragment?: boolean | undefined;
}

relativeTo

ActivatedRoute | null | undefined

Задает корневой URI для относительной навигации.

Например, рассмотрим следующую конфигурацию маршрутов, в которой у родительского маршрута есть два дочерних маршрута.

[{
  path: 'parent',
  component: ParentComponent,
  children: [{
    path: 'list',
    component: ListComponent
  },{
    path: 'child',
    component: ChildComponent
  }]
}]

Следующая функция go() переходит к маршруту list, интерпретируя целевой URI относительно активированного маршрута child

 @Component({...})
 class ChildComponent {
   constructor(private router: Router, private route: ActivatedRoute) {}

   go() {
     router.navigate(['../list'], { relativeTo: this.route });
   }
 }

Значение null или undefined указывает, что команды навигации следует применять относительно корня.

queryParams

Params | null | undefined

Задает параметры запроса для URL.

// Navigate to /results?page=1
router.navigate(['/results'], { queryParams: { page: 1 } });

fragment

string | undefined

Задает фрагмент хеша для URL.

// Navigate to /results#top
router.navigate(['/results'], { fragment: 'top' });

queryParamsHandling

QueryParamsHandling | null | undefined

Способ обработки параметров запроса в ссылке маршрутизатора при следующей навигации. Возможные варианты:

preserve : Сохранить текущие параметры.
merge : Объединить новые параметры с текущими.

Вариант "preserve" отбрасывает все новые параметры запроса:

// from /view1?page=1 to/view2?page=1
router.navigate(['/view2'], { queryParams: { page: 2 },  queryParamsHandling: "preserve"
});

Вариант "merge" добавляет новые параметры запроса к параметрам из текущего URL:

// from /view1?page=1 to/view2?page=1&otherKey=2
router.navigate(['/view2'], { queryParams: { otherKey: 2 },  queryParamsHandling: "merge"
});

Если ключ текущего параметра совпадает с ключом в объекте queryParams, используется новое значение.

preserveFragment

boolean | undefined

Если значение равно true, фрагмент URL сохраняется при следующей навигации

// Preserve fragment from /results#top to /view#top
router.navigate(['/view'], { preserveFragment: true });