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.

GroupDefinition

interfaz Since 1.5.0

Opciones de un +group.ts, que heredan las páginas de su carpeta y de sus subcarpetas. Meeko las lee sin ejecutar el archivo: layout es un literal y layoutProps un objeto literal.

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

Source code src/shared/layout.ts:175

Declaración #

ts
interface GroupDefinition<L extends LayoutName | false = LayoutName> {
	readonly layout?: L
	readonly layoutProps?: Partial<LayoutProps<L>>
	readonly middleware?: readonly RouteMiddlewareName[] | false
}

Type parameters #

L extends LayoutName | false = LayoutName

Layout del grupo.

Example #

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

const group: GroupDefinition<"dashboard"> = { layout: "dashboard", layoutProps: { showAlert: false } };

Propiedades #

layout #

propiedad sólo lectura opcional

readonly layout?: L

Layout con nombre de las páginas del grupo, o false para quitarlo. Una página puede elegir otro.

layoutProps #

propiedad sólo lectura opcional

readonly layoutProps?: Partial<LayoutProps<L>>

Props del layout para las páginas del grupo. Se combinan por clave con las de los grupos exteriores y con las de la página, que gana. Un grupo o una página que elige otro layout empieza sin las props heredadas.

middleware #

propiedad sólo lectura opcional since 1.6.0

readonly middleware?: readonly RouteMiddlewareName[] | false

Middleware con nombre de app/middleware para las páginas del grupo, que se ejecutan después de los globales y de los de los grupos exteriores, o false para quitar los heredados. Una página puede añadir los suyos.

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