flutter_observable 0.2.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 71

flutter_observable #

A simple observable with corresponding controller and builder.

Use this package when you want to build widgets that builds whenever an external value is changed.

Usage #

The following code demonstrates a simple click-counter app with the state stored outside of the widget.

import 'package:flutter_observable/flutter_observable.dart';
import 'package:flutter/material.dart';

///
/// This is a global variable here, but should probably come from a provider.
///
final clicksController = ObservableController(0);
final clicksObservable = clicksController.observable;

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      home: Scaffold(
        appBar: AppBar(title: Text('Flutter counter demo')),

        ///
        /// Here we are using the `ObservableBuilder` to re-build the view whenever the count is changed.
        ///
        /// It listens to the specified `Observable` and re-builds whenever there is a new value set.
        ///
        body: ObservableBuilder(
          observable: clicksObservable,
          builder: (context, snapshot) {
            return Center(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: <Widget>[
                  Text(
                    'You have pushed the button this many times:',
                  ),
                  Text(
                    '${snapshot.data}',
                    style: Theme.of(context).textTheme.display1,
                  ),
                ],
              ),
            );
          },
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            ///
            /// When the button is pressed, we increment the value of the observable by one.
            ///
            /// This will automatically trigger a re-build of the `ObservableBuilder` above.
            ///
            clicksController.value += 1;
          },
          tooltip: 'Increment',
          child: Icon(Icons.add),
        ),
      ),
    );
  }
}

0.2.0 #

  • 💥 Provide the value directly to the builder function

    Migration Guide:

    Instead of receiving an AsyncSnapshot<T> as it's second argument, the builder function will now receive the value, T, directly. Update your builder functions accordingly.

0.1.1 #

  • 🎉 Add a constructor to Observable from stream & initial value

0.1.0 #

  • 🎉 Add initial implementation

example/README.md

flutter_observable_example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_observable: ^0.2.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:flutter_observable/flutter_observable.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
41
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
71
Learn more about scoring.

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

  • Dart: 2.6.1
  • 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/flutter_observable.dart.

Run flutter format to format lib/flutter_observable.dart.

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.7 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test