Merge pull request #23 from codenameakshay/t3code/audit-next-release-improvements

Prepare flutter_floating_bottom_bar 2.1.0 for release

Author: codenameakshay

.fvmrc

@@ -1,3 +1,3 @@
 {
-  "flutter": "stable"
-}
+  "flutter": "3.44.4"
+}

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  verify:
+    runs-on: macos-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Flutter 3.44.4
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: 3.44.4
+          channel: stable
+          cache: true
+
+      - name: Install package dependencies
+        run: flutter pub get
+
+      - name: Install example dependencies
+        working-directory: example
+        run: flutter pub get
+
+      - name: Run quality checks
+        run: make check FLUTTER=flutter DART=dart
+
+      - name: Validate pub publish archive
+        run: flutter pub publish --dry-run

.pubignore

@@ -3,12 +3,18 @@ build/
 
 # Internal planning / spec docs — not part of the published package
 docs/
+.omx/
+.claude/
 
 # IDE settings
 .vscode/
 
 # Development tooling
 Makefile
+tool/
+.github/
+AGENTS.md
+screenshots/
 
 # FVM (Flutter Version Management) — local toolchain, not needed by consumers
 .fvm/

CHANGELOG.md

@@ -1,88 +1,184 @@
+## 2.1.0
+
+### Added
+
+- `BottomBarLayout.maxWidth` and `BottomBarLayout.adaptive(maxWidth: ...)` for
+  width-capped adaptive layouts, plus `copyWith(clearMaxWidth: true)` for
+  returning a derived layout to an uncapped width.
+- `BottomBarBodyPadding` as the built-in way to reserve the live floating-bar
+  footprint inside `BottomBar.body`.
+- `BottomBarScrollBehavior.showAtStart` and
+  `BottomBarScrollBehavior.showOnScrollEnd` for settling-based visibility
+  restoration.
+
+### Changed
+
+- `BottomBarScope.barHeight` now reflects the full rendered footprint reserved
+  by the bar, including configured offset and bottom safe-area when enabled.
+- `BottomBarItem` accessible naming is now deterministic:
+  `semanticLabel` wins, otherwise `tooltip`, otherwise descendant semantics.
+  Explicit names exclude descendant semantics to avoid duplicate announcements;
+  items also expose selected/enabled button state, keep a 48x48 minimum target,
+  and place badges at the directional top-end in both LTR and RTL layouts.
+- Custom `BottomBarMotion.transitionBuilder` usage is documented as a
+  paint-only contract that must preserve layout footprint.
+- The hidden action is direction-aware by default: glyph, tooltip, and
+  semantics flip with `scrollOpposite`, the touch target stays at least 48x48
+  when active, and the default glyph color follows `ColorScheme.onPrimary`.
+- Hidden bar actions are non-interactive and excluded from semantics when the
+  bar is visible.
+- Reduced-motion environments snap directly to the target shown/hidden state
+  instead of animating.
+- `BottomBarController` ownership is strict: double-attach fails in debug and
+  release, and visibility updates are accepted only from the owning bar.
+- `BottomBarController` boundary scrolling now documents and uses explicit
+  start/end semantics independent of `scrollOpposite`.
+
+### Fixed
+
+- `BottomBarController.scrollToStart()` always targets
+  `ScrollPosition.minScrollExtent`, and `scrollToEnd()` always targets
+  `ScrollPosition.maxScrollExtent`.
+- `NestedScrollView` boundary scrolling now targets the correct coordinated
+  controller so start/end actions reset both header and body as expected.
+- Large `iconOffset` values keep the hidden action tappable because hit testing
+  now follows the translated visual position.
+- The hidden action's full 48x48 minimum target now accepts taps at its corners;
+  circular clipping applies only to the animated visual.
+- The example web app now uses Flutter's current generated bootstrap and
+  package-specific, orientation-neutral PWA metadata.
+
 ## 2.0.2
 
