RouterOutletContract — Angular

Интерфейс, определяющий контракт для разработки точки выхода компонента для Router.

API

interface RouterOutletContract {
  isActivated: boolean;
  component: Object | null;
  activatedRouteData: Data;
  activatedRoute: ActivatedRoute | null;
  activateWith(activatedRoute: ActivatedRoute, environmentInjector: EnvironmentInjector): void;
  deactivate(): void;
  detach(): ComponentRef<unknown>;
  attach(ref: ComponentRef<unknown>, activatedRoute: ActivatedRoute): void;
  activateEvents?: EventEmitter<unknown> | undefined;
  deactivateEvents?: EventEmitter<unknown> | undefined;
  attachEvents?: EventEmitter<unknown> | undefined;
  detachEvents?: EventEmitter<unknown> | undefined;
  readonly supportsBindingToComponentInputs?: true | undefined;
}

isActivated

boolean

Указывает, активирована ли данная точка выхода.

Точка выхода считается «активированной», если в ней находится активный компонент.

component

Object | null

Экземпляр активированного компонента или null, если точка выхода не активирована.

activatedRouteData

Data

Data снимка ActivatedRoute.

activatedRoute

ActivatedRoute | null

ActivatedRoute для точки выхода или null, если точка выхода не активирована.

activateWith

void

Вызывается Router, когда точку выхода нужно активировать (создать компонент).

@paramactivatedRouteActivatedRoute

@paramenvironmentInjectorEnvironmentInjector

@returnsvoid

deactivate

void

Запрос на уничтожение текущего активированного компонента.

Если RouteReuseStrategy указывает, что ActivatedRoute нужно удалить, но сохранить для повторного использования, а не уничтожать, Router вместо этого вызовет detach.

@returnsvoid

detach

ComponentRef<unknown>

Вызывается, когда RouteReuseStrategy указывает отсоединить поддерево.

Это похоже на deactivate, но активированный компонент не должен уничтожаться. Вместо этого он возвращается, чтобы позднее его можно было присоединить снова с помощью метода attach.

@returnsComponentRef<unknown>

attach

void

Вызывается, когда RouteReuseStrategy указывает повторно присоединить ранее отсоединённое поддерево.

@paramrefComponentRef<unknown>

@paramactivatedRouteActivatedRoute

@returnsvoid

activateEvents

EventEmitter<unknown> | undefined

Выдаёт событие активации при создании нового экземпляра компонента.

deactivateEvents

EventEmitter<unknown> | undefined

Выдаёт событие деактивации при уничтожении компонента.

attachEvents

EventEmitter<unknown> | undefined

Выдаёт экземпляр присоединённого компонента, когда RouteReuseStrategy указывает повторно присоединить ранее отсоединённое поддерево.

detachEvents

EventEmitter<unknown> | undefined

Выдаёт экземпляр отсоединённого компонента, когда RouteReuseStrategy указывает отсоединить поддерево.

supportsBindingToComponentInputs

true | undefined

Указывает, что точка выхода может связывать данные из Router с входными параметрами компонента точки выхода.

Если это значение равно undefined или false и разработчик включил эту функцию с помощью withComponentInputBinding, в режиме разработки будет выведено предупреждение, если эта точка выхода используется в приложении.

Описание

Интерфейс, определяющий контракт для разработки точки выхода компонента для Router.

Точка выхода служит заполнителем, который Angular динамически заполняет в соответствии с текущим состоянием маршрутизатора.

Точка выхода маршрутизатора должна зарегистрироваться в Router с помощью ChildrenOutletContexts#onChildOutletCreated и отменить регистрацию с помощью ChildrenOutletContexts#onChildOutletDestroyed. Когда Router находит совпадающий Route, он ищет зарегистрированную точку выхода в ChildrenOutletContexts и активирует её.