Configuration

How to Configure

Configure the Vite plugin by passing an options object to the router() function in your Vite configuration:

vite.config.ts

import { router } from 'sv-router/vite-plugin';

export default defineConfig({
	plugins: [
		svelte(),
		router({
			path: 'src/pages',
		}),
	],
});

Apply the same options to the CLI in your postinstall script:

package.json

{
	"scripts": {
		"postinstall": "sv-router --path src/pages"
	}
}

Options

allLazy

Type	Default	Required
boolean	false	No

When set to true, all routes will be lazy loaded by default.

js

Type	Default	Required
boolean	false	No

When set to true, generates a .js file instead of a .ts file.

path

Type	Default	Required
string	src/routes	No

Specifies the directory containing your route files.