Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

vanilla-dom-router

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vanilla-dom-router

Lightweight vanilla JavaScript DOM router

  • 0.1.3-alpha-2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

Vanilla DOM Router

Lightweight, pure vanilla JavaScript based router for the DOM

Documentation Build codecov

When bundling and shipping Vanilla JavaScript, often we require only specific modules to be specific pages. This could mean registering event handlers, times, basically everything that would panic when run in other pages.

DOM Router supports matching modules(functions, more specifically) against routes. It requires a route(either a string or a regular expression in string form) and a bootstrapping function.

The bootstrapping function could initialize timers, register event handlers and perform page specific operations.

Route

  • Only exact matches are accepted. For example, if /foo is registered, only http://example.com/foo and not http://example.com/foo/bar

  • Routes are normalized by removing trailing slash. So /foo is the same as /foo/

  • Sometimes routes will have variable fields. These cases can be represented with a regular expression rule. For example, Reddit's subreddit route, www.reddit.com/r/<subreddit-name>), can be matched with /r/[A-Z,a-z,0-9]+/(assuming subreddit names are alphanumerical)

Bootstrapping function

This function will get executed when window.location.pathname matches the any one of the registered routes. Generally, this function should be used to set up register handlers, initialize timers, etc.

Example

import Router from 'vanilla-dom-router';

// Initialize router
const router = new Router();

const settingsRoute = '/settings';
const profileRoute = '/r/[A-Z,a-z,0-9]+/';

const settings = () => {
  let form = document.getElementById('form');
  const submit = () => {
    alert('Settings updated');
  };
  form.addEbentListener('submit', submit, true);
};

const profile = () => {
  let form = document.getElementById('form');
  const submit = () => {
    alert('profile updated');
  };
  form.addEbentListener('submit', submit, true);
};

router.register(settingsRoute, settings);
router.register(profileRoute, profile);

try {
  router.router();
} catch (e) {
  console.log(e);
}

In the wild

Keywords

FAQs

Package last updated on 09 Sep 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc