npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

push-router

v1.0.0

Published

Client side router for Single Page Application (SPA)

Downloads

22

Readme

spa-router

Client side router for Single Page Application (SPA)

Router uses history API so even tho it is client side router (doesn't do page reload) doesn't use hashes (#) but slashes(/).

This project is working but it is still in development. When it becames stable version will changed to 1.

If you are using this router and notice anything to be improved please do send feedback to [email protected] with subject push-router.

Instalation

CLI

npm install push-router

package.json

"push-router": "x.y.z"

Example

There is example in example folder. It uses node and ExpressJS. To start it set position in terminal inside example folder. To install dependencies run:

npm install

To start it run:

node server/server.js

Usage

Getting module

var Router = require("push-router");

Adding route

Router.addRoute(route, callback)

Adding default route

Router.addDefaultRoute(callback)

Start listening for route changes

Router.init()

Before route changed action

To execute some action in between routes (etc sending for analytics) you can use addBeforeRouteChanged method. In it as a parameters you will receive previous route and next route.

Router.addBeforeRouteChanged(function(){})

Changing route

Changing route works by clicking on a element with attribute data-route="route". Router will catch click and execute for route defined in href.

<a data-route="route" href="test">test</a>

Query

Each route can have query and it will be passed as a object and last object in route callback. For route test?param=2 arguments in callback will be ["test?param=2", {param: "2"}]

Route rules

Simple route

Router.addRoute("test",function() {}); matches maysite.com/test

Regex route

Router.addRoute("test/{{\\d+}}",function() {}); matches maysite.com/test/1

Parameter route

Router.addRoute("test/{id}",function() {}); matches maysite.com/test/1, passes
1 as argument in callback ["test/1", "1"]

If you want to make that parameter optional just add ? after it

Router.addRoute("test/{id}?",function() {}); matches maysite.com/test/1 and maysite.com/test/