Help Angular by taking a 1 minute survey!Go to surveyHome

UrlTree

Represents the parsed URL.

See more...

      
      interface UrlTree {
  root: UrlSegmentGroup
  queryParams: Params
  fragment: string | null
  queryParamMap: ParamMap
  toString(): string
}
    

Description

Since a router state is a tree, and the URL is nothing but a serialized state, the URL is a serialized tree. UrlTree is a data structure that provides a lot of affordances in dealing with URLs

Properties

Property Description
root: UrlSegmentGroup

The root segment group of the URL tree

queryParams: Params

The query params of the URL

fragment: string | null

The fragment of the URL

queryParamMap: ParamMap Read-only.

Methods

toString(): string
      
      toString(): string
    
Parameters

There are no parameters.

Returns

string

Usage notes

Example

@Component({templateUrl:'template.html'}) class MyComponent { constructor(router: Router) { const tree: UrlTree = router.parseUrl('/team/33/(user/victor//support:help)?debug=true#fragment'); const f = tree.fragment; // return 'fragment' const q = tree.queryParams; // returns {debug: 'true'} const g: UrlSegmentGroup = tree.root.children[PRIMARY_OUTLET]; const s: UrlSegment[] = g.segments; // returns 2 segments 'team' and '33' g.children[PRIMARY_OUTLET].segments; // returns 2 segments 'user' and 'victor' g.children['support'].segments; // return 1 segment 'help' } }
      
      
  1. @Component({templateUrl:'template.html'})
  2. class MyComponent {
  3. constructor(router: Router) {
  4. const tree: UrlTree =
  5. router.parseUrl('/team/33/(user/victor//support:help)?debug=true#fragment');
  6. const f = tree.fragment; // return 'fragment'
  7. const q = tree.queryParams; // returns {debug: 'true'}
  8. const g: UrlSegmentGroup = tree.root.children[PRIMARY_OUTLET];
  9. const s: UrlSegment[] = g.segments; // returns 2 segments 'team' and '33'
  10. g.children[PRIMARY_OUTLET].segments; // returns 2 segments 'user' and 'victor'
  11. g.children['support'].segments; // return 1 segment 'help'
  12. }
  13. }