NavigationRailDestination

Represents a destination in a NavigationRail.

Inherits: Control

Properties

• icon - The name of the icon or Control of the destination.
• indicator_color - The color of the indicator_shape when this destination is selected.
• indicator_shape - The shape of the selection indicator.
• label - A string or Control representing the destination's label.
• padding - The amount of space to inset the destination item.
• selected_icon - The name of alternative icon or Control displayed when this destination is selected.

Properties

buildiconclass-attributeinstance-attribute

icon: Optional[IconDataOrControl] = None

The name of the icon or Control of the destination.

If selected_icon is provided, this will only be displayed when the destination is not selected.

To make the NavigationRail more accessible, consider choosing an icon with a stroked and filled version, such as Icons.CLOUD and Icons.CLOUD_QUEUE. The icon should be set to the stroked version and selected_icon to the filled version.

buildindicator_colorclass-attributeinstance-attribute

indicator_color: Optional[ColorValue] = None

The color of the indicator_shape when this destination is selected.

buildindicator_shapeclass-attributeinstance-attribute

indicator_shape: Optional[OutlinedBorder] = None

The shape of the selection indicator.

buildlabelclass-attributeinstance-attribute

label: Optional[StrOrControl] = None

A string or Control representing the destination's label.

buildpaddingclass-attributeinstance-attribute

padding: Optional[PaddingValue] = None

The amount of space to inset the destination item.

buildselected_iconclass-attributeinstance-attribute

selected_icon: Optional[IconDataOrControl] = None

The name of alternative icon or Control displayed when this destination is selected.

If this icon is not provided, the NavigationRail will display icon in either state.