forked from mmistakes/minimal-mistakes
-
Notifications
You must be signed in to change notification settings - Fork 27
/
injectables.html
1014 lines (1013 loc) · 59.8 KB
/
injectables.html
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
redirect_from: /docs/1.0.19/modules/injectables.html
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>injectables | @uirouter/angularjs</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/uirouter.css">
<script src="../assets/js/modernizr.js"></script>
<script src="../assets/js/reset.js"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@uirouter/angularjs</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<!--
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
-->
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Internal UI-Router API</label>
<!--
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
-->
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@uirouter/angularjs</a>
</li>
<li>
<a href="injectables.html">injectables</a>
</li>
</ul>
<h1>Module injectables</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<h1 id="angular-1-injectable-services">Angular 1 injectable services</h1>
</div>
<p>This is a list of the objects which can be injected using angular's injector.</p>
<p>There are three different kind of injectable objects:</p>
<h2 id="provider-objects"><strong>Provider</strong> objects</h2>
<h4 id="injectable-into-a-config-block-during-configtime">injectable into a <code>.config()</code> block during configtime</h4>
<ul>
<li><a href="injectables.html#_uirouterprovider">$uiRouterProvider</a>: The UI-Router instance</li>
<li><a href="injectables.html#_stateprovider">$stateProvider</a>: State registration</li>
<li><a href="injectables.html#_transitionsprovider">$transitionsProvider</a>: Transition hooks</li>
<li><p><a href="injectables.html#_urlserviceprovider">$urlServiceProvider</a>: All URL related public APIs</p>
</li>
<li><p><a href="injectables.html#_uiviewscrollprovider">$uiViewScrollProvider</a>: Disable ui-router view scrolling</p>
</li>
<li><a href="injectables.html#_urlrouterprovider">$urlRouterProvider</a>: (deprecated) Url matching rules</li>
<li><a href="injectables.html#_urlmatcherfactoryprovider">$urlMatcherFactoryProvider</a>: (deprecated) Url parsing config</li>
</ul>
<h2 id="service-objects"><strong>Service</strong> objects</h2>
<h4 id="injectable-globally-during-runtime">injectable globally during runtime</h4>
<ul>
<li><a href="injectables.html#_uirouter">$uiRouter</a>: The UI-Router instance</li>
<li><a href="injectables.html#_trace">$trace</a>: Enable transition trace/debug</li>
<li><a href="injectables.html#_transitions">$transitions</a>: Transition hooks</li>
<li><a href="injectables.html#_state">$state</a>: Imperative state related APIs</li>
<li><a href="injectables.html#_stateregistry">$stateRegistry</a>: State registration</li>
<li><a href="injectables.html#_urlservice">$urlService</a>: All URL related public APIs</li>
<li><a href="injectables.html#_uirouterglobals">$uiRouterGlobals</a>: Global variables</li>
<li><p><a href="injectables.html#_uiviewscroll">$uiViewScroll</a>: Scroll an element into view</p>
</li>
<li><p><a href="injectables.html#_stateparams">$stateParams</a>: (deprecated) Global state param values</p>
</li>
<li><a href="injectables.html#_urlrouter">$urlRouter</a>: (deprecated) URL synchronization</li>
<li><a href="injectables.html#_urlmatcherfactory">$urlMatcherFactory</a>: (deprecated) URL parsing config</li>
</ul>
<h2 id="per-transition-objects"><strong>Per-Transition</strong> objects</h2>
<ul>
<li>These kind of objects are injectable into:<ul>
<li>Resolves (<a href="../interfaces/ng1.ng1statedeclaration.html#resolve">Ng1StateDeclaration.resolve</a>),</li>
<li>Transition Hooks (<a href="../classes/transition.transitionservice.html#onstart">TransitionService.onStart</a>, etc),</li>
<li>Routed Controllers (<a href="../interfaces/ng1.ng1viewdeclaration.html#controller">Ng1ViewDeclaration.controller</a>)</li>
</ul>
</li>
</ul>
<h4 id="different-instances-are-injected-based-on-the-a-href-classes-transition-transition-1-html-transition-a-">Different instances are injected based on the <a href="../classes/transition.transition-1.html">Transition</a></h4>
<ul>
<li><a href="injectables.html#_transition_">$transition$</a>: The current Transition object</li>
<li><a href="injectables.html#_stateparams">$stateParams</a>: State param values for pending Transition (deprecated)</li>
<li>Any resolve data defined using <a href="../interfaces/ng1.ng1statedeclaration.html#resolve">Ng1StateDeclaration.resolve</a></li>
</ul>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_state" class="tsd-kind-icon">$state</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_stateparams" class="tsd-kind-icon">$state<wbr>Params</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_stateprovider" class="tsd-kind-icon">$state<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_stateregistry" class="tsd-kind-icon">$state<wbr>Registry</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_stateregistryprovider" class="tsd-kind-icon">$state<wbr>Registry<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_trace" class="tsd-kind-icon">$trace</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_transition_" class="tsd-kind-icon">$transition$</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_transitions" class="tsd-kind-icon">$transitions</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_transitionsprovider" class="tsd-kind-icon">$transitions<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_uirouter" class="tsd-kind-icon">$ui<wbr>Router</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_uirouterglobals" class="tsd-kind-icon">$ui<wbr>Router<wbr>Globals</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_uirouterprovider" class="tsd-kind-icon">$ui<wbr>Router<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_uiviewscroll" class="tsd-kind-icon">$ui<wbr>View<wbr>Scroll</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_uiviewscrollprovider" class="tsd-kind-icon">$ui<wbr>View<wbr>Scroll<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_urlmatcherfactory" class="tsd-kind-icon">$url<wbr>Matcher<wbr>Factory</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_urlmatcherfactoryprovider" class="tsd-kind-icon">$url<wbr>Matcher<wbr>Factory<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_urlrouter" class="tsd-kind-icon">$url<wbr>Router</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_urlrouterprovider" class="tsd-kind-icon">$url<wbr>Router<wbr>Provider</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_urlservice" class="tsd-kind-icon">$url<wbr>Service</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="injectables.html#_urlserviceprovider" class="tsd-kind-icon">$url<wbr>Service<wbr>Provider</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_state" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $state</h3>
-->
<div class="tsd-signature tsd-kind-icon">$state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StateService</span> <div class="tsd-header">
<p> The State Service </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The State Service</p>
</div>
<p>The <a href="../classes/state.stateservice.html">StateService</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This service used to manage and query information on registered states.
It exposes state related APIs including:</p>
<ul>
<li>Start a <a href="../classes/transition.transition-1.html">Transition</a></li>
<li>Imperatively lazy load states</li>
<li>Check if a state is currently active</li>
<li>Look up states by name</li>
<li>Build URLs for a state+parameters</li>
<li>Configure the global Transition error handler</li>
</ul>
<p>This angular service exposes the <a href="../classes/state.stateservice.html">StateService</a> singleton.</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L235">ui-router-angularjs/src/injectables.ts:235</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_stateparams" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $state<wbr>Params</h3>
-->
<div class="tsd-signature tsd-kind-icon">$state<wbr>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StateParams</span> <div class="tsd-header">
<p> The current (or pending) State Parameters </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current (or pending) State Parameters</p>
</div>
<p>An injectable global <strong>Service Object</strong> which holds the state parameters for the latest <strong>SUCCESSFUL</strong> transition.</p>
<p>The values are not updated until <em>after</em> a <code>Transition</code> successfully completes.</p>
<p><strong>Also:</strong> an injectable <strong>Per-Transition Object</strong> object which holds the pending state parameters for the pending <code>Transition</code> currently running.</p>
<h3 id="deprecation-warning-">Deprecation warning:</h3>
<p>The value injected for <code>$stateParams</code> is different depending on where it is injected.</p>
<ul>
<li>When injected into an angular service, the object injected is the global <strong>Service Object</strong> with the parameter values for the latest successful <code>Transition</code>.</li>
<li>When injected into transition hooks, resolves, or view controllers, the object is the <strong>Per-Transition Object</strong> with the parameter values for the running <code>Transition</code>.</li>
</ul>
<p>Because of these confusing details, this service is deprecated.</p>
<h3 id="instead-of-using-the-global-stateparams-service-object-">Instead of using the global <code>$stateParams</code> service object,</h3>
<p>inject <a href="injectables.html#_uirouterglobals">$uiRouterGlobals</a> and use <a href="../classes/core.uirouterglobals.html#params">UIRouterGlobals.params</a></p>
<pre><code class="lang-js">MyService.$inject = [<span class="hljs-string">'$uiRouterGlobals'</span>];
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">MyService</span>(<span class="hljs-params">$uiRouterGlobals</span>) </span>{
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">paramValues</span>: <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">return</span> $uiRouterGlobals.params;
}
}
}
</code></pre>
<h3 id="instead-of-using-the-per-transition-stateparams-object-">Instead of using the per-transition <code>$stateParams</code> object,</h3>
<p>inject the current <code>Transition</code> (as <a href="injectables.html#_transition_">$transition$</a>) and use <a href="../classes/transition.transition-1.html#params">Transition.params</a></p>
<pre><code class="lang-js">MyController.$inject = [<span class="hljs-string">'$transition$'</span>];
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">MyController</span>(<span class="hljs-params">$transition$</span>) </span>{
<span class="hljs-keyword">var</span> username = $transition$.params().username;
<span class="hljs-comment">// .. do something with username</span>
}
</code></pre>
<hr>
<p>This object can be injected into other services.</p>
<h4 id="deprecated-example-">Deprecated Example:</h4>
<pre><code class="lang-js">SomeService.$inject = [<span class="hljs-string">'$http'</span>, <span class="hljs-string">'$stateParams'</span>];
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">SomeService</span>(<span class="hljs-params">$http, $stateParams</span>) </span>{
<span class="hljs-keyword">return</span> {
<span class="hljs-attr">getUser</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">return</span> $http.get(<span class="hljs-string">'/api/users/'</span> + $stateParams.username);
}
}
};
angular.service(<span class="hljs-string">'SomeService'</span>, SomeService);
</code></pre>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L132">ui-router-angularjs/src/injectables.ts:132</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_stateprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $state<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$state<wbr>Provider<span class="tsd-signature-symbol">:</span> <a href="../classes/ng1.stateprovider.html" class="tsd-signature-type">StateProvider</a> <div class="tsd-header">
<p> The StateProvider </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The StateProvider</p>
</div>
<p>An angular1-only <a href="../classes/ng1.stateprovider.html">StateProvider</a> as a <strong>Provider Object</strong> (injectable during config time).</p>
<p>This angular service exposes the <a href="../classes/ng1.stateprovider.html">StateProvider</a> singleton.</p>
<p>The <code>StateProvider</code> is primarily used to register states or add custom state decorators.</p>
<h5 id="note-this-provider-is-a-ng1-vestige-">Note: This provider is a ng1 vestige.</h5>
<p>It is a passthrough to <a href="injectables.html#_stateregistry">$stateRegistry</a> and <a href="injectables.html#_state">$state</a>.</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L308">ui-router-angularjs/src/injectables.ts:308</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_stateregistry" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $state<wbr>Registry</h3>
-->
<div class="tsd-signature tsd-kind-icon">$state<wbr>Registry<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StateRegistry</span> <div class="tsd-header">
<p> The State Registry </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The State Registry</p>
</div>
<p>The <a href="../interfaces/ng1.__uirouter_core_lib_state_stateregistry_.stateregistry.html">StateRegistry</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This service is used to register/deregister states.
It has state registration related APIs including:</p>
<ul>
<li>Register/deregister states</li>
<li>Listen for state registration/deregistration</li>
<li>Get states by name</li>
<li>Add state decorators (to customize the state creation process)</li>
</ul>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_stateregistryprovider-stateregistryprovider-a-for-injection-during-the-config-phase-">Note: This object is also exposed as <a href="injectables.html#_stateregistryprovider">$stateRegistryProvider</a> for injection during the config phase.</h4>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L252">ui-router-angularjs/src/injectables.ts:252</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_stateregistryprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $state<wbr>Registry<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$state<wbr>Registry<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StateRegistry</span> <div class="tsd-header">
<p> The State Registry </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The State Registry</p>
</div>
<p>The <a href="../interfaces/ng1.__uirouter_core_lib_state_stateregistry_.stateregistry.html">StateRegistry</a> singleton as a <strong>Provider Object</strong> (injectable during config time).</p>
<p>This service is used to register/deregister states.
It has state registration related APIs including:</p>
<ul>
<li>Register/deregister states</li>
<li>Listen for state registration/deregistration</li>
<li>Get states by name</li>
<li>Add state decorators (to customize the state creation process)</li>
</ul>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_stateregistry-stateregistry-a-for-injection-during-runtime-">Note: This object is also exposed as <a href="injectables.html#_stateregistry">$stateRegistry</a> for injection during runtime.</h4>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L269">ui-router-angularjs/src/injectables.ts:269</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_trace" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $trace</h3>
-->
<div class="tsd-signature tsd-kind-icon">$trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Trace</span> <div class="tsd-header">
<p> Transition debug/tracing </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transition debug/tracing</p>
</div>
<p>The <a href="../classes/trace.trace-1.html">Trace</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>Enables or disables Transition tracing which can help to debug issues.</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L174">ui-router-angularjs/src/injectables.ts:174</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_transition_" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $transition$</h3>
-->
<div class="tsd-signature tsd-kind-icon">$transition$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Transition</span> <div class="tsd-header">
<p> The current <a href="../classes/transition.transition-1.html">Transition</a> object </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current <a href="../classes/transition.transition-1.html">Transition</a> object</p>
</div>
<p>The current <a href="../classes/transition.transition-1.html">Transition</a> object as a <strong>Per-Transition Object</strong> (injectable into Resolve, Hooks, Controllers)</p>
<p>This object returns information about the current transition, including:</p>
<ul>
<li>To/from states</li>
<li>To/from parameters</li>
<li>Transition options</li>
<li>States being entered, exited, and retained</li>
<li>Resolve data</li>
<li>A Promise for the transition</li>
<li>Any transition failure information</li>
<li>An injector for both Service and Per-Transition Objects</li>
</ul>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L216">ui-router-angularjs/src/injectables.ts:216</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_transitions" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $transitions</h3>
-->
<div class="tsd-signature tsd-kind-icon">$transitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TransitionService</span> <div class="tsd-header">
<p> The Transition Service </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Transition Service</p>
</div>
<p>The <a href="../classes/transition.transitionservice.html">TransitionService</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This angular service exposes the <a href="../classes/transition.transitionservice.html">TransitionService</a> singleton, which is primarily
used to register global transition hooks.</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_transitionsprovider-transitionsprovider-a-for-injection-during-the-config-phase-">Note: This object is also exposed as <a href="injectables.html#_transitionsprovider">$transitionsProvider</a> for injection during the config phase.</h4>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L186">ui-router-angularjs/src/injectables.ts:186</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_transitionsprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $transitions<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$transitions<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TransitionService</span> <div class="tsd-header">
<p> The Transition Service </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Transition Service</p>
</div>
<p>The <a href="../classes/transition.transitionservice.html">TransitionService</a> singleton as a <strong>Provider Object</strong> (injectable during config phase)</p>
<p>This angular service exposes the <a href="../classes/transition.transitionservice.html">TransitionService</a> singleton, which is primarily
used to register global transition hooks.</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_transitions-transitions-a-for-injection-during-runtime-">Note: This object is also exposed as <a href="injectables.html#_transitions">$transitions</a> for injection during runtime.</h4>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L198">ui-router-angularjs/src/injectables.ts:198</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_uirouter" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $ui<wbr>Router</h3>
-->
<div class="tsd-signature tsd-kind-icon">$ui<wbr>Router<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UIRouter</span> <div class="tsd-header">
<p> The UI-Router instance </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The UI-Router instance</p>
</div>
<p>The <a href="../interfaces/ng1.__uirouter_core_lib_router_.uirouter.html">UIRouter</a> singleton (the router instance) as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This object is the UI-Router singleton instance, created by angular dependency injection during application bootstrap.
It has references to the other UI-Router services</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_uirouterprovider-uirouterprovider-a-for-injection-during-angular-config-time-">Note: This object is also exposed as <a href="injectables.html#_uirouterprovider">$uiRouterProvider</a> for injection during angular config time.</h4>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L153">ui-router-angularjs/src/injectables.ts:153</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_uirouterglobals" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $ui<wbr>Router<wbr>Globals</h3>
-->
<div class="tsd-signature tsd-kind-icon">$ui<wbr>Router<wbr>Globals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UIRouterGlobals</span> <div class="tsd-header">
<p> Global UI-Router variables </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Global UI-Router variables</p>
</div>
<p>The router global state as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This object contains globals such as the current state and current parameter values.</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L141">ui-router-angularjs/src/injectables.ts:141</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_uirouterprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $ui<wbr>Router<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$ui<wbr>Router<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UIRouter</span> <div class="tsd-header">
<p> The UI-Router instance </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The UI-Router instance</p>
</div>
<p>The <a href="../interfaces/ng1.__uirouter_core_lib_router_.uirouter.html">UIRouter</a> singleton (the router instance) as a <strong>Provider Object</strong> (injectable during config phase).</p>
<p>This object is the UI-Router singleton instance, created by angular dependency injection during application bootstrap.
It has references to the other UI-Router services</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_uirouter-uirouter-a-for-injection-during-runtime-">Note: This object is also exposed as <a href="injectables.html#_uirouter">$uiRouter</a> for injection during runtime.</h4>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L165">ui-router-angularjs/src/injectables.ts:165</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_uiviewscroll" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $ui<wbr>View<wbr>Scroll</h3>
-->
<div class="tsd-signature tsd-kind-icon">$ui<wbr>View<wbr>Scroll<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span> <div class="tsd-header">
<p> The View Scroll function </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The View Scroll function</p>
</div>
<p>The View Scroll function as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This is a function that scrolls an element into view.
The element is scrolled after a <code>$timeout</code> so the DOM has time to refresh.</p>
<p>If you prefer to rely on <code>$anchorScroll</code> to scroll the view to the anchor,
this can be enabled by calling <a href="../interfaces/ng1.uiviewscrollprovider.html#useanchorscroll">UIViewScrollProvider.useAnchorScroll</a>.</p>
<p>Note: this function is used by the <a href="directives.html#uiview">directives.uiView</a> when the <code>autoscroll</code> expression evaluates to true.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>$element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JQuery</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>$element <span class="tsd-signature-type">JQuery</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L294">ui-router-angularjs/src/injectables.ts:294</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_uiviewscrollprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $ui<wbr>View<wbr>Scroll<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$ui<wbr>View<wbr>Scroll<wbr>Provider<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ng1.uiviewscrollprovider.html" class="tsd-signature-type">UIViewScrollProvider</a> <div class="tsd-header">
<p> The View Scroll provider </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The View Scroll provider</p>
</div>
<p>The <a href="../interfaces/ng1.uiviewscrollprovider.html">UIViewScrollProvider</a> as a <strong>Provider Object</strong> (injectable during config time).</p>
<p>This angular service exposes the <a href="../interfaces/ng1.uiviewscrollprovider.html">UIViewScrollProvider</a> singleton and is
used to disable UI-Router's scroll behavior.</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L279">ui-router-angularjs/src/injectables.ts:279</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_urlmatcherfactory" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $url<wbr>Matcher<wbr>Factory</h3>
-->
<div class="tsd-signature tsd-kind-icon">$url<wbr>Matcher<wbr>Factory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlMatcherFactory</span> <div class="tsd-header">
<p> The URL Matcher Factory </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL Matcher Factory</p>
</div>
<h3 id="deprecation-warning-this-object-is-now-considered-internal-use-a-href-injectables-html-_urlservice-urlservice-a-instead-">Deprecation warning: This object is now considered internal. Use <a href="injectables.html#_urlservice">$urlService</a> instead.</h3>
<p>The <a href="../classes/url.urlmatcherfactory.html">UrlMatcherFactory</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>This service is used to set url mapping options, define custom parameter types, and create <a href="../classes/url.urlmatcher.html">UrlMatcher</a> objects.</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_urlmatcherfactoryprovider-urlmatcherfactoryprovider-a-for-injection-during-angular-config-time-">Note: This object is also exposed as <a href="injectables.html#_urlmatcherfactoryprovider">$urlMatcherFactoryProvider</a> for injection during angular config time.</h4>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L387">ui-router-angularjs/src/injectables.ts:387</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_urlmatcherfactoryprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $url<wbr>Matcher<wbr>Factory<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$url<wbr>Matcher<wbr>Factory<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlMatcherFactory</span> <div class="tsd-header">
<p> The URL Matcher Factory </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL Matcher Factory</p>
</div>
<h3 id="deprecation-warning-this-object-is-now-considered-internal-use-a-href-injectables-html-_urlservice-urlservice-a-instead-">Deprecation warning: This object is now considered internal. Use <a href="injectables.html#_urlservice">$urlService</a> instead.</h3>
<p>The <a href="../classes/url.urlmatcherfactory.html">UrlMatcherFactory</a> singleton as a <strong>Provider Object</strong> (injectable during config time).</p>
<p>This service is used to set url mapping options, define custom parameter types, and create <a href="../classes/url.urlmatcher.html">UrlMatcher</a> objects.</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_urlmatcherfactory-urlmatcherfactory-a-for-injection-during-runtime-">Note: This object is also exposed as <a href="injectables.html#_urlmatcherfactory">$urlMatcherFactory</a> for injection during runtime.</h4>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L402">ui-router-angularjs/src/injectables.ts:402</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_urlrouter" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $url<wbr>Router</h3>
-->
<div class="tsd-signature tsd-kind-icon">$url<wbr>Router<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlRouter</span> <div class="tsd-header">
<p> The Url Router </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Url Router</p>
</div>
<h3 id="deprecation-warning-this-object-is-now-considered-internal-use-a-href-injectables-html-_urlservice-urlservice-a-instead-">Deprecation warning: This object is now considered internal. Use <a href="injectables.html#_urlservice">$urlService</a> instead.</h3>
<p>The <a href="../classes/url.urlrouter.html">UrlRouter</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_urlrouterprovider-urlrouterprovider-a-for-injection-during-angular-config-time-">Note: This object is also exposed as <a href="injectables.html#_urlrouterprovider">$urlRouterProvider</a> for injection during angular config time.</h4>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L372">ui-router-angularjs/src/injectables.ts:372</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_urlrouterprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $url<wbr>Router<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$url<wbr>Router<wbr>Provider<span class="tsd-signature-symbol">:</span> <a href="../classes/url.urlrouterprovider.html" class="tsd-signature-type">UrlRouterProvider</a> <div class="tsd-header">
<p> The URL Router Provider </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL Router Provider</p>
</div>
<h3 id="deprecation-warning-this-object-is-now-considered-internal-use-a-href-injectables-html-_urlserviceprovider-urlserviceprovider-a-instead-">Deprecation warning: This object is now considered internal. Use <a href="injectables.html#_urlserviceprovider">$urlServiceProvider</a> instead.</h3>
<p>The <a href="../classes/url.urlrouter.html">UrlRouter</a> singleton as a <strong>Provider Object</strong> (injectable during config time).</p>
<h4 id="note-this-object-is-also-exposed-as-a-href-injectables-html-_urlrouter-urlrouter-a-for-injection-during-runtime-">Note: This object is also exposed as <a href="injectables.html#_urlrouter">$urlRouter</a> for injection during runtime.</h4>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L359">ui-router-angularjs/src/injectables.ts:359</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_urlservice" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $url<wbr>Service</h3>
-->
<div class="tsd-signature tsd-kind-icon">$url<wbr>Service<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlService</span> <div class="tsd-header">
<p> The URL Service </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL Service</p>
</div>
<p>The <a href="../classes/url.urlservice.html">UrlService</a> singleton as a <strong>Service Object</strong> (injectable during runtime).</p>
<p>Note: This service can also be injected during the config phase as <a href="injectables.html#_urlserviceprovider">$urlServiceProvider</a>.</p>
<p>Used to configure the URL.
It has URL related APIs including:</p>
<ul>
<li>register custom Parameter types <code>UrlService.config.type</code> (<a href="../interfaces/url.urlconfigapi.html#type">UrlConfigApi.type</a>)</li>
<li>add URL rules: <code>UrlService.rules.when</code> (<a href="../interfaces/url.urlrulesapi.html#when">UrlRulesApi.when</a>)</li>
<li>configure behavior when no url matches: <code>UrlService.rules.otherwise</code> (<a href="../interfaces/url.urlrulesapi.html#otherwise">UrlRulesApi.otherwise</a>)</li>
<li>delay initial URL synchronization <a href="../classes/url.urlservice.html#deferintercept">UrlService.deferIntercept</a>.</li>
<li>get or set the current url: <a href="../classes/url.urlservice.html#url">UrlService.url</a></li>
</ul>
<h5 id="note-this-service-can-also-be-injected-during-the-config-phase-as-a-href-injectables-html-_urlserviceprovider-urlserviceprovider-a-">Note: This service can also be injected during the config phase as <a href="injectables.html#_urlserviceprovider">$urlServiceProvider</a>.</h5>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L346">ui-router-angularjs/src/injectables.ts:346</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="_urlserviceprovider" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagLet">Let</span> $url<wbr>Service<wbr>Provider</h3>
-->
<div class="tsd-signature tsd-kind-icon">$url<wbr>Service<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlService</span> <div class="tsd-header">
<p> The URL Service Provider </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL Service Provider</p>
</div>
<p>The <a href="../classes/url.urlservice.html">UrlService</a> singleton as a <strong>Provider Object</strong> (injectable during the angular config phase).</p>
<p>A service used to configure and interact with the URL.
It has URL related APIs including:</p>
<ul>
<li>register custom Parameter types <code>UrlService.config.type</code> (<a href="../interfaces/url.urlconfigapi.html#type">UrlConfigApi.type</a>)</li>
<li>add URL rules: <code>UrlService.rules.when</code> (<a href="../interfaces/url.urlrulesapi.html#when">UrlRulesApi.when</a>)</li>
<li>configure behavior when no url matches: <code>UrlService.rules.otherwise</code> (<a href="../interfaces/url.urlrulesapi.html#otherwise">UrlRulesApi.otherwise</a>)</li>
<li>delay initial URL synchronization <a href="../classes/url.urlservice.html#deferintercept">UrlService.deferIntercept</a>.</li>
<li>get or set the current url: <a href="../classes/url.urlservice.html#url">UrlService.url</a></li>
</ul>
<h5 id="note-this-service-can-also-be-injected-during-runtime-as-a-href-injectables-html-_urlservice-urlservice-a-">Note: This service can also be injected during runtime as <a href="injectables.html#_urlservice">$urlService</a>.</h5>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/7141abb/src/injectables.ts#L326">ui-router-angularjs/src/injectables.ts:326</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>@uirouter/angularjs</em></a>
</li>
<li class="label tsd-is-external">
<span>Public API</span>
</li>
<li class=" tsd-kind-external-module">
<a href="core.html">core</a>
</li>
<li class="current tsd-kind-external-module">
<a href="injectables.html">injectables</a>
</li>
<li class=" tsd-kind-external-module">
<a href="ng1.html">ng1</a>
</li>
<li class=" tsd-kind-external-module">
<a href="ng1_state_events.html">ng1_<wbr>state_<wbr>events</a>
</li>
<li class=" tsd-kind-external-module">
<a href="params.html">params</a>
</li>
<li class=" tsd-kind-external-module">
<a href="resolve.html">resolve</a>
</li>
<li class=" tsd-kind-external-module">
<a href="transition.html">transition</a>
</li>
<li class="label tsd-is-external">
<span>Internal UI-<wbr><wbr>Router API</span>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common.html">common</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_hof.html">common_<wbr>hof</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_predicates.html">common_<wbr>predicates</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_strings.html">common_<wbr>strings</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="directives.html">directives</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="hooks.html">hooks</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="path.html">path</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="state.html">state</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="trace.html">trace</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="url.html">url</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="vanilla.html">vanilla</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="view.html">view</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_state" class="tsd-kind-icon">$state</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_stateparams" class="tsd-kind-icon">$state<wbr>Params</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_stateprovider" class="tsd-kind-icon">$state<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_stateregistry" class="tsd-kind-icon">$state<wbr>Registry</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_stateregistryprovider" class="tsd-kind-icon">$state<wbr>Registry<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_trace" class="tsd-kind-icon">$trace</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_transition_" class="tsd-kind-icon">$transition$</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_transitions" class="tsd-kind-icon">$transitions</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_transitionsprovider" class="tsd-kind-icon">$transitions<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_uirouter" class="tsd-kind-icon">$ui<wbr>Router</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_uirouterglobals" class="tsd-kind-icon">$ui<wbr>Router<wbr>Globals</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_uirouterprovider" class="tsd-kind-icon">$ui<wbr>Router<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_uiviewscroll" class="tsd-kind-icon">$ui<wbr>View<wbr>Scroll</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_uiviewscrollprovider" class="tsd-kind-icon">$ui<wbr>View<wbr>Scroll<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_urlmatcherfactory" class="tsd-kind-icon">$url<wbr>Matcher<wbr>Factory</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_urlmatcherfactoryprovider" class="tsd-kind-icon">$url<wbr>Matcher<wbr>Factory<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_urlrouter" class="tsd-kind-icon">$url<wbr>Router</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_urlrouterprovider" class="tsd-kind-icon">$url<wbr>Router<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_urlservice" class="tsd-kind-icon">$url<wbr>Service</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="injectables.html#_urlserviceprovider" class="tsd-kind-icon">$url<wbr>Service<wbr>Provider</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">