Permalink
Fetching contributors…
Cannot retrieve contributors at this time
396 lines (395 sloc) 20.4 KB
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>react | ui-router-react</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">ui-router-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">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">ui-router-react</a>
</li>
<li>
<a href="react.html">react</a>
</li>
</ul>
<h1>Module react</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<h1 id="react-specific-api">React Specific API</h1>
</div>
<p>UI-Router for React relies heavily on <a href="http://github.com/ui-router/core"><code>ui-router-core</code></a>.
The following APIs are extensions to the core ui-router APIs, specific to <code>ui-router-react</code>.</p>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/react.reactviewconfig.html" class="tsd-kind-icon">React<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/react.uirouterreact.html" class="tsd-kind-icon">UIRouter<wbr>React</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/react.reactcomponent.html" class="tsd-kind-icon">React<wbr>Component</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/react.reactstatedeclaration.html" class="tsd-kind-icon">React<wbr>State<wbr>Declaration</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/react.reactviewdeclaration.html" class="tsd-kind-icon">React<wbr>View<wbr>Declaration</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"><a href="react.html#id" class="tsd-kind-icon">id</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="react.html#reactviewsbuilder" class="tsd-kind-icon">react<wbr>Views<wbr>Builder</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"><a href="react.html#viewconfigfactory" class="tsd-kind-icon">view<wbr>Config<wbr>Factory</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a name="id" class="tsd-anchor"></a>
<!--
<h3>id</h3>
-->
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;0</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/react/blob/22b1413/src/reactViews.tsx#L48">ui-router-react/src/reactViews.tsx:48</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="reactviewsbuilder" class="tsd-anchor"></a>
<!--
<h3>react<wbr>Views<wbr>Builder</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">react<wbr>Views<wbr>Builder<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../classes/state.state-1.html" class="tsd-signature-type">State</a><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> This is a <a href="../classes/state.statebuilder.html#builder">StateBuilder.builder</a> function for react <code>views</code>. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This is a <a href="../classes/state.statebuilder.html#builder">StateBuilder.builder</a> function for react <code>views</code>.</p>
</div>
<p>When the <a href="../classes/state.statebuilder.html">StateBuilder</a> builds a <a href="../classes/state.state-1.html">State</a> object from a raw <a href="../interfaces/state.statedeclaration.html">StateDeclaration</a>, this builder
handles the <code>views</code> property with logic specific to ui-router-react.</p>
<p>If no <code>views: {}</code> property exists on the <a href="../interfaces/state.statedeclaration.html">StateDeclaration</a>, then it creates the <code>views</code> object and
applies the state-level configuration to a view named <code>$default</code>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>state <a href="../classes/state.state-1.html" class="tsd-signature-type">State</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<ul class="tsd-parameters">
</ul>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/react/blob/22b1413/src/reactViews.tsx#L19">ui-router-react/src/reactViews.tsx:19</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a name="viewconfigfactory" class="tsd-anchor"></a>
<!--
<h3>view<wbr>Config<wbr>Factory</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">view<wbr>Config<wbr>Factory<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a href="../classes/path.pathnode.html" class="tsd-signature-type">PathNode</a><span class="tsd-signature-symbol">]</span>, config<span class="tsd-signature-symbol">: </span><a href="../interfaces/react.reactviewdeclaration.html" class="tsd-signature-type">ReactViewDeclaration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/react.reactviewconfig.html" class="tsd-signature-type">ReactViewConfig</a></li>
<li class="tsd-header">
<p> React View Config Factory </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>React View Config Factory</p>
</div>
<p>Given a path and a <a href="../interfaces/react.reactviewdeclaration.html">ReactViewDeclaration</a>
(the view declaration object found on the state declaration),
returns a <a href="../classes/react.reactviewconfig.html">ReactViewConfig</a></p>
<p>The ReactViewConfig is an instance of a view,
which will be provided to the matching <code>UIView</code> Component&#39;s
<a href="../classes/components.uiview.html#viewconfigupdated">UIView.viewConfigUpdated</a> function.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>node <span class="tsd-signature-symbol">[</span><a href="../classes/path.pathnode.html" class="tsd-signature-type">PathNode</a><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>config <a href="../interfaces/react.reactviewdeclaration.html" class="tsd-signature-type">ReactViewDeclaration</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../classes/react.reactviewconfig.html" class="tsd-signature-type">ReactViewConfig</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/react/blob/22b1413/src/core.ts#L22">ui-router-react/src/core.ts:22</a></li>
</ul>
</aside> </li>
</ul>
</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>ui-<wbr>router-<wbr>react</em></a>
</li>
<li class="label tsd-is-external">
<span>Public API</span>
</li>
<li class=" tsd-kind-external-module">
<a href="components.html">components</a>
</li>
<li class=" tsd-kind-external-module">
<a href="core.html">core</a>
</li>
<li class="current tsd-kind-external-module">
<a href="react.html">react</a>
</li>
<li class=" tsd-kind-external-module">
<a href="resolve.html">resolve</a>
</li>
<li class=" tsd-kind-external-module">
<a href="state.html">state</a>
</li>
<li class=" tsd-kind-external-module">
<a href="trace.html">trace</a>
</li>
<li class=" tsd-kind-external-module">
<a href="transition.html">transition</a>
</li>
<li class=" tsd-kind-external-module">
<a href="url.html">url</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="_ui_router_core_src_vanilla_.html">"ui-<wbr>router-<wbr>core/src/vanilla"</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common.html">common</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_hof.html">common_<wbr>hof</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_predicates.html">common_<wbr>predicates</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_strings.html">common_<wbr>strings</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="hooks.html">hooks</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="params.html">params</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="path.html">path</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="vanilla.html">vanilla</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="view.html">view</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/react.reactviewconfig.html" class="tsd-kind-icon">React<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/react.uirouterreact.html" class="tsd-kind-icon">UIRouter<wbr>React</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/react.reactcomponent.html" class="tsd-kind-icon">React<wbr>Component</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/react.reactstatedeclaration.html" class="tsd-kind-icon">React<wbr>State<wbr>Declaration</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/react.reactviewdeclaration.html" class="tsd-kind-icon">React<wbr>View<wbr>Declaration</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="react.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="react.html#reactviewsbuilder" class="tsd-kind-icon">react<wbr>Views<wbr>Builder</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="react.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>