Merge pull request #33 from electrode-io/feat-replace-option

feat: replace option for navigateInternal
electrode-io · Jun 2, 2020 · 403847e · 403847e
2 parents 701fc07 + 9ab37c3
commit 403847e
Show file tree

Hide file tree

Showing 10 changed files with 201 additions and 39 deletions.
diff --git a/docs/AppNavigator.html b/docs/AppNavigator.html
@@ -70,6 +70,7 @@
 											<li><a href="global.html#LeftButton">LeftButton</a></li>
 											<li><a href="global.html#NavigationBar">NavigationBar</a></li>
 											<li><a href="global.html#NavigationEvent">NavigationEvent</a></li>
+											<li><a href="global.html#RouteOptions">RouteOptions</a></li>
 									</ul>
 								</li>
 								<li class="dropdown">

diff --git a/docs/Component.html b/docs/Component.html
@@ -70,6 +70,7 @@
 											<li><a href="global.html#LeftButton">LeftButton</a></li>
 											<li><a href="global.html#NavigationBar">NavigationBar</a></li>
 											<li><a href="global.html#NavigationEvent">NavigationEvent</a></li>
+											<li><a href="global.html#RouteOptions">RouteOptions</a></li>
 									</ul>
 								</li>
 								<li class="dropdown">
@@ -271,7 +272,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-138">line 138</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-146">line 146</a></p>
 								</div>
 							</div>
 
@@ -316,7 +317,7 @@ <h4 id=".getRegisteredRoute" class="function public"><span class="signature-attr
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-154">line 154</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-162">line 162</a></p>
 								</div>
 							</div>
 
@@ -374,7 +375,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-163">line 163</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-171">line 171</a></p>
 								</div>
 							</div>
 
@@ -419,7 +420,7 @@ <h4 id=".getAppNavigator" class="function public"><span class="signature-attribs
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-172">line 172</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-180">line 180</a></p>
 								</div>
 							</div>
 
@@ -478,7 +479,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-294">line 294</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-302">line 302</a></p>
 								</div>
 							</div>
 
@@ -537,7 +538,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-304">line 304</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-312">line 312</a></p>
 								</div>
 							</div>
 
@@ -574,7 +575,7 @@ <h4 id=".onFocus" class="function public"><span class="signature-attribs">&lt;ab
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-317">line 317</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-325">line 325</a></p>
 								</div>
 							</div>
 
@@ -611,7 +612,7 @@ <h4 id=".onBlur" class="function public"><span class="signature-attribs">&lt;abs
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-325">line 325</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-333">line 333</a></p>
 								</div>
 							</div>
 
@@ -648,7 +649,7 @@ <h4 id=".onAppData" class="function public"><span class="signature-attribs">&lt;
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-333">line 333</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-341">line 341</a></p>
 								</div>
 							</div>
 
@@ -694,7 +695,7 @@ <h4 id="resetNavigationBar" class="function public"><span class="signature-attri
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-343">line 343</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-351">line 351</a></p>
 								</div>
 							</div>
 
@@ -761,7 +762,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-358">line 358</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-366">line 366</a></p>
 								</div>
 							</div>
 
@@ -828,7 +829,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-375">line 375</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-383">line 383</a></p>
 								</div>
 							</div>
 
@@ -840,7 +841,7 @@ <h5>Parameters</h5>
 </dd>
 											<hr/>
 											<dt class="symbol-title function public collapsible-symbol">
-			<h4 id="navigateInternal" class="function public"><span class="signature-attribs">&lt;async> </span><span class="name">navigateInternal</span><span class="signature-params">( <span class="signature-param">screenName</span> [,&nbsp;<span class="signature-param">jsonPayload</span>&nbsp;]&nbsp;)</span><span class="signature-type"> &rarr;&nbsp;{Promise}</span></h4>
+			<h4 id="navigateInternal" class="function public"><span class="signature-attribs">&lt;async> </span><span class="name">navigateInternal</span><span class="signature-params">( <span class="signature-param">screenName</span> [,&nbsp;<span class="signature-param">jsonPayload</span> [,&nbsp;<span class="signature-param">options</span>&nbsp;]&nbsp;]&nbsp;)</span><span class="signature-type"> &rarr;&nbsp;{Promise}</span></h4>
 		</dt>
 <dd class="symbol-details function public  collapsible-symbol">
 	<div class="symbol-details-inner">
@@ -875,6 +876,14 @@ <h5>Parameters</h5>
 			screen.
 							</td>
 						</tr>
+						<tr>
+								<td><code>options</code></td>
+							<td><span class="param-type"><a href="global.html#RouteOptions">RouteOptions</a></span></td>
+								<td class="attributes">&lt;optional&gt;<br/></td>
+							<td class="last">
+									(optional) Additional route options.
+							</td>
+						</tr>
 					</tbody>
 				</table>
 			</div>
@@ -907,7 +916,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-391">line 391</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-400">line 400</a></p>
 								</div>
 							</div>
 
@@ -975,7 +984,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-436">line 436</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-446">line 446</a></p>
 								</div>
 							</div>
 
@@ -1021,7 +1030,7 @@ <h4 id="back" class="function public"><span class="signature-attribs">&lt;async>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-475">line 475</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-485">line 485</a></p>
 								</div>
 							</div>
 
