mobile-navigation-controller - npm Package Compare versions

mobile-navigation-controller

Package Overview

Dependencies

Maintainers

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.0.1 to 1.0.2

package.json

		{
		"name": "mobile-navigation-controller",
		"version": "1.0.1",
		"version": "1.0.2",
		"description": "Navigator for Cordova with React.js(react.cordova), This will help you to manage your pages history in the app and change pages with animation.",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

133

README.md

		@@ -8,2 +8,3 @@ # mobile-navigation-controller
		<br>
		For example:
		In the render function return
		@@ -50,26 +51,118 @@

		### Navigator props
		``onRef={ref => (this.navigatorRef = ref)}`` required
		<br>
		``key={string}`` Required
		<br>
		``height={...}``
		<br>
		``onChangePage={(nowPageKey,levelAction) => { ... }}`` levelAction==>> "Out"\|\|"In"\|\|"SameLevel"
		<br>
		``beforChangePage={(goToPageKey,levelAction) => { ... }}`` levelAction==>> "Out"\|\|"In"\|\|"SameLevel"
		<br>
		``homePageKey={"home"}`` defult==>> The key of the first child
		### Navigator props

		### Child props
		``levelPage=={integer}`` important
		<br>
		``backgroundColor="..."`` defult==>> #fff
		<br>
		`` //backOnSwipeRight={true}``defult==>> false
		<br>
		`` //alwaysLive={true}``defult==>> false

		<table>
		<thead>
		<tr>
		<th>prop</th>
		<th>type</th>
		<th>required</th>
		<th>defult</th>
		<th>node</th>
		</tr>
		</thead>
		<tbody>
		<tr>
		<td>onRef</td>
		<td></td>
		<td>required</td>
		<td>-</td>
		<td> onRef={ref => (this.navigatorRef = ref)} </td>
		</tr>
		<tr>
		<td>key</td>
		<td>string</td>
		<td>required</td>
		<td>-</td>
		<td></td>
		</tr>
		<tr>
		<td>height</td>
		<td>string or integer</td>
		<td>optional</td>
		<td>"100%"</td>
		<td></td>
		</tr>
		<tr>
		<td>onChangePage</td>
		<td>function</td>
		<td>optional</td>
		<td>-</td>
		<td>(nowPageKey,levelAction) => { ... }</td>
		</tr>
		<tr>
		<td>beforChangePage</td>
		<td>function</td>
		<td>optional</td>
		<td>-</td>
		<td>(goToPageKey,levelAction) => { ... }</td>
		</tr>
		<tr>
		<td>homePageKey</td>
		<td>string</td>
		<td>optional</td>
		<td>The key of the first child</td>
		<td>(nowPageKey,levelAction) => { ... }</td>
		</tr>
		</tbody>
		</table>
		*levelAction return "Out" or "In" or "SameLevel"



		### Child props


		<table>
		<thead>
		<tr>
		<th>prop</th>
		<th>type</th>
		<th>required</th>
		<th>defult</th>
		<th>node</th>
		</tr>
		</thead>
		<tbody>
		<tr>
		<td>levelPage</td>
		<td>integer</td>
		<td>required</td>
		<td>-</td>
		<td>important!</td>
		</tr>
		<tr>
		<td>backgroundColor</td>
		<td>string</td>
		<td>optional</td>
		<td>#fff</td>
		<td></td>
		</tr>
		<tr>
		<td>height</td>
		<td>string or integer</td>
		<td>optional</td>
		<td>"100%"</td>
		<td></td>
		</tr>
		<tr>
		<td>backOnSwipeRight</td>
		<td>boolean</td>
		<td>optional</td>
		<td>false</td>
		<td></td>
		</tr>
		<tr>
		<td>alwaysLive</td>
		<td>boolean</td>
		<td>optional</td>
		<td>false</td>
		<td>Don't kill the child. Life is always in the background</td>
		</tr>

		</tbody>
		</table>


		#### Check what is page now
		@@ -76,0 +169,0 @@ ```

Improved metrics