NavigationRail

NavigationRail control. Build it with the navigation_rail helper.

Example

navigation_rail(
  leading: icon("menu"),
  trailing: icon("chevron_right"),
  bgcolor: :surface_container_high,
  expand: true,
  on_change: ->(event) {}
)

Properties

• bgcolor — Background color.
• destinations — The navigation destinations.
• elevation — Shadow depth (z-height).
• extended — Sets the extended property.
• group_alignment — Group alignment.
• indicator_color — Indicator color.
• indicator_shape — Sets the indicator shape property.
• label_type — Sets the label type property.
• leading — Control placed before the main content (e.g. an icon or avatar).
• min_extended_width — Min extended width.
• min_width — Min width.
• selected_index — Sets the selected index property.
• selected_label_text_style — Selected label text style.
• trailing — Control placed after the main content.
• unselected_label_text_style — Unselected label text style.
• use_indicator — Sets the use indicator property.

Common layout and animation properties

• align — Alignment of the control within its parent.
• animate_align — Animates alignment changes.
• animate_margin — Animates margin changes.
• animate_offset — Animates offset changes.
• animate_opacity — Animates opacity changes.
• animate_position — Animates position changes.
• animate_rotation — Animates rotation changes.
• animate_scale — Animates scale changes.
• animate_size — Animates size changes.
• aspect_ratio — Width-to-height ratio to maintain.
• badge — Badge drawn on the corner of the control.
• bottom — Bottom offset when positioned inside a stack.
• col — Responsive column span (1-12) per breakpoint.
• data — Arbitrary value you can attach to the control and read back in handlers.
• disabled — Disables interaction when true.
• expand — Fills the available space along the parent's main axis when true.
• expand_loose — Like expand, but only grows up to the child's natural size.
• height — Fixed height in logical pixels.
• key — Stable identity used to preserve state across rebuilds.
• left — Left offset when positioned inside a stack.
• margin — Outer spacing around the control.
• offset — Translation offset applied to the control.
• opacity — Opacity from 0.0 (transparent) to 1.0 (opaque).
• right — Right offset when positioned inside a stack.
• rotate — Rotation applied to the control.
• rtl — Renders right-to-left when true.
• scale — Scale transform applied to the control.
• size_change_interval — Throttle interval for on_size_change, in ms.
• tooltip — Text shown on hover/long-press.
• top — Top offset when positioned inside a stack.
• visible — Hides the control when false.
• width — Fixed width in logical pixels.

Events

• on_animation_end — Fired when an animation completes.
• on_change — Fired when the value changes.
• on_size_change — Fired when the control's size changes.

Reference

• Family: materials
• Widget type: navigationrail
• Helpers: navigation_rail, navigationrail