`header` element

Introductory content for a page or a section; often the site header inside a component.

Renders

<header>

Required

Nothing beyond type.

Native apps

Compiled native apps and server-driven apps

Syntax

header element

{ "type": "header" }

An element lives in a screen's sections, another element's elements, a layout slot or a component root.

Properties

Property	Type	Description
`elements`	`array of element`
`layout`	`object`	`align`: `"start" \| "center" \| "end" \| "stretch" \| "baseline"` `direction`: `"row" \| "column" \| "row-reverse" \| "column-reverse"` `gap`: `string` `justify`: `"start" \| "center" \| "end" \| "between" \| "around" \| "evenly"` `wrap`: `boolean`
`gap`	`string`
`content`	`string`	literal text, or an expression starting with = ("=product.name")
`data`	`object`	`aggregate`: `object` — summarise in the database: one record per group with its measures; sort by a group or measure name `as`: `string` — identifiers use letters, digits and '_' and do not start with a digit `cache`: `duration (500ms, 6s…)` — durations look like 500ms, 30s, 5m, 1h or 7d `columns`: `array of string` `filter`: `object {name: string \| number \| boolean \| null \| object}` `include`: `object {name: object}` — related records loaded with each record, one query per include: {"category": {}} or {"reviews": {"source": "DATABASE.reviews", "on": "product"}} `items`: `array of any` — inline records for STATIC sources `limit`: `integer (1–500)` `live`: `boolean` — re-render when the underlying records change (server push) `mode`: `"list" \| "single"` `paginate`: `object` `query`: `object {name: string \| number \| boolean \| null \| object}` — API sources: query values passed to the api (literals or {param\|query\|props} references) `refresh`: `duration (500ms, 6s…)` — durations look like 500ms, 30s, 5m, 1h or 7d `required`: `boolean` — page data: when nothing matches, the page answers 404 `search`: `object` `sort`: `object` `source`: `string` — sources are DATABASE.<schema>, API.<name>, STATIC, USER, STATE.<store>.<list> or an expression giving a list ("=product.images")
`item`	`element`

Plus the properties every element accepts: id, className, style, responsive, states, animation, visible, ariaLabel, attributes and more.

Example

header example

{
  "type": "header",
  "layout": { "align": "center", "justify": "between" },
  "elements": [
    { "type": "link", "label": "Lumen & Oak", "target": "/", "className": "brand" },
    {
      "type": "link",
      "label": "Sign in",
      "target": "/login",
      "visible": { "auth": "signed-out" }
    }
  ]
}

For a header with a collapsing menu use navbar; for the site-wide frame use a layout.

Expected output

The HTML IWC rendered for the example above (inside the page's content wrapper). Class names such as i807b63fc are generated per element for its scoped CSS.

Rendered HTML

<div class="iwc-page ipage" id="iwc-content">
  <header class="iwc-header i5c7f5888">
    <a class="iwc-link ide8237b3 brand" href="/">Lumen &amp; Oak</a><a class="iwc-link i669abede" href="/login">Sign in</a>
  </header>
</div>

Data, conditions & styling

Conditional rendering: "visible": {"auth": "signed-in"}, {"roles": ["admin"]} or an expression such as "=product.stock > 0". Decided on the server: hidden elements are never sent.
Data binding: bind takes text from data (name, user.name, props.title, params.slug, state.cart.count); binds binds attributes. Containers become data-driven with data + item. See data binding.
Styling: className for your stylesheets, style for CSS in JSON, states for hover/focus/active, animation for entrance motion. See the style property reference.
Responsive behaviour: responsive applies CSS at or below a breakpoint ({"mobile": {"padding": "12px"}}); grids also take responsiveColumns.