header-menu.ts

Header navigation items.

config/header-menu.ts defines header navigation in array order. Each item is a navigation object with a required label. The template's header component reads label, pathname, hash, description, external, and hidden.

Prop

Type

badge

Prop

Type

The template's header component does not display badge.

visibility

Prop

Type

The template's header component does not read visibility. To control navigation visibility by role or capability, modify the navigation component yourself.

match

Prop

Type

The template's header component does not read match. It identifies the current page directly from pathname: the homepage requires an exact match, while other paths match both the page itself and its child pages.

children

An array of child navigation items. Each item uses the same navigation object and can contain further nested items. The template's header component does not display child navigation.

meta

Additional data of type Record<string, unknown>. The template's header component does not read this field.

Default navigation items

Orderlabel.valuelabel.keypathnamehashdescription.value
1Homecomponents.header.nav.home/—Return to the homepage.
2Docscomponents.header.nav.docs/docs—Learn how to configure and extend the application.
3Pricingcomponents.header.nav.pricing/#pricingCompare monthly and yearly subscription plans.
4FAQscomponents.header.nav.faqs/#faqsfrequently asked questions

The array order determines the display order in the header. When both pathname and hash are set, the link opens the specified anchor on the target page.