|
3 | 3 | * @name ngComponentRouter
|
4 | 4 | * @installation
|
5 | 5 | *
|
| 6 | + * <div class="alert alert-danger"> |
| 7 | + * **Deprecation Notice:** This implementation of the Component Router has been deprecated and will not receive further updates. |
| 8 | + * Alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)). |
| 9 | + * </div> |
| 10 | +
|
6 | 11 | * Currently, the **Component Router** module must be installed via `npm`, it is not yet available
|
7 | 12 | * on Bower or the Google CDN.
|
8 | 13 | *
|
|
15 | 20 | * <script src="/node_modules/@angular/router/angular1/angular_1_router.js"></script>
|
16 | 21 | *```
|
17 | 22 | *
|
18 |
| - * You also need to include ES6 shims to support running on Internet Explorer: |
| 23 | + * You also need to include ES6 shims for browsers that do not support ES6 code (Internet Explorer, |
| 24 | + iOs < 8, Android < 5.0, Windows Mobile < 10): |
19 | 25 | * ```html
|
20 | 26 | * <!-- IE required polyfills, in this exact order -->
|
21 | 27 | * <script src="https://cdnjs.cloudflare.com/ajax/libs/es6-shim/0.33.3/es6-shim.min.js"></script>
|
|
36 | 42 | * @ngdoc type
|
37 | 43 | * @name Router
|
38 | 44 | * @description
|
| 45 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
39 | 46 | * A `Router` is responsible for mapping URLs to components.
|
40 | 47 | *
|
41 | 48 | * * Routers and "Routing Component" instances have a 1:1 correspondence.
|
|
51 | 58 | * @ngdoc type
|
52 | 59 | * @name ChildRouter
|
53 | 60 | * @description
|
| 61 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
54 | 62 | *
|
55 | 63 | * This type extends the {@link Router}.
|
56 | 64 | *
|
|
63 | 71 | * @ngdoc type
|
64 | 72 | * @name RootRouter
|
65 | 73 | * @description
|
| 74 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
66 | 75 | *
|
67 | 76 | * This type extends the {@link Router}.
|
68 | 77 | *
|
|
75 | 84 | * @ngdoc type
|
76 | 85 | * @name ComponentInstruction
|
77 | 86 | * @description
|
| 87 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
| 88 | + * |
78 | 89 | * A `ComponentInstruction` represents the route state for a single component. An `Instruction` is
|
79 | 90 | * composed of a tree of these `ComponentInstruction`s.
|
80 | 91 | *
|
|
88 | 99 | * @ngdoc type
|
89 | 100 | * @name RouteDefinition
|
90 | 101 | * @description
|
| 102 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
91 | 103 | *
|
92 | 104 | * Each item in the **RouteConfig** for a **Routing Component** is an instance of
|
93 | 105 | * this type. It can have the following properties:
|
|
102 | 114 | * @ngdoc type
|
103 | 115 | * @name RouteParams
|
104 | 116 | * @description
|
| 117 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
| 118 | + * |
105 | 119 | * A map of parameters for a given route, passed as part of the {@link ComponentInstruction} to
|
106 | 120 | * the Lifecycle Hooks, such as `$routerOnActivate` and `$routerOnDeactivate`.
|
107 | 121 | */
|
|
112 | 126 | * @priority 400
|
113 | 127 | * restrict: AE
|
114 | 128 | * @description
|
| 129 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
115 | 130 | *
|
116 | 131 | * The directive that identifies where the {@link Router} should render its **Components**.
|
117 | 132 | */
|
118 | 133 |
|
119 | 134 | /**
|
120 | 135 | * @name ngLink
|
121 | 136 | * @description
|
| 137 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
122 | 138 | *
|
123 | 139 | * Lets you create links to different views, automatically generating the `href`.
|
124 | 140 | *
|
|
135 | 151 | * @ngdoc service
|
136 | 152 | * @name $rootRouter
|
137 | 153 | * @description
|
| 154 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
| 155 | + * |
138 | 156 | * The singleton instance of the {@link RootRouter} type, which is associated
|
139 | 157 | * with the top level {@link $routerRootComponent}.
|
140 | 158 | */
|
|
144 | 162 | * @ngdoc service
|
145 | 163 | * @name $routerRootComponent
|
146 | 164 | * @description
|
| 165 | + * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore. |
147 | 166 | *
|
148 | 167 | * The top level **Routing Component** associated with the {@link $rootRouter}.
|
149 | 168 | */
|
0 commit comments