forked from angular/angular.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRouter.js
217 lines (205 loc) · 9.05 KB
/
Router.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/**
* @ngdoc module
* @name ngComponentRouter
* @installation
*
* <div class="alert alert-info">
* **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.
* 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)).
* </div>
*
* Currently, the **Component Router** module must be installed via `npm`, it is not yet available
* on Bower or the Google CDN.
*
* ```bash
* npm install @angular/router@0.2.0 --save
* ```
*
* Include `angular_1_router.js` in your HTML:
* ```html
* <script src="/node_modules/@angular/router/angular1/angular_1_router.js"></script>
*```
*
* You also need to include ES6 shims for browsers that do not support ES6 code (Internet Explorer,
iOs < 8, Android < 5.0, Windows Mobile < 10):
* ```html
* <!-- IE required polyfills, in this exact order -->
* <script src="https://cdnjs.cloudflare.com/ajax/libs/es6-shim/0.33.3/es6-shim.min.js"></script>
* <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.20/system-polyfills.js"></script>
* <script src="https://npmcdn.com/angular2/es6/dev/src/testing/shims_for_IE.js"></script>
* ```
*
* Then load the module in your application by adding it as a dependent module:
*
* ```js
* angular.module('app', ['ngComponentRouter']);
* ```
*
* @description
*/
/**
* @ngdoc type
* @name Router
* @description
* A `Router` is responsible for mapping URLs to components.
*
* * Routers and "Routing Component" instances have a 1:1 correspondence.
* * The Router holds reference to one or more of Outlets.
* * There are two kinds of Router: {@link RootRouter} and {@link ChildRouter}.
*
* You can see the state of a router by inspecting the read-only field `router.navigating`.
* This may be useful for showing a spinner, for instance.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc type
* @name ChildRouter
* @description
*
* This type extends the {@link Router}.
*
* Apart from the **Top Level Component** ({@link $routerRootComponent}) which is associated with
* the {@link $rootRouter}, every **Routing Component** is associated with a `ChildRouter`,
* which manages the routing for that **Routing Component**.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc type
* @name RootRouter
* @description
*
* This type extends the {@link Router}.
*
* There is only one instance of this type in a Component Router application injectable as the
* {@link $rootRouter} service. This **Router** is associate with the **Top Level Component**
* ({@link $routerRootComponent}). It acts as the connection between the **Routers** and the **Location**.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc type
* @name ComponentInstruction
* @description
*
* A `ComponentInstruction` represents the route state for a single component. An `Instruction` is
* composed of a tree of these `ComponentInstruction`s.
*
* `ComponentInstructions` is a public API. Instances of `ComponentInstruction` are passed
* to route lifecycle hooks, like `$routerCanActivate`.
*
* You should not modify this object. It should be treated as immutable.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc type
* @name RouteDefinition
* @description
*
* Each item in the **RouteConfig** for a **Routing Component** is an instance of
* this type. It can have the following properties:
*
* * `path` or (`regex` and `serializer`) - defines how to recognize and generate this route
* * `component`, `loader`, `redirectTo` (requires exactly one of these)
* * `name` - the name used to identify the **Route Definition** when generating links
* * `data` (optional)
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc type
* @name RouteParams
* @description
*
* A map of parameters for a given route, passed as part of the {@link ComponentInstruction} to
* the Lifecycle Hooks, such as `$routerOnActivate` and `$routerOnDeactivate`.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc directive
* @name ngOutlet
* @priority 400
* restrict: AE
* @description
*
* The directive that identifies where the {@link Router} should render its **Components**.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @name ngLink
* @description
*
* Lets you create links to different views, automatically generating the `href`.
*
* ## Use
* Provide an array of {@link RouteDefinition} names and extra parameter objects:
*
* ```html
* <a ng-link="['Parent', {param: 1}, 'Child']">Link to Child View</a>
* ````
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc service
* @name $rootRouter
* @description
*
* The singleton instance of the {@link RootRouter} type, which is associated
* with the top level {@link $routerRootComponent}.
*
* @deprecated
* 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.
* 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)).
*/
/**
* @ngdoc service
* @name $routerRootComponent
* @description
*
* The top level **Routing Component** associated with the {@link $rootRouter}.
*
* @deprecated
* 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.
* 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)).
*/