guide

Introduction

Parameters

Parameters in Routify are plain URL queries, eg. /posts?page=1.

Parameters can be accessed in Routify with the $params helper, eg. $param.page.

To generate a URL, we have the $url helper: $url('/posts', {page: 1}). This would produce the string /posts?page=1

Pretty URLS

Often we want our URLs to look a little more appealing. For instance, /posts/1 would look nicer than the previous example.

To accomplish this we can add a dynamic page or module, /posts/[page].svelte.

Routify knows which pages are dynamic and will automatically output the correct URL when using $url. Eg. $url('/posts/', {page: 1, theme: 'dark'}) would output /posts/1?theme=dark.

Spread parameters

Sometimes parameters are variadic and can take multiple arguments. For this we can use spread operators, eg: people/[...names].svelte. Here /people/john/peter/paul would return ['john', 'peter', 'paul'] from $params.

Reloading the page on parameter updates

Routify pages are reactive and reflect parameter changes in realtime. If for some reason you need to force reload a page when a parameter changes, you can use the meta option param-is-page.

<!-- routify:meta param-is-page -->

Module Precedence

In Routify the most specific node always takes precedence. That means that when you visit /blog/hello-world, Routify will look for nodes in the following order.

1. /blog.svelte
2. /[dynamic].svelte
3. /[...spread].svelte
4. /blog/hello-world.svelte
5. /blog/[dynamic].svelte
6. /blog/[...spread].svelte

If Routify reaches a dead end while resolving a route, it will backtrace to the nearest node with a spread parameters such as [...404].svelte. This lets you create module specific 404 pages.