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

rutr

v0.0.2

Published

A small router that works with a simple state machine

Downloads

4

Readme

State Machine Router

Small state machine based router for SPAs

How it works

import { Router, Link, navigation } from 'the-router'
  • Router is the main function
  • Link returns an anchor tag that already has a listener attached to it
  • navigation is to programmatically navigate

Router

Router({
  routes,
  ErrorFallback,
  LoadingFallback,
  onRouteChange,
  container
})
routes

Routes should be shaped like this:

{ [routepath]: [function that returns HTMLElement] }

So, for example:

{
  '/': Index,
  '/about': About
}

function Index() {
  const content = document.createElement('div');
  content.innerHTML = '<h1>This is the index page</h1>'
}

function About() {
  const content = document.createElement('div');
  content.innerHTML = '<h1>This is the about page</h1>'
}
ErrorFallback (optional)

This is the fallback page that will be rendered in case of a 404, just like the other paths this needs to be a function returning a HTMLElement

LoadingFallback (optional)

This is the fallback page that will be rendered in case you are using code splitting or async functions are being handed to the router

  • For code splitting on webpack:
  const About = () => import('./pages/about')

  let routes = {
    ...
    '/about': About
  }
onRouteChange (optional)

Function that will be called every route change, it takes from and to as args:

function onRouteChange(from, to) {
  /* do whatever */
}
container

Where the routes will be rendered

Link

Function that takes in two args (to, textContent) and returns HTMLAnchorElement

navigate

Function that takes in the to parameter and navigates to it