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

mini-router

v0.6.0

Published

Yet another mini router library

Downloads

9

Readme

mini-router

Install

npm install mini-router
bower install mini-router

Files

  • dist/click-interceptor.js - ClickInterceptor (standalone library, exported as global var)
  • dist/mini-router.core.js - Router without ClickInterceptor (standalone library)
  • dist/mini-router.js - Router + ClickInterceptor (standalone library)
  • router.js - CommonJS module (use with webpack or browserify)
  • ClickInterceptor.js - CommonJS module

Usage

var router = new Router({
	html5: true // default true if browser supports it
	base: '' // optional base url (gets stripped away when routing)
	routes: { '/some/route': callback } // optional routes
	clickInterceptor: ClickInterceptor // override or set the ClickInterceptor
})

// Define and handle route. You can use :named parameters.
router.add('/route/:param1',function(params){
	// handle your route
	console.log(params.param1);
});
// Note: If you define multiple routes with the same name, only the latest callback is called!

// Manually set location and fire route handler
router.set(url)

// Normalize URL;
// - remove domain name.
router.normalize('http://yourwebsite.com/some/path/') // /some/path
// - remove ending slash
router.normalize('/some/path/') // /some/path
// - add prepending slash
router.normalize('some/path') // /some/path

// You can also only use the click interceptor.
// It translates link-clicks to hash-changes or html5 popState()
ClickInterceptor({
	html5: true,
	base: '',
	normalize: function(url){
		return url;
	},
	set: function(url) { } // callback function to set URL of the router in HTML5 mode
});

Why?

It seems that you only listen to history events. There is no event fired when the user navigates to a new location.

So we have to intercept click events. However, no micro router library has this functionality.

So I wrote this one!

Changelog

  • 0.5.0: Bugfix
  • 0.4.0: Fixed ClickInterceptor bug with HTML5 (there is no onpushstate listener, so explicitly call router.set(url))
  • 0.3.0: Fixed some versioning issues with NPM and Bower
  • 0.2.0: Split Router into Router + ClickInterceptor. Some minor improvements.
  • 0.1.0: Initial release

Contribute

Feel free to contribute to this project in any way. The easiest way to support this project is by giving it a star.

Contact

© 2014 - Mark Marijnissen