🚨 Disclaimer: Routify 3 is currently in Release Candidate stage.

Please be aware that while the documentation is comprehensive, it may contain inaccuracies or errors. The codebase is also subject to changes that could affect functionality. We appreciate your understanding and welcome any feedback or contributions.

api

Helpers

Goto

$goto (path, params, options)

Programmatic navigation.

path: string

The internal path to the URL, eg.: /blog/[slug]/comments

params: object

The parameters to be used in the URL. Parameters not used in the path will be appended to the url as a query string.

options: urlOptions

urlOptions

recursive: boolean

Returns true if a descendant of the path is active

strict: boolean

Require internal paths. Eg. `/blog/[slug]` instead of `/blog/hello-world`

includeIndex: boolean

Suffix path with `/index`

silent: boolean

Suppress errors

mode: "push" | "replace"

Mode push to or replace in navigation history