RNavNSheet class

Animated, modern and highly customisable BottomNavigationBar

Inheritance

Constructors

RNavNSheet.new({Key? key, required List<RNavItem> items, void onTap(int index)?, int? initialSelectedIndex, Widget? sheet, List<Color>? borderColors, Color? backgroundColor, Gradient? backgroundGradient, BoxDecoration? sheetToggleDecoration, IconData? sheetOpenIcon, IconData? sheetCloseIcon, void onSheetToggle(bool value)?, double? sheetIconRotateAngle, Color? selectedItemColor, Color? unselectedItemColor, Gradient? selectedItemGradient, Gradient? unselectedItemGradient, Color? sheetOpenIconBoxColor, Color? sheetCloseIconBoxColor, Color? sheetOpenIconColor, Color? sheetCloseIconColor})
const

Properties

backgroundColor Color?
Background Color of RNavNSheet
final
backgroundGradient Gradient?
Background Gradient of RNavNSheet
final
borderColors List<Color>?
List of Color for border over RNavNSheet (Gradient from left to right)
final
hashCode int
The hash code for this object.
no setterinherited
initialSelectedIndex int?
Index of default selected item
final
items List<RNavItem>
List of RNavItem (bottom navigation items)
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSheetToggle → void Function(bool value)?
Function callback that returns true if sheet is open and false if sheet is closed
final
onTap → void Function(int index)?
Function callback that returns index of selected RNavItem
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectedItemColor Color?
Color of selected nav item
final
selectedItemGradient Gradient?
Gradient of selected RNavItem
final
sheet Widget?
Bottom sheet to be displayed on dock icon click
final
sheetCloseIcon IconData?
Toggle button icon when sheet is closed
final
sheetCloseIconBoxColor Color?
Toggle button background Color when sheet is closed
final
sheetCloseIconColor Color?
Toggle button foreground Color when sheet is closed
final
sheetIconRotateAngle double?
Angle (in radians) to rotate toggle button when sheet is open
final
sheetOpenIcon IconData?
Toggle button icon when sheet is open
final
sheetOpenIconBoxColor Color?
Toggle button foreground Color when sheet is open
final
sheetOpenIconColor Color?
Toggle button foreground Color when sheet is open
final
sheetToggleDecoration BoxDecoration?
Decoration for toggle button
final
unselectedItemColor Color?
Color of unselected nav item
final
unselectedItemGradient Gradient?
Gradient of unselected RNavItem
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<RNavNSheet>
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, 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