NavigationDrawer

Material Design Navigation Drawer component.

Navigation Drawer is a panel slides in horizontally from the left or right edge of a page to show primary destinations in an app.

Inherits: DialogControl

Properties

• bgcolor(ColorValue | None) –

  The color of the navigation drawer itself.

• controls(list[Control]) –

  Defines the appearance of the items within the navigation drawer.

• elevation(Number | None) –

  The elevation of the navigation drawer itself.

• indicator_color(ColorValue | None) –

  The color of the selected destination

• indicator_shape(OutlinedBorder | None) –

  The shape of the selected destination indicator.

• position(NavigationDrawerPosition) –

  The position of this drawer.

• selected_index(int) –

  The index for the current selected NavigationDrawerDestination or null if no

• shadow_color(ColorValue | None) –

  The color used for the drop shadow to

• tile_padding(PaddingValue | None) –

  Defines the padding for destination controls.

Events

• on_change(ControlEventHandler[NavigationDrawer] | None) –

  Called when selected destination changed.

Examples

Live example

Start-aligned drawer

import flet as ft


def main(page: ft.Page):
    def handle_dismissal(e: ft.Event[ft.NavigationDrawer]):
        print("Drawer dismissed!")

    def handle_change(e: ft.Event[ft.NavigationDrawer]):
        print(f"Selected Index changed: {e.control.selected_index}")
        page.pop_dialog()

    drawer = ft.NavigationDrawer(
        on_dismiss=handle_dismissal,
        on_change=handle_change,
        controls=[
            ft.Container(height=12),
            ft.NavigationDrawerDestination(
                label="Item 1",
                icon=ft.Icons.DOOR_BACK_DOOR_OUTLINED,
                selected_icon=ft.Icon(ft.Icons.DOOR_BACK_DOOR),
            ),
            ft.Divider(thickness=2),
            ft.NavigationDrawerDestination(
                icon=ft.Icon(ft.Icons.MAIL_OUTLINED),
                label="Item 2",
                selected_icon=ft.Icons.MAIL,
            ),
            ft.NavigationDrawerDestination(
                icon=ft.Icon(ft.Icons.PHONE_OUTLINED),
                label="Item 3",
                selected_icon=ft.Icons.PHONE,
            ),
        ],
    )

    page.add(
        ft.Button(
            content="Show drawer",
            on_click=lambda e: page.show_dialog(drawer),
        )
    )


ft.run(main)

End-aligned drawer

import flet as ft


def main(page: ft.Page):
    def handle_dismissal(e: ft.Event[ft.NavigationDrawer]):
        print("End drawer dismissed")

    def handle_change(e: ft.Event[ft.NavigationDrawer]):
        print(f"Selected Index changed: {e.control.selected_index}")
        page.pop_dialog()

    end_drawer = ft.NavigationDrawer(
        position=ft.NavigationDrawerPosition.END,
        on_dismiss=handle_dismissal,
        on_change=handle_change,
        controls=[
            ft.NavigationDrawerDestination(
                icon=ft.Icons.ADD_TO_HOME_SCREEN_SHARP,
                label="Item 1",
            ),
            ft.NavigationDrawerDestination(
                icon=ft.Icon(ft.Icons.ADD_COMMENT),
                label="Item 2",
            ),
        ],
    )

    page.add(
        ft.Button(
            content="Show end drawer",
            on_click=lambda e: page.show_dialog(end_drawer),
        )
    )


ft.run(main)

Properties

bgcolor class-attribute instance-attribute

bgcolor: ColorValue | None = None

The color of the navigation drawer itself.

controls class-attribute instance-attribute

controls: list[Control] = field(default_factory=list)

Defines the appearance of the items within the navigation drawer.

The list contains NavigationDrawerDestination items and/or other controls such as headlines and dividers.

elevation class-attribute instance-attribute

elevation: Number | None = None

The elevation of the navigation drawer itself.

indicator_color class-attribute instance-attribute

indicator_color: ColorValue | None = None

The color of the selected destination indicator.

indicator_shape class-attribute instance-attribute

indicator_shape: OutlinedBorder | None = None

The shape of the selected destination indicator.

position class-attribute instance-attribute

position: NavigationDrawerPosition = START

The position of this drawer.

selected_index class-attribute instance-attribute

selected_index: int = 0

The index for the current selected NavigationDrawerDestination or null if no destination is selected.

A valid selected_index is an integer between 0 and number of destinations - 1. For an invalid selected_index, for example, -1, all destinations will appear unselected.

shadow_color class-attribute instance-attribute

shadow_color: ColorValue | None = None

The color used for the drop shadow to indicate elevation.

tile_padding class-attribute instance-attribute

tile_padding: PaddingValue | None = None

Defines the padding for destination controls.

Events

on_change class-attribute instance-attribute

on_change: ControlEventHandler[NavigationDrawer] | None = (
    None
)

Called when selected destination changed.