API Reference / @gtkx/navigation / HeaderOptions

Type Alias: HeaderOptions

HeaderOptions = object

Defined in: packages/navigation/dist/shared/types.d.ts:3

Header options shared by every navigator.

Properties

headerEnd?

optional headerEnd?: ReactNode

Defined in: packages/navigation/dist/shared/types.d.ts:13

Widgets packed at the end of the header bar.

---

headerShown?

optional headerShown?: boolean

Defined in: packages/navigation/dist/shared/types.d.ts:7

Whether to render a header bar above the screen; defaults to true.

---

headerStart?

optional headerStart?: ReactNode

Defined in: packages/navigation/dist/shared/types.d.ts:11

Widgets packed at the start of the header bar.

---

headerTitle?

optional headerTitle?: string | ReactElement

Defined in: packages/navigation/dist/shared/types.d.ts:9

Replaces the header bar title: a string becomes an AdwWindowTitle, an element is used as the title widget.

---

title?

optional title?: string

Defined in: packages/navigation/dist/shared/types.d.ts:5

Title of the screen, shown in the header bar; defaults to the route name.