Flutter Data is the seamless way to work with persistent data models in Flutter.
Inspired by Ember Data and ActiveRecord.
provider
, riverpod
and get_it
See the quickstart guide in the docs.
For a given User
model annotated with @DataRepository
β¦
@JsonSerializable()
@DataRepository([MyJSONServerAdapter])
class User with DataModel<User> {
@override
final int id;
final String name;
User({this.id, this.name});
}
mixin MyJSONServerAdapter on RemoteAdapter<User> {
@override
String get baseUrl => "https://my-json-server.typicode.com/flutterdata/demo/";
}
id
can be of int
, String
, etcUser.fromJson
and toJson
are not required!After a code-gen build, Flutter Data will generate a Repository<User>
:
// obtain it via Provider
final repository = context.watch<Repository<User>>();
return DataStateBuilder<List<User>>(
notifier: () => repository.watchAll();
builder: (context, state, notifier, _) {
if (state.isLoading) {
return CircularProgressIndicator();
}
// state.model is a list of 10 user items
return ListView.builder(
itemBuilder: (context, i) {
return UserTile(state.model[i]);
},
);
}
}
repository.watchAll()
will make an HTTP request (to https://my-json-server.typicode.com/flutterdata/demo/users
in this case), parse the incoming JSON and listen for any further changes to the User
collection β whether those are local or remote!
state
is of type DataState
which has loading/error/data substates. Moreover, notifier.reload()
is available, useful for the classic βpull-to-refreshβ scenario.
In addition to the reactivity, a User
now gets extensions and automatic relationships, ActiveRecord-style:
final todo = await Todo(title: 'Finish docs').init(context).save();
// POST https://my-json-server.typicode.com/flutterdata/demo/todos/
print(todo.id); // 201
final user = await repository.findOne(1, params: { '_embed': 'todos' });
// GET https://my-json-server.typicode.com/flutterdata/demo/users/1?_embed=todos
print(user.todos.length); // 20
await user.todos.last.delete();
For an in-depth example check out the Tutorial.
Fully functional app built with Flutter Data? See the code for the finished Flutter Data TO-DOs Sample App.
Fully compatible with the tools we know and love:
Flutter | β | It can also be used with pure Dart |
json_serializable | β | Not required! Other fromJson /toJson can be supplied |
JSON REST API | β | Great support |
JSON:API | β | Great support |
Firebase | β | Adapter coming soon π as well as Firebase Auth |
Provider | β | Not required! Configure in a few lines of code |
Riverpod | β | Not required! Configure in a few lines of code |
get_it | β | Not required! Configure in a few lines of code |
BLoC | β | Great support |
Freezed | β | Good support |
Flutter Web | β | Great support |
Hive | β | Flutter Data uses Hive internally for local storage |
Chopper/Retrofit | Not required: Flutter Data generates its own REST clients |
The new offline-first Scout Flutter app is being developed in record time with Flutter Data.
Please use Github to ask questions, open issues and send PRs. Thanks!
You can also hit me up on Twitter @thefrank06
Tests can be run with: pub run test
Author: flutterdata
Source Code: https://github.com/flutterdata/flutter_data
#flutter #dart #mobile-apps