SiteHeader

SiteHeader

Documentation

Site-wide header content organized into authored sections.

Kind

Layout

Required fields

sections

Style Guide

Used by

Authoring guidance

Use when

Use for navigation and identity content that should appear in the site's header across pages.

Avoid when

The content applies only to one page or a subset of pages; keep it in the page or use a reusable component.

Properties

*

sections

Sections rendered in authored order within the site header.

Example

Required

{ "sections": [] }

Full

{ "sections": [ { "id": "site-header", "title": "Site header", "titleSrOnly": true, "elements": [ { "type": "image", "src": "/branding/logo.svg", "alt": "Acme Home", "loading": "eager", "fetchPriority": "high", "link": { "href": "/" }, "class": "site-logo" }, { "type": "menu", "navId": "qp-primary-nav", "mobileCollapse": true, "ariaLabel": "Primary navigation", "items": [ { "label": "Home", "link": { "href": "/" } }, { "label": "Pricing", "link": { "href": "/pricing/" } } ] } ] } ] }

examples are generated from the schema.