Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 418fb9c

Browse files
StephenFluinpetebacondarwin
StephenFluin
authored and
petebacondarwin
committed
docs(guide/Component Router): improving comms
1 parent 2f61845 commit 418fb9c

File tree

2 files changed

+66
-17
lines changed

2 files changed

+66
-17
lines changed

‎docs/content/guide/component-router.ngdoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
# Component Router
77

8-
<div class="alert alert-danger">
9-
**Deprecation Notice:** This implementation of the Component Router (ngComponentRouter module) has been deprecated and will not receive further updates.
10-
Alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
8+
<div class="alert alert-info">
9+
**Deprecation Notice:** In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module) has been deprecated and will not receive further updates.
10+
We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
1111
</div>
1212

1313
This guide describes the new Component Router for AngularJS 1.5.

‎src/ngComponentRouter/Router.js

Lines changed: 63 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
* @name ngComponentRouter
44
* @installation
55
*
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)).
6+
* <div class="alert alert-info">
7+
* **Deprecation Notice:** In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module) has been deprecated and will not receive further updates.
8+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
99
* </div>
10-
10+
*
1111
* Currently, the **Component Router** module must be installed via `npm`, it is not yet available
1212
* on Bower or the Google CDN.
1313
*
@@ -42,7 +42,6 @@
4242
* @ngdoc type
4343
* @name Router
4444
* @description
45-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
4645
* A `Router` is responsible for mapping URLs to components.
4746
*
4847
* * Routers and "Routing Component" instances have a 1:1 correspondence.
@@ -52,39 +51,53 @@
5251
* You can see the state of a router by inspecting the read-only field `router.navigating`.
5352
* This may be useful for showing a spinner, for instance.
5453
*
54+
* @deprecated
55+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
56+
* has been deprecated and will not receive further updates.
57+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
58+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
5559
*/
5660

5761
/**
5862
* @ngdoc type
5963
* @name ChildRouter
6064
* @description
61-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
6265
*
6366
* This type extends the {@link Router}.
6467
*
6568
* Apart from the **Top Level Component** ({@link $routerRootComponent}) which is associated with
6669
* the {@link $rootRouter}, every **Routing Component** is associated with a `ChildRouter`,
6770
* which manages the routing for that **Routing Component**.
71+
*
72+
* @deprecated
73+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
74+
* has been deprecated and will not receive further updates.
75+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
76+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
6877
*/
6978

7079
/**
7180
* @ngdoc type
7281
* @name RootRouter
7382
* @description
74-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
7583
*
7684
* This type extends the {@link Router}.
7785
*
7886
* There is only one instance of this type in a Component Router application injectable as the
7987
* {@link $rootRouter} service. This **Router** is associate with the **Top Level Component**
8088
* ({@link $routerRootComponent}). It acts as the connection between the **Routers** and the **Location**.
89+
*
90+
* @deprecated
91+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
92+
* has been deprecated and will not receive further updates.
93+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
94+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
8195
*/
8296

8397
/**
8498
* @ngdoc type
8599
* @name ComponentInstruction
86100
* @description
87-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
88101
*
89102
* A `ComponentInstruction` represents the route state for a single component. An `Instruction` is
90103
* composed of a tree of these `ComponentInstruction`s.
@@ -93,13 +106,18 @@
93106
* to route lifecycle hooks, like `$routerCanActivate`.
94107
*
95108
* You should not modify this object. It should be treated as immutable.
109+
*
110+
* @deprecated
111+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
112+
* has been deprecated and will not receive further updates.
113+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
114+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
96115
*/
97116

98117
/**
99118
* @ngdoc type
100119
* @name RouteDefinition
101120
* @description
102-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
103121
*
104122
* Each item in the **RouteConfig** for a **Routing Component** is an instance of
105123
* this type. It can have the following properties:
@@ -108,16 +126,27 @@
108126
* * `component`, `loader`, `redirectTo` (requires exactly one of these)
109127
* * `name` - the name used to identify the **Route Definition** when generating links
110128
* * `data` (optional)
129+
*
130+
* @deprecated
131+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
132+
* has been deprecated and will not receive further updates.
133+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
134+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
111135
*/
112136

113137
/**
114138
* @ngdoc type
115139
* @name RouteParams
116140
* @description
117-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
118141
*
119142
* A map of parameters for a given route, passed as part of the {@link ComponentInstruction} to
120143
* the Lifecycle Hooks, such as `$routerOnActivate` and `$routerOnDeactivate`.
144+
*
145+
* @deprecated
146+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
147+
* has been deprecated and will not receive further updates.
148+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
149+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
121150
*/
122151

123152
/**
@@ -126,15 +155,19 @@
126155
* @priority 400
127156
* restrict: AE
128157
* @description
129-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
130158
*
131159
* The directive that identifies where the {@link Router} should render its **Components**.
160+
*
161+
* @deprecated
162+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
163+
* has been deprecated and will not receive further updates.
164+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
165+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
132166
*/
133167

134168
/**
135169
* @name ngLink
136170
* @description
137-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
138171
*
139172
* Lets you create links to different views, automatically generating the `href`.
140173
*
@@ -144,25 +177,41 @@
144177
* ```html
145178
* <a ng-link="['Parent', {param: 1}, 'Child']">Link to Child View</a>
146179
* ````
180+
*
181+
* @deprecated
182+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
183+
* has been deprecated and will not receive further updates.
184+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
185+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
147186
*/
148187

149188

150189
/**
151190
* @ngdoc service
152191
* @name $rootRouter
153192
* @description
154-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
155193
*
156194
* The singleton instance of the {@link RootRouter} type, which is associated
157195
* with the top level {@link $routerRootComponent}.
196+
*
197+
* @deprecated
198+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
199+
* has been deprecated and will not receive further updates.
200+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
201+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
158202
*/
159203

160204

161205
/**
162206
* @ngdoc service
163207
* @name $routerRootComponent
164208
* @description
165-
* @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
166209
*
167210
* The top level **Routing Component** associated with the {@link $rootRouter}.
211+
*
212+
* @deprecated
213+
* In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
214+
* has been deprecated and will not receive further updates.
215+
* We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
216+
* projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
168217
*/

0 commit comments

Comments
 (0)