API Reference / @gtkx/navigation / DrawerNavigationConfig

Type Alias: DrawerNavigationConfig

DrawerNavigationConfig = object

Defined in: packages/navigation/src/drawer/types.ts:101

Props of the drawer navigator beyond the options every navigator shares.

Properties

collapsed?

optional collapsed?: boolean

Defined in: packages/navigation/src/drawer/types.ts:105

Whether the sidebar overlays the content instead of sitting beside it; defaults to false.

---

drawerContent?

optional drawerContent?: (props) => ReactNode

Defined in: packages/navigation/src/drawer/types.ts:103

Renders the sidebar; defaults to a header bar above a DrawerItemList.

Parameters

props

DrawerContentProps

Returns

ReactNode

---

maxSidebarWidth?

optional maxSidebarWidth?: number

Defined in: packages/navigation/src/drawer/types.ts:113

Maximum sidebar width, in the unit libadwaita uses for the split view.

---

minSidebarWidth?

optional minSidebarWidth?: number

Defined in: packages/navigation/src/drawer/types.ts:111

Minimum sidebar width, in the unit libadwaita uses for the split view.

---

pinSidebar?

optional pinSidebar?: boolean

Defined in: packages/navigation/src/drawer/types.ts:109

Whether collapsing and uncollapsing leave the sidebar's visibility alone; defaults to false.

---

sidebarPosition?

optional sidebarPosition?: "start" | "end"

Defined in: packages/navigation/src/drawer/types.ts:107

Which side the sidebar sits on; defaults to "start".

---

sidebarWidthFraction?

optional sidebarWidthFraction?: number

Defined in: packages/navigation/src/drawer/types.ts:115

Preferred sidebar width as a fraction of the total width.