RouterConfigOptions — Angular

Дополнительные параметры конфигурации, которые можно использовать с функцией withRouterConfig.

API

interface RouterConfigOptions {
  canceledNavigationResolution?: "replace" | "computed" | undefined;
  onSameUrlNavigation?: OnSameUrlNavigation | undefined;
  paramsInheritanceStrategy?: "emptyOnly" | "always" | undefined;
  urlUpdateStrategy?: "deferred" | "eager" | undefined;
  defaultQueryParamsHandling?: QueryParamsHandling | undefined;
  resolveNavigationPromiseOnError?: boolean | undefined;
}

canceledNavigationResolution

"replace" | "computed" | undefined

Настраивает способ, которым маршрутизатор пытается восстановить состояние при отмене навигации.

'replace' — всегда использует location.replaceState, чтобы установить состояние браузера в состояние маршрутизатора до начала навигации. Это означает, что если URL браузера обновился до отмены навигации, маршрутизатор просто заменит элемент в истории, а не попытается вернуться к предыдущему месту в истории сеанса. Чаще всего это происходит при urlUpdateStrategy: 'eager' и навигации с помощью кнопок «Назад» и «Вперед» браузера.

'computed' — попытается вернуться к тому же индексу в истории сеанса, который соответствует маршруту Angular, при отмене навигации. Например, если нажать кнопку «Назад» браузера и навигация будет отменена, маршрутизатор инициирует навигацию вперед, и наоборот.

Примечание: параметр 'computed' несовместим с любыми UrlHandlingStrategy, которые обрабатывают только часть URL, поскольку восстановление истории выполняет переход к предыдущему месту в истории браузера, а не просто сбрасывает часть URL.

Если значение не задано, по умолчанию используется replace.

onSameUrlNavigation

OnSameUrlNavigation | undefined

Настраивает поведение по умолчанию при обработке запроса на навигацию к текущему URL.

Если значение не задано, Router будет использовать 'ignore'.

paramsInheritanceStrategy

"emptyOnly" | "always" | undefined

Определяет, как маршрутизатор объединяет параметры, данные и разрешенные данные родительских маршрутов с дочерними маршрутами.

По умолчанию ('always') маршрут наследует все параметры родительских маршрутов.

Задайте 'emptyOnly', чтобы сохранить прежнее поведение: маршрут наследует параметры родительского маршрута, только если у самого маршрута пустой путь или у родительского маршрута не задан компонент.

Обратите внимание: при работе с матричными параметрами «родительский» означает родительскую конфигурацию Route, что не обязательно означает «сегмент URL слева». Если Route path содержит несколько сегментов, матричные параметры должны находиться в последнем сегменте. Например, матричные параметры для {path: 'a/b', component: MyComp} должны указываться как a/b;foo=bar, а не как a;foo=bar/b.

urlUpdateStrategy

"deferred" | "eager" | undefined

Определяет, когда маршрутизатор обновляет URL браузера. По умолчанию ('deferred') URL обновляется после успешной навигации. Задайте 'eager', если хотите обновлять URL в начале навигации. Раннее обновление URL позволяет обработать сбой навигации, показав сообщение об ошибке с URL, для которого произошел сбой.

defaultQueryParamsHandling

QueryParamsHandling | undefined

Стратегия по умолчанию для обработки параметров запроса в Router.createUrlTree, если она не указана.

Метод createUrlTree используется внутри Router.navigate и RouterLink. Обратите внимание, что QueryParamsHandling не применяется к Router.navigateByUrl.

Если при вызове createUrlTree не указаны ни значение по умолчанию, ни параметр queryParamsHandling, текущие параметры будут заменены новыми.

resolveNavigationPromiseOnError

boolean | undefined

Если true, вместо этого Promise будет разрешен со значением false, как и в случае других неудачных навигаций (например, при отклонении проверками).

В противном случае Promise, возвращаемый при навигации с помощью маршрутизатора, будет отклонен при возникновении ошибки.