v6.0.0

.github/workflows/tests.yaml

@@ -7,7 +7,7 @@ on:
   workflow_call:
 
 env:
-  FLUTTER_VERSION: "3.19.3"
+  FLUTTER_VERSION: "3.24.4"
 
 jobs:
   tests:
@@ -33,7 +33,7 @@ jobs:
 
       # Checkout and get packages.
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Get packages
         run: flutter pub get
@@ -42,9 +42,11 @@ jobs:
       - name: Run Unit Tests
         run: flutter test --coverage
 
-      - name: Upload Coverage to Codecov
+      - name: Upload coverage to Codecov
         if: ${{ runner.os == 'Linux' }}
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   format:
     name: Format

.vscode/settings.json

@@ -1,8 +1,7 @@
 {
-    "dart.lineLength": 80,
-    "[dart]": {
-        "editor.rulers": [
-            80
-        ],
-    }
+  "dart.lineLength": 80,
+  "[dart]": {
+    "editor.rulers": [80]
+  },
+  "cmake.ignoreCMakeListsMissing": true
 }

CHANGELOG.md

@@ -1,9 +1,39 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
+# ChangelogAll notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Added
+- Hide the NavBar on scroll: Set `hideOnScrollVelocity` to x (x != 0) to make the NavBar disappear after x pixels have been scrolled (and reappear respectively)
+- `SelectedTabPressConfig`, which is responsible for any configuration when the selected tab is pressed again.
+  - `SelectedTabPressConfig.popAction` allows to specify how many screens of the current tab should be popped if the tab is pressed again
+  - `SelectedTabPressConfig.scrollToTop` enables automatically scrolling the tab content to top if the current tab is pressed again. This requires a ScrollController on each `PersistentTabConfig.scrollController` for each tab this should be activated for.
+  - `SelectedTabPressConfig.onPressed` is a callback that gets executed whenever the current tab is pressed again. I also provides an argument whether there are any pages pushed to the tab.
+- Navigator function that pop all screens of the current tab: `popAllScreensOfCurrentTab`
+- Animated Icons: Have nice animations of the navigation bar icons simply by using the provided `AnimatedIconWrapper` (see README for more)
+- PersistentTabController now gives you access to the previousIndex. Before the first tab switch, this will be null though
+
+### Breaking Changes
+- Use `NavBarOverlap.none()` as the default for `navBarOverlap`
+- Removed ItemConfig.opacity. Use the opacity of NavBarDecoration.color instead
+- Removed ItemConfig.filter. Use NavBarDecoration.filter instead
+- Removed default value of NavBarDecoration.filter to allow omitting the filter
+- Replaced popAllScreensOnTapAnyTabs with keepNavigatorHistory, which has an inverted meaning. To migrate, invert the boolean value for that parameter if you use it.
+- Combined `popAllScreensOnTapOfSelectedTab` and `popActionScreens` into the `SelectedTabPressConfig.popAction`.
+  - Set `popAction` to `PopActionType.all` to pop all screens of the current tab if it is pressed again
+  - 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
+- The state of each tab was not disposed if stateManagement was true and gestures were enabled
+
+### Removed
+- Removed `selectedTabContext`. Use the list of your tabs instead to get the current tab context like so: `tabs[controller.index].navigatorConfig.navigatorKey.currentContext`
+- Removed `PersistentTabController.onIndexChanged`. Use `PersistentTabController.listen` instead.
+
 ## [5.3.1] - 2024-10-03
 ### Fixed
 - Improve documentation on the historyLength (https://github.com/jb3rndt/PersistentBottomNavBarV2/pull/138)
@@ -574,6 +604,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Includes platform specific behavior as an option (specify it in the two navigator functions).
 - Based on flutter's Cupertino(iOS) bottom navigation bar.
 
+[Unreleased]: https://github.com/jb3rndt/PersistentBottomNavBarV2/compare/5.3.1...HEAD
 [5.3.1]: https://github.com/jb3rndt/PersistentBottomNavBarV2/compare/5.3.0...5.3.1
 [5.3.0]: https://github.com/jb3rndt/PersistentBottomNavBarV2/compare/5.2.3...5.3.0
 [5.2.3]: https://github.com/jb3rndt/PersistentBottomNavBarV2/compare/5.2.2...5.2.3