@modnes/router
v1.1.1
Published
Module to Control which Element to insert based on the Path
Downloads
3
Readme
Router Module
Router is a browser module that aims to let implementations change elements inside a wrapper element in response to path change events.
Installing
npm i @modnes/routerUsage
The Router must receive an HTML Element from DOM and optionally an Array of route objects.
import Router from "path/to/@modnes/router/router.js"
let router = new Router(document.querySelector('main'), [
{
path: '/posts', // will use this settings when accessing /posts
tagName: 'post-list' // will put <post-list></post-list> inside <main></main>
},
{
path: '/posts/:id', // will provide the parameter 'id' with value 3 at /posts/3
tagName: 'post-article',
attributes: [
{ // will change main element content to <post-article post-id="3"></post-article>
name: 'post-id',
value: '{{ id }}'
}
]
},
{ // will change main element content to <category-list class="categories list"></category-list>
path: '/categories',
tagName: 'category-list',
classes: ['categories', 'list'],
modules: ['path/to/category-list-module/index.js'] // will import this module before update the element
},
{ // will change main element content to <movies-list class="movies-category list"></movies-list>
path: '/categories/:name', // will provide the parameter 'name' with value 'movies' at /categories/movies
tagName: '{{ name }}-list',
classes: ['{{ name }}-category', 'list']
},
{ path: '/*', tagName: 'home-page' }
])Methods
addRoute
The addRoute() method can be used inside a proccess to dynamically add new routes to the Router.
router.addRoute({
path: '/section/:param1/:param2/*',
tagName: 'section-list'
})getParams
The getParams() returns an object with URI parameters as properties.
// When location is /section/book/50/any-string
// and route path is /section/:param1/:param2/*
let params = router.getParams()
// params will be equal { param1: 'book', param2: '50' }Router.goTo
Router.goTo() is a static method that can be used to navigate to a new path.
Router.goTo('/categories') // will change location path to /categoriesRouter Anchor
The Router package also provides a custom element module to extend the native a HTML tag. It implements the Router.goTo() static method.
<html>
<head>
<title>Router Anchor</title>
<script href="path/to/@modnes/router/anchor/index.js" type="module"></script>
</head>
<body>
<a href="/categories" is="router-anchor">Go To Categories</a>
</body>
</html>See the API documentation