header-chrome.ts#

View Markdown

Source

10 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

10 symbols 4 functions 4 interfaces 1 types 1 modules 8 parameters 16 members 4 returns

Reference#

moduleheader-chromeOpt-in header nav, announcement, and per-page chrome helpers.

Opt-in header nav, announcement, and per-page chrome helpers.

View source

interfaceHeaderNavItemHeader nav link or dropdown.3 members

Header nav link or dropdown.

Signature

export interface HeaderNavItem

View source

Members

Properties

Name	Type	Description
`items`optional	`HeaderNavItem[]`
`link`optional	`string`
`text`	`LocaleLabel`

typeLocaleLabel = string | Record<string, string>Plain label or locale map ({ en: "Guide", ja: "ガイド" }).

Plain label or locale map ({ en: "Guide", ja: "ガイド" }).

Signature

export type LocaleLabel = string | Record<string, string>

View source

interfacePageChromeFlagsPer-page frontmatter chrome flags. false hides that region.7 members

Per-page frontmatter chrome flags. false hides that region.

Signature

export interface PageChromeFlags

View source

Members

Properties

Name	Type	Description
`aside`optional	`boolean`
`editLink`optional	`boolean`
`footer`optional	`boolean`
`lastUpdated`optional	`boolean`
`navbar`optional	`boolean`
`outline`optional	`boolean`
`sidebar`optional	`boolean`

fnparsePageChromeFlags(frontmatter: Record<string, unknown>): PageChromeFlagsReads hide flags from frontmatter. Non-boolean values are ignored.1 paramreturns PageChromeFlags

Reads hide flags from frontmatter. Non-boolean values are ignored.

Signature

export function parsePageChromeFlags(frontmatter: Record<string, unknown>): PageChromeFlags

View source

Parameters

frontmatter Record<string, unknown>

Returns

PageChromeFlags

interfaceResolvedHeaderNavItemNav item after locale maps are flattened to strings.3 members

Nav item after locale maps are flattened to strings.

Signature

export interface ResolvedHeaderNavItem

View source

Members

Properties

Name	Type	Description
`items`optional	`ResolvedHeaderNavItem[]`
`link`optional	`string`
`text`	`string`

resolveHeaderNavItems(items: HeaderNavItem[] | undefined, locale?: string, defaultLocale?: string): ResolvedHeaderNavItem[] | undefined

Resolves locale maps so NAPI always receives string labels.3 paramsreturns ResolvedHeaderNavItem[] | undefined

Resolves locale maps so NAPI always receives string labels.

Signature

export function resolveHeaderNavItems(items: HeaderNavItem[] | undefined, locale?: string, defaultLocale?: string): ResolvedHeaderNavItem[] | undefined

View source

Parameters

items HeaderNavItem[] | undefined
locale string

optional
defaultLocale string

optional

Returns

ResolvedHeaderNavItem[] | undefined

fnresolveLocaleLabel(text: LocaleLabel, locale?: string, defaultLocale?: string): stringPicks the exact locale, its language, the default locale, then the first non-em…3 paramsreturns string

Picks the exact locale, its language, the default locale, then the first non-empty own string in declaration order.

Signature

export function resolveLocaleLabel(text: LocaleLabel, locale?: string, defaultLocale?: string): string

View source

Parameters

text LocaleLabel
locale string

optional
defaultLocale string

optional

Returns

string

fnresolvePageChromeOption(value: boolean | Record<string, unknown> | undefined): booleanfalse or omitted stays off. true or {} enables default flag reading.1 paramreturns boolean

false or omitted stays off. true or {} enables default flag reading.

Signature

export function resolvePageChromeOption(value: boolean | Record<string, unknown> | undefined): boolean

View source

Parameters

value boolean | Record<string, unknown> | undefined

Returns

boolean

interfaceThemeAnnouncementAnnouncement bar. Text is escaped; no raw HTML slot.3 members

Announcement bar. Text is escaped; no raw HTML slot.

Signature

export interface ThemeAnnouncement

View source

Members

Properties

Name	Type	Description
`dismissKey`optional	`string`	Best-effort localStorage key for dismiss.
`link`optional	`string`	https or same-origin only.
`text`	`string`