ZetaNavigationRail class

This widget provides a navigation rail for navigating between different sections of an app. It is designed to be used as a side navigation menu and can be customized with different icons and labels for each navigation item.

Should be used with ZetaNavigationRailItem.

Figma: https://www.figma.com/design/JesXQFLaPJLc1BdBM4sisI/%F0%9F%A6%93-ZDS---Components?node-id=229-43&node-type=canvas&m=dev

Widgetbook: https://design.zebra.com/flutter/widgetbook/index.html#/?path=components/navigation-rail/zetanavigationrail/navigation-rail

Inheritance
Available extensions

Constructors

ZetaNavigationRail({Key? key, bool? rounded, required List<ZetaNavigationRailItem> items, int? selectedIndex, void onSelect(int)?, EdgeInsets? margin, EdgeInsets? itemSpacing, EdgeInsets? itemPadding, bool? wordWrap, String? semanticLabel})
Constructor for ZetaNavigationRail.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
itemPadding → EdgeInsets?
The padding within an item in ZetaNavigationRail. Default is:
final
items → List<ZetaNavigationRailItem>
Required list of navigation items.
final
itemSpacing → EdgeInsets?
The spacing between items in ZetaNavigationRail. If undefined, defaults to:
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
margin → EdgeInsets?
The margin around the ZetaNavigationRail. If undefined, defaults to:
final
onSelect → void Function(int)?
Called when an item is selected.
final
rounded → bool?
Sets rounded or sharp border of the containing box and the icon style.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIndex → int?
Initially selected item form the list of items.
final
semanticLabel → String?
Value passed to the wrapping Semantics widget.
final
wordWrap → bool?
Determines if words in items' labels should be wrapped on separate lines. Default is true.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paddingAll(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Equal padding on all sides.
paddingBottom(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Padding on bottom only.
paddingEnd(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Padding on start edge only. Is affected by whether the device is LTR or RTL:
paddingHorizontal(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Equal padding on start and end.
paddingStart(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Padding on start edge only. Is affected by whether the device is LTR or RTL:
paddingTop(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Padding on top only.
paddingVertical(double space) → Widget

Available on Widget, provided by the SpacingWidget extension

Equal padding on top and bottom.
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, int wrapWidth = 65}) → 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