useRoute()

useRoute(): RouteLocation returns the current RouteLocation. It must be called inside a component's setup (or script setup).

import { useRoute } from '@meng-xi/unix-router'

const route = useRoute()

Return Value

It returns the global reactive object; access its fields directly — there is no .value.

Difference from vue-router

In vue-router, route is a ref-style object where the template can use route.path but the script needs computed and similar helpers to access the raw value. This library's useRoute() returns the global reactive RouteLocation itself; both script and template access it directly as route.path, with no .value and no unwrapping needed.

Fields

Field	Type	Description
path	string	Page path (with a leading slash, e.g. /pages/index/index)
name	string | null	Named route name; null when unnamed
meta	RouteMeta	Route meta (title / isTab / requireAuth)
query	Map<string, string>	Query parameters; read with .get(key)
params	Map<string, string>	Route params (requires ParamsPlugin)
fullPath	string	Full path (path + serialized query)
hash	string	Always '' (uni-app x does not support hash; field kept)
matched	RouteConfig[]	Matched route records (a single-record array under the flat model)

Reading Route Info

<script setup lang="uts">
import { useRoute } from '@meng-xi/unix-router'

const route = useRoute()

// Access fields directly (no .value)
console.log(route.path)            // /pages/detail/detail
console.log(route.fullPath)        // /pages/detail/detail?id=1
console.log(route.query.get('id')) // '1'
console.log(route.name)            // 'detail' (null when unnamed)
</script>

<template>
	<view class="page">
		<text>Current page: {{ route.path }}</text>
	</view>
</template>

Both query and params are Maps

In uni-app x, query travels in the URL as a string; both route.query / route.params are Map<string, string>, read with .get(...), checked with .has(...).

Update Timing

• Forward navigations only: updated automatically after a push / replace / relaunch succeeds and the target page is confirmed via the page stack top (written after stripping plugin-internal keys).
• back() and syncRoute() do not write this object: they update only the router-internal currentRoute (router.currentRoute). useRoute() and the router's internal state are two independently maintained objects.

onShow Timing Hint

A page's onShow may run before any state update. If you need to deterministically read this page's parameters inside onShow, prefer reading the native options in the page's onLoad(options) (i.e. the URL query), or read router.currentRoute (the router-internal state aligned by syncRoute()).

Related APIs

• RouteLocation
• useRouter()
• Router Instance - currentRoute