CustomNavigationRail class

A wrapper for NavigationRail that handles the selectedIndex for you.

Inheritance

Constructors

CustomNavigationRail({Key? key, required List<NavigationRailDestination> destinations, Color? backgroundColor, double? elevation, bool extended = false, Color? indicatorColor, ShapeBorder? indicatorShape, NavigationRailLabelType? labelType, Widget? leading, ValueChanged<int>? onDestinationSelected, int? selectedIndex, Widget? trailing, bool? useIndicator})
A wrapper for NavigationRail that handles the selectedIndex for you.
const

Properties

backgroundColor → Color?
Sets the color of the Container that holds all of the NavigationRail's contents.
final
destinations → List<NavigationRailDestination>
Defines the appearance of the button items that are arrayed within the navigation rail.
final
elevation → double?
The rail's elevation or z-coordinate.
final
extended → bool
Indicates that the NavigationRail should be in the extended state.
final
hashCode → int
The hash code for this object.
no setterinherited
indicatorColor → Color?
Overrides the default value of NavigationRail's selection indicator color, when useIndicator is true.
final
indicatorShape → ShapeBorder?
Overrides the default value of NavigationRail's selection indicator shape, when useIndicator is true.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
labelType → NavigationRailLabelType?
Defines the layout and behavior of the labels for the default, unextended NavigationRail.
final
leading → Widget?
The leading widget in the rail that is placed above the destinations.
final
onDestinationSelected → ValueChanged<int>?
Called when one of the destinations is selected.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIndex → int
The index into destinations for the current selected NavigationRailDestination or null if no destination is selected.
final
trailing → Widget?
The trailing widget in the rail that is placed below the destinations.
final
useIndicator → bool?
If true, adds a rounded NavigationIndicator behind the selected destination's icon.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CustomNavigationRail>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited