ChildrenOutletContexts

ChildrenOutletContexts

class

Store contextual information about the children (= nested) RouterOutlet

class ChildrenOutletContexts {
  onChildOutletCreated(childName: string, outlet: RouterOutletContract): void
  onChildOutletDestroyed(childName: string): void
  onOutletDeactivated(): Map<string, OutletContext>
  onOutletReAttached(contexts: Map<string, OutletContext>)
  getOrCreateContext(childName: string): OutletContext
  getContext(childName: string): OutletContext | null
}

Methods

onChildOutletCreated()
Called when a RouterOutlet directive is instantiated
onChildOutletCreated(childName: string, outlet: RouterOutletContract): void Parameters childName string outlet RouterOutletContract Returns void

onChildOutletDestroyed()
Called when a RouterOutlet directive is destroyed. We need to keep the context as the outlet could be destroyed inside a NgIf and might be re-created later.
onChildOutletDestroyed(childName: string): void Parameters childName string Returns void

onOutletDeactivated()
Called when the corresponding route is deactivated during navigation. Because the component get destroyed, all children outlet are destroyed.
onOutletDeactivated(): Map<string, OutletContext> Parameters There are no parameters. Returns Map<string, OutletContext>

onOutletReAttached()
onOutletReAttached(contexts: Map<string, OutletContext>) Parameters contexts Map

getOrCreateContext()
getOrCreateContext(childName: string): OutletContext Parameters childName string Returns OutletContext

getContext()
getContext(childName: string): OutletContext | null Parameters childName string Returns OutletContext | null

© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/router/ChildrenOutletContexts