-- Fix: `BottomBarController.scrollToStart()` (and the back-to-top icon) did not fully reset a `NestedScrollView` — the collapsed `SliverAppBar`/`FlexibleSpaceBar` stayed collapsed and the list landed below its true top. A `NestedScrollView` scrolls on two coordinated positions (an outer header and an inner body), but the bar only animated the most-recently-active one. The controller now detects an enclosing `NestedScrollView` and drives its shared scroll coordinator with a single call — animating the outer controller to the top (which pulls the inner body up with it) for `scrollToStart`, and the inner controller to the bottom (which collapses the header) for `scrollToEnd`. ([#21](https://github.com/codenameakshay/flutter-floating-bottom-bar/issues/21))
+- Fix: `BottomBarController.scrollToStart()` (and the back-to-top icon) did not
+  fully reset a `NestedScrollView` — the collapsed
+  `SliverAppBar`/`FlexibleSpaceBar` stayed collapsed and the list landed below
+  its true top. A `NestedScrollView` scrolls on two coordinated positions (an
+  outer header and an inner body), but the bar only animated the
+  most-recently-active one. The controller now detects an enclosing
+  `NestedScrollView` and drives its shared scroll coordinator with a single
+  call — animating the outer controller to the top (which pulls the inner body
+  up with it) for `scrollToStart`, and the inner controller to the bottom
+  (which collapses the header) for `scrollToEnd`.
+  ([#21](https://github.com/codenameakshay/flutter-floating-bottom-bar/issues/21))
 
 ## 2.0.1
 
-- Fix: the back-to-top icon became unclickable when a large `iconOffset` was set. The icon was painted at the offset position but its `SafeArea` ancestor still hit-tested against the original (untranslated) rect, so a large offset moved the visible icon outside its tappable area. The offset now wraps the icon's `SafeArea` so hit-testing follows the painted position. ([#19](https://github.com/codenameakshay/flutter-floating-bottom-bar/issues/19))
+- Fix: the back-to-top icon became unclickable when a large `iconOffset` was
+  set. The icon was painted at the offset position but its `SafeArea` ancestor
+  still hit-tested against the original (untranslated) rect, so a large offset
+  moved the visible icon outside its tappable area. The offset now wraps the
+  icon's `SafeArea` so hit-testing follows the painted position.
+  ([#19](https://github.com/codenameakshay/flutter-floating-bottom-bar/issues/19))
 
 ## 2.0.0
 
-Major release. Breaking changes — see the migration table in README.md and EXAMPLES.md.
+Major release. Breaking changes — see the migration table in `README.md`.
 
 Breaking:
-- Dart SDK minimum is now `>=3.5.0` because the package uses Motor-backed motion.
-- `BottomBar.body` is now `Widget` instead of `Widget Function(BuildContext, ScrollController)`. The bar listens to `ScrollNotification` from any descendant scrollable; you no longer wire a controller through the builder.
-- The `barColor`, `width`, `offset`, `borderRadius`, `barAlignment`, `fit`, `clip`, `respectSafeArea` parameters have moved into `BottomBarLayout`.
-- The `duration`, `curve`, `start`, `end` parameters have moved into `BottomBarMotion`. `BottomBarMotion()` now defaults to Cupertino spring motion; existing `BottomBarMotion(duration: ..., curve: ...)` calls remain curve-based. `start`/`end` (doubles) are now `slideStart`/`slideEnd` (`Offset`s).
-- The `hideOnScroll`, `reverse`, `scrollOpposite`, `scrollDeltaThreshold` parameters have moved into `BottomBarScrollBehavior`. `scrollDeltaThreshold` is now `deltaThreshold`.
-- The `iconWidth`, `iconHeight`, `iconDecoration`, `barDecoration` parameters move to `BottomBarThemeData` (per-instance overrides remain via the `theme:` argument).
-- `BottomBarScrollControllerProvider` is replaced by `BottomBarScope`. The `scrollController` field is gone; new fields are `barHeight` and `isVisible`.
-- The hardcoded `Colors.black` default is replaced with Material 3 `colorScheme.surfaceContainer` for the bar and `colorScheme.primary` for the icon.
+
+- Dart SDK minimum is now `>=3.5.0` because the package uses Motor-backed
+  motion.
+- `BottomBar.body` is now `Widget` instead of
+  `Widget Function(BuildContext, ScrollController)`. The bar listens to
+  `ScrollNotification` from any descendant scrollable; you no longer wire a
+  controller through the builder.
+- The `barColor`, `width`, `offset`, `borderRadius`, `barAlignment`, `fit`,
+  `clip`, and `respectSafeArea` parameters moved into `BottomBarLayout`.
+- The `duration`, `curve`, `start`, and `end` parameters moved into
+  `BottomBarMotion`. `BottomBarMotion()` now defaults to Cupertino spring
+  motion; existing `BottomBarMotion(duration: ..., curve: ...)` calls remain
+  curve-based. `start`/`end` (doubles) are now `slideStart`/`slideEnd`
+  (`Offset`s).
+- The `hideOnScroll`, `reverse`, `scrollOpposite`, and
+  `scrollDeltaThreshold` parameters moved into `BottomBarScrollBehavior`.
+  `scrollDeltaThreshold` is now `deltaThreshold`.
+- The `iconWidth`, `iconHeight`, `iconDecoration`, and `barDecoration`
+  parameters moved to `BottomBarThemeData` (per-instance overrides remain via
+  the `theme:` argument).
+- `BottomBarScrollControllerProvider` is replaced by `BottomBarScope`. The
+  `scrollController` field is gone; new fields are `barHeight` and `isVisible`.
+- The hardcoded `Colors.black` default is replaced with Material 3
+  `colorScheme.surfaceContainer` for the bar and `colorScheme.primary` for the
+  icon.
 
 New:
-- Motor-backed Cupertino motion is the default show/hide engine, with velocity-preserving redirection when scroll direction changes mid-animation.
-- `BottomBarMotion.cupertino(...)`, `BottomBarMotion.curved(...)`, and `BottomBarMotion.motor(...)` constructors.
+
+- Motor-backed Cupertino motion is the default show/hide engine, with
+  velocity-preserving redirection when scroll direction changes mid-animation.
+- `BottomBarMotion.cupertino(...)`, `BottomBarMotion.curved(...)`, and
+  `BottomBarMotion.motor(...)` constructors.
 - `BottomBarThemeData` `ThemeExtension` for app-wide defaults.
-- `BottomBarTransition` enum (`slide`, `fade`, `scale`, `slideAndFade`) plus `BottomBarMotion.transitionBuilder` escape hatch.
+- `BottomBarTransition` enum (`slide`, `fade`, `scale`, `slideAndFade`) plus
+  `BottomBarMotion.transitionBuilder`.
 - `BottomBarItem` and `BottomBarItems` helpers for the common nav-item case.
-- `BottomBarScope.barHeight` exposes the live rendered bar height to descendants for content-padding purposes.
-- `BottomBarScope.isVisible` exposes live visibility without owning a controller.
-- Notification-based scroll detection works with `NestedScrollView`, `CustomScrollView`, multiple `TabBarView` children, and any user-supplied `ScrollController` with no wiring.
+- `BottomBarScope.barHeight` exposes the live rendered bar height to
+  descendants for content-padding purposes.
+- `BottomBarScope.isVisible` exposes live visibility without owning a
+  controller.
+- Notification-based scroll detection works with `NestedScrollView`,
+  `CustomScrollView`, multiple `TabBarView` children, and any user-supplied
+  `ScrollController` with no wiring.
 - `BottomBarScrollBehavior.predicate` for filtering unwanted notifications.
 - `BottomBarController` now asserts on double-attach in debug.
 
 Repository:
-- Package source moved from `packages/flutter_floating_bottom_bar/` to repo root. The example app moved to `example/`. The `packages/` directory is removed.
+
+- Package source moved from `packages/flutter_floating_bottom_bar/` to repo
+  root. The example app moved to `example/`. The `packages/` directory is
+  removed.
 
 ## 1.4.0
 
 - Upgrade project/tooling for Flutter `3.41.4` development via FVM.
 - Update SDK constraints and refresh dependencies.
-- Add `BottomBarController` for programmatic `show`, `hide`, `toggle`, `scrollToStart`, and `scrollToEnd`.
+- Add `BottomBarController` for programmatic `show`, `hide`, `toggle`,
+  `scrollToStart`, and `scrollToEnd`.
 - Add `onVisibilityChanged` callback for visibility state transitions.
 - Add `scrollDeltaThreshold` to reduce flicker from minor scroll movement.
 - Add `iconSemanticLabel` and `iconTooltip` for better accessibility.
 - Improve internal scroll/visibility handling and test coverage.
 
 ## 1.3.0
 
-- Added `respectSafeArea` property to control whether the BottomBar should respect the SafeArea
-- Removed deprecated `alignment` property (use `barAlignment` instead)
-- Fixed ScrollController issues with multiple attachments
-- Improved scroll listener management for better performance
+- Added `respectSafeArea` property to control whether the `BottomBar` should
+  respect the safe area.
+- Removed deprecated `alignment` property (use `barAlignment` instead).
+- Fixed `ScrollController` issues with multiple attachments.
+- Improved scroll listener management for better performance.
 
 ## 1.2.1+1
 
-- Fix code formatting
+- Fix code formatting.
 
 ## 1.2.1
 
-- Update to Flutter v3.22.1
-- Fix divider error in example
-- Update dependencies
+- Update to Flutter `3.22.1`.
+- Fix divider error in example.
+- Update dependencies.
 
 ## 1.2.0
 
-- Add `offset`, `barAlignment`, `barDecoration`, `iconDecoration` properties.
+- Add `offset`, `barAlignment`, `barDecoration`, and `iconDecoration`
+  properties.
 - Remove `bottom` property.
-- Deperecated `alignment` property, use `barAlignment` instead. `alignment` will be removed in a future release.
-- Update all code examples, and fix errors.
+- Deprecate `alignment` in favor of `barAlignment`.
+- Update all code examples and fix errors.
 
 ## 1.1.0
 
-- Add clip property to support clip behavior.
-- Add an example for bar with a FAB.
+- Add `clip` property to support clip behavior.
+- Add an example for a bar with a FAB.
 
 ## 1.0.1
 
-- Support for Flutter 3.10.5
-- Update dependencies
+- Support Flutter `3.10.5`.
+- Update dependencies.
 
 ## 1.0.0+1
 
-- Add documentation
+- Add documentation.
 
 ## 1.0.0
 
-- Initial release with basic functionality
+- Initial release with basic functionality.

CONTRIBUTING.md

@@ -1,66 +1,60 @@
 Contributing to Flutter Floating Bottom Bar
-==========================
-Thanks for your time.
-If you'd like to report a bug or join in the development
-of Flutter Floating Bottom Bar, then here are some notes on how to do that.
+===========================================
 
-Please **note** we have a [code of conduct](https://github.com/codenameakshay/flutter-floating-bottom-bar/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+Thanks for contributing.
 
-## Contents
-* [Reporting bugs and opening issues](#reporting-bugs-and-opening-issues)
-* [Coding Guidelines](#coding-guidelines)
-    * [Pull Requests](#pull-requests)
-    * [MVP architecture](#mvp-architecture)
-    * [Style Check](#style-check)
-    * [Git Commit Messages](#git-commit-messages)
-* [Security](#security)
-  
-## Reporting bugs and opening issues
+Please follow the
+[code of conduct](https://github.com/codenameakshay/flutter-floating-bottom-bar/blob/main/CODE_OF_CONDUCT.md)
+in all project interactions.
 
-If you'd like a report a bug or open an issue then please:
+## Report bugs and issues
 
-**Check if there is an existing issue.** If there is then please add
-   any more information that you have, or give it a 👍.
+Before opening a new issue:
 
-When submitting an issue please describe the issue as clearly as possible, including how to
-reproduce the bug, which situations it appears in, what you expected to happen, and what actually happens.
-If you can include a screenshot for front end issues that is very helpful.
+- Check whether an existing issue already covers the problem.
+- Include clear reproduction steps.
+- Include expected behavior, actual behavior, and environment details.
+- Add screenshots or screen recordings for UI issues when possible.
 
-## Coding Guidelines
+## Local setup
 
-### Pull Requests
-We love pull requests, so be bold with them! Don't be afraid of going ahead
-and changing something, or adding a new feature. We're very happy to work with you
-to get your changes merged into Flutter Floating Bottom Bar
+This repo is pinned to Flutter `3.44.4` through FVM.
 
-If you've got an idea for a change then please discuss it in the open first, 
-either by opening an issue, or email me at [akshaymaurya3006@gmail.com](mailto:akshaymaurya3006@gmail.com).
+```bash
+fvm install 3.44.4
+fvm use 3.44.4
+make setup
+```
 
-If you're looking for something to work on, have a look at the open issues in the repository [here](https://github.com/codenameakshay/flutter-floating-bottom-bar/issues).
+Useful commands:
 
-> We don't have a set format for Pull requests, but we expect you to list changes, bugs generated and other relevant things in PR message.
+- `make format` to rewrite Dart formatting.
+- `make analyze` to run static analysis for the package and example app.
+- `make test` to run tests for the package and example app.
+- `make check` to run format check, analyze, and tests together.
+- `make publish-dry-run` to validate the package for pub.dev without
+  publishing.
 
-Refer this pull request [template](https://github.com/codenameakshay/flutter-floating-bottom-bar/blob/master/PULL_REQUEST_TEMPLATE.md).
+## Pull requests
 
-### MVP architecture
-Flutter Floating Bottom Bar is built keeping [MVP (model-view-presenter)](https://en.wikipedia.org/wiki/Model–view–presenter) architecture in mind, so any changes that are proposed to Flutter Floating Bottom Bar should follow MVP architecture.
+- Keep changes small and reviewable.
+- Update docs and examples when public behavior changes.
+- Add or update tests when behavior changes.
+- Run `make check` before opening the PR.
+- Run `make publish-dry-run` for release-oriented changes.
+- Explain user-visible behavior changes clearly in the PR description.
 
-### Style Check
-Flutter Floating Bottom Bar uses `dartfmt`  for performing style checks on the codebase, which helps us in maintaining the quality of the code. Please check that the code is properly formatted according to `dartfmt` and also resolve all the issues, if any, shown by `dart analyze` before making a pull request. **Pull Requests will only be merged once all the violations are resolved**.
+If you want to propose a larger change, open an issue first so the approach can
+be discussed in the open.
 
-### Git Commit Messages
-* Use the present tense ("Add feature" not "Added feature")
-* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-* Limit the first line to 72 characters or less
-* Reference issues and pull requests liberally
-* When only changing documentation, include `[ci skip]` in the commit description
-* Please start your commits with the following prefixes for better understanding among collaborators, based on the type of commit:
-```
-   feat: (addition of a new feature)
-   rfac: (refactoring the code: optimization/ different logic of existing code - output doesn't change, just the way of execution changes)
-   docs: (documenting the code, be it readme, or extra comments)
-   bfix: (bug fixing)
-   chor: (chore - beautifying code, indents, spaces, camelcasing, changing variable names to have an appropriate meaning)
-   ptch: (patches - small changes in code, mainly UI, for example color of a button, incrasing size of tet, etc etc)
-   conf: (configurational settings - changing directory structure, updating gitignore, add libraries, changing manifest etc)
-```
+## Style and scope
+
+- Prefer the simplest implementation that fully solves the current problem.
+- Reuse existing patterns and utilities before adding new ones.
+- Remove obsolete paths instead of adding compatibility layers.
+- Keep public API docs accurate when contracts change.
+
+## Commit messages
+
+Use clear, imperative commit messages that explain why the change was needed.
+Reference relevant issues or PRs when helpful.