Маршрутизатор

Stable Class

Что он делает

Предоставляет возможности навигации и манипулирования URL.

См. Routes для получения дополнительных сведений и примеров.

Обзор класса

class Router {
  constructor(rootComponentType: Type<any>, urlSerializer: UrlSerializer, outletMap: RouterOutletMap, location: Location, injector: Injector, loader: NgModuleFactoryLoader, compiler: Compiler, config: Routes)
  
  
  errorHandler : ErrorHandler
  navigated : boolean
  urlHandlingStrategy : UrlHandlingStrategy
  routeReuseStrategy : RouteReuseStrategy
  config : Routes
  initialNavigation() : void
  setUpLocationChangeListener() : void
  routerState : RouterState
  url : string
  events : Observable<Event>
  resetConfig(config: Routes) : void
  ngOnDestroy()
  dispose() : void
  createUrlTree(commands: any[], {relativeTo, queryParams, fragment, preserveQueryParams,}?: NavigationExtras) : UrlTree
  navigateByUrl(url: string|UrlTree, extras?: NavigationExtras) : Promise<boolean>
  navigate(commands: any[], extras?: NavigationExtras) : Promise<boolean>
  serializeUrl(url: UrlTree) : string
  parseUrl(url: string) : UrlTree
  isActive(url: string|UrlTree, exact: boolean) : boolean
}

Описание класса

Конструктор

constructor(rootComponentType: Type<any>, urlSerializer: UrlSerializer, outletMap: RouterOutletMap, location: Location, injector: Injector, loader: NgModuleFactoryLoader, compiler: Compiler, config: Routes)

Создает службу маршрутизатора.

Подробное описание класса

errorHandler : ErrorHandler

Обработчик ошибок, который вызывается при ошибке навигации.

См. ErrorHandler для получения дополнительной информации.

navigated : boolean

Указывает, произошла ли хотя бы одна навигация.

urlHandlingStrategy : UrlHandlingStrategy

Извлекает и объединяет URL-адреса. Используется для миграции из AngularJS в Angular.

routeReuseStrategy : RouteReuseStrategy

config : Routes

initialNavigation() : void

Настраивает прослушиватель изменений местоположения и выполняет начальную навигацию.

setUpLocationChangeListener() : void

Настраивает прослушиватель изменений местоположения.

routerState : RouterState

Текущее состояние маршрута

url : string

Текущий URL

events : Observable<Event>

Наблюдаемый объект событий маршрутизатора

resetConfig(config: Routes) : void

Сбрасывает конфигурацию, используемую для навигации и генерации ссылок.

Использование

router.resetConfig([
 { path: 'team/:id', component: TeamCmp, children: [
   { path: 'simple', component: SimpleCmp },
   { path: 'user/:name', component: UserCmp }
 ]}
]);

ngOnDestroy()

dispose() : void

Удаляет маршрутизатор

createUrlTree(commands: any[], {relativeTo, queryParams, fragment, preserveQueryParams,
                        preserveFragment}?: NavigationExtras) : UrlTree

Применяет массив команд к текущей дереву URL и создает новое дерево URL.

Если предоставлен активный маршрут, применяет заданные команды, начиная с маршрута. Если маршрут не предоставлен, применяет заданные команды, начиная с корневого маршрута.

Использование

// create /team/33/user/11
router.createUrlTree(['/team', 33, 'user', 11]);

// create /team/33;expand=true/user/11
router.createUrlTree(['/team', 33, {expand: true}, 'user', 11]);

// you can collapse static segments like this (this works only with the first passed-in value):
router.createUrlTree(['/team/33/user', userId]);

// If the first segment can contain slashes, and you do not want the router to split it, you
// can do the following:

router.createUrlTree([{segmentPath: '/one/two'}]);

// create /team/33/(user/11//right:chat)
router.createUrlTree(['/team', 33, {outlets: {primary: 'user/11', right: 'chat'}}]);

// remove the right secondary node
router.createUrlTree(['/team', 33, {outlets: {primary: 'user/11', right: null}}]);

// assuming the current url is `/team/33/user/11` and the route points to `user/11`

// navigate to /team/33/user/11/details
router.createUrlTree(['details'], {relativeTo: route});

// navigate to /team/33/user/22
router.createUrlTree(['../22'], {relativeTo: route});

// navigate to /team/44/user/22
router.createUrlTree(['../../team/44/user/22'], {relativeTo: route});

navigateByUrl(url: string|UrlTree, extras?: NavigationExtras) : Promise<boolean>

Переход по предоставленному URL. Эта навигация всегда абсолютна.

Возвращает обещание, которое:

• разрешается до 'true', если навигация успешна,
• разрешается до 'false', если навигация терпит неудачу,
• отклоняется, если произошла ошибка.

Использование

router.navigateByUrl("/team/33/user/11");

// Navigate without updating the URL
router.navigateByUrl("/team/33/user/11", { skipLocationChange: true });

В отличие от navigate, navigateByUrl принимает весь URL и не применяет никаких изменений к текущему.

navigate(commands: any[], extras?: NavigationExtras) : Promise<boolean>

Переход по предоставленному массиву команд и начальной точке. Если начальный маршрут не предоставлен, навигация абсолютна.

Возвращает обещание, которое:

• разрешается до 'true', если навигация успешна,
• разрешается до 'false', если навигация терпит неудачу,
• отклоняется, если произошла ошибка.

Использование

router.navigate(['team', 33, 'user', 11], {relativeTo: route});

// Navigate without updating the URL
router.navigate(['team', 33, 'user', 11], {relativeTo: route, skipLocationChange: true});

В отличие от navigateByUrl, navigate всегда принимает разницу, которая применяется к текущему URL.

serializeUrl(url: UrlTree) : string

Сериализует UrlTree в строку

parseUrl(url: string) : UrlTree

Парсит строку в UrlTree

isActive(url: string|UrlTree, exact: boolean) : boolean

Возвращает, активирован ли URL

экспортировано из @angular/router/index, определено в @angular/router/src/router.ts