@@ -1091,7 +1100,7 @@ <h5>Parameters</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-489">line 489</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-499">line 499</a></p>
 								</div>
 							</div>
 

diff --git a/docs/app-navigator.js.html b/docs/app-navigator.js.html
@@ -71,6 +71,7 @@
 											<li><a href="global.html#LeftButton">LeftButton</a></li>
 											<li><a href="global.html#NavigationBar">NavigationBar</a></li>
 											<li><a href="global.html#NavigationEvent">NavigationEvent</a></li>
+											<li><a href="global.html#RouteOptions">RouteOptions</a></li>
 									</ul>
 								</li>
 								<li class="dropdown">

diff --git a/docs/global.html b/docs/global.html
@@ -70,6 +70,7 @@
 											<li><a href="global.html#LeftButton">LeftButton</a></li>
 											<li><a href="global.html#NavigationBar">NavigationBar</a></li>
 											<li><a href="global.html#NavigationEvent">NavigationEvent</a></li>
+											<li><a href="global.html#RouteOptions">RouteOptions</a></li>
 									</ul>
 								</li>
 								<li class="dropdown">
@@ -210,6 +211,14 @@ <h5>Properties</h5>
 									(optional) Show this page as an overlay (navigate only).
 							</td>
 						</tr>
+						<tr>
+								<td><code>hide</code></td>
+							<td><span class="param-type">boolean</span></td>
+								<td class="attributes">&lt;nullable&gt;<br/></td>
+							<td class="last">
+									(optional) Hide this page's navigation bar.
+							</td>
+						</tr>
 						<tr>
 								<td><code>buttons</code></td>
 							<td><span class="param-type">Array.&lt;<a href="global.html#Button">Button</a>></span></td>
@@ -263,6 +272,80 @@ <h5>Properties</h5>
 
 
 
+					</form>
+			</div>	</div>
+</dd>
+											<hr/>
+											<dt class="symbol-title typedef public collapsible-symbol">
+			<h4 id="RouteOptions" class="typedef public"><span class="name">RouteOptions</span></h4>
+		</dt>
+<dd class="symbol-details typedef public  collapsible-symbol">
+	<div class="symbol-details-inner">
+			<div class="callout callout-info">
+				<h5>Properties</h5>
+				<table class="params table table-striped">
+					<thead>
+					<tr>
+							<th>Name</th>
+						<th>Type</th>
+							<th>Attributes</th>
+						<th class="last">Description</th>
+					</tr>
+					</thead>
+					<tbody>
+						<tr>
+								<td><code>overlay</code></td>
+							<td><span class="param-type">boolean</span></td>
+								<td class="attributes">&lt;nullable&gt;<br/></td>
+							<td class="last">
+									(optional) Show this page as an overlay (navigate only).
+							</td>
+						</tr>
+						<tr>
+								<td><code>replace</code></td>
+							<td><span class="param-type">boolean</span></td>
+								<td class="attributes">&lt;nullable&gt;<br/></td>
+							<td class="last">
+									(optional) Replace the current page with this page in the stack.
+							</td>
+						</tr>
+					</tbody>
+				</table>
+			</div>
+			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
+
+							<!-- type -->
+							<div class="form-group">
+								<label class="col-sm-3 control-label">Type</label>
+								<div class="col-sm-9">
+									<div class="form-control-static type-names"><span class="param-type">Object</span></div>
+								</div>
+							</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+							<!-- source -->
+							<div class="form-group">
+								<label class="col-sm-3 control-label">Source</label>
+								<div class="col-sm-9">
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-57">line 57</a></p>
+								</div>
+							</div>
+
+
+
+
 					</form>
 			</div>	</div>
 </dd>
@@ -347,7 +430,7 @@ <h5>Properties</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-56">line 56</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-63">line 63</a></p>
 								</div>
 							</div>
 
@@ -397,7 +480,8 @@ <h5>Properties</h5>
 							<td><span class="param-type">string</span></td>
 								<td class="attributes">&lt;nullable&gt;<br/></td>
 							<td class="last">
-									The ID of the button; will be used in header button events.  If set, the press event must be handled on the Javascript side, as native will no longer handle the back press.  Cannot contain '.'.
+									The ID of the button; will be used in header button events.  If set, the press event
+			must be handled on the Javascript side, as native will no longer handle the back press.  Cannot contain '.'.
 							</td>
 						</tr>
 						<tr>
@@ -438,7 +522,7 @@ <h5>Properties</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-65">line 65</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-72">line 72</a></p>
 								</div>
 							</div>
 
@@ -520,7 +604,7 @@ <h5>Properties</h5>
 							<div class="form-group">
 								<label class="col-sm-3 control-label">Source</label>
 								<div class="col-sm-9">
-									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-74">line 74</a></p>
+									<p class="form-control-static"><a href="navigation-component.js.html">navigation-component.js</a>, <a href="navigation-component.js.html#line-82">line 82</a></p>
 								</div>
 							</div>
 

diff --git a/docs/index.html b/docs/index.html
@@ -71,6 +71,7 @@
 											<li><a href="global.html#LeftButton">LeftButton</a></li>
 											<li><a href="global.html#NavigationBar">NavigationBar</a></li>
 											<li><a href="global.html#NavigationEvent">NavigationEvent</a></li>
+											<li><a href="global.html#RouteOptions">RouteOptions</a></li>
 									</ul>
 								</li>
 								<li class="dropdown">