Skip to content
Meeko
Type to search the guides and the API reference. Open it from any page with / or Ctrl K; move with the arrow keys and open a result with Enter.
Get started

Contents

On this page

Not translated yet

This page has not been translated into English yet, so it is shown in Spanish.

RouteState

interfaz Since 1.2.0

Ruta confirmada que renderiza un componente: la de la petición en SSR y la de la última navegación confirmada en el navegador. La devuelve useRoute; cada campo es una señal de sólo lectura.

ts
import type { RouteState } from "@meekojs/meeko/framework";

Source code src/app/runtime/navigation.ts:48

Declaración #

ts
interface RouteState {
	readonly url: ReadonlySignal<string>
	readonly path: ReadonlySignal<string>
	readonly id: ReadonlySignal<string | null>
	readonly params: ReadonlySignal<Readonly<Record<string, unknown>>>
	readonly search: ReadonlySignal<Readonly<Record<string, unknown>>>
	isActive<K extends RouteId>(to: K, ...options: ActiveArguments<K>): 'page' | 'true' | false
}

Example #

ts
import { useRoute } from "@meekojs/meeko/framework";
import type { RouteState } from "@meekojs/meeko/framework";

const route: RouteState = useRoute();
const onUsers = route.path.value.startsWith("/users");

Miembros #

url #

propiedad sólo lectura

readonly url: ReadonlySignal<string>

URL relativa al origen: pathname, search y, en el navegador, el fragmento (/users/42?tab=a#bio). En SSR no hay fragmento, porque el navegador no lo envía: al hidratar vale lo mismo que en el servidor y, si la dirección tiene #fragmento, se actualiza justo después de la hidratación.

path #

propiedad sólo lectura

readonly path: ReadonlySignal<string>

pathname de la URL, codificado como en location.pathname (/users/42).

id #

propiedad sólo lectura

readonly id: ReadonlySignal<string | null>

ID de la ruta en el manifiesto ("/users/[id]"), o null en la página 404 de app/error.meeko.

params #

propiedad sólo lectura

readonly params: ReadonlySignal<Readonly<Record<string, unknown>>>

Parámetros de la ruta, con la misma forma que recibe la página (validados por su schema).

propiedad sólo lectura

readonly search: ReadonlySignal<Readonly<Record<string, unknown>>>

Parámetros de búsqueda, con la misma forma que recibe la página (validados por su schema).

isActive #

método since 1.5.0

isActive<K extends RouteId>(to: K, ...options: ActiveArguments<K>): 'page' | 'true' | false

Indica si la ruta to está activa, con la misma regla que <MeekoLink> y su atributo match: "page" cuando la ruta confirmada es exactamente la de to (con sus params) y, con prefix: true, "true" cuando está por debajo de ella por segmentos completos (/dashboard cubre /dashboard/stats, no /dashboards); si no, false. "/" sólo coincide exacta, también con prefix. Ignora la query string y el fragmento, y compara las rutas codificadas como href(). El resultado sirve tal cual para bind:aria-current (false quita el atributo) y como condición. Es reactivo: lee path, así que una plantilla o un computed que lo usan se actualizan al navegar; en SSR y al hidratar devuelve lo mismo.

See also #

Was this page helpful?

Add a comment

It is sent when you choose “Yes” or “No”. Only the page, your answer and the comment are stored: no cookies and no personal data.

0 of 2000 characters

Edit on GitHub: packages/meeko/src/app/runtime/navigation.ts