stateprovider 0.5.1

  • Readme
  • Changelog
  • Installing
  • new51

StateProvider for Flutter #

A lightweight StateProvider for handling global data. This Plugin wraps an InheritedWidget into a StreamBuilder for updating the UI if any changes appears in the InheritedWidget.

Getting Started #

1. Import stateprovider

import 'package:stateprovider/stateprovider.dart';

2. Create a Model which extends the Store class. Add your custom attributes and functions. Call notify() in every function where you want to update the state.

class MyModel extends Store<MyModel> {

  String name = "";
  int age = 0; 

  //stores only the new data but doesn't update the ui
  void setName(String name) {
    this.name = name;
  } 

  //updates the ui because of notify()
  void setAge(int age) {
    this.index = index;
    notify();
  }

}

3. Add the StatefulProvider widget in the SECOND position of your tree under MaterialApp or CupertinoApp. Add your custom Model to the StatefulProvider.

void main() => runApp(
  MaterialApp(
    home: StatefulProvider(
      store: MyModel(),
      child: PageOne(),
    ),
  )
);

4. Now inside your widget you can use your data with the StateProvider class:

StateProvider.of(context).getState<MyModel>().setAge(34)

Additional #

if you want to update the state manually use:

StateProvider.of(context).getState<MyModel>().notify()

[0.5.1] - TODO: Add release date. #

  • Refractoring

[0.5.0] - TODO: Add release date. #

  • Initial release.

Use this package as a library

1. Depend on it

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


dependencies:
  stateprovider: ^0.5.1

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:stateprovider/stateprovider.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
7
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]
51
Learn more about scoring.

We analyzed this package on Feb 26, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.5
  • Flutter: 1.12.13+hotfix.8

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 stateprovider.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
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test