SpotlightBottomNavigationBar class

A Custom Bottom Navigation Bar that is displayed at the bottom of the screen. The SpotlightNavigationBar shows a spotlight over the selected item. This navigation bar is usually can be used in a Scaffold, by providing it as the Scaffold.bottomNavigationBar argument.

Inheritance

Constructors

SpotlightBottomNavigationBar({Key? key, required List<SpotlightBottomNavigationBarItem> items, ValueChanged<int>? onTap, required int currentIndex, bool darkTheme = true, Color unselectedItemColor = const Color(0xff666666), Color selectedItemColor = const Color(0xffffffff), Color backgroundColor = const Color(0xff101010), double iconSize = 24.0, IconThemeData? unselectedIconTheme, IconThemeData? selectedIconTheme, Gradient? spotlightGradient})
Creates a spotlight bottom navigation bar which can be used with Scaffold's Scaffold.bottomNavigationBar argument.

Properties

backgroundColor → Color
The color of the SpotlightBottomNavigationBar itself.
final
currentIndex → int
The index of the selected SpotlightBottomNavigationBarItem in items.
final
darkTheme → bool
TODO Implement Dark/Light Themes
final
hashCode → int
The hash code for this object.
no setterinherited
iconSize → double
The size of the SpotlightBottomNavigationBarItem icons.
final
items → List<SpotlightBottomNavigationBarItem>
Defines the list of items which will be shown in the navigation bar.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onTap → ValueChanged<int>?
Called when one of the items is tapped.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIconTheme → IconThemeData?
The size, opacity, and color of the icon in the currently selected SpotlightBottomNavigationBarItem.icon.
final
selectedItemColor → Color
The color of selected BottomNavigationBarItem.icon, current item header and the color of the spotlight if spotlightGradient is not provided.
final
spotlightGradient → Gradient?
The custom Gradient to use for the spotlight of the selected BottomNavigationBarItem.
final
unselectedIconTheme → IconThemeData?
The size, opacity, and color of the icon in the currently selected SpotlightBottomNavigationBarItem.icon.
final
unselectedItemColor → Color
The color of unselected BottomNavigationBarItem.icons.
final

Methods

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