PersistentBottomNavBarItem class

An item widget for the PersistentTabView.

Constructors

PersistentBottomNavBarItem({required Widget icon, Widget? inactiveIcon, String? title, double contentPadding = 5.0, Color activeColorPrimary = CupertinoColors.activeBlue, Color? activeColorSecondary, Color? inactiveColorPrimary, Color inactiveColorSecondary = CupertinoColors.systemGrey, double opacity = 1.0, ImageFilter? filter, TextStyle? textStyle, double iconSize = 26.0, VoidCallback? onSelectedTabPressWhenNoScreensPushed, AnimationController? iconAnimationController, ScrollController? scrollController, RouteAndNavigatorSettings? routeAndNavigatorSettings, bool scrollToTopOnNavBarItemPress = true, dynamic onPressed(BuildContext?)?})

Properties

activeColorPrimary → Color
Color for the current selected item in the navigation bar. If activeColorSecondary property is empty, this will act in its place (recommended). cupertino activeBlue by default.
final
activeColorSecondary → Color?
Color for the item's icon and title. In most styles, declaring the the activeColorPrimary will be enough. But in some styles like style7, this might come help in differentiating the colors.
final
contentPadding → double
Padding of the navigation bar item. Applies on all sides. 5.0 by default.
final
filter → ImageFilter?
Filter used when opacity < 1.0. Can be used to create 'frosted glass' effect.
final
hashCode → int
The hash code for this object.
no setterinherited
icon → Widget
Icon for the bar item.
final
iconAnimationController → AnimationController?
For animated icons to work, this property must not be null or left empty.
final
iconSize → double
final
inactiveColorPrimary → Color?
Color for the unselected item(s) in the navigation bar.
final
inactiveColorSecondary → Color
Color for the item's inactiveIcon and title. In most styles, declaring the the inactiveColorPrimary will be enough. But in some styles like style7, this might come help in differentiating the colors.
final
inactiveIcon → Widget?
In-Active icon for the bar item. This is an optional property and will only be used if defined.
final
onPressed → dynamic Function(BuildContext?)?
If you want custom behavior on a press of a NavBar item like display a modal screen, you can declare your logic here.
final
onSelectedTabPressWhenNoScreensPushed → VoidCallback?
Use it when you want to run some code when user presses the NavBar when on the initial screen of that respective tab. The inspiration was taken from the native iOS navigation bar behavior where when performing similar operation, you taken to the top of the list.
final
opacity → double
Enables and controls the transparency effect of the entire NavBar when this tab is selected.
final
routeAndNavigatorSettings → RouteAndNavigatorSettings?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
For scrollToTopOnNavBarItemPress to work, this property must not be null or left empty.
final
scrollToTopOnNavBarItemPress → bool
If an already selected navigation bar is tapped again, the scroll controller provided in PersistentBottomNavBarItem will animate to top.
final
textStyle → TextStyle?
TextStyle of the title's text.
final
title → String?
Title for the bar item. Might not appear is some styles.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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