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.

LayoutHandle

interfaz Since 1.5.0

Lo que devuelve useLayout: las props del layout con nombre de la página, para leerlas y cambiarlas desde el <script> de la página.

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

Source code src/shared/layout.ts:73

Declaración #

ts
interface LayoutHandle<P extends object = Record<string, unknown>> {
	readonly name: string | undefined
	readonly props: Readonly<Partial<P>>
	set<const Q extends Partial<P>>(patch: Q & { readonly [K in Exclude<keyof Q, keyof P>]: never }): void
}

Type parameters #

P extends object = Record<string, unknown>

Props del layout, sin outlet.

Example #

meeko
<script lang="ts">
const layout = useLayout();
const title = signal("Conexiones");
effect(() => layout.set({ title: title.value }));
</script>

Miembros #

name #

propiedad sólo lectura

readonly name: string | undefined

Nombre del layout con nombre de la página, o undefined si no tiene (layout: false).

props #

propiedad sólo lectura

readonly props: Readonly<Partial<P>>

Las props que recibe ahora el layout (sin outlet): las de layoutProps y los +group.ts con lo que haya escrito la página encima. La lectura es reactiva.

set #

método

set<const Q extends Partial<P>>(patch: Q & { readonly [K in Exclude<keyof Q, keyof P>]: never }): void

Cambia props del layout; las que no nombra se conservan. El layout no se vuelve a montar: sólo cambia lo que lee esas props. Al navegar a otra página, el layout recibe las de la página nueva. Sin layout con nombre, no hace nada.

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/shared/layout.ts