@daleighan/vanilla-js-router v0.1.2

vanilla-js-router

What is this project?

It is a library for client-side routing that is independent of any other frameworks or libraries. It was created to be used for a single page application and is designed to be flexible and lightweight. It provides the functionality of libraries like react-router for apps using vanilla JavaScript. It uses template literals or dom elements as components for each different view. Along with this repository there is also an example application here that may be useful in learning to use this .

Installation

Install with npm: npm install @daleighan/vanilla-js-router

Usage

Creating a router:

import VanillaJSRouter from 'vanilla-js-router';

const router = new VanillaJSRouter(anchorId, routes, options);

• anchorId is a string that is the id of the component that the router will attach to.

• routes is an object in the following format:

const routes = {
	[url]: [component],
	[url]: [component],
	...
};

• The url is a string that is the relative path of the url for a particular component and the route.
• The component for a route can either be a string of HTML, a function that returns a string of html or a function that returns a DOM node.

options is also an object that looks like this:

const options = {
  debug: [boolean],
  errorHTML: [component],
  header: [component],
  footer: [component],
};

• The debug option allows addition information about route changes to be logged in the console.

• errorHTML accepts the same types of components mentioned above and is displayed if the requested url is not found in the routes object.

• header accepts the same types of components and is placed above the content within the router
• footer accepts the same types of components and is placed below the content within the router

Creating components:

As previously mentioned, there are three different ways that components can be provided. They are as follows:

As a string:

const Component = '<div>My Component</div>';

As a function that returns a string or template literal:

function Component() {
  return '<div>My Component</div>';
}

As a function that returns a DOM element:

function Component() {
  const div = document.createElement('div');
  div.textContent = 'My Component';
  return div;
}

Path matching:

Currently, path matching is not very sophisticated, but it does allow for exact path matching and path matching with params. An of a routes object with these two kinds of paths:

const routes = {
	'/component': Component1,
	'/component/:id': Component2,
	'/component/:id/:action': Component3,
	...
};

The first route would have to be an exact match but the second one could be given any id and the third would has two params. If there is an exact match found for the route, it is prioritized over any route that includes params.

For a route with params, these params can be passed to the component if it is a function. The way to do that for a route that is given two params is as follows:

function Component3({ params }) {
  const div = document.createElement('div');
  div.textContent = `id: ${params.id}, action: ${params.action}`;
  return div;
}

Navigation:

There are two ways to navigate with the router.

Using JavaScript. This can be done with:

window.router.goTo(route);

Adding an HTML anchor element with a class of 'router-link':

<a class="router-link" href="/component">My Link</a>

Any HTML elements with that class name at the time a route is loaded will navigate using the router.

Credits:

Developed primarily by daleighan but always open to additional contributors.