easy_router 0.9.4

  • Readme
  • Changelog
  • Installing
  • new40

Language: English | 中文简体

easy_router #

License Pub support

A Simple Flutter Page Jump Router

Get started #

1. Add dependency #

dependencies:
  easy_router: 0.9.4  #latest version

2. How to use #

2.1. Add EasyRoutePathAnnotation annotation #

//True means that the parameter is required, and the constructor that passes the 
//EasyRouteParam parameter must be added.
@EasyRoutePathAnnotation("pageA", true)
class PageA extends StatelessWidget {
  final EasyRouteParam param;

  PageA(this.param);

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Page A"),
      ),
      body: Container(
        alignment: Alignment.center,
        child: Text("param:${param["key"]}"),
      ),
    );
  }
}

//False means no parameters are required, no need to add a constructor that passes the 
//EasyRouteParam parameter
@EasyRoutePathAnnotation("pageB", false)
class PageB extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Page B"),
      ),
      body: Container(
        alignment: Alignment.center,
        child: Text("no param"),
      ),
    );
  }
}

2.2. Add router annotations #

Use @EasyRouterAnnotation() to annotate the custom class before you can generate the relevant code with the command, for example

@EasyRouterAnnotation()
class Router {
  
}

2.3. Generate code #

cd to your app module and execute the command

flutter packages pub run build_runner build --delete-conflicting-outputs

It is recommended to clean up the previous code before building

flutter packages pub run build_runner clean

2.4. Display page #

onPressed: () {
    Navigator.of(context).push(
        MaterialPageRoute(
            builder: (context) {
                return EasyRouter.instance.getWidget("pageA", {"key": "a"});
                //or
                //return EasyRouter.instance.getWidget("pageB");
            },
        ),
    );
}

Recommend wrapping EasyRouter, refer to router.dart in demo

To learn how to generate code using source_gen, check out My Blog

Plugins #

PluginsStatus
source_genPub
build_configPub
mustache4dartPub

License #

the license is MIT

0.9.3 #

  • demo中的router.dart文件的Router类增加了一个方便使用的跳转方法 (The Router class of the router.dart file in the demo adds a convenient jump method.)
  • 页面参数变为可选了 (Page parameters become optional)

0.9.2 #

  • 修改文档 (modify document)

0.9.1 #

  • 修改注释 (modify note)

0.9.0 #

  • 首次发版 (first publish)

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  easy_router: ^0.9.4

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:easy_router/easy_router.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
50
Overall:
Weighted score of the above. [more]
40
Learn more about scoring.

We analyzed this package on Oct 9, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/easy_router.dart.

Run flutter format to format lib/easy_router.dart.

Format lib/src/builder.dart.

Run flutter format to format lib/src/builder.dart.

Format lib/src/generate_code_template.dart.

Run flutter format to format lib/src/generate_code_template.dart.

Format lib/src/generator_param.dart.

Run flutter format to format lib/src/generator_param.dart.

Format lib/src/generator_router.dart.

Run flutter format to format lib/src/generator_router.dart.

Maintenance issues and suggestions

The description contains too many non-ASCII characters. (-20 points)

The site uses English as its primary language. The value of the description field in your package's pubspec.yaml field should primarily contain characters used in English.

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and easy_router.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
mustache4dart ^3.0.0-dev.1.0 3.0.0-dev.1.0
source_gen ^0.9.4+4 0.9.4+5
Transitive dependencies
analyzer 0.37.1+1 0.38.5
args 1.5.2
async 2.4.0
build 1.1.6 1.2.0
build_config 0.4.1+1
build_daemon 2.1.0
build_resolvers 1.1.1
build_runner 1.6.9 1.7.1
build_runner_core 3.1.1 4.1.0
built_collection 4.2.2
built_value 6.7.1
charcode 1.1.2
checked_yaml 1.0.2
code_builder 3.2.0
collection 1.14.11 1.14.12
convert 2.1.1
crypto 2.1.3
csslib 0.16.1
dart_style 1.2.10 1.3.1
fixnum 0.10.9
front_end 0.1.21+1 0.1.27
glob 1.1.7
graphs 0.2.0
html 0.14.0+3
http 0.12.0+2
http_multi_server 2.1.0
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
json_annotation 3.0.0
kernel 0.3.21+1 0.3.27
logging 0.11.3+2
matcher 0.12.5
meta 1.1.7
mime 0.9.6+3
package_config 1.1.0
package_resolver 1.0.10
path 1.6.4
pedantic 1.8.0+1
pool 1.4.0
pub_semver 1.4.2
pubspec_parse 0.1.5
quiver 2.0.5
reflectable 2.1.0
shelf 0.7.5
shelf_web_socket 0.2.3
sky_engine 0.0.99
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
stream_transform 0.0.19
string_scanner 1.0.5
term_glyph 1.1.0
timing 0.1.1+2
typed_data 1.1.6
vector_math 2.0.8
watcher 0.9.7+12
web_socket_channel 1.0.15
yaml 2.2.0