Header

Header container for site-wide navigation and branding. Same as Container but positioned at the top.

Required Props: idSupports Children: any

Structure

All styling goes in props.className as a single Tailwind utility string. Non-class props (text, src, alt, etc.) stay on their own keys. root.animation for scroll effects.

Properties

PropertyTypeDescriptionExamples
typestring
header |
Use header for site chrome
Default: "header"
-
canDeleteboolean
-
-
canEditNameboolean
-
-
customobject
-
-
classNamestring
Tailwind utility classes string. Mobile-first: unprefixed = base, md: = 768px+, sm: = 640px+, lg: = 1024px+. Includes layout, spacing, surface design, and typography.
flex flex-col gap-space-sm py-space-lg px-container-x md:flex-rowbg-primary text-primary-content rounded-box py-3.5 px-6 font-semibold
anchorstring
-
-
rolestring
-
-
aria-labelstring
-
-
aria-hiddenstring
-
-
aria-describedbystring
-
-
aria-livestring
polite | assertive | off
-
-
backgroundobject
-
-
rootobject
-
-

Examples

Site Header

Standard header container

{
  "canDelete": false,
  "canEditName": false,
  "type": "header",
  "custom": {
    "displayName": "Header"
  },
  "className": "flex w-full"
}

Dark Header

Header with dark surface for light text nav

{
  "canDelete": false,
  "canEditName": false,
  "type": "header",
  "className": "bg-base-content text-base-100 flex w-full"
}

Primary Header

Header with brand accent background

{
  "canDelete": false,
  "canEditName": false,
  "type": "header",
  "className": "bg-primary text-primary-content flex w-full"
}