OudsBottomBar class
Reference design version: 1.0.0
A platform-adaptive OUDS bottom bar.
This widget renders:
- OudsTabBar on iOS (backed by Cupertino's CupertinoTabBar),
- OudsNavigationBar on Android (backed by the Material 3 NavigationBar).
It provides a single, shared API so consumers don't have to branch on platform.
Parameters:
- destinations: The list of OudsNavigationBarItem displayed in the bar. These are forwarded to either OudsTabBar or OudsNavigationBar.
- selectedIndex: The currently selected destination index. This controls which item is highlighted as active.
- translucent: When true, the underlying implementation renders a translucent (blurred) background; otherwise it renders an opaque background.
- onDestinationSelected: Called with the tapped destination index. If null, the bar is considered disabled.
Example usage:
Using OudsBottomBar:
OudsBottomBar(
destinations: [
OudsNavigationBarItem(icon: 'assets/home.svg', label: 'Home'),
OudsNavigationBarItem(icon: 'assets/search.svg', label: 'Search'),
],
selectedIndex: selectedIndex,
onDestinationSelected: (index) => setState(() => selectedIndex = index),
),
Using the alias OudsBottomNavigationBar:
OudsBottomNavigationBar(
destinations: [
OudsNavigationBarItem(icon: 'assets/home.svg', label: 'Home'),
OudsNavigationBarItem(icon: 'assets/search.svg', label: 'Search'),
],
selectedIndex: selectedIndex,
onDestinationSelected: (index) => setState(() => selectedIndex = index),
),
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- OudsBottomBar
Constructors
-
OudsBottomBar({Key? key, required List<
OudsNavigationBarItem> destinations, required int selectedIndex, bool translucent = false, ValueChanged<int> ? onDestinationSelected}) -
Creates an adaptive OUDS bottom bar.
const
Properties
-
destinations
→ List<
OudsNavigationBarItem> -
The list of OudsNavigationBarItem to display.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onDestinationSelected
→ ValueChanged<
int> ? -
Callback triggered when a destination is tapped (returns the tapped index).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedIndex → int
-
The currently selected destination index.
final
- translucent → bool
-
If true, renders a translucent background; otherwise opaque.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
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