vader_flutter 1.1.1
vader_flutter: ^1.1.1 copied to clipboard

A Flutter implementation of the Vader package with widgets and Provider wrap around

vader_flutter #

A Flutter implementation of the Vader package

Getting Started #

This is a Flutter package with helper classes to more convenient integration with Vader - runtime dependency injection library for Dart.

It's wrap around Provider package. And provides ModuleInjector and DependentWidget Widgets to manage your project dependencies.

And you can ask Why not just using a Provider? The first, Provider is a great package for maintain reactive interactions between different widgets. And I strongly recommend using it for that purpose. But using it just for a Dependency Injection pattern is resulting in writing too much code, because of Widget nature of Provider. So in my projects I need a fast and convenient way to define a lot of services, repositories, BloCs(Business Logic Components), etc 'static components' to receive it from any point of a Flutter app. Note, that Vader not listening on all dependencies like a Provider. And it's use case just to define and pass static 'business logic' dependencies. It's only listening on DiContainer and rebuilds ModuleInjector's subtree only if the parent DiContainer changes, because it passes through app via a Provider.

Basic Usage #

A ModuleInjector is just a Widget wrapper around a DiContainer vader class. It is an abstract, so you need to subclass it to override a configure(DiContainer) build(BuildContext) methods. The first one is just defines dependencies via DiContainer (see Vader) for the subtree building from build(BuildContext) method.

A DependentWidget is just a receiver of your dependencies, defined in the ModuleInjector. So in the builder parameter you need to pass a factory function that builds a child widget with this dependencies. It's very similar to Provider's Consumer widget but without any context or other widget parameters to avoid boilerplate code with _ and __ arguments.

A NavigatorModule widget adds convenient and flexible way to create a nested Navigator with it's own context. You can combine it with ModuleInjector and get independent module with it's own dependencies. Note that if you want to use a Hero you in the nested Navigator - you need to add a HeroController to observers parameter in Navigator or NavigatorModule.

Tired of a boring builder and factory writings for Widgets? Look at InjectableWidget<T>. It just resolves and builds as child configured earlier Widget of type T

Example #

import 'package:flutter/material.dart';
import 'package:vader_di/vader.dart';
import 'package:vader_flutter/vader_flutter.dart';

void main() {
  runApp(
    ModuleValueInjector<String>(
      valueToResolve: 'Hello world',
      child: DependentWidget<String>(
        builder: (val) => Text(val.toString()),
      ),
    )
  );
}

class TestableWidget<T extends Object> extends StatelessWidget {
  final T valueToResolve;

  const TestableWidget({
    Key key,
    this.valueToResolve
  }) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return ModuleValueInjector(
      valueToResolve: valueToResolve,
      child: DependentWidget<T>(
        builder: (val) => Text(val.toString()),
      ),
    );
  }
}

class ModuleValueInjector<T> extends ModuleInjector {
  final Widget child;
  final T valueToResolve;

  ModuleValueInjector({
    Key key,
    @required this.child,
    @required this.valueToResolve
  }) : super(key: key);

  @override
  void configure(DiContainer container) {
    container.bind<T>().toValue(valueToResolve);
  }
}
4
likes
90
pub points
28%
popularity

A Flutter implementation of the Vader package with widgets and Provider wrap around

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

abramov.denis163@gmail.com

License

LICENSE

Dependencies

flutter, meta, provider, vader_di

More

Packages that depend on vader_flutter