forked from mmistakes/minimal-mistakes
/
_uirouter_core_state_interface._viewdeclaration.html
365 lines (365 loc) · 17.9 KB
/
_uirouter_core_state_interface._viewdeclaration.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
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>_ViewDeclaration | @uirouter/react</title>
<meta name="description" content="Documentation for @uirouter/react">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.json" 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/react</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">Externals</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/react</a>
</li>
<li>
<a href="../modules/_uirouter_core_state_interface.html">@uirouter/core/state/interface</a>
</li>
<li>
<a href="_uirouter_core_state_interface._viewdeclaration.html">_ViewDeclaration</a>
</li>
</ul>
<h1>Interface _ViewDeclaration</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>Base interface for declaring a view</p>
</div>
<p>This interface defines the basic data that a normalized view declaration will have on it.
Each implementation of UI-Router (for a specific framework) should define its own extension of this interface.
Add any additional fields that the framework requires to that interface.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">_ViewDeclaration</span>
<ul class="tsd-hierarchy">
<li>
<a href="_interface_.reactviewdeclaration.html" class="tsd-signature-type">ReactViewDeclaration</a>
</li>
</ul>
</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 tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_state_interface._viewdeclaration.html#_context" class="tsd-kind-icon">$context</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_state_interface._viewdeclaration.html#_name" class="tsd-kind-icon">$name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_state_interface._viewdeclaration.html#_type" class="tsd-kind-icon">$type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_state_interface._viewdeclaration.html#_uiviewcontextanchor" class="tsd-kind-icon">$ui<wbr>View<wbr>Context<wbr>Anchor</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_state_interface._viewdeclaration.html#_uiviewname" class="tsd-kind-icon">$ui<wbr>View<wbr>Name</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="_context" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> $context</h3>
<div class="tsd-signature tsd-kind-icon">$context<span class="tsd-signature-symbol">:</span> <a href="_uirouter_core_view_interface.viewcontext.html" class="tsd-signature-type">ViewContext</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/918f51f/src/state/interface.ts#L67">@uirouter/core/src/state/interface.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The context that this view is declared within.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> $name</h3>
<div class="tsd-signature tsd-kind-icon">$name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/918f51f/src/state/interface.ts#L35">@uirouter/core/src/state/interface.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raw name for the view declaration, i.e., the <a href="_uirouter_core_state_interface.statedeclaration.html#views">StateDeclaration.views</a> property name.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="_type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> $type</h3>
<div class="tsd-signature tsd-kind-icon">$type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/918f51f/src/state/interface.ts#L62">@uirouter/core/src/state/interface.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A type identifier for the View</p>
</div>
<p>This is used when loading prerequisites for the view, before it enters the DOM. Different types of views
may load differently (e.g., templateProvider+controllerProvider vs component class)</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="_uiviewcontextanchor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> $ui<wbr>View<wbr>Context<wbr>Anchor</h3>
<div class="tsd-signature tsd-kind-icon">$ui<wbr>View<wbr>Context<wbr>Anchor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/918f51f/src/state/interface.ts#L54">@uirouter/core/src/state/interface.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized context anchor (state name) for the <code>uiViewName</code></p>
</div>
<p>When targeting a <code>ui-view</code>, the <code>uiViewName</code> address is anchored to a context name (state name).</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="_uiviewname" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> $ui<wbr>View<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">$ui<wbr>View<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/918f51f/src/state/interface.ts#L47">@uirouter/core/src/state/interface.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The normalized address for the <code>ui-view</code> which this ViewConfig targets.</p>
</div>
<p>A ViewConfig targets a <code>ui-view</code> in the DOM (relative to the <code>uiViewContextAnchor</code>) which has
a specific name.</p>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p><code>header</code> or <code>$default</code></p>
<p>The <code>uiViewName</code> can also target a <em>nested view</em> by providing a dot-notation address</p>
</dd>
<dt>example</dt>
<dd><p><code>foo.bar</code> or <code>foo.$default.bar</code></p>
</dd>
</dl>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label ">
<span></span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_core_.uirouterreact.html">UIRouter<wbr>React</a>
</li>
<li class="label ">
<span>Services</span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_state_stateservice.stateservice.html">State<wbr>Service</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_state_stateregistry.stateregistry.html">State<wbr>Registry</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_transition_transitionservice.transitionservice.html">Transition<wbr>Service</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_url_urlservice.urlservice.html">Url<wbr>Service</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html">Url<wbr>Config</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_url_urlrules.urlrules.html">Url<wbr>Rules</a>
</li>
<li class="label ">
<span>Interfaces</span>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_interface_.reactstatedeclaration.html">React<wbr>State<wbr>Declaration</a>
</li>
<li class="label ">
<span>Components</span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_router.uirouter.html">UIRouter</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter tsd-is-external">
<a href="../classes/_components_uiview_.uiview.html">UIView</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_components_uisref_.html#uisref">UISref</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_components_uisrefactive_.html#uisrefactive">UISref<wbr>Active</a>
</li>
<li class="label ">
<span>React <wbr>Hooks</span>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_userouter_.html#userouter">use<wbr>Router</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_usesref_.html#usesref">use<wbr>Sref</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_usesrefactive_.html#usesrefactive">use<wbr>Sref<wbr>Active</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_usesrefactiveexact_.html#usesrefactiveexact">use<wbr>Sref<wbr>Active<wbr>Exact</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_usetransitionhook_.html#usetransitionhook">use<wbr>Transition<wbr>Hook</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_usecurrentstateandparams_.html#usecurrentstateandparams">use<wbr>Current<wbr>State<wbr>And<wbr>Params</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_useonstatechanged_.html#useonstatechanged">use<wbr>OnState<wbr>Changed</a>
</li>
<li class="current tsd-kind-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/_hooks_useisactive_.html#useisactive">use<wbr>IsActive</a>
</li>
<li class="label ">
<span>Other</span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_transition_transition.transition.html">Transition</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_common_trace.trace.html">Trace</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_state_interface.hrefoptions.html" class="tsd-kind-icon">Href<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_state_interface.lazyloadresult.html" class="tsd-kind-icon">Lazy<wbr>Load<wbr>Result</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_state_interface.statedeclaration.html" class="tsd-kind-icon">State<wbr>Declaration</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_state_interface.targetstatedef.html" class="tsd-kind-icon">Target<wbr>State<wbr>Def</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_state_interface.transitionpromise.html" class="tsd-kind-icon">Transition<wbr>Promise</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_state_interface._viewdeclaration.html" class="tsd-kind-icon">_<wbr>View<wbr>Declaration</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_state_interface._viewdeclaration.html#_context" class="tsd-kind-icon">$context</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_state_interface._viewdeclaration.html#_name" class="tsd-kind-icon">$name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_state_interface._viewdeclaration.html#_type" class="tsd-kind-icon">$type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_state_interface._viewdeclaration.html#_uiviewcontextanchor" class="tsd-kind-icon">$ui<wbr>View<wbr>Context<wbr>Anchor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_state_interface._viewdeclaration.html#_uiviewname" class="tsd-kind-icon">$ui<wbr>View<wbr>Name</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external">
<a href="../modules/_uirouter_core_state_interface.html#redirecttoresult" class="tsd-kind-icon">Redirect<wbr>ToResult</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external">
<a href="../modules/_uirouter_core_state_interface.html#resolvetypes" class="tsd-kind-icon">Resolve<wbr>Types</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external">
<a href="../modules/_uirouter_core_state_interface.html#stateorname" class="tsd-kind-icon">State<wbr>OrName</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external">
<a href="../modules/_uirouter_core_state_interface.html#_statedeclaration" class="tsd-kind-icon">_<wbr>State<wbr>Declaration</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>