Reference

NavigationDrawer

NavigationDrawer

NavigationDrawer control. Build it with the navigation_drawer helper.

Example

navigation_drawer(
  bgcolor: :surface_container_high,
  expand: true,
  width: 240,
  on_change: ->(event) {}
)

Properties

  • adaptive — Adapts to the platform (Material/Cupertino) when true.
  • bgcolor — Background color.
  • controls — The list of child controls.
  • elevation — Shadow depth (z-height).
  • indicator_color — Indicator color.
  • indicator_shape
  • selected_index
  • shadow_color — Color of the drop shadow.
  • surface_tint_color — Surface tint color.
  • tile_padding — Tile padding.

Plus the common layout and animation properties shared by most controls (expand, visible, disabled, opacity, width, height, align, tooltip, animate_*, …).

Events

  • on_change — Fired when the value changes.
  • on_dismiss — Fired when the control is dismissed.

Reference

  • Family: materials
  • Widget type: navigationdrawer
  • Helper: navigation_drawer