svelte-app-router
v3.0.7
Published
Simple SPA router made with Svelte.
Downloads
11
Readme
Svelte App Router
A simple router for your Single Page Application.
Features
- Hash based routing
- Data can be set for components when declaring routes
- Querystring parameters are passed to component when mounted (optional)
- No special
<link>
components needed, just use standard<a>
.
Installation
npm install --save svelte-app-router
Usage:
Routes should be specified as on object where each key is a route, and each value is an array containing a component as the first element and optionally an object with data for that component as the second element.
<!-- Links. These can be here or anywhere else in your app. -->
<a href="#/home">Home</a>
<a href="#/contact">Contact</a>
<a href="#/notfound">Does not exist</a>
<!-- The Router component. Content between Router start and end tag will be
shown in case of navigation to a non-existing route.-->
<Router routes={routes}>
<div class="error">
Houston, we have a problem! This page was not found.
</div>
</Router>
<script>
import Router from 'svelte-app-router'
import Home from './pages/Home.html'
import Contact from './pages/Contact.html'
export let routes: {
'/': [Home, {message: 'from "/" path'}],
'/home' [Home, {message: 'from "/home" path'}]
'/contact': [Contact]
}
</script>
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Credits
- Jeroen Coussement - @coussej - coussej.github.io
License
MIT