ui-router.github.io/_react_docs/latest/index.html at master · ui-router/ui-router.github.io · GitHub

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
---
---
<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>@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>
			</ul>
			<h1>@uirouter/react</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<div class="tsd-panel tsd-typography">
				<a href="#ui-router-for-react" id="ui-router-for-react" style="color: inherit; text-decoration: none;">
					<h1><a href="https://ui-router.github.io/react/docs/latest">UI Router for React</a></h1>
				</a>
				<a href="#state-based-routing-for-react" id="state-based-routing-for-react" style="color: inherit; text-decoration: none;">
					<h4>State based routing for React</h4>
				</a>
				<div style="display: flex;">
					<iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=ui-router&repo=react&type=fork&count=true&size=medium" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
					<iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=ui-router&repo=react&type=star&count=true&size=medium" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
					[![Build Status](https://travis-ci.org/ui-router/react.svg?branch=master)](https://travis-ci.org/ui-router/react)
				</div>
				<p>UI-Router React is a client-side <a href="https://en.wikipedia.org/wiki/Single-page_application">Single Page Application</a>
				routing framework for <a href="https://facebook.github.io/react/">React</a>.</p>
				<p><strong><a href="http://github.com/ui-router/react">View on Github</a> |</strong>
					<strong><a href="http://github.com/ui-router/core">View ui-router-core on Github</a> |</strong>
					<strong><a href="https://ui-router.github.io/react/tutorial/">Tutorials</a> |</strong>
					<strong><a href="https://ui-router.github.io/guide">Guides</a> |</strong>
				<strong><a href="http://ui-router.github.io/resources/sampleapp/">Sample App</a></strong></p>
				<a href="#api-documentation-organization" id="api-documentation-organization" style="color: inherit; text-decoration: none;">
					<h4>API Documentation Organization</h4>
				</a>
				<p>The documentation is arranged according to API concern, such as <code>components</code>, <code>url</code>, <code>resolve</code>, and <code>core</code>.
					By default, only the public API is shown.
				To view both public API and the internal APIs, check the &quot;Internal UI-Router API&quot; checkbox.</p>
				<a href="#typescript" id="typescript" style="color: inherit; text-decoration: none;">
					<h4>Typescript</h4>
				</a>
				<p>UI-Router is written in Typescript.
					The API documentation is generated using <a href="https://github.com/TypeStrong/typedoc">TypeDoc</a>.
				The documentation reflects the Typescript classes, interfaces, and parameter types information embedded in the source code.</p>
				<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
					<h4>Contributing</h4>
				</a>
				<p>UI-Router React depends on the framework agnostic <code>ui-router-core</code>.
					To contribute to the documentation, please submit a PR to either
					<a href="http://github.com/ui-router/react">@uirouter/react</a>
					or
					<a href="http://github.com/ui-router/core">@uirouter/core</a>.
				To find where a specific piece of API documentation is written, follow the links that say:</p>
				<blockquote>
					<p><em>Defined in ui-router/somedir/somefile.ts</em></p>
				</blockquote>
			</div>
		</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="interfaces/_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">
				</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>