This module is a router for Svelte 3 applications, specifically optimized for Single Page Applications (SPA).
Main features:
- Leverages hash-based routing, which is optimal for SPAs and doesn't require any server-side processing
- Insanely simple to use, and has a minimal footprint
- Uses the tiny regexparam for parsing routes, with support for parameters (e.g.
/book/:id?) and more
This module is released under MIT license.
With hash-based routing, navigation is possible thanks to storing the current view in the part of the URL after #, called "hash" or "fragment".
For example, if your SPA is in a static file called index.html, your URLs for navigating within the app look something like index.html#/profile, index.html#/book/42, etc. (The index.html part can usually be omitted for the index file, so you can just create URLs that look like http://example.com/#/profile).
When I created this component, other routers for Svelte 3 implemented navigation using the HTML5 history API. While those URLs look nicer (e.g. you can actually navigate to http://example.com/profile), they are not ideal for static Single Page Applications. In order for users to be able to share links or even just refresh the page, you are required to have a server on the backend processing the request, and building fully-static apps is much harder as a consequence.
Hash-based routing is simpler, works well even without a server, and it's generally better suited for static SPAs, especially when SEO isn't a concern, as is the case when the app requires authentication. Many popular apps use hash-based routing, including GMail!
Check out the code in the example folder for some usage example. It's a full Svelte app, showcasing all the features of the router.
To run the sample, clone the repository, install the dependencies, then build the sample:
git clone https://github.com/ItalyPaleAle/svelte-spa-router
cd svelte-spa-router
npm install
npm run build-example
npm run start-exampleYou can include the router in any project using Svelte 3.
To add svelte-spa-router to your project:
npm install svelte-spa-routerEach route is a normal Svelte component, with the markup, scripts, bindings, etc. Any Svelte component can be a route.
The route definition is just a JavaScript dictionary (object) where the key is a string with the path (including parameters, etc), and the value is the route object.
For example:
import Home from './routes/Home.svelte'
import Author from './routes/Author.svelte'
import Book from './routes/Book.svelte'
import NotFound from './routes/NotFound.svelte'
const routes = {
// Exact path
'/': Home,
// Using named parameters, with last being optional
'/author/:first/:last?': Author,
// Wildcard parameter
'/book/*': Book,
// Catch-all
// This is optional, but if present it must be the last
'*': NotFound,
}Routes must begin with / (or * for the catch-all route).
Alternatively, you can also define your routes using custom regular expressions, as explained below.
Note that the order matters! When your users navigate inside the app, the first matching path will determine which route to load. It's important that you leave any "catch-all" route (e.g. a "Page not found" one) at the end.
To display the router, in a Svelte component (usually App.svelte), first import the router component:
import Router from 'svelte-spa-router'Then, display the router anywhere you'd like by placing the component in the markup. For example:
<body>
<Router {routes}/>
</body>The routes prop is the dictionary defined above.
That's it! You already have all that you need for a fully-functional routing experience.
You can navigate between pages with normal anchor (<a>) tags. For example:
<a href="#/book/123">Thus Spoke Zarathustra</a>Rather than having to type # before each link, you can also use the use:link action:
<script>
import {link} from 'svelte-spa-router'
</script>
<a href="/book/321" use:link>The Little Prince</a>You can navigate between pages programmatically too:
import {push, pop, replace} from 'svelte-spa-router'
// The push(url) method navigates to another page, just like clicking on a link
push('/book/42')
// The pop() method is equivalent to hitting the back button in the browser
pop()
// The replace(url) method navigates to a new page, but without adding a new entry in the browser's history stack
// So, clicking on the back button in the browser would not lead to the page users were visiting before the call to replace()
replace('/book/3')These methods can be used inside Svelte markup too, for example:
<button on:click={() => push('/page')}>Go somewhere</button>Note: The push, pop and replace methods perform navigation actions only in the next iteration ("tick") of the JavaScript event loop. This makes it safe to use them also inside onMount callbacks within Svelte components.
svelte-spa-router uses regexparam to parse routes, so you can add optional parameters to the route. Basic syntax is:
/pathmatches/pathexactly (and only that)/path/:idmatches/path/followed by any string, which is a named argumentid/path/:id/:version?allows for an optional second named argumentversion/path/*matches/path/followed by anything, using a non-named argument
Please refer to the documentation of regexparam for more details.
If your route contains any parameter, they will be made available to your component inside the params dictionary.
For example, for a route /name/:first/:last?, you can create this Svelte component:
<p>Your name is: <b>{params.first}</b> <b>{#if params.last}{params.last}{/if}</b></p>
<script>
// You need to define the component prop "params"
export let params = {}
</script>Non-named arguments are returned as params.wild.
You can get the current page from the $location readable store. This is a Svelte store, so it can be used reactively too.
<script>
import {location} from 'svelte-spa-router'
</script>
<p>The current page is: {$location}</p>You can also extract "querystring" parameters from the hash of the page. This isn't the real querystring, as it's located after the # character in the URL, but it can be used in a similar way. For example: #/books?show=authors,titles&order=1.
When svelte-spa-router finds a "querystring" in the hash, it separates that from the location and returns it as a string in the Svelte store $querystring. For example:
<script>
import {location, querystring} from 'svelte-spa-router'
</script>
<p>The current page is: {$location}</p>
<p>The querystring is: {$querystring}</p>With the example above, this would print:
The current page is: /books
The querystring is: show=authors,titles&order=1
It's important to note that, to keep this component lightweight, svelte-spa-router does not parse the "querystring". If you want to parse the value of $querystring, you can use third-party modules such as qs in your application.
svelte-spa-router has built-in support for automatically marking links as "active", with the use:active action.
For example, you can use the code below to add the CSS class active to links that are active:
<script>
import {link} from 'svelte-spa-router'
import active from 'svelte-spa-router/active'
</script>
<style>
/* Style for "active" links; need to mark this :global because the router adds the class directly */
:global(a.active) {
color: red;
}
</style>
<a href="/hello/user" use:link use:active={{path: '/hello/*', className: 'active'}}>Say hi!</a>
<a href="/hello/user" use:link use:active={'/hello/*'}>Say hi with a default className!</a>
<a href="/hello/user" use:link use:active>Say hi with all default options!</a>The active action accepts a dictionary options as argument:
options.path: the path that, when matched, makes the link active. In the first example above, we want the link to be active when the route is/hello/*(the asterisk matches anything after that). As you can see, this doesn't have to be the same as the path the link points to. Whenoptions.pathis omitted or falsey, it defaults to the path specified in the link'shrefattribute. This parameter can also be a regular expression that will mark the link as active when it matches: for example, setting to the regular expression/^\/*\/hi$/will make the link active when it starts with/and ends with/hi, regardless of what's in between.options.className: the name of the CSS class to add. This is optional, and it defaults toactiveif not present.
As a shorthand, instead of passing a dictionary as options, you can pass a single string or regular expression that will be interpreted as options.path.
Since version 1.2 of svelte-spa-router, it's possible to define routes using custom regular expressions too, allowing for greater flexibility. However, this requires defining routes using a JavaScript Map rather than an object:
import Home from './routes/Home.svelte'
import Name from './routes/Name.svelte'
import NotFound from './routes/NotFound.svelte'
const routes = new Map()
// You can still use strings to define routes
routes.set('/', Home)
routes.set('/hello/:first/:last?', Name)
// The keys for the next routes are regular expressions
// You will very likely always want to start the regular expression with ^
routes.set(/^\/hola\/(.*)/i, Name)
routes.set(/^\/buongiorno(\/([a-z]+))/i, Name)
// Catch-all, must be last
routes.set('*', NotFound)When you define routes as regular expressions, the params prop is populated with an array with the result of the matches from the regular expression.
For example, with this Name.svelte route:
<p>Params is: <code>{JSON.stringify(params)}</code></p>
<script>
// You need to define the component prop "params"
export let params = {}
</script>When visiting #/hola/amigos, the params prop will be ["/hola/amigos","amigos"]. This is consistent with the results of RegExp.prototype.exec().
Check out the Advanced Usage documentation for using: