API Reference / @gtkx/navigation / createDrawerNavigator

Function: createDrawerNavigator()

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

Defined in: packages/navigation/dist/drawer/create-drawer-navigator.d.ts:28

Creates a drawer navigator rendered with AdwOverlaySplitView: a sidebar listing the screens beside the content.

Type Parameters

ParamList

ParamList extends ParamListBase

NavigatorID

NavigatorID extends string | undefined = string | undefined

TypeBag

TypeBag extends NavigatorTypeBagBase = DrawerTypeBag<ParamList, NavigatorID>

Config

Config extends StaticConfig<TypeBag> | undefined = undefined

Parameters

config?

Config

Returns

TypedNavigator<TypeBag, Config>