Remove navBarHeight use the height of each style instead

jb3rndt · Oct 25, 2024 · 657cdae · 657cdae
1 parent 24bd019
commit 657cdae
Show file tree

Hide file tree

Showing 24 changed files with 77 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Set `popAction` to `PopActionType.single` to pop a single screen of the current tab if it is pressed again
   - Set `popAction` to `PopActionType.none` to pop no screen of the current tab if it is pressed again
 - Replaced `onSelectedTabPressWhenNoScreensPushed` with `SelectedTabPressConfig.onPressed`. You need to check the passed argument whether there are any pages pushed to that tab.
+- Removed `navBarHeight` parameter. Use the `height` parameter of each style instead if needed.
 
 ### Fixed
 - Adjusting the number of tabs at runtime threw an error

diff --git a/README.md b/README.md
@@ -268,7 +268,7 @@ class CustomNavBar extends StatelessWidget {
   Widget build(BuildContext context) {
     return DecoratedNavBar(
       decoration: navBarDecoration,
-      height: navBarConfig.navBarHeight,
+      height: kBottomNavigationBarHeight,
       child: Row(
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         crossAxisAlignment: CrossAxisAlignment.center,

diff --git a/lib/components/decorated_navbar.dart b/lib/components/decorated_navbar.dart
@@ -5,12 +5,12 @@ class DecoratedNavBar extends StatelessWidget {
     required this.child,
     super.key,
     this.decoration = const NavBarDecoration(),
-    this.height = kBottomNavigationBarHeight,
+    this.height,
   });
 
   final NavBarDecoration decoration;
   final Widget child;
-  final double height;
+  final double? height;
 
   @override
   Widget build(BuildContext context) => Stack(
@@ -34,7 +34,8 @@ class DecoratedNavBar extends StatelessWidget {
               left: false,
               child: Container(
                 padding: decoration.padding,
-                height: height - decoration.borderHeight(),
+                height:
+                    height != null ? height! - decoration.borderHeight() : null,
                 child: child,
               ),
             ),

diff --git a/lib/components/persistent_tab_view.dart b/lib/components/persistent_tab_view.dart
@@ -15,7 +15,6 @@ class PersistentTabView extends StatefulWidget {
     required this.navBarBuilder,
     super.key,
     this.controller,
-    this.navBarHeight = kBottomNavigationBarHeight,
     this.navBarOverlap = const NavBarOverlap.none(),
     this.margin = EdgeInsets.zero,
     this.backgroundColor = Colors.white,
@@ -42,7 +41,6 @@ class PersistentTabView extends StatefulWidget {
     required this.navBarBuilder,
     required StatefulNavigationShell this.navigationShell,
     super.key,
-    this.navBarHeight = kBottomNavigationBarHeight,
     this.navBarOverlap = const NavBarOverlap.none(),
     this.margin = EdgeInsets.zero,
     this.backgroundColor = Colors.white,
@@ -93,12 +91,6 @@ class PersistentTabView extends StatefulWidget {
   /// Defaults to [FloatingActionButtonLocation.endFloat].
   final FloatingActionButtonLocation? floatingActionButtonLocation;
 
-  /// Specifies the navBarHeight
-  ///
-  /// Defaults to `kBottomNavigationBarHeight` which is `56.0`.
-  // TODO: Get rid of this
-  final double navBarHeight;
-
   /// Works similar to [Scaffold.extendBody].
   ///
   /// If set to [NavBarOverlap.full], the tabs will extend to the bottom of
@@ -303,7 +295,6 @@ class _PersistentTabViewState extends State<PersistentTabView> {
           NavBarConfig(
             selectedIndex: _controller.index,
             items: widget.tabs.map((e) => e.item).toList(),
-            navBarHeight: widget.navBarHeight,
             onItemSelected: onItemSelected,
           ),
         ),

diff --git a/lib/models/configs.dart b/lib/models/configs.dart
@@ -125,26 +125,22 @@ class NavBarConfig {
     required this.selectedIndex,
     required this.items,
     required this.onItemSelected,
-    this.navBarHeight = kBottomNavigationBarHeight,
   });
   final int selectedIndex;
   final List<ItemConfig> items;
   final void Function(int) onItemSelected;
-  final double navBarHeight;
 
   ItemConfig get selectedItem => items[selectedIndex];
 
   NavBarConfig copyWith({
     int? selectedIndex,
     List<ItemConfig>? items,
     bool Function(int)? onItemSelected,
-    double? navBarHeight,
   }) =>
       NavBarConfig(
         selectedIndex: selectedIndex ?? this.selectedIndex,
         items: items ?? this.items,
         onItemSelected: onItemSelected ?? this.onItemSelected,
-        navBarHeight: navBarHeight ?? this.navBarHeight,
       );
 }
 

diff --git a/lib/models/navbar_overlap.dart b/lib/models/navbar_overlap.dart
@@ -1,10 +1,7 @@
 part of "../persistent_bottom_nav_bar_v2.dart";
 
 class NavBarOverlap {
-  const NavBarOverlap.full()
-      :
-        // This is the placeholder so [PersistentTabScaffold] uses the navBarHeight instead
-        overlap = double.infinity;
+  const NavBarOverlap.full() : overlap = double.infinity;
 
   const NavBarOverlap.none() : overlap = 0.0;
 

diff --git a/lib/styles/neumorphic_bottom_navbar.dart b/lib/styles/neumorphic_bottom_navbar.dart
@@ -6,11 +6,13 @@ class NeumorphicBottomNavBar extends StatelessWidget {
     super.key,
     this.navBarDecoration = const NavBarDecoration(),
     this.neumorphicProperties = const NeumorphicProperties(),
+    this.height = kBottomNavigationBarHeight,
   });
 
   final NavBarConfig navBarConfig;
   final NeumorphicProperties neumorphicProperties;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   Widget _getNavItem(
     ItemConfig item,
@@ -72,7 +74,7 @@ class NeumorphicBottomNavBar extends StatelessWidget {
   @override
   Widget build(BuildContext context) => DecoratedNavBar(
         decoration: navBarDecoration,
-        height: navBarConfig.navBarHeight,
+        height: height,
         child: Row(
           mainAxisAlignment: MainAxisAlignment.spaceEvenly,
           children: navBarConfig.items.map((item) {

diff --git a/lib/styles/style_10_bottom_navbar.dart b/lib/styles/style_10_bottom_navbar.dart
@@ -5,11 +5,13 @@ class Style10BottomNavBar extends StatefulWidget {
     required this.navBarConfig,
     this.navBarDecoration = const NavBarDecoration(),
     this.itemAnimationProperties = const ItemAnimation(),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   });
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   /// This controls the animation properties of the items of the NavBar.
   final ItemAnimation itemAnimationProperties;
@@ -41,7 +43,7 @@ class _Style10BottomNavBarState extends State<Style10BottomNavBar>
       );
       _animationList.add(
         Tween(
-          begin: Offset(0, widget.navBarConfig.navBarHeight),
+          begin: Offset(0, widget.height),
           end: Offset.zero,
         )
             .chain(CurveTween(curve: widget.itemAnimationProperties.curve))
@@ -107,7 +109,7 @@ class _Style10BottomNavBarState extends State<Style10BottomNavBar>
     }
     return DecoratedNavBar(
       decoration: widget.navBarDecoration,
-      height: widget.navBarConfig.navBarHeight,
+      height: widget.height,
       child: Row(
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         children: widget.navBarConfig.items.map((item) {

diff --git a/lib/styles/style_11_bottom_navbar.dart b/lib/styles/style_11_bottom_navbar.dart
@@ -5,11 +5,13 @@ class Style11BottomNavBar extends StatefulWidget {
     required this.navBarConfig,
     this.navBarDecoration = const NavBarDecoration(),
     this.itemAnimationProperties = const ItemAnimation(),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   });
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   /// This controls the animation properties of the items of the NavBar.
   final ItemAnimation itemAnimationProperties;
@@ -40,7 +42,7 @@ class _Style11BottomNavBarState extends State<Style11BottomNavBar>
       );
       _animationList.add(
         Tween(
-          begin: Offset(0, widget.navBarConfig.navBarHeight / 1.5),
+          begin: Offset(0, widget.height / 1.5),
           end: Offset.zero,
         )
             .chain(CurveTween(curve: widget.itemAnimationProperties.curve))
@@ -110,7 +112,7 @@ class _Style11BottomNavBarState extends State<Style11BottomNavBar>
     }
     return DecoratedNavBar(
       decoration: widget.navBarDecoration,
-      height: widget.navBarConfig.navBarHeight,
+      height: widget.height,
       child: Row(
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         children: widget.navBarConfig.items.map((item) {

diff --git a/lib/styles/style_12_bottom_navbar.dart b/lib/styles/style_12_bottom_navbar.dart
@@ -5,11 +5,13 @@ class Style12BottomNavBar extends StatefulWidget {
     required this.navBarConfig,
     this.navBarDecoration = const NavBarDecoration(),
     this.itemAnimationProperties = const ItemAnimation(),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   });
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   /// This controls the animation properties of the items of the NavBar.
   final ItemAnimation itemAnimationProperties;
@@ -41,7 +43,7 @@ class _Style12BottomNavBarState extends State<Style12BottomNavBar>
       );
       _animationList.add(
         Tween(
-          begin: Offset(0, widget.navBarConfig.navBarHeight / 1.5),
+          begin: Offset(0, widget.height / 1.5),
           end: Offset.zero,
         )
             .chain(CurveTween(curve: widget.itemAnimationProperties.curve))
@@ -125,7 +127,7 @@ class _Style12BottomNavBarState extends State<Style12BottomNavBar>
     }
     return DecoratedNavBar(
       decoration: widget.navBarDecoration,
-      height: widget.navBarConfig.navBarHeight,
+      height: widget.height,
       child: Row(
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         children: widget.navBarConfig.items.map((item) {

diff --git a/lib/styles/style_13_bottom_navbar.dart b/lib/styles/style_13_bottom_navbar.dart
@@ -4,6 +4,7 @@ class Style13BottomNavBar extends StatelessWidget {
   Style13BottomNavBar({
     required this.navBarConfig,
     this.navBarDecoration = const NavBarDecoration(),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   }) : assert(
           navBarConfig.items.length.isOdd,
@@ -12,6 +13,7 @@ class Style13BottomNavBar extends StatelessWidget {
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   Widget _buildItem(BuildContext context, ItemConfig item, bool isSelected) =>
       Column(
@@ -48,7 +50,7 @@ class Style13BottomNavBar extends StatelessWidget {
         children: <Widget>[
           Container(
             width: 150,
-            height: navBarConfig.navBarHeight,
+            height: height,
             decoration: BoxDecoration(
               shape: BoxShape.circle,
               color: item.activeForegroundColor,
@@ -96,7 +98,7 @@ class Style13BottomNavBar extends StatelessWidget {
             const SizedBox(height: 23),
             DecoratedNavBar(
               decoration: navBarDecoration,
-              height: navBarConfig.navBarHeight,
+              height: height,
               child: Row(
                 mainAxisAlignment: MainAxisAlignment.spaceAround,
                 children: navBarConfig.items.map((item) {

diff --git a/lib/styles/style_14_bottom_navbar.dart b/lib/styles/style_14_bottom_navbar.dart
@@ -4,6 +4,7 @@ class Style14BottomNavBar extends StatelessWidget {
   Style14BottomNavBar({
     required this.navBarConfig,
     this.navBarDecoration = const NavBarDecoration(),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   }) : assert(
           navBarConfig.items.length.isOdd,
@@ -12,6 +13,7 @@ class Style14BottomNavBar extends StatelessWidget {
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   Widget _buildItem(ItemConfig item, bool isSelected) => Column(
         mainAxisSize: MainAxisSize.min,
@@ -52,8 +54,8 @@ class Style14BottomNavBar extends StatelessWidget {
         mainAxisAlignment: MainAxisAlignment.center,
         children: <Widget>[
           Container(
-            width: navBarConfig.navBarHeight,
-            height: navBarConfig.navBarHeight,
+            width: height,
+            height: height,
             decoration: BoxDecoration(
               borderRadius: BorderRadius.circular(10),
               color: item.activeForegroundColor,
@@ -101,7 +103,7 @@ class Style14BottomNavBar extends StatelessWidget {
             const SizedBox(height: 23),
             DecoratedNavBar(
               decoration: navBarDecoration,
-              height: navBarConfig.navBarHeight,
+              height: height,
               child: Row(
                 mainAxisAlignment: MainAxisAlignment.spaceAround,
                 children: navBarConfig.items.map((item) {

diff --git a/lib/styles/style_15_bottom_navbar.dart b/lib/styles/style_15_bottom_navbar.dart
@@ -70,7 +70,6 @@ class Style15BottomNavBar extends StatelessWidget {
     final midIndex = (navBarConfig.items.length / 2).floor();
     return DecoratedNavBar(
       decoration: navBarDecoration,
-      height: navBarConfig.navBarHeight,
       child: Row(
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         children: navBarConfig.items.map((item) {

diff --git a/lib/styles/style_16_bottom_navbar.dart b/lib/styles/style_16_bottom_navbar.dart
@@ -4,6 +4,7 @@ class Style16BottomNavBar extends StatelessWidget {
   Style16BottomNavBar({
     required this.navBarConfig,
     this.navBarDecoration = const NavBarDecoration(),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   }) : assert(
           navBarConfig.items.length.isOdd,
@@ -12,6 +13,7 @@ class Style16BottomNavBar extends StatelessWidget {
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   Widget _buildItem(ItemConfig item, bool isSelected) => Column(
         mainAxisAlignment: MainAxisAlignment.center,
@@ -76,7 +78,7 @@ class Style16BottomNavBar extends StatelessWidget {
     final midIndex = (navBarConfig.items.length / 2).floor();
     return DecoratedNavBar(
       decoration: navBarDecoration,
-      height: navBarConfig.navBarHeight,
+      height: height,
       child: Row(
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         children: navBarConfig.items.map((item) {

diff --git a/lib/styles/style_1_bottom_navbar.dart b/lib/styles/style_1_bottom_navbar.dart
@@ -5,10 +5,12 @@ class Style1BottomNavBar extends StatelessWidget {
     required this.navBarConfig,
     super.key,
     this.navBarDecoration = const NavBarDecoration(),
+    this.height = kBottomNavigationBarHeight,
   });
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
+  final double height;
 
   Widget _buildItem(ItemConfig item, bool isSelected) => Column(
         mainAxisAlignment: MainAxisAlignment.center,
@@ -47,7 +49,7 @@ class Style1BottomNavBar extends StatelessWidget {
   @override
   Widget build(BuildContext context) => DecoratedNavBar(
         decoration: navBarDecoration,
-        height: navBarConfig.navBarHeight,
+        height: height,
         child: Row(
           mainAxisAlignment: MainAxisAlignment.spaceAround,
           children: navBarConfig.items.map((item) {

diff --git a/lib/styles/style_2_bottom_navbar.dart b/lib/styles/style_2_bottom_navbar.dart
@@ -6,12 +6,14 @@ class Style2BottomNavBar extends StatelessWidget {
     this.navBarDecoration = const NavBarDecoration(),
     this.itemAnimationProperties = const ItemAnimation(),
     this.itemPadding = const EdgeInsets.all(5),
+    this.height = kBottomNavigationBarHeight,
     super.key,
   });
 
   final NavBarConfig navBarConfig;
   final NavBarDecoration navBarDecoration;
   final EdgeInsets itemPadding;
+  final double height;
 
   /// This controls the animation properties of the items of the NavBar.
   final ItemAnimation itemAnimationProperties;
@@ -62,7 +64,7 @@ class Style2BottomNavBar extends StatelessWidget {
   @override
   Widget build(BuildContext context) => DecoratedNavBar(
         decoration: navBarDecoration,
-        height: navBarConfig.navBarHeight,
+        height: height,
         child: Row(
           mainAxisAlignment: MainAxisAlignment.spaceAround,
           children: navBarConfig.items.map((item) {