api

The instance that this router belongs to.

Manually specify the root node. By default the root node from the routes object will be used.

The name of the router. All routers inside an instance must have unique names.

The generated routes to be imported into the router.

Keeps the internal path synchronized to the browser (AddressReflector) or the local storage (LocalStorageReflector). InternalReflector does not synchronize the internal path to anything.

Runs before the route has been changed.

Runs after the route has been changed.

Manipulate the fragments returned by route.fragments

Called when the router is destroyed

Plugins share the same options as the router options.

Synchronizes the query parameters with the path in the address bar.

Configures which clicks the router listens to.

Whether or not to add a trailing slash to the URL. preserve will keep the trailing slash if it was there, and contextual will add a trailing slash if the URL is a directory, e.g.: /example/index.svelte.

Rewrites the external URL (visible in the address bar) before it's passed to the router.

Rewrites the internal URL before it's passed to the router (visible in the address bar).

Parses the query string from the path and returns an object with parameters.

Serializes the parameters and returns a string.

The element that will be listened to for clicks.

Can rewrite the url or ignore the click by returning null.