Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maheshmnj/navbar_router
A Navbar widget for advanced usecases to improve user experience and save your time.
https://github.com/maheshmnj/navbar_router
bottomnavigationbar flutter hacktoberfest package widget
Last synced: 19 days ago
JSON representation
A Navbar widget for advanced usecases to improve user experience and save your time.
- Host: GitHub
- URL: https://github.com/maheshmnj/navbar_router
- Owner: maheshmnj
- License: mit
- Created: 2022-06-14T04:09:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T21:45:32.000Z (2 months ago)
- Last Synced: 2024-05-01T17:37:36.731Z (2 months ago)
- Topics: bottomnavigationbar, flutter, hacktoberfest, package, widget
- Language: HTML
- Homepage: https://docs.maheshjamdade.com/navbar_router/
- Size: 42 MB
- Stars: 29
- Watchers: 4
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-stars - navbar_router
- awesome-stars - navbar_router
README
## **navbar_router v0.7.3**
_Checkout our [extensive docs](https://docs.maheshjamdade.com/navbar_router/) to learn more about this package, the inspiration behind it and how to use it._
## Adding a BottomNavigationBar to your app?
NavbarRouter is a complete package to handle all your BottomNavigationBar needs. It provides a simplest api to achieve the advanced features of BottomNavigationBar making the user experience of your app much better. You only need to specify the NavbarItems and the routes for each NavbarItem and NavbarRouter will take care of the rest.
_Most of the features which this package provides are mainly to improve the user experience by handling the smallest things possible._
## **Key Features**
- Choose between different NavigationBar types.
- Remembers navigation history of Navbar (Android).
- Persist Navbar when pushing routes
- Support for nested navigation.
- Intercept back button press to handle app exits (Android).
- Fade smoothly between NavbarDestinations
- show different icons for selected and unselected NavbarItems.
- Consistent API for all types of Navbar.
- Programmatically control state of bottom navbar from any part of widget tree e.g change index, hide/show bottom navbar,push/pop routes of a specific tab etc
- Show Snackbar messages on top of Navbar with a single line of code.
- persist state across bottom navbar tabs.
- Jump to base route from a deep nested route with a single tap(same as instagram).
- Adapatable to different device Sizes.
## Supports mulitple NavbarTypes
You can choose between different NavbarTypes using the `NavbarDecoration.navbarType` property. This allows you to choose between the default `NavbarType.standard` and `NavbarType.notched` NavbarTypes.
| NavbarType.standard (default) | NavbarType.notched |
| :-----------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: |
|  |  |
| NavbarType.material3 | NavbarType.floating |
| :------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: |
|  |  |
_Heres a [sample app](example/lib/main.dart) built using this package to see how it works._
_video demo of the sample app_
This package will help you save atleast 50% lines of code in half the time required to implement the above features. Heres the same [sample app](https://dartpad.dev/?id=894922ccb67f5fdc4ffb652e41916fa2) without the package which requires around 800 lines of code.
## **Installation**
Run from the root of your flutter project.
```console
flutter pub add navbar_router
```
_Example_
```dart
class HomePage extends StatelessWidget {
HomePage({Key? key}) : super(key: key);
List items = [
NavbarItem(Icons.home_outlined, 'Home',
backgroundColor: mediumPurple,
selectedIcon: Icon(
Icons.home,
size: 26,
)),
NavbarItem(Icons.shopping_bag_outlined, 'Products',
backgroundColor: Colors.orange,
selectedIcon: Icon(
Icons.shopping_bag,
size: 26,
)),
NavbarItem(Icons.person_outline, 'Me',
backgroundColor: Colors.teal,
selectedIcon: Icon(
Icons.person,
size: 26,
)),
];
final Map> _routes = const {
0: {
'/': HomeFeeds(),
FeedDetail.route: FeedDetail(),
},
1: {
'/': ProductList(),
ProductDetail.route: ProductDetail(),
},
2: {
'/': UserProfile(),
ProfileEdit.route: ProfileEdit(),
},
};
@override
Widget build(BuildContext context) {
return NavbarRouter(
errorBuilder: (context) {
return const Center(child: Text('Error 404'));
},
onBackButtonPressed: (isExiting) {
return isExiting;
},
destinationAnimationCurve: Curves.fastOutSlowIn,
destinationAnimationDuration: 600,
decoration:
NavbarDecoration(navbarType: BottomNavigationBarType.shifting),
destinations: [
for (int i = 0; i < items.length; i++)
DestinationRouter(
navbarItem: items[i],
destinations: [
for (int j = 0; j < _routes[i]!.keys.length; j++)
Destination(
route: _routes[i]!.keys.elementAt(j),
widget: _routes[i]!.values.elementAt(j),
),
],
initialRoute: _routes[i]!.keys.first,
),
],
);
}
}
```
# Features Breakdown
## Remembers NavigationBar history (for Android Devices)
When the selected NavbarItem is at the root of the navigation stack, pressing the Back button (On Android) will by default trigger app exit.
For instance:
Your app has three tabs and you navigate from Tab1 -> Tab2 -> Tab3
- `BackButtonBehavior.exit` (default)
when you press Back Button (on Tab3) your app will exit
- `BackButtonBehavior.rememberHistory`,
This will switch the navbar current index to the last selected NavbarItem (Tab 2) from the navbarHistory.
You can read [more about this feature here.](https://github.com/maheshmnj/navbar_router/issues/9#issuecomment-1211569478)
## Fading between NavbarDestinations
You can have smooth Transitions between NavbarDestinations by setting the `destinationAnimationCurve` and `destinationAnimationDuration` properties.
defaults to
```dart
destinationAnimationCurve: Curves.fastOutSlowIn,
destinationAnimationDuration: 300,
```
## Hide or show bottomNavigationBar
You can hide or show bottom navigationBar with a single line of code from anywhere in the widget tree. This allows you to handle useCases like scroll down to hide the navbar or hide the navbar on opening the drawer.
```dart
NavbarNotifier.hideBottomNavBar = true;
```
| Hide/show navbar on scroll | Hide/show navbar on drawer open/close | Consistent behavior across all Navbars |
| :---------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: |
|  | 
|  |
## Show Snackbar
You can show a snackbar on top of the navbar by using the `NavbarNotifier.showSnackBar` method.
```dart
NavbarNotifier.showSnackBar(
context,
"This is shown on top of the Floating Action Button",
/// offset from bottom of the screen
bottom: state.hasFloatingActionButton ? 0 : kNavbarHeight,
);
```
And hide it using the `NavbarNotifier.hideSnackBar` method.
```dart
NavbarNotifier.hideSnackBar(context);
```
## Intercept BackButton press events (Android)
_navbar_router_ provides a `onBackButtonPressed` callback to intercept events from android back button, giving you the ability to handle app exits so as to prevent abrupt app exits without users consent. (or you might want to implement double press back button to exit).
This callback method must return `true` to exit the app and false other wise.
_sample code implementing double press back button to exit_
```dart
onBackButtonPressed: (isExitingApp) {
if (isExitingApp) {
newTime = DateTime.now();
int difference = newTime.difference(oldTime).inMilliseconds;
oldTime = newTime;
if (difference < 1000) {
hideSnackBar();
return isExitingApp;
} else {
showSnackBar();
return false;
}
} else {
return isExitingApp;
}
},
```
## Adapatable to different device Sizes
```dart
NavbarRouter(
errorBuilder: (context) {
return const Center(child: Text('Error 404'));
},
isDesktop: size.width > 600 ? true : false,
decoration: NavbarDecoration(
isExtended: size.width > 800 ? true : false,
navbarType: BottomNavigationBarType.shifting),
...
...
);
```
For detailed description of all the features and properties please visit the [documentation](https://docs.maheshjamdade.com/navbar_router)
### Curious how the navbar_router works?
Read more in a [medium blog post](https://maheshmnj.medium.com/everything-about-the-bottomnavigationbar-in-flutter-e99e5470dddb) for detailed explanation.
Youtube: [Heres a discussion](https://www.youtube.com/watch?v=IhlikgW8OY8&t=614s) I had with [Allen Wyma](https://twitter.com/fhwflutter) from Flying high with Fluter regarding this package.
## **Contribution**
Contributions are welcome! for more details on how to contribute, please see the [contributing guide](./CONTRIBUTING.md)