Nutmeg Plundering Muse

    @af-modules/router

    1.0.2 • Public • Published

    AF Router CCC

    Greenkeeper badge Build Status Coverage Status

    AF Router is a single page application router. It allows to easily attach listeners to state changes.

    Installation

    npm i --save @af-modules/router
    

    How to Use

    import Router from '@af-modules/router';
    
    Router.init([
        {
            path: ['/', '/home'],
            onEnter: (path) => {...},   
            onLeave: (path) => {...},
            isPersistent: true,
        },
        {
            path: '/home/details',
            onEnter: (path) => {...},
            onLeave: (path) => {...},
            isPersistent: true,
        }
    
    ]);
    
    Router.restore();

    API

    Router.init([{ path: string, onEnter: Function, onLeave: Function, isPersistent: boolean }]);

    The init() method initializes the router. An array of objects can be specified to define the initial states.

    Router.restore();

    Restores the state of the application the last time it was open. Call this method if users should be able to return to the application in the same state they left.

    Install

    npm i @af-modules/router

    DownloadsWeekly Downloads

    8

    Version

    1.0.2

    License

    Apache-2.0

    Unpacked Size

    24.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • titannano