NavigationRailTheme

Customizes the appearance of NavigationRail across the app.

Properties

• bgcolor(ColorValue | None) –

  Color to be used for the NavigationRail's background.

• elevation(Number | None) –

  The z-coordinate to be used for the NavigationRail's elevation.

• group_alignment(Number | None) –

  The alignment for the NavigationRail.destinations as they are positioned within the NavigationRail.

• indicator_color(ColorValue | None) –

  Overrides the default value of NavigationRail.indicator_color in all descendant NavigationRail controls. when NavigationRailTheme.use_indicator

• indicator_shape(OutlinedBorder | None) –

  Overrides the default value of NavigationRail.indicator_shape in all descendant NavigationRail controls.

• label_type(NavigationRailLabelType | None) –

  The type that defines the layout and behavior of the labels in the NavigationRail.

• min_extended_width(Number | None) –

  Overrides the default value of NavigationRail.min_extended_width in all descendant NavigationRail controls when they are extended.

• min_width(Number | None) –

  Overrides the default value of NavigationRail.min_width in all descendant NavigationRail controls when they are not extended.

• selected_label_text_style(TextStyle | None) –

  Overrides the default value of NavigationRail.selected_label_text_style

• unselected_label_text_style(TextStyle | None) –

  Overrides the default value of NavigationRail.unselected_label_text_style

• use_indicator(bool | None) –

  Overrides the default value of NavigationRail.use_indicator in all descendant NavigationRail controls.

Properties

bgcolor class-attribute instance-attribute

bgcolor: ColorValue | None = None

Color to be used for the NavigationRail's background.

elevation class-attribute instance-attribute

elevation: Number | None = None

The z-coordinate to be used for the NavigationRail's elevation.

group_alignment class-attribute instance-attribute

group_alignment: Number | None = None

The alignment for the NavigationRail.destinations as they are positioned within the NavigationRail.

indicator_color class-attribute instance-attribute

indicator_color: ColorValue | None = None

Overrides the default value of NavigationRail.indicator_color in all descendant NavigationRail controls. when NavigationRailTheme.use_indicator is true.

indicator_shape class-attribute instance-attribute

indicator_shape: OutlinedBorder | None = None

Overrides the default value of NavigationRail.indicator_shape in all descendant NavigationRail controls.

label_type class-attribute instance-attribute

label_type: NavigationRailLabelType | None = None

The type that defines the layout and behavior of the labels in the NavigationRail.

min_extended_width class-attribute instance-attribute

min_extended_width: Number | None = None

Overrides the default value of NavigationRail.min_extended_width in all descendant NavigationRail controls when they are extended.

min_width class-attribute instance-attribute

min_width: Number | None = None

Overrides the default value of NavigationRail.min_width in all descendant NavigationRail controls when they are not extended.

selected_label_text_style class-attribute instance-attribute

selected_label_text_style: TextStyle | None = None

Overrides the default value of NavigationRail.selected_label_text_style in all descendant NavigationRail controls.

unselected_label_text_style class-attribute instance-attribute

unselected_label_text_style: TextStyle | None = None

Overrides the default value of NavigationRail.unselected_label_text_style in all descendant NavigationRail controls.

use_indicator class-attribute instance-attribute

use_indicator: bool | None = None

Overrides the default value of NavigationRail.use_indicator in all descendant NavigationRail controls.