active_observers 0.7.0

  • Readme
  • Changelog
  • Installing
  • 48

active_observers #

Build Status

A new way to create composable UI logic, inspired by React hooks.

Getting Started #

import 'package:active_observers/active_observers.dart'; // 1.import package

class TestObserveState extends StatefulWidget with DetailedLifecyleInState {  // mixin is optional
  TestObserveState(this.stream);
  
  final Stream<String> stream;

  @override
  _TestObserveStateState createState() => _TestObserveStateState();
}

class _TestObserveStateState extends State<TestObserveState>
    with ActiveObservers { // 2. Add a mixin to your State
  @override
  assembleActiveObservers() {
    // 3. Setup active observers in assembleActiveObservers
    // codes in this method will be executed on hot reload
    observeUpdate(()=> widget.stream.listen((v){
      // subscription will be automatically restarted when any value in values updates
      setState((){
        value = v;
      });
    }).cancel, values: ()=> [widget.stream]);
  }

  String value;

  @override
  Widget build(BuildContext context) {
    return Text(value, textDirection: TextDirection.ltr);
  }
}

Under construction.

Please refer to ./test/src for more active observers.

[0.0.1]

  • initial release

[0.1.0]

  • Add ActiveObserver interface

[0.1.1]

  • Add observeStream

[0.1.2]

  • Add observeListenable & observeValueListenableState

[0.2.0]

  • Add dependency update detection logic

[0.3.0]

  • Major rewrite
  • Remove dependencies other than Flutter
  • Active observers should be called in State's constructor

[0.3.1]

  • Make active observers run in the expected order

[0.3.2]

  • Always restart effect on reassemble

[0.3.3]

  • Add assembleActiveObservers slot

[0.3.4]

  • Clean active observers on reassemble
  • Now all active observers must be placed in assembleActiveObservers

[0.4.0]

  • Use implicit this in active observers

[0.4.1]

  • Mark assembleActiveObservers as virtual

[0.5.0]

  • Update observeLifecycle interface

[0.5.1]

  • Add example

[0.6.0]

  • Add didSetState lifecycle
  • observeEffect now receive a function to decide when to restart
  • observeEffect now may restart effect in setState
  • Add observePaint observer

[0.7.0]

  • Add observeContext and observeInheritedWidget
  • Remove some observers
  • Rename observeEffect to observeUpdate
  • Adjust reassemble order
  • Add optional widget mixin DetailedLifecycleInstate
  • Improve performance

Use this package as a library

1. Depend on it

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


dependencies:
  active_observers: ^0.7.0

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:active_observers/active_observers.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 Oct 21, 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.

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 active_observers.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
collection ^1.14.11 1.14.11 1.14.12
flutter 0.0.0
Transitive dependencies
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test