Header

amerta

---

amerta / payload-types / Header

Interface: Header

Defined in: payload-types.ts:5435

This interface was referenced by Config's JSON-Schema via the definition "header".

Properties

buttonLink?

optional buttonLink: { appearance?: "default" | "link" | "outline" | "destructive" | "ghost" | "secondary" | null; label?: string | null; newTab?: boolean | null; reference?: { relationTo: "pages"; value: string | Page; } | { relationTo: "posts"; value: string | Post; } | { relationTo: "categories"; value: string | Category; } | { relationTo: "products"; value: string | Product; } | { relationTo: "collections"; value: string | Collection; } | { relationTo: "product-brands"; value: string | ProductBrand; } | null; size?: "default" | "sm" | "lg" | "xs" | null; type?: "custom" | "reference" | null; url?: string | null; }

Defined in: payload-types.ts:5465

appearance?

optional appearance: "default" | "link" | "outline" | "destructive" | "ghost" | "secondary" | null

Choose how the link should be rendered.

label?

optional label: string | null

newTab?

optional newTab: boolean | null

reference?

optional reference: { relationTo: "pages"; value: string | Page; } | { relationTo: "posts"; value: string | Post; } | { relationTo: "categories"; value: string | Category; } | { relationTo: "products"; value: string | Product; } | { relationTo: "collections"; value: string | Collection; } | { relationTo: "product-brands"; value: string | ProductBrand; } | null

size?

optional size: "default" | "sm" | "lg" | "xs" | null

Choose how the link size.

type?

optional type: "custom" | "reference" | null

url?

optional url: string | null

use {locale} to insert the current locale code into the URL

---

className?

optional className: string | null

Defined in: payload-types.ts:5507

---

createdAt?

optional createdAt: string | null

Defined in: payload-types.ts:5509

---

defaultTheme?

optional defaultTheme: "dark" | "light" | "system" | null

Defined in: payload-types.ts:5464

Default theme when users first visit the site

---

enableThemeSwitch?

optional enableThemeSwitch: boolean | null

Defined in: payload-types.ts:5460

Allow users to toggle between light and dark mode

---

id

id: string

Defined in: payload-types.ts:5436

---

logoClassName?

optional logoClassName: string | null

Defined in: payload-types.ts:5456

Custom CSS classes to apply to the logo element

---

logoDark?

optional logoDark: string | Media | null

Defined in: payload-types.ts:5452

Logo to display in dark mode. SVG recommended for best quality.

---

logoLight?

optional logoLight: string | Media | null

Defined in: payload-types.ts:5448

Logo to display in light mode. SVG recommended for best quality.

---

menu?

optional menu: string | Menu | null

Defined in: payload-types.ts:5440

Select a menu to display in the header navigation

---

secondary-menu?

optional secondary-menu: string | Menu | null

Defined in: payload-types.ts:5444

Select a menu to display in the header navigation

---

updatedAt?

optional updatedAt: string | null

Defined in: payload-types.ts:5508