react-touch-navigator

This is a plugin for React to include fast navigation optimised for mobile devices. React Touch Navigator works with touch gestures.

Installation

Using npm, run:

npm i -s @master-maker/react-touch-navigator

Getting started

Run the following commands:

npm i -g create-react-app
create-react-app demo-app
cd demo-app

This installs React and a tool to setup an application to start working on, followed by setting up the application project and moving to the project folder.

Next install react-touch-navigator to the project

npm i -s @master-maker/react-touch-navigator

Copy the code snippet under Usage and paste it in src/App.js.

Now it is time to start the application. To do so run:

npm start

Usage

Here follows a quick start example. This code snippet can replace the whole App.js file to start a demo.

import React, { Component } from 'react';
import Navigator, { NavigatorPage } from '@master-maker/react-touch-navigator';

export default class App extends Component {
    constructor(props) {
        super(props);

        this.state = {
            navigationOpen: false
        };
    }

    handleClickToggleNavigation(event) {
        this.setState({navigationOpen: !this.state.navigationOpen});
    }

    render() {
        return (
            <div className="app">
                <header>
                    <button type="button" onClick={this.handleClickToggleNavigation.bind(this)}>
                        open
                    </button>
                    Example
                </header>
                <Navigator open={this.state.navigationOpen}>
                    <NavigatorPage>
                        <header>Main</header>
                    </NavigatorPage>
                    <NavigatorPage>
                        <header>Sub</header>
                    </NavigatorPage>
                    <NavigatorPage>
                        <header>Tags</header>
                    </NavigatorPage>
                </Navigator>
            </div>
        );
    }
}

Issues

Issues can be sent to me directly by e-mail at [email protected].

Changes

• 0.0.1 Source code
• 0.0.2 Add dependencies
• 0.0.3 Correct README
• 0.0.4 Set compiled version
• 0.0.5 Correct code snippet and index file
• 0.1.0 Add navigation page indicator
• 0.1.1 Add option to close by force

Credits

React Touch Navigator is built and maintained by Wesley Verheijen.