Cookies concent notice

This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
This site is no longer updated.Head to Angular.devHome
/

This is the archived documentation for Angular v17. Please visit angular.dev to see this page for the current version of Angular.

ChildrenOutletContexts

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 }

Provided in

  • 'root'

Methods

Called when a RouterOutlet directive is instantiated

      
      onChildOutletCreated(childName: string, outlet: RouterOutletContract): void
    
Parameters
childName string
outlet RouterOutletContract
Returns

void

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

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(contexts: Map<string, OutletContext>)
    
Parameters
contexts Map<string, OutletContext>
      
      getOrCreateContext(childName: string): OutletContext
    
Parameters
childName string
Returns

OutletContext

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

OutletContext | null