NavbarRouter class

Inheritance

Constructors

Take a look at the readme for more information on how to use this package.
const

Properties

backButtonBehavior → BackButtonBehavior
Whether the back button pressed should pop the current route and switch to the previous route, defaults to true. if false, the back button will trigger app exit. This is applicable only for Android's back button.
final
decoration → NavbarDecoration?
The decoraton for Navbar has all the properties you would expect in a BottomNavigationBar to adjust the style of the Navbar.
final
destinationAnimationCurve → Curve
defaults to Curves.fastOutSlowIn
final
destinationAnimationDuration → int
AnimationDuration in milliseconds for the destination animation defaults to 300 milliseconds
final
destinations → List<DestinationRouter>
The destination to show when the user taps the NavbarItem destination also defines the list of Nested destination sand the navbarItem associated with it
final
errorBuilder → WidgetBuilder
Route to show the user when the user tried to navigate to a route that does not exist in the destinations
final
hashCode → int
The hash code for this object.
no setterinherited
hideBadgeOnPageChanged → bool
Set to true will hide the badges when the tap on the navbar icon.
final
initialIndex → int
Navbar item that is initially selected defaults to the first item in the list of NavbarItems
final
isDesktop → bool
if true, navbar will be shown on the left, this property can be used along with NavbarDecoration.isExtended to make the navbar adaptable for large screen sizes. defaults to false.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onBackButtonPressed → (bool Function(bool)?)
This callback is invoked, when the user taps the back button on Android. Defines whether it is the root Navigator or not if the method returns true then the Navigator is at the base of the navigator stack
final
onChanged → (dynamic Function(int)?)
callback when the currentIndex changes
final
onCurrentTabClicked → (dynamic Function()?)
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldPopToBaseRoute → bool
whether the navbar should pop to base route of current tab when the selected navbarItem is tapped all the routes from that navigator are popped. feature similar to Instagram's navigation bar defaults to true.
final
type → NavbarType
The type of the Navbar that is to be rendered. defaults to NavbarType.standard which is a standard BottomNavigationBar
final

Methods

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