Napoleonic Political Magnificence

    pico-router

    4.2.1 • Public • Published

    🔀 pico-router

    An incredibly tiny React router for isomorphic apps. Under 100 lines of code

    NPM

    Goal : pico-router was made to quickly bootstrap your project with a easy to understand and agnostic implementation of an isomorphic React router. If you need to make modifications or add features, it's easy to understand what's happening under the hood and make tweaks. As your project grows, it's easy to swap out to another more full-featured router implementation.

    Features

    • Under 100 lines of code
    • Very easy route -> function mapping
    • Uses url-pattern-style url matching
    • Works on both client and server for server-side rendering
    • Uses history pushstate for instant page transitions
    • Included Link component (anchor tag replacement) to use history pushstate

    Anti-Features (features removed to reduce complexity)

    • No built-in redirects
    • If pushstate isn't supported it does not fall back to hash fragments. Falls back to standard anchor tag behaviour.

    Example main.jsx

    const React = require('react');
    const {CreateRouter, Link} = require('pico-router');
     
    const UserPage = require('./user.jsx');
    const HomePage = require('./home.jsx');
    const SearchPage = require('./search.jsx');
     
    const Router = CreateRouter({
        '/'       : <HomePage />,
        '/search' : ({args, query})=> <SearchPage term={query.q} />,
        '/user/:id' : ({args})=>{
            return <UserPage userId={arg.id} />
        }
    });
     
    function Main({url = '/'}){
        return <div className='Main'>
            <nav>
                <Link href='/'>Home</Link>
                <Link href='/search' forceReload={true}>Search</Link>
            </nav>
            <Router serverSideUrl={url} />
        </div>
    }

    pico-router.CreateRouter(routeMap, [opts])

    routeMap is a key-value object where the keys are url-pattern-style routes and the values are either React components or functions that return React components.

    Returns a React component that will render to one of the passed in components in the current url matches any of the keys. Once mounted, the router component will update itself and re-render whenever the history.pushState changes.

    const Router = CreateRouter({
        '/'       : <HomePage />,
        '/search' : ({args, query})=> <SearchPage term={query.q} />,
        '/user/:id' : ({args})=>{
            return <UserPage userId={arg.id} />
        }
    });
     
    //...
     
        return <div className='main'>
            <Router serverSideUrl={this.props.url} />
        </div>
    });
     

    Functions passed in the routeMap will be passed args, query, hash, and url as parameters. args and query are objects; hash and url is a string.

        //url -> '/users/fred/details?q=adv#main'
        '/users/:id/:page' : function({args, query, hash, url}){
            //args -> {id : 'fred', page : 'details'}
            //query -> {q : 'adv'}
            //hash -> '#main'
            //url -> '/users/fred/details?q=adv#main'
        }

    opts

    {
        prefix : '' // Will add this string at the front of each url
    }

    <Router />

    Creating a router will return a React component that is used in your render function. The router can take 4 additional props:

     
    const Router = CreateRouter({
        '/' : ()=><main>Oh hello</main>
    });
     
    function MainComponent(){
        return <Router
            scope={this}          // Used as the scope for the route mapping functions. Useful if your route mapping needs props or state
            serverSideUrl={'/'}   // When not being rendered on the browser, this defines what url it should use.
            forceUrl={false}      // Always uses the passed in URL, no matter server or client side
        />
    }

    Nested Routers

    It's also possible to nest routers together

    const Subrouter = CreateRouter({
        '/sub/test' : <div>I am a sub page</div>
    })
     
    const MainRouter = CreateRouter({
        '/' : <main>Oh hello</main>,
        '/sub(/*)' : <Subrouter />
    })

    pico-router.Link

    Link is a wrapper for the standard anchor tag that, on click, will try to use history.pushState first to update the url. Renders exactly to a <a></a> and falls back to default behaviour whenever needed. Replace any <a> in your app to make the link an instant page transition.

    If you wish to force standard behaviour, eg. a page reload, pass the prop forceReload={true}

    <Link href='/update' forceReload={true}>Update Page</Link>

    pico-router.navigate(path, forceReload=false)

    If you need to update the url using history.pushState you can use this. It will trigger the router to re-render. Pass true as the second parameter to force the browser to reload at the path given.

    Returns true if it was able to successfully re-route using the routers. Returns false if the passed in route wasn't handled or if it's not on the browser.

    pico-router.onUrlChange(handler)

    Adds an event handler whenever pico-router handles a url change.

    pico-router.removeListener(handler)

    Removes the url change event handler.

    Install

    npm i pico-router

    DownloadsWeekly Downloads

    40

    Version

    4.2.1

    License

    ISC

    Unpacked Size

    9.52 kB

    Total Files

    3

    Last publish

    Collaborators

    • stolksdorf