toolmark-monorepo / @toolmark/inertia / NavigationToolOptions

Interface: NavigationToolOptions

Defined in: packages/inertia/src/navigation.ts:23

Options for navigationTool.

Properties

description?

optional description?: string

Defined in: packages/inertia/src/navigation.ts:31

Tool description. Default "Navigate to a page in this app. Use route names from the enum."

---

name?

optional name?: string

Defined in: packages/inertia/src/navigation.ts:29

Tool name. Default navigate.

---

routes

routes: Record<string, RouteFn>

Defined in: packages/inertia/src/navigation.ts:25

Navigable routes by name; their keys become the route enum.

---

visit

visit: (url, opts) => void

Defined in: packages/inertia/src/navigation.ts:27

Starts the visit (typically (url, opts) => router.visit(url, opts)).

Parameters

url

string

opts

method

"get"

Returns

void