App shell

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "title",
    "sidebar",
    "tabbar"
  ],
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "description": "Page title in the top bar (\"Anmeldungen\")."
    },
    "titleHidden": {
      "type": "boolean",
      "default": false,
      "description": "Hide the title visually (e.g. home screens whose `h1` greets the user); it stays for screen readers."
    },
    "skipLabel": {
      "type": "string",
      "default": "Zum Inhalt springen",
      "description": "Text of the skip link."
    },
    "mainId": {
      "type": "string",
      "pattern": "^[A-Za-z][\\w-]*$",
      "default": "main",
      "description": "Id of the main region; target of the skip link. The app renders page content into it."
    },
    "navLabel": {
      "type": "string",
      "default": "Hauptnavigation",
      "description": "Accessible name of sidebar and tab bar (only one is visible at a time)."
    },
    "clubSwitcher": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "current"
      ],
      "properties": {
        "current": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "description": "The active club.",
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "description": "Full club name (\"Taekwondo Bern\"), used in the accessible label."
            },
            "shortName": {
              "type": "string",
              "description": "Short visible name when space is tight (\"TKD Bern\"). Defaults to `name`."
            },
            "logo": {
              "type": "string",
              "description": "Logo image URL (src); decorative, square."
            }
          }
        },
        "menuId": {
          "type": "string",
          "pattern": "^[A-Za-z][\\w-]*$",
          "default": "club-menu",
          "description": "Id of the popover menu (`popovertarget`). Unique on the page."
        },
        "clubs": {
          "type": "array",
          "description": "All clubs of the person (including the current one), from their memberships. The menu is rendered only with 2 or more.",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "name",
              "href"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[A-Za-z0-9_-]+$",
                "description": "Club id (tenant), written to `data-club`."
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "description": "Club name shown in the menu."
              },
              "href": {
                "type": "string",
                "description": "Home URL of that club (switching target)."
              },
              "logo": {
                "type": "string",
                "description": "Logo image URL (src)."
              },
              "current": {
                "type": "boolean",
                "default": false,
                "description": "This is the active club (check mark, `aria-current`)."
              }
            }
          }
        }
      },
      "description": "Optional club switcher at the start of the top bar (see Club switcher)."
    },
    "back": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "label",
        "href"
      ],
      "description": "Back link at the start of the top bar, for detail pages (points to the parent list, not to browser history).",
      "properties": {
        "label": {
          "type": "string",
          "minLength": 1,
          "description": "Parent page name (\"Mitglieder\"), not \"Zurück\"."
        },
        "href": {
          "type": "string",
          "description": "URL of the parent page."
        }
      }
    },
    "actions": {
      "type": "array",
      "maxItems": 3,
      "description": "Top bar actions (Button data), usually ghost icon-only buttons with `ariaLabel` (search, notifications).",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [],
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1,
            "description": "Visible text. Required unless `iconOnly`."
          },
          "variant": {
            "type": "string",
            "enum": [
              "secondary",
              "primary",
              "ghost",
              "danger",
              "danger-ghost"
            ],
            "default": "secondary",
            "description": "Visual weight / meaning."
          },
          "size": {
            "type": "string",
            "enum": [
              "sm",
              "md",
              "lg"
            ],
            "default": "md",
            "description": "`sm` (36 px) only in dense desktop tables; `lg` (52 px) for the single main action of a screen."
          },
          "icon": {
            "type": "string",
            "description": "Icon id from the sprite, shown before the label."
          },
          "iconOnly": {
            "type": "boolean",
            "default": false,
            "description": "Square button showing only `icon`. Requires `ariaLabel`."
          },
          "ariaLabel": {
            "type": "string",
            "description": "Accessible name when the visible label is missing or ambiguous (\"Weitere Aktionen für Lea Müller\")."
          },
          "href": {
            "type": "string",
            "description": "Render an `<a>` that looks like a button (navigation, not actions)."
          },
          "type": {
            "type": "string",
            "enum": [
              "button",
              "submit",
              "reset"
            ],
            "default": "button",
            "description": "Button type inside forms."
          },
          "value": {
            "type": "string",
            "description": "Form value, e.g. `cancel` / `confirm` inside `<form method=\"dialog\">`."
          },
          "name": {
            "type": "string",
            "description": "Form field name when the button submits a value."
          },
          "disabled": {
            "type": "boolean",
            "default": false,
            "description": "Not available now. Prefer explaining why nearby over silently disabling."
          },
          "busy": {
            "type": "boolean",
            "default": false,
            "description": "Action in progress (`aria-busy`)."
          },
          "formNoValidate": {
            "type": "boolean",
            "default": false,
            "description": "Submit without native validation — use on \"Abbrechen\" inside `<form method=\"dialog\">` so required fields do not block closing."
          },
          "block": {
            "type": "string",
            "enum": [
              "always",
              "mobile"
            ],
            "description": "Full width always, or only below 768 px."
          },
          "behavior": {
            "type": "string",
            "description": "Behaviour hook (`data-behavior`), e.g. `open-dialog`, `theme-toggle`."
          },
          "action": {
            "type": "string",
            "pattern": "^[a-z][a-zA-Z0-9-]*$",
            "description": "Screen action name (`data-action`). Declared in the `actions` of the screen with a handler and a risk class; the engine adds undo or confirm accordingly."
          },
          "actionId": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]+$",
            "description": "Id of the thing the action applies to (`data-id`), when the button is not inside an element that has one."
          },
          "target": {
            "type": "string",
            "description": "Id of the element a behaviour acts on (`data-target`), e.g. the dialog to open."
          },
          "popoverTarget": {
            "type": "string",
            "description": "Id of a popover menu this button toggles (`popovertarget`)."
          }
        },
        "description": "One button."
      }
    },
    "sidebar": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "brand",
        "sections"
      ],
      "description": "Desktop sidebar.",
      "properties": {
        "brand": {
          "type": "string",
          "minLength": 1,
          "description": "Brand line at the top (\"TKD Bern · Admin\")."
        },
        "logo": {
          "type": "string",
          "description": "Club logo image URL (src), decorative."
        },
        "sections": {
          "type": "array",
          "minItems": 1,
          "maxItems": 7,
          "description": "Groups of nav items. The first usually has no label.",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "items"
            ],
            "properties": {
              "label": {
                "type": "string",
                "description": "Section heading (\"Verein\"); omit for the first group."
              },
              "items": {
                "type": "array",
                "minItems": 1,
                "description": "Items of the section.",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "label",
                    "href",
                    "icon"
                  ],
                  "description": "One navigation item.",
                  "properties": {
                    "label": {
                      "type": "string",
                      "minLength": 1,
                      "description": "Area name (\"Heute\", \"Mitglieder\"). Short — tab bar labels are tiny."
                    },
                    "href": {
                      "type": "string",
                      "description": "Route URL of the area."
                    },
                    "icon": {
                      "type": "string",
                      "description": "Icon id from the sprite (\"home\", \"users\", \"list\", \"award\", \"more\")."
                    },
                    "current": {
                      "type": "boolean",
                      "default": false,
                      "description": "The current area (`aria-current=\"page\"`). Exactly one item per navigation."
                    },
                    "count": {
                      "type": "integer",
                      "minimum": 0,
                      "description": "Number of items needing attention (count bubble); 0 shows nothing."
                    },
                    "countLabel": {
                      "type": "string",
                      "description": "Accessible text for the count (\"3 offene Anmeldungen\"); see Count bubble."
                    }
                  }
                }
              }
            }
          }
        },
        "footer": {
          "type": "array",
          "description": "Items pinned to the bottom (help, settings).",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "label",
              "href",
              "icon"
            ],
            "description": "One navigation item.",
            "properties": {
              "label": {
                "type": "string",
                "minLength": 1,
                "description": "Area name (\"Heute\", \"Mitglieder\"). Short — tab bar labels are tiny."
              },
              "href": {
                "type": "string",
                "description": "Route URL of the area."
              },
              "icon": {
                "type": "string",
                "description": "Icon id from the sprite (\"home\", \"users\", \"list\", \"award\", \"more\")."
              },
              "current": {
                "type": "boolean",
                "default": false,
                "description": "The current area (`aria-current=\"page\"`). Exactly one item per navigation."
              },
              "count": {
                "type": "integer",
                "minimum": 0,
                "description": "Number of items needing attention (count bubble); 0 shows nothing."
              },
              "countLabel": {
                "type": "string",
                "description": "Accessible text for the count (\"3 offene Anmeldungen\"); see Count bubble."
              }
            }
          }
        }
      }
    },
    "tabbar": {
      "type": "array",
      "minItems": 2,
      "maxItems": 5,
      "description": "Mobile tab bar: max 5 items (4 areas by frequency for the role + \"Mehr\").",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "label",
          "href",
          "icon"
        ],
        "description": "One navigation item.",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1,
            "description": "Area name (\"Heute\", \"Mitglieder\"). Short — tab bar labels are tiny."
          },
          "href": {
            "type": "string",
            "description": "Route URL of the area."
          },
          "icon": {
            "type": "string",
            "description": "Icon id from the sprite (\"home\", \"users\", \"list\", \"award\", \"more\")."
          },
          "current": {
            "type": "boolean",
            "default": false,
            "description": "The current area (`aria-current=\"page\"`). Exactly one item per navigation."
          },
          "count": {
            "type": "integer",
            "minimum": 0,
            "description": "Number of items needing attention (count bubble); 0 shows nothing."
          },
          "countLabel": {
            "type": "string",
            "description": "Accessible text for the count (\"3 offene Anmeldungen\"); see Count bubble."
          }
        }
      }
    }
  }
}