App

The full application shell record. Use it to define the top-level structure of a Mateu application, including navigation menu, layout variant, header, favicon, and home route.

@Builder
@With
public record AppShell(
    String clientSideComponentId,
    String route,
    String homeRoute,
    String homeBaseUrl,
    String homeServerSideType,
    String homeUriPrefix,
    String homeConsumedRoute,
    String serverSideType,
    String favicon,
    String pageTitle,
    String title,
    String subtitle,
    @Singular("menuItem") List<Actionable> menu,
    AppVariant variant,
    AppLayout layout,
    @Singular List<Component> widgets,
    boolean drawerClosed,
    String style,
    String cssClasses,
    String logo)
    implements Component, PageMainContent { }

Properties

Property	Type	Default	Description
route	String	""	Base route for this app
homeRoute	String	—	Route shown by default when navigating to the root
favicon	String	—	URL of the browser favicon
pageTitle	String	—	Browser tab title
title	String	—	App name shown in the header or drawer
subtitle	String	—	Subtitle shown below the app title
menu	List<Actionable>	[]	Top-level navigation menu items
variant	AppVariant	TABS	Layout variant
widgets	List<Component>	—	Additional widget components in the shell
drawerClosed	boolean	false	Start with the drawer closed
logo	String	—	URL of the logo image
style	String	—	Inline CSS
cssClasses	String	—	CSS class names

AppVariant values

HAMBURGER_MENU, MENU_ON_LEFT, MENU_ON_TOP, TABS, TILES, RAIL, AUTO, MEDIATOR — see @App for what each one draws. HAMBURGUER_MENU (the old misspelling of HAMBURGER_MENU) is deprecated but still accepted, in Java and in YAML.

Basic usage

@UI("")
public class MyApp implements ComponentTreeSupplier {

    @Override
    public Component component(HttpRequest httpRequest) {
        return AppShell.builder()
            .title("My Application")
            .favicon("/images/favicon.ico")
            .homeRoute("/dashboard")
            .variant(AppVariant.MENU_ON_LEFT)
            .menuItem(new RouteLink("/dashboard", "Dashboard"))
            .menuItem(new RouteLink("/customers", "Customers"))
            .menuItem(new RouteLink("/reports", "Reports"))
            .build();
    }
}

With logo and subtitle

return AppShell.builder()
    .title("Admin Panel")
    .subtitle("Powered by Mateu")
    .logo("/images/logo.svg")
    .homeRoute("/home")
    .variant(AppVariant.MENU_ON_LEFT)
    .drawerClosed(false)
    .build();