API Reference / @gtkx/navigation / createSplitViewNavigator

Function: createSplitViewNavigator()

createSplitViewNavigator<ParamList, NavigatorID, TypeBag, Config>(config?): TypedNavigator<TypeBag, Config>

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:31

Creates a master/detail navigator rendered with AdwNavigationSplitView: the first screen fills the sidebar pane, the rest are a stack in the content pane, and a narrow window collapses the two into one.

Type Parameters

ParamList

ParamList extends ParamListBase

NavigatorID

NavigatorID extends string | undefined = string | undefined

TypeBag

TypeBag extends NavigatorTypeBagBase = SplitViewTypeBag<ParamList, NavigatorID>

Config

Config extends StaticConfig<TypeBag> | undefined = undefined

Parameters

config?

Config

Returns

TypedNavigator<TypeBag, Config>