deep_link_navigation 0.1.2

  • Readme
  • Changelog
  • Installing
  • new48

Flutter Deep Link Navigation #

Provides an elegant abstraction for complete deep linking navigation in flutter.

Orchestrates a native flutter navigator in the background.

Getting Started #

Please refer to the examples folder.

Features #

  • DeepLinkNavigator mirrors native Navigator interface, also accessible through context
  • DeepLinkNavigator.navigateTo navigates to ANY route in the hierarchy
  • Doesn't interfere with native dialogs, selects, and popups
  • Custom mixins add provide custom logic on a deep link basis (see multiple_base_routes example)
  • Animates transitions between routes as if navigation was done natively
  • TODO: enumarate others

Limitations #

  • Can't currently define arbitrarily deep navigation hierarchies (think Spotify)
  • Can't store separate persisted navigation states for a multi-base route application (think Instagram)
  • Can't type DeepLinkDispatcher.value(_, value, __) due to recursive nature of navigation hierarchy definition

What's left to do #

[x] Finish UI testing single base example [x] Animated transition for pushes [x] Custom mixins [x] Exception handling routes [] Push with completer [x] Advanced example with multiple base routes and custom mixins [] Navigation diagrams [] Finish UI testing multi base example [] Fully clean up code, tests, and documentation [] Publish dart package [] Unit test deep link navigator logic

[0.1.2] - 2019/11/06

  • Made defaultRoute field optional

[0.1.1] - 2019/11/02

  • Initial release

Use this package as a library

1. Depend on it

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


dependencies:
  deep_link_navigation: ^0.1.2

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:deep_link_navigation/deep_link_navigation.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]
90
Overall:
Weighted score of the above. [more]
48
Learn more about scoring.

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

  • Dart: 2.6.0
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/deep_link_navigation.dart.

Run flutter format to format lib/deep_link_navigation.dart.

Format lib/src/deep_link.dart.

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

Format lib/src/deep_link_material_app.dart.

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

Fix additional 6 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/deep_link_navigator.dart (Run flutter format to format lib/src/deep_link_navigator.dart.)
  • lib/src/default_page_loader.dart (Run flutter format to format lib/src/default_page_loader.dart.)
  • lib/src/dispatchers.dart (Run flutter format to format lib/src/dispatchers.dart.)
  • lib/src/exceptions.dart (Run flutter format to format lib/src/exceptions.dart.)
  • lib/src/pop_observer.dart (Run flutter format to format lib/src/pop_observer.dart.)
  • lib/src/utils.dart (Run flutter format to format lib/src/utils.dart.)

Maintenance suggestions

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 deep_link_navigation.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.2.2 <3.0.0
after_layout ^1.0.7+2 1.0.7+2
flutter 0.0.0
provider ^3.0.0 3.1.0+1
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test