forked from mmistakes/minimal-mistakes
/
params.paramdeclaration.html
711 lines (701 loc) · 36.6 KB
/
params.paramdeclaration.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
---
redirect_from: /docs/1.0.16/interfaces/params.paramdeclaration.html
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ParamDeclaration | @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="../modules/params.html">params</a>
</li>
<li>
<a href="params.paramdeclaration.html">ParamDeclaration</a>
</li>
</ul>
<h1>Interface ParamDeclaration</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>Configuration for a single Parameter</p>
</div>
<p>In a <a href="state.statedeclaration.html#params">StateDeclaration.params</a>, each <code>ParamDeclaration</code>
defines how a single State Parameter should work.</p>
<h4 id="example-">Example:</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> mystate = {
<span class="hljs-attr">template</span>: <span class="hljs-string">'<div ui-view/>'</span>,
<span class="hljs-attr">controller</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{}
url: <span class="hljs-string">'/mystate/:start?{count:int}'</span>,
<span class="hljs-attr">params</span>: {
<span class="hljs-attr">start</span>: { <span class="hljs-comment">// <-- ParamDeclaration for `start`</span>
type: <span class="hljs-string">'date'</span>,
<span class="hljs-attr">value</span>: <span class="hljs-keyword">new</span> <span class="hljs-built_in">Date</span>(), <span class="hljs-comment">// <-- Default value</span>
squash: <span class="hljs-literal">true</span>,
},
<span class="hljs-attr">nonUrlParam</span>: { <span class="hljs-comment">// <-- ParamDeclaration for 'nonUrlParam'</span>
type: <span class="hljs-string">"int"</span>,
<span class="hljs-attr">array</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">value</span>: []
},
<span class="hljs-attr">count</span>: <span class="hljs-number">0</span>, <span class="hljs-comment">// <-- Default value for 'param1'</span>
<span class="hljs-comment">// (shorthand ParamDeclaration.value)</span>
}
}
</code></pre>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ParamDeclaration</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#array" class="tsd-kind-icon">array</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#dynamic" class="tsd-kind-icon">dynamic</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#inherit" class="tsd-kind-icon">inherit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#raw" class="tsd-kind-icon">raw</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="params.paramdeclaration.html#replace" class="tsd-kind-icon">replace</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#squash" class="tsd-kind-icon">squash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="params.paramdeclaration.html#value" class="tsd-kind-icon">value</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="array" class="tsd-anchor"></a>
<!--
<h3>array</h3>
-->
<div class="tsd-signature tsd-kind-icon">array<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <div class="tsd-header">
<p> The parameter's <code>array</code> mode </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The parameter's <code>array</code> mode</p>
</div>
<p>Explicitly specifies the array mode of a URL parameter</p>
<ul>
<li>If <code>false</code>, the parameter value will be treated (encoded/decoded) as a single value</li>
<li>If <code>true</code>, the parameter value will be treated (encoded/decoded) as an array of values.</li>
<li>If <code>auto</code> (for query parameters only), if multiple values for a single parameter are present
in the URL (e.g.: /foo?bar=1&bar=2&bar=3) then the values are mapped to an array (e.g.:
<code>{ foo: [ '1', '2', '3' ] }</code>). However, if only one value is present (e.g.: /foo?bar=1)
then the value is treated as single value (e.g.: { foo: '1' }).</li>
</ul>
<p>If you specified a <a href="params.paramdeclaration.html#type">type</a> for the parameter, the value will be treated as an array
of the specified <a href="../classes/params.paramtype.html">ParamType</a>.</p>
<h4 id="example-">Example:</h4>
<pre><code class="lang-js">{
name: 'foo',
url: '/foo/{arrayParam:int}`,
params: {
arrayParam: { array: true }
}
}
// After the transition, URL should be '/foo/1-2-3'
$state.go("foo", { arrayParam: [ 1, 2, 3 ] });
</code></pre>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p><code>false</code> for path parameters, such as <code>url: '/foo/:pathParam'</code></p>
</dd>
<dt>default</dt>
<dd><p><code>auto</code> for query parameters, such as <code>url: '/foo?queryParam'</code></p>
</dd>
<dt>default</dt>
<dd><p><code>true</code> if the parameter name ends in <code>[]</code>, such as <code>url: '/foo/{implicitArrayParam:int[]}'</code></p>
</dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L171">ui-router-core/src/params/interface.ts:171</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dynamic" class="tsd-anchor"></a>
<!--
<h3>dynamic</h3>
-->
<div class="tsd-signature tsd-kind-icon">dynamic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <div class="tsd-header">
<p> Dynamic flag </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dynamic flag</p>
</div>
<p>When <code>dynamic</code> is <code>true</code>, changes to the parameter value will not cause the state to be entered/exited.
The resolves will not be re-fetched, nor will views be reloaded.</p>
<p>Normally, if a parameter value changes, the state which declared that the parameter will be reloaded (entered/exited).
When a parameter is <code>dynamic</code>, a transition still occurs, but it does not cause the state to exit/enter.</p>
<p>This can be useful to build UI where the component updates itself when the param values change.
A common scenario where this is useful is searching/paging/sorting.</p>
<hr>
<p>Note: this value overrides the <code>dynamic</code> value on a custom parameter type (<a href="params.paramtypedefinition.html#dynamic">ParamTypeDefinition.dynamic</a>).</p>
<hr>
<p>Default: <code>false</code></p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L275">ui-router-core/src/params/interface.ts:275</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="inherit" class="tsd-anchor"></a>
<!--
<h3>inherit</h3>
-->
<div class="tsd-signature tsd-kind-icon">inherit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <div class="tsd-header">
<p> Enables/disables inheriting of this parameter's value </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables/disables inheriting of this parameter's value</p>
</div>
<p>When a transition is run with <a href="transition.transitionoptions.html#inherit">TransitionOptions.inherit</a> set to
<code>true</code>, the current param values are inherited in the new transition.
However, parameters values which have <code>inherit: false</code> set will <em>not be inherited</em>.</p>
<h4 id="example-state-">Example state :</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> fooState = {
<span class="hljs-attr">name</span>: <span class="hljs-string">'foo'</span>,
<span class="hljs-attr">url</span>: <span class="hljs-string">'/:fooId?mode&refresh'</span>,
<span class="hljs-attr">params</span>: {
<span class="hljs-attr">refresh</span>: { <span class="hljs-attr">inherit</span>: <span class="hljs-literal">false</span> }
}
}
<span class="hljs-comment">// Set fooId to 123</span>
$state.go(<span class="hljs-string">'fooState'</span>, { <span class="hljs-attr">fooId</span>: <span class="hljs-number">1234</span>, <span class="hljs-attr">mode</span>: <span class="hljs-string">'list'</span>, <span class="hljs-attr">refresh</span>: <span class="hljs-literal">true</span> });
</code></pre>
<p>In the component:
<code>mode: 'list' is inherited, but refresh: true is not inherited.
// The param values are thus:</code>{ fooId: 4567, mode: 'list' }`</p>
<pre><code><span class="xml"><span class="hljs-tag"><<span class="hljs-name">ui-sref="foo(</span></span></span><span class="hljs-template-variable">{ fooId: 4567 }</span><span class="xml"><span class="hljs-tag">)"></span>4567<span class="hljs-tag"></<span class="hljs-name">ui-sref</span>></span></span>
</code></pre><hr>
<p>See also <a href="transition.transitionoptions.html#inherit">TransitionOptions.inherit</a> and <a href="params.paramtypedefinition.html#inherit">ParamTypeDefinition.inherit</a></p>
<hr>
<p>Default: <code>true</code></p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L351">ui-router-core/src/params/interface.ts:351</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="raw" class="tsd-anchor"></a>
<!--
<h3>raw</h3>
-->
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <div class="tsd-header">
<p> Disables url-encoding of parameter values </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disables url-encoding of parameter values</p>
</div>
<p>When <code>true</code>, parameter values are not url-encoded.
This is commonly used to allow "slug" urls, with a parameter value including non-semantic slashes.</p>
<h4 id="example-">Example:</h4>
<pre><code class="lang-js">url: <span class="hljs-string">'/product/:slug'</span>,
<span class="hljs-attr">params</span>: {
<span class="hljs-attr">slug</span>: { <span class="hljs-attr">type</span>: <span class="hljs-string">'string'</span>, <span class="hljs-attr">raw</span>: <span class="hljs-literal">true</span> }
}
</code></pre>
<p>This allows a URL parameter of <code>{ slug: 'camping/tents/awesome_tent' }</code>
to serialize to <code>/product/camping/tents/awesome_tent</code>
instead of <code>/product/camping%2Ftents%2Fawesome_tent</code>.</p>
<hr>
<p>Note: this value overrides the <code>raw</code> value on a custom parameter type (<a href="params.paramtypedefinition.html#raw">ParamTypeDefinition.raw</a>).</p>
<h3 id="decoding-warning">Decoding warning</h3>
<p>The decoding behavior of raw parameters is not defined.
For example, given a url template such as <code>/:raw1/:raw2</code>
the url <code>/foo/bar/baz/qux/</code>, there is no way to determine which slashes belong to which params.</p>
<p>It's generally safe to use a raw parameter at the end of a path, like '/product/:slug'.
However, beware of the characters you allow in your raw parameter values.
Avoid unencoded characters that could disrupt normal URL parsing, such as <code>?</code> and <code>#</code>.</p>
<hr>
<p>Default: <code>false</code></p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L313">ui-router-core/src/params/interface.ts:313</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="replace" class="tsd-anchor"></a>
<!--
<h3>replace</h3>
-->
<div class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Replace[]</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/9bb7287/src/params/interface.ts#L245">ui-router-core/src/params/interface.ts:245</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="squash" class="tsd-anchor"></a>
<!--
<h3>squash</h3>
-->
<div class="tsd-signature tsd-kind-icon">squash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span> <div class="tsd-header">
<p> Squash mode: omit default parameter values in URL </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Squash mode: omit default parameter values in URL</p>
</div>
<p>Configures how a default parameter value is represented in the URL when the current parameter value
is the same as the default value.</p>
<p>There are three squash settings:</p>
<ul>
<li><code>false</code>: The parameter's default value is not squashed. It is encoded and included in the URL</li>
<li><code>true</code>: The parameter's default value is omitted from the URL.
If the parameter is preceeded and followed by slashes in the state's url declaration, then one of those slashes are omitted.
This can allow for cleaner looking URLs.</li>
<li><code>"&lt;arbitrary string&gt;"</code>: The parameter's default value is replaced with an arbitrary
placeholder of your choice.</li>
</ul>
<h4 id="example-">Example:</h4>
<pre><code class="lang-js">{
<span class="hljs-attr">name</span>: <span class="hljs-string">'mystate'</span>,
<span class="hljs-attr">url</span>: <span class="hljs-string">'/mystate/:myparam'</span>,
<span class="hljs-attr">params</span>: {
<span class="hljs-attr">myparam</span>: <span class="hljs-string">'defaultParamValue'</span>
squash: <span class="hljs-literal">true</span>
}
}
<span class="hljs-comment">// URL will be `/mystate/`</span>
$state.go(<span class="hljs-string">'mystate'</span>, { <span class="hljs-attr">myparam</span>: <span class="hljs-string">'defaultParamValue'</span> });
<span class="hljs-comment">// URL will be `/mystate/someOtherValue`</span>
$state.go(<span class="hljs-string">'mystate'</span>, { <span class="hljs-attr">myparam</span>: <span class="hljs-string">'someOtherValue'</span> });
</code></pre>
<h4 id="example-">Example:</h4>
<pre><code class="lang-js">{
<span class="hljs-attr">name</span>: <span class="hljs-string">'mystate2'</span>,
<span class="hljs-attr">url</span>: <span class="hljs-string">'/mystate2/:myparam2'</span>,
<span class="hljs-attr">params</span>: {
<span class="hljs-attr">myparam2</span>: <span class="hljs-string">'defaultParamValue'</span>
squash: <span class="hljs-string">"~"</span>
}
}
<span class="hljs-comment">// URL will be `/mystate/~`</span>
$state.go(<span class="hljs-string">'mystate'</span>, { <span class="hljs-attr">myparam2</span>: <span class="hljs-string">'defaultParamValue'</span> });
<span class="hljs-comment">// URL will be `/mystate/someOtherValue`</span>
$state.go(<span class="hljs-string">'mystate'</span>, { <span class="hljs-attr">myparam2</span>: <span class="hljs-string">'someOtherValue'</span> });
</code></pre>
<p>Default: If squash is not set, it uses the configured default squash policy. (See <a href="url.urlconfigapi.html#defaultsquashpolicy">defaultSquashPolicy</a>())</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L226">ui-router-core/src/params/interface.ts:226</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<!--
<h3>type</h3>
-->
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/params.paramtype.html" class="tsd-signature-type">ParamType</a> <div class="tsd-header">
<p> The parameter's type </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The parameter's type</p>
</div>
<p>Specifies the <a href="../classes/params.paramtype.html">ParamType</a> of the parameter.
Parameter types can be used to customize the encoding/decoding of parameter values.</p>
<p>Set this property to the name of parameter's type.
The type may be either one of the built in types, or a custom type that has been registered with the <a href="../classes/url.urlmatcherfactory.html">UrlMatcherFactory</a>.</p>
<p>See <a href="../classes/params.paramtypes.html">ParamTypes</a> for the list of built in types.</p>
<hr>
<p>Default:</p>
<ul>
<li>Path parameters (<code>/:fooParam</code>): <code>path</code></li>
<li>Query parameters (<code>?queryParam</code>): <code>query</code></li>
<li>Non-url parameters (<code>param: { foo: null }</code>): <code>any</code></li>
</ul>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L136">ui-router-core/src/params/interface.ts:136</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="value" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagOptional">Optional</span> value</h3>
-->
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <div class="tsd-header">
<p> The default value for this parameter. </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The default value for this parameter.</p>
</div>
<p>Specifies the default value for this parameter.
This implicitly sets this parameter as optional.</p>
<p>When UI-Router routes to a state and no value is specified for this parameter in the URL or transition,
the default value will be used instead.
If value is a function, it will be injected and invoked, and the return value used.</p>
<p>Note: <code>value: undefined</code> is treated as though <strong>no default value was specified</strong>, while <code>value: null</code> is treated
as <strong>"the default value is null"</strong>.</p>
<pre><code><span class="hljs-comment">// define default values for param1 and param2</span>
<span class="hljs-attribute">params</span>: {
<span class="hljs-attribute">param1</span>: {
<span class="hljs-attribute">value</span>: <span class="hljs-string">"defaultValue"</span>
},
<span class="hljs-attribute">param2</span>: {
<span class="hljs-attribute">value</span>: "param2Default;
}
}
</code></pre><h3 id="shorthand-declaration">Shorthand Declaration</h3>
<p>If you only want to set the default value of the parameter, you may use a shorthand syntax.
In the params map, instead mapping the param name to a full parameter configuration object, simply set map it
to the default parameter value, e.g.:</p>
<pre><code><span class="hljs-comment">// Normal (non-shorthand) default value syntax</span>
<span class="hljs-symbol">params:</span> {
<span class="hljs-symbol"> param1:</span> {
<span class="hljs-symbol"> value:</span> <span class="hljs-string">"defaultValue"</span>
},
<span class="hljs-symbol"> param2:</span> {
<span class="hljs-symbol"> value:</span> <span class="hljs-string">"param2Default"</span>
}
}
<span class="hljs-comment">// Shorthand default value syntax</span>
<span class="hljs-symbol">params:</span> {
<span class="hljs-symbol"> param1:</span> <span class="hljs-string">"defaultValue"</span>,
<span class="hljs-symbol"> param2:</span> <span class="hljs-string">"param2Default"</span>
}
</code></pre><p>This defines a default value for the parameter.
If a parameter value is <code>undefined</code>, this default value will be used instead</p>
<hr>
<p>Default: <code>undefined</code></p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/9bb7287/src/params/interface.ts#L115">ui-router-core/src/params/interface.ts:115</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="../modules/core.html">core</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/injectables.html">injectables</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ng1.html">ng1</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ng1_state_events.html">ng1_<wbr>state_<wbr>events</a>
</li>
<li class="current 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/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="../modules/common.html">common</a>
</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/directives.html">directives</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/path.html">path</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/state.html">state</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/url.html">url</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/vanilla.html">vanilla</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/view.html">view</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-external-module tsd-is-external">
<a href="../enums/params.deftype.html" class="tsd-kind-icon">Def<wbr>Type</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/params.param.html" class="tsd-kind-icon">Param</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/params.paramtype.html" class="tsd-kind-icon">Param<wbr>Type</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/params.paramtypes.html" class="tsd-kind-icon">Param<wbr>Types</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/params.stateparams.html" class="tsd-kind-icon">State<wbr>Params</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="params.paramdeclaration.html" class="tsd-kind-icon">Param<wbr>Declaration</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#array" class="tsd-kind-icon">array</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#dynamic" class="tsd-kind-icon">dynamic</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#inherit" class="tsd-kind-icon">inherit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#raw" class="tsd-kind-icon">raw</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="params.paramdeclaration.html#replace" class="tsd-kind-icon">replace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#squash" class="tsd-kind-icon">squash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="params.paramdeclaration.html#value" class="tsd-kind-icon">value</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="params.paramtypedefinition.html" class="tsd-kind-icon">Param<wbr>Type<wbr>Definition</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="params.rawparams.html" class="tsd-kind-icon">Raw<wbr>Params</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="params.replace.html" class="tsd-kind-icon">Replace</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="../modules/params.html#arraytype" class="tsd-kind-icon">Array<wbr>Type</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="../modules/params.html#getreplace" class="tsd-kind-icon">get<wbr>Replace</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="../modules/params.html#getsquashpolicy" class="tsd-kind-icon">get<wbr>Squash<wbr>Policy</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>