forked from mmistakes/minimal-mistakes
-
Notifications
You must be signed in to change notification settings - Fork 27
/
view.viewservice.html
851 lines (850 loc) · 44.9 KB
/
view.viewservice.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
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ViewService | @uirouter/angular</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/angular</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/angular</a>
</li>
<li>
<a href="../modules/view.html">view</a>
</li>
<li>
<a href="view.viewservice.html">ViewService</a>
</li>
</ul>
<h1>Class ViewService</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">
<p>The View service</p>
</div>
<p>This service pairs existing <code>ui-view</code> components (which live in the DOM)
with view configs (from the state declaration objects: <a href="../interfaces/state.statedeclaration.html#views">StateDeclaration.views</a>).</p>
<ul>
<li><p>After a successful Transition, the views from the newly entered states are activated via <a href="view.viewservice.html#activateviewconfig">activateViewConfig</a>.
The views from exited states are deactivated via <a href="view.viewservice.html#deactivateviewconfig">deactivateViewConfig</a>.
(See: the <a href="../modules/hooks.html#registeractivateviews">registerActivateViews</a> Transition Hook)</p>
</li>
<li><p>As <code>ui-view</code> components pop in and out of existence, they register themselves using <a href="view.viewservice.html#registeruiview">registerUIView</a>.</p>
</li>
<li><p>When the <a href="view.viewservice.html#sync">sync</a> function is called, the registered <code>ui-view</code>(s) (<a href="../interfaces/view.activeuiview.html">ActiveUIView</a>)
are configured with the matching <a href="../interfaces/view.viewconfig.html">ViewConfig</a>(s)</p>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ViewService</span>
</li>
</ul>
</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 ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#activateviewconfig" class="tsd-kind-icon">activate<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#active" class="tsd-kind-icon">active</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#available" class="tsd-kind-icon">available</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#createviewconfig" class="tsd-kind-icon">create<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#deactivateviewconfig" class="tsd-kind-icon">deactivate<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#registeruiview" class="tsd-kind-icon">registerUIView</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#sync" class="tsd-kind-icon">sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="view.viewservice.html#matches" class="tsd-kind-icon">matches</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="view.viewservice.html#normalizeuiviewtarget" class="tsd-kind-icon">normalizeUIView<wbr>Target</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-external"><a href="view.viewservice.html#_pluginapi" class="tsd-kind-icon">_pluginapi</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="activateviewconfig" class="tsd-anchor"></a>
<!--
<h3>activate<wbr>View<wbr>Config</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">activate<wbr>View<wbr>Config<span class="tsd-signature-symbol">(</span>viewConfig<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a><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>viewConfig <a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L224">ui-router-core/src/view/view.ts:224</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="active" class="tsd-anchor"></a>
<!--
<h3>active</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any[]</span></li>
<li class="tsd-header">
<p> Returns the list of views on the page containing loaded content. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the list of views on the page containing loaded content.</p>
</div>
</div>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any[]</span></h4>
: <p>Returns an array of fully-qualified view names.</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L332">ui-router-core/src/view/view.ts:332</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="available" class="tsd-anchor"></a>
<!--
<h3>available</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">available<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any[]</span></li>
<li class="tsd-header">
<p> Returns the list of views currently available on the page, by fully-qualified name. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the list of views currently available on the page, by fully-qualified name.</p>
</div>
</div>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any[]</span></h4>
: <p>Returns an array of fully-qualified view names.</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L323">ui-router-core/src/view/view.ts:323</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createviewconfig" class="tsd-anchor"></a>
<!--
<h3>create<wbr>View<wbr>Config</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>View<wbr>Config<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathNode[]</span>, decl<span class="tsd-signature-symbol">: </span><a href="../interfaces/state._viewdeclaration.html" class="tsd-signature-type">_ViewDeclaration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ViewConfig[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path <span class="tsd-signature-type">PathNode[]</span></h5>
</li>
<li>
<h5>decl <a href="../interfaces/state._viewdeclaration.html" class="tsd-signature-type">_ViewDeclaration</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ViewConfig[]</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L204">ui-router-core/src/view/view.ts:204</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deactivateviewconfig" class="tsd-anchor"></a>
<!--
<h3>deactivate<wbr>View<wbr>Config</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">deactivate<wbr>View<wbr>Config<span class="tsd-signature-symbol">(</span>viewConfig<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-header">
<p> Deactivates a ViewConfig. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deactivates a ViewConfig.</p>
</div>
<p>This function deactivates a <code>ViewConfig</code>.
After calling <a href="view.viewservice.html#sync">sync</a>, it will un-pair from any <code>ui-view</code> with which it is currently paired.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>viewConfig <a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a></h5>
: <div class="tsd-comment tsd-typography">
<p>The ViewConfig view to deregister.</p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L219">ui-router-core/src/view/view.ts:219</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registeruiview" class="tsd-anchor"></a>
<!--
<h3>registerUIView</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">registerUIView<span class="tsd-signature-symbol">(</span>uiView<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
<li class="tsd-header">
<p> Registers a <code>ui-view</code> component </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers a <code>ui-view</code> component</p>
</div>
<p>When a <code>ui-view</code> component is created, it uses this method to register itself.
After registration the <a href="view.viewservice.html#sync">sync</a> method is used to ensure all <code>ui-view</code> are configured with the proper <a href="../interfaces/view.viewconfig.html">ViewConfig</a>.</p>
<p>Note: the <code>ui-view</code> component uses the <code>ViewConfig</code> to determine what view should be loaded inside the <code>ui-view</code>,
and what the view's state context is.</p>
<p>Note: There is no corresponding <code>deregisterUIView</code>.
A <code>ui-view</code> should hang on to the return value of <code>registerUIView</code> and invoke it to deregister itself.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uiView <a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a></h5>
: <div class="tsd-comment tsd-typography">
<p>The metadata for a UIView</p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
: <p>a de-registration function used when the view is destroyed.</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L297">ui-router-core/src/view/view.ts:297</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sync" class="tsd-anchor"></a>
<!--
<h3>sync</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</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">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L229">ui-router-core/src/view/view.ts:229</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="matches" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagStatic">Static</span> matches</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">matches<span class="tsd-signature-symbol">(</span>uiViewsByFqn<span class="tsd-signature-symbol">: </span><a href="../interfaces/common.typedmap.html" class="tsd-signature-type">TypedMap</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">></span>, uiView<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
<li class="tsd-header">
<p> Given a ui-view and a ViewConfig, determines if they "match". </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a ui-view and a ViewConfig, determines if they "match".</p>
</div>
<p>A ui-view has a fully qualified name (fqn) and a context object. The fqn is built from its overall location in
the DOM, describing its nesting relationship to any parent ui-view tags it is nested inside of.</p>
<p>A ViewConfig has a target ui-view name and a context anchor. The ui-view name can be a simple name, or
can be a segmented ui-view path, describing a portion of a ui-view fqn.</p>
<p>In order for a ui-view to match ViewConfig, ui-view's $type must match the ViewConfig's $type</p>
<p>If the ViewConfig's target ui-view name is a simple name (no dots), then a ui-view matches if:</p>
<ul>
<li>the ui-view's name matches the ViewConfig's target name</li>
<li>the ui-view's context matches the ViewConfig's anchor</li>
</ul>
<p>If the ViewConfig's target ui-view name is a segmented name (with dots), then a ui-view matches if:</p>
<ul>
<li>There exists a parent ui-view where:<ul>
<li>the parent ui-view's name matches the first segment (index 0) of the ViewConfig's target name</li>
<li>the parent ui-view's context matches the ViewConfig's anchor</li>
</ul>
</li>
<li>And the remaining segments (index 1..n) of the ViewConfig's target name match the tail of the ui-view's fqn</li>
</ul>
<p>Example:</p>
<p>DOM:
<ui-view> <!-- created in the root context (name: "") -->
<ui-view name="foo"> <!-- created in the context named: "A" -->
<ui-view> <!-- created in the context named: "A.B" -->
<ui-view name="bar"> <!-- created in the context named: "A.B.C" -->
</ui-view>
</ui-view>
</ui-view>
</ui-view></p>
<p>uiViews: [
{ fqn: "$default", creationContext: { name: "" } },
{ fqn: "$default.foo", creationContext: { name: "A" } },
{ fqn: "$default.foo.$default", creationContext: { name: "A.B" } }
{ fqn: "$default.foo.$default.bar", creationContext: { name: "A.B.C" } }
]</p>
<p>These four view configs all match the ui-view with the fqn: "$default.foo.$default.bar":</p>
<ul>
<li>ViewConfig1: { uiViewName: "bar", uiViewContextAnchor: "A.B.C" }</li>
<li>ViewConfig2: { uiViewName: "$default.bar", uiViewContextAnchor: "A.B" }</li>
<li>ViewConfig3: { uiViewName: "foo.$default.bar", uiViewContextAnchor: "A" }</li>
<li>ViewConfig4: { uiViewName: "$default.foo.$default.bar", uiViewContextAnchor: "" }</li>
</ul>
<p>Using ViewConfig3 as an example, it matches the ui-view with fqn "$default.foo.$default.bar" because:</p>
<ul>
<li>The ViewConfig's segmented target name is: [ "foo", "$default", "bar" ]</li>
<li>There exists a parent ui-view (which has fqn: "$default.foo") where:<ul>
<li>the parent ui-view's name "foo" matches the first segment "foo" of the ViewConfig's target name</li>
<li>the parent ui-view's context "A" matches the ViewConfig's anchor context "A"</li>
</ul>
</li>
<li>And the remaining segments [ "$default", "bar" ].join("."_ of the ViewConfig's target name match
the tail of the ui-view's fqn "default.bar"</li>
</ul>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uiViewsByFqn <a href="../interfaces/common.typedmap.html" class="tsd-signature-type">TypedMap</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>uiView <a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L126">ui-router-core/src/view/view.ts:126</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="normalizeuiviewtarget" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagStatic">Static</span> normalizeUIView<wbr>Target</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">normalizeUIView<wbr>Target<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a>, rawViewName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
<li class="tsd-header">
<p> Normalizes a view's name from a state.views configuration block. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Normalizes a view's name from a state.views configuration block.</p>
</div>
<p>This should be used by a framework implementation to calculate the values for
<a href="../interfaces/state._viewdeclaration.html#_uiviewname"><em>ViewDeclaration.$uiViewName</a> and <a href="../interfaces/state.</em>viewdeclaration.html#<em>uiviewcontextanchor"></em>ViewDeclaration.$uiViewContextAnchor</a>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>context <a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a></h5>
: <div class="tsd-comment tsd-typography">
<p>the context object (state declaration) that the view belongs to</p>
</div>
</li>
<li>
<h5>rawViewName: <span class="tsd-flag ts-flagDefault value">Default value</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
: <div class="tsd-comment tsd-typography">
<p>the name of the view, as declared in the <a href="../interfaces/state.statedeclaration.html#views">StateDeclaration.views</a></p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
: <p>the normalized uiViewName and uiViewContextAnchor that the view targets</p>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ui<wbr>View<wbr>Context<wbr>Anchor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>ui<wbr>View<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L158">ui-router-core/src/view/view.ts:158</a></li>
</ul>
</aside> </li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-class tsd-is-external">
<a name="_pluginapi" class="tsd-anchor"></a>
<!--
<h3>_pluginapi</h3>
-->
<div class="tsd-signature tsd-kind-icon">_pluginapi<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L57">ui-router-core/src/view/view.ts:57</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="_pluginapi._rootviewcontext" class="tsd-anchor"></a>
<!--
<h3>_root<wbr>View<wbr>Context</h3>
-->
<div class="tsd-signature tsd-kind-icon">_root<wbr>View<wbr>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = this._rootViewContext.bind(this)</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L58">ui-router-core/src/view/view.ts:58</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="_pluginapi._viewconfigfactory" class="tsd-anchor"></a>
<!--
<h3>_view<wbr>Config<wbr>Factory</h3>
-->
<div class="tsd-signature tsd-kind-icon">_view<wbr>Config<wbr>Factory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = this._viewConfigFactory.bind(this)</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L59">ui-router-core/src/view/view.ts:59</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._activeviewconfigs" class="tsd-anchor"></a>
<!--
<h3>_active<wbr>View<wbr>Configs</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_active<wbr>View<wbr>Configs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ViewConfig[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ViewConfig[]</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L62">ui-router-core/src/view/view.ts:62</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._onsync" class="tsd-anchor"></a>
<!--
<h3>_on<wbr>Sync</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_on<wbr>Sync<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewsynclistener.html" class="tsd-signature-type">ViewSyncListener</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>listener <a href="../interfaces/view.viewsynclistener.html" class="tsd-signature-type">ViewSyncListener</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L63">ui-router-core/src/view/view.ts:63</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._registereduiview" class="tsd-anchor"></a>
<!--
<h3>_registeredUIView</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_registeredUIView<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L60">ui-router-core/src/view/view.ts:60</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._registereduiviews" class="tsd-anchor"></a>
<!--
<h3>_registeredUIViews</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_registeredUIViews<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ActiveUIView[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ActiveUIView[]</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/view/view.ts#L61">ui-router-core/src/view/view.ts:61</a></li>
</ul>
</aside> </li>
</ul>
</section>
</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/angular</em></a>
</li>
<li class="label tsd-is-external">
<span>Public API</span>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/core.html">core</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/directives.html">directives</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/params.html">params</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/resolve.html">resolve</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/state.html">state</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/transition.html">transition</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/url.html">url</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/view.html">view</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="../modules/common_hof.html">common_<wbr>hof</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/common_predicates.html">common_<wbr>predicates</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/common_strings.html">common_<wbr>strings</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/hooks.html">hooks</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/ng2.html">ng2</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/path.html">path</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/trace.html">trace</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/vanilla.html">vanilla</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="view.viewservice.html" class="tsd-kind-icon">View<wbr>Service</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#activateviewconfig" class="tsd-kind-icon">activate<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#active" class="tsd-kind-icon">active</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#available" class="tsd-kind-icon">available</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#createviewconfig" class="tsd-kind-icon">create<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#deactivateviewconfig" class="tsd-kind-icon">deactivate<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#registeruiview" class="tsd-kind-icon">registerUIView</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#sync" class="tsd-kind-icon">sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="view.viewservice.html#matches" class="tsd-kind-icon">matches</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="view.viewservice.html#normalizeuiviewtarget" class="tsd-kind-icon">normalizeUIView<wbr>Target</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-class tsd-is-external">
<a href="view.viewservice.html#_pluginapi" class="tsd-kind-icon">_pluginapi</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/view.activeuiview.html" class="tsd-kind-icon">ActiveUIView</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewconfig.html" class="tsd-kind-icon">View<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/view.viewcontext.html" class="tsd-kind-icon">View<wbr>Context</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewservicepluginapi.html" class="tsd-kind-icon">View<wbr>Service<wbr>PluginAPI</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewsynclistener.html" class="tsd-kind-icon">View<wbr>Sync<wbr>Listener</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewtuple.html" class="tsd-kind-icon">View<wbr>Tuple</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/view.html#viewconfigfactory" class="tsd-kind-icon">View<wbr>Config<wbr>Factory</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">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>