Skip to content

flutterdata/flutter_data

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

Flutter Data

tests codecov pub.dev license

Persistent reactive models in Flutter with zero boilerplate

Flutter Data is an offline-first persistence framework that provides a powerful convention-over-configuration REST client and model relationships. Inspired by Ember Data and ActiveRecord.

Features

  • Repositories for all models 🚀
  • Built for offline-first 🔌
    • Hive-based local storage at its core
    • Failure handling & retry API
  • Intuitive APIs, effortless setup 💙
    • Truly configurable and composable via Dart mixins and codegen
    • Built-in Riverpod providers for all models
  • Exceptional relationship support ⚡️
    • Automatically synchronized, fully traversable relationship graph
    • Reactive relationships

Check out the Tutorial 📚 where we build a TO-DO app from the ground up in record time.

👩🏾‍💻 Usage

(See the quickstart guide for setup and boot configuration.)

For a given User model annotated with @DataRepository:

@JsonSerializable()
@DataRepository([MyJSONServerAdapter])
class User extends DataModel<User> {
  @override
  final int? id; // ID can be of any type
  final String name;
  User({this.id, required this.name});
  // `User.fromJson` and `toJson` optional
}

mixin MyJSONServerAdapter on RemoteAdapter<User> {
  @override
  String get baseUrl => "https://my-json-server.typicode.com/flutterdata/demo/";
}

After a code-gen build, Flutter Data will generate a Repository<User> (and shortcuts like ref.users for Riverpod):

@override
Widget build(BuildContext context, WidgetRef ref) {
  final state = ref.users.watchOne(1);
  if (state.isLoading) {
    return Center(child: const CircularProgressIndicator());
  }
  final user = state.model;
  return Text(user.name);
}

Update the user:

TextButton(
  onPressed: () => ref.users.save(User(id: 1, name: 'Updated')),
  child: Text('Update'),
),

ref.users.watchOne(1) will make a background HTTP request (to https://my-json-server.typicode.com/flutterdata/demo/users/1 in this case), deserialize data and listen for any further changes to the User – whether those are local or remote!

state is of type DataState which has loading, error and data substates.

In addition to the reactivity, DataModels get extensions and automatic relationships, ActiveRecord-style, so the above becomes:

GestureDetector(
  onTap: () => User(id: 1, name: 'Updated').save(),
  child: Text('Update')
),

More examples:

final todo = await Todo(title: 'Finish docs').save();
// or its equivalent:
final todo = await ref.todos.save(Todo(title: 'Finish docs'));
// POST https://my-json-server.typicode.com/flutterdata/demo/todos/
print(todo.id); // 201

final user = await repository.findOne(1, params: {'_embed': 'todos'});
// (remember repository can be accessed via ref.users)
// GET https://my-json-server.typicode.com/flutterdata/demo/users/1?_embed=todos
print(user.todos.length); // 20

await user.todos.last.delete();

Explore the Documentation.

Compatibility

Fully compatible with the tools we know and love:

Flutter And pure Dart, too.
Flutter Web Supported!
json_serializable Fully supported (but not required)
Riverpod Supported & automatically wired up
Provider Supported with minimal extra code
get_it Supported with minimal extra code
Classic JSON REST API Built-in support!
JSON:API Supported via external adapter
Freezed Supported!

📲 Apps using Flutter Data in production

logos

Questions and collaborating

Please use Github to ask questions, open issues and send PRs. Thanks!

On Twitter: @flutterdata

Tests can be run with: pub run test

📝 License

See LICENSE.

About

Seamlessly manage persistent data in your Flutter apps

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages