docs: clarify static router-outlet name attribute (#32973)

PR Close #32973
This commit is contained in:
Judy Bogart 2019-10-02 14:25:12 -07:00 committed by Miško Hevery
parent a9228aabac
commit ac745c8356
1 changed files with 5 additions and 2 deletions

View File

@ -18,14 +18,17 @@ import {PRIMARY_OUTLET} from '../shared';
*
* Acts as a placeholder that Angular dynamically fills based on the current router state.
*
* Each outlet can have a unique name, determined by the optional `name` attribute.
* The name cannot be set or changed dynamically. If not set, default value is "primary".
*
* ```
* <router-outlet></router-outlet>
* <router-outlet name='left'></router-outlet>
* <router-outlet name='right'></router-outlet>
* ```
*
* A router outlet will emit an activate event any time a new component is being instantiated,
* and a deactivate event when it is being destroyed.
* A router outlet emits an activate event when a new component is instantiated,
* and a deactivate event when a component is destroyed.
*
* ```
* <router-outlet