Navigation Rail
- Web Components
- Flutter
Demo
zeta-web v0.6.6
Web Components
Navigation rails allow navigation between sections of an app.
Storybook
https://design.zebra.com/web/storybook/?path=/docs/components-navigation-rail--docs
Slots
| Name | Description | Type |
|---|---|---|
| default | The navigation items. | zeta-navigation-rail-item[] |
Inherited Attributes
| Name | Description | Type | Default | Inherited From |
|---|---|---|---|---|
| rounded | Whether the component is rounded or sharp.When true, rounded will set the border radius of the first child, and any children with class 'contourable-target' to --radius-minimal.Otherwise, this value will be --radius-none. | boolean | undefined | true | Contourable |
Demo
This widget provides a navigation rail for navigating between differentsections of an app. It is designed to be used as a side navigationmenu and can be customized with different icons and labels for eachnavigation item.
Widgetbook
Inheritance
Object > DiagnosticableTree > Widget > StatelessWidget > ZetaStatelessWidget
Constructors
Constructor for ZetaNavigationRail.
ZetaNavigationRail.new({Key? key, bool? rounded, required List<ZetaNavigationRailItem> items, int? selectedIndex, void onSelect(int)?, EdgeInsets? margin, EdgeInsets? itemSpacing, EdgeInsets? itemPadding, bool? wordWrap, String? semanticLabel})
Properties
| Name | Description | Type | Features |
|---|---|---|---|
| hashCode | The hash code for this object. | int | no setter inherited |
| itemPadding | The padding within an item in ZetaNavigationRail. | EdgeInsets? | final |
| items | Required list of navigation items. | List<ZetaNavigationRailItem> | final |
| itemSpacing | The spacing between items in ZetaNavigationRail. | EdgeInsets? | final |
| key | Controls how one widget replaces another widget in the tree. | Key? | final inherited |
| margin | The margin around the ZetaNavigationRail. | EdgeInsets? | final |
| onSelect | Called when an item is selected. | void Function(int)? | final |
| rounded | Sets rounded or sharp border of the containing box and the icon style. | bool? | final inherited |
| runtimeType | A representation of the runtime type of the object. | Type | no setter inherited |
| selectedIndex | Initially selected item form the list of items. | int? | final |
| semanticLabel | Value passed to the wrapping Semantics widget. | String? | final |
| wordWrap | Determines if words in items' labels should be wrapped on separate lines. | bool? | final |
Methods
| Name | Description | Type | Features |
|---|---|---|---|
| build(BuildContext context) | Describes the part of the user interface represented by this widget. | Widget | override |
| createElement() | Creates a StatelessElement to manage this widget's location in the tree. | StatelessElement | inherited |
| debugDescribeChildren() | Returns a list of DiagnosticsNode objects describing this node's children. | List<DiagnosticsNode> | inherited |
| debugFillProperties(DiagnosticPropertiesBuilder properties) | Add additional properties associated with the node. | void | override |
| noSuchMethod(Invocation invocation) | Invoked when a nonexistent method or property is accessed. | dynamic | inherited |
| paddingAll(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| paddingBottom(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| paddingEnd(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| paddingHorizontal(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| paddingStart(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| paddingTop(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| paddingVertical(double space) | Available on Widget, provided by the SpacingWidget extension | Widget | undefined |
| toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) | Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep. | DiagnosticsNode | inherited |
| toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) | A string representation of this object. | String | inherited |
| toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) | Returns a string representation of this node and its descendants. | String | inherited |
| toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) | Returns a one-line detailed description of the object. | String | inherited |
| toStringShort() | A short, textual description of this widget. | String | inherited |
Figma