Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fluttercandies/nav_router
flutter The lightest, easiest and most convenient route management!
https://github.com/fluttercandies/nav_router
flutter flutter-plugin flutter-widget
Last synced: about 1 month ago
JSON representation
flutter The lightest, easiest and most convenient route management!
- Host: GitHub
- URL: https://github.com/fluttercandies/nav_router
- Owner: fluttercandies
- License: apache-2.0
- Created: 2019-12-04T01:29:01.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T10:13:49.000Z (5 months ago)
- Last Synced: 2024-06-24T11:47:14.851Z (5 months ago)
- Topics: flutter, flutter-plugin, flutter-widget
- Language: Dart
- Homepage:
- Size: 8.16 MB
- Stars: 103
- Watchers: 8
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Language: [English](README.md) | [中文简体](README_ZH.md)
[](https://github.com/fluttercandies/nav_router/stargazers)
[](https://github.com/fluttercandies/nav_router/network)
[](https://github.com/fluttercandies/nav_router/issues)
# nav_router
nav_router is the simplest / lightweight / convenient routing management solution for flutter. It supports various routing animations, and it is very convenient to jump / pass parameters. To jump to a new page, just routePush (NewPage ());
# Log
* 2021.03.25 - Migrating to `nullSafety`
* 2020.07.04 - Test Flutter 1.17.3
* 2020.06.03 - Cancel pop default empty string data
* 2020.02.28 - Fix pop method of dev branch flutter error.
## Getting started
### Add dependency
```yaml
dependencies:
nav_router: ^1.0.0
```
> Related articles updated ...
Then use `flutter packages upgrade` to update flutter plugin packages
# Sample project
There is a pretty sweet example project in the example folder. Check it out. Otherwise, keep reading to get up and running.
# Setting up
* 1.Import our plugin on the page of `MaterialApp`
```dart
import 'package:nav_router/nav_router.dart';
```
* 2.Write `navGK` value in` navigatorKey` property of `MaterialApp`
```dart
Widget build(BuildContext context) {
return new MaterialApp(
title: '',
navigatorKey: navGK,
);
}
```
* 3.Then, we can start using it, here is an example of a jump page
```dart
Widget buildItem(RouteModel item) {
return new FlatButton(
onPressed: () => routePush(new NewPage()),
child: new Text('Click to jump'),
);
}
```
* 4.If we want to use other routing animations to jump, we can add jump properties later, such as: gradient animation
```dart
routePush(new NewPage(), RouterType.fade);
```
# Parameter passing
## Way 1：
Normally push the new page, but add Then at the back, the v behind is the data brought back by the page after we jump, and then we print it out.
```dart
routePush(NewPage()).then((v) {
print('I received::$v');
});
```
Then our new page will pop the return value. Add our parameters directly in the pop and then the brackets. It can be any type of parameter value. After that, what we wrote above will receive the parameters we returned this time with the past.
```dart
FlatButton(
onPressed: () {
pop('This is the parameter');
},
child: Text('Return with parameters'),
),
```
## Way 2：
Method two can use our NavData, first add the NavData type parameter to the page we want to push to,
```dart
class NewPage extends StatlessWidget {
final NavData navData;
NewPage({this.navData});
}
```
Then the following judges whether the navData is empty, that is, whether the superior has received this method, and if so, returns it with parameters.
```dart
FlatButton(
onPressed: () {
if(navData == null) return;
widget.navData('NavData mode parameter transmission');
pop();
},
child: Text('Return with parameters'),
),
```
Then the place where we push can use navData to receive the value and print it out.
```dart
routePush(NewPage(navData: (v) {
print('I received::$v');
}),
);
```
# Effect map [图片不能显示点我](http://img.flutterj.com/nav_router/)
||  | |
| --- | --- | --- |
||  | |
||  | |
||  | |
# Flutter WeChat group
[Above can't show my point](git/left_group.png)
FlutterJ：www.flutterj.com
# Contributor
* author: crazyQ1 [https://github.com/ahyangnb](https://github.com/ahyangnb)
* migrator: dwikyhardi [github.com/dwikyhardi](github.com/dwikyhardi)
### LICENSE
```
fluttercandies/nav_router is licensed under the
Apache License 2.0
A permissive license whose main conditions require preservation of copyright and license notices.
Contributors provide an express grant of patent rights.
Licensed works, modifications, and larger works may be distributed under different terms and without source code.
```