https://github.com/simplr/simplr-router

Simplr Router is a easy to use and easy to set up router for Web Components.
https://github.com/simplr/simplr-router

hacktoberfest javascript routing simplr webcomponent webcomponents

Last synced: 4 months ago
JSON representation

Simplr Router is a easy to use and easy to set up router for Web Components.

• Host: GitHub
• URL: https://github.com/simplr/simplr-router
• Owner: Simplr
• License: mit
• Created: 2019-09-27T07:45:27.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T22:43:15.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T12:28:14.768Z (10 months ago)
• Topics: hacktoberfest, javascript, routing, simplr, webcomponent, webcomponents
• Language: HTML
• Homepage: https://simplr.github.io/simplr-router/
• Size: 7.62 MB
• Stars: 46
• Watchers: 3
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Title Image](assets/simplr-router-logo-banner.png)

[![npm version](https://badgen.net/npm/v/@simplr-wc/router)](https://www.npmjs.com/package/@simplr-wc/router)

# Simplr Router

A small and effective routing solution for Web Components.

## Getting started

Get started using Simplr Router with [one of the guides from the documentation site](https://simplr.github.io/simplr-router/guides/getting-started/using-a-starter/)

```javascript

import { SimplrRouter } from "@simplr-wc/router";

const routes = [

  { path: "", component: "minimal-setup" },

  { path: "example", component: "example-view" },

  { path: "dynamic/:id", component: "dynamic-view" },

];

new SimplrRouter({ routes }).init();

```

## Why

#### Quick and Simple

Simple to get up and running. Basic setup in just a few lines of code.

#### Small

No dependencies and a small codebase means less breaking parts.

0 dependencies means that what you see is what you get.

#### Easy to transition into

Works by utilizing the native API's used for navigation and therefore doesn't require any extra steps compared to your every day MPA.

#### Web Component focused

Built with web components, for web components. Simplr Router was designed from the get go to be used in web component applications.

#### Customizable

Even though there's no configuration necessary to get started, the router ships with a lot of customizability to fit your needs.

 

#### Performant

Allowing for lazy loading and creating dynamic routes, Simplr Router is a great library for projects of all sizes.

Discover