sepal_ui.sepalwidgets.app.NavDrawer#

class sepal_ui.sepalwidgets.app.NavDrawer(**kwargs)[source]#

Custom NavDrawer using the different DrawerItems of the user.

The drawer can include links to the github page of the project for wiki, bugs and repository.

Parameters:

items (List[DrawerItem]) – the list of all the drawerItem to display in the drawer. This items should pilote the different tile visibility
code (str) – the absolute link to the source code
wiki (str) – the absolute link the the wiki page
issue (str) – the absolute link to the issue tracker
repo_folder (str | Path) – the path to the github repository folder where the changelog and version are stored. Default to the current working directory.
kwargs (optional)

Attributes

items

the list of all the drawerItem to display in the drawer

Methods

`__init__`	Custom NavDrawer using the different DrawerItems of the user.
`display_drawer`	Bind the drawer to the app toggleButton.

NavDrawer.__init__(items=[], code='', wiki='', issue='', repo_folder='', **kwargs)[source]#

Custom NavDrawer using the different DrawerItems of the user.

The drawer can include links to the github page of the project for wiki, bugs and repository.

Parameters:

items (List[DrawerItem]) – the list of all the drawerItem to display in the drawer. This items should pilote the different tile visibility
code (str) – the absolute link to the source code
wiki (str) – the absolute link the the wiki page
issue (str) – the absolute link to the issue tracker
repo_folder (str | Path) – the path to the github repository folder where the changelog and version are stored. Default to the current working directory.
kwargs (optional)

Return type:

None

NavDrawer.display_drawer(toggleButton)[source]#

Bind the drawer to the app toggleButton.