GTKX

API Reference / @gtkx/navigation / SplitViewNavigationConfig

Type Alias: SplitViewNavigationConfig ​

SplitViewNavigationConfig = object

Defined in: packages/navigation/dist/split-view/types.d.ts:24

Props of the split view navigator beyond the options every navigator shares.

Properties ​

collapsed? ​

optional collapsed?: boolean

Defined in: packages/navigation/dist/split-view/types.d.ts:26

Whether the panes stack into one instead of sitting side by side; defaults to false.

contentPlaceholder? ​

optional contentPlaceholder?: ReactNode

Defined in: packages/navigation/dist/split-view/types.d.ts:28

Fills the content pane while no content route is open; defaults to nothing.

maxSidebarWidth? ​

optional maxSidebarWidth?: number

Defined in: packages/navigation/dist/split-view/types.d.ts:34

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

minSidebarWidth? ​

optional minSidebarWidth?: number

Defined in: packages/navigation/dist/split-view/types.d.ts:32

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

popOnEscape? ​

optional popOnEscape?: boolean

Defined in: packages/navigation/dist/split-view/types.d.ts:38

Whether pressing Escape pops the visible content page; defaults to true.

sidebarPosition? ​

optional sidebarPosition?: "start" | "end"

Defined in: packages/navigation/dist/split-view/types.d.ts:30

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

sidebarWidthFraction? ​

optional sidebarWidthFraction?: number

Defined in: packages/navigation/dist/split-view/types.d.ts:36

Preferred sidebar width as a fraction of the total width.