Code Monkey home page Code Monkey logo

flight-history's Introduction

flight-history

A Flight component for bi-directional handling of push|hash state.

Installation

bower install --save flight-history

Example

Initialize and specify routes

var History = require('flight-history');
History.attachTo(window, {
    routeBase: '/app',     // Prepended to all routes. Default: ''
    routes: {'/': 'uiRootNavigation', 
            '/user/{id}/': 'uiUserPageNavigation'
    }
});

Using the above snippet as a reference, browser navigation to

  • /app/ triggers the uiRootNavigation event with an empty data object.
  • /app/user/1234/ triggers the uiUserPageNavigation event with data object {id: 1234}

Conversely:

  • On the uiRootNavigation event, the URL /app/ will be added to browser history using pushstate (if supported) or hash state
  • On the uiUserPageNavigation event with data {id: 442242}, the URL /app/user/442242/ will be added to browser history

Development

Development of this component requires Bower, and preferably Karma to be globally installed:

npm install -g bower karma

Then install the Node.js and client-side dependencies by running the following commands in the repo's root directory.

npm install
bower install

To Do

  • Tests
  • Allow regex customization (currently {thing} is replaced with [\\w\\s\\d-]+ for location matching)
  • Allow splitting triggers into the the event fired on browser navigation and the event that triggers the push|hash state change.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.