docs: add paginated-query section and update optimistc update section
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Optimistic Updates (Still WIP)
|
||||
title: Optimistic Updates
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
@@ -34,6 +34,7 @@ return MutationBuilder(
|
||||
return MutationBuilder(
|
||||
job: mutationJob,
|
||||
onMutate: (variable) {
|
||||
final data = QueryBowl.of(context).getQuery(successJob.queryKey)?.data;
|
||||
QueryBowl.of(context)
|
||||
.setQueryData<Map<String, dynamic>, void>(successJob.queryKey, (oldData) {
|
||||
// replacing the soon to be expired data with updated data
|
||||
@@ -44,6 +45,15 @@ return MutationBuilder(
|
||||
// of the intended query data which can be used when
|
||||
// an error occurs in mutation & we can rollback to a previous
|
||||
// data set
|
||||
return data;
|
||||
},
|
||||
onData: (data, variables, context) {
|
||||
print("Passed Variable: $variables");
|
||||
print("Safe Previous Value: $context");
|
||||
},
|
||||
onError: (data, variables, context) {
|
||||
print("Passed Variable: $variables");
|
||||
print("Safe Previous Value: $context");
|
||||
}
|
||||
);
|
||||
```
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
title: Paginated/Lagged Query
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
|
||||
Rendering paginated data is a very common UI pattern and in Fl-Query, it "just works" by including the page information in the query key:
|
||||
|
||||
```dart
|
||||
final queryVariableKeyJob = QueryJob.withVariableKey<String, void>(
|
||||
task: (queryKey, externalData) {
|
||||
return MyAPI.getData(id: getVariable(queryKey));
|
||||
},
|
||||
);
|
||||
|
||||
/// inside a widget build method
|
||||
QueryBuilder(
|
||||
job: queryVariableKeyJob(id),
|
||||
externalData: null,
|
||||
builder: (context, query){...}
|
||||
)
|
||||
```
|
||||
|
||||
However, if you run this simple example, you might notice something strange:
|
||||
|
||||
**The UI jumps in and out of the `success` and `loading` states because each new page is treated like a brand new query.**
|
||||
|
||||
This experience is not optimal and unfortunately is how many tools today insist on working. But not Fl-Query! As you may have guessed, Fl-Query comes with an awesome feature called `keepPreviousData` that allows us to get around this.
|
||||
|
||||
## Better Paginated Queries with `keepPreviousData`
|
||||
|
||||
Consider the following example where we would ideally want to increment a pageIndex (or cursor) for a query. If we were to use just `QueryJob.withVariableKey`, **it would still technically work fine**, but the UI would jump in and out of the `success` and `loading` states as different queries are created and destroyed for each page or cursor. By setting `keepPreviousData` to `true` we get a few new things:
|
||||
|
||||
- **The data from the last successful fetch available while new data is being requested, even though the query key has changed**.
|
||||
- When the new data arrives, the previous `data` is seamlessly swapped to show the new data.
|
||||
- `isPreviousData` is made available to know what data the query is currently providing you
|
||||
|
||||
```dart
|
||||
final todoJob = QueryJob.withVariableKey<Map, void>(
|
||||
preQueryKey: "todo",
|
||||
task: (queryKey, _) async {
|
||||
final res = await http.get(
|
||||
Uri.parse(
|
||||
"https://jsonplaceholder.typicode.com/todos/${getVariable(queryKey)}"),
|
||||
);
|
||||
return jsonDecode(res.body);
|
||||
},
|
||||
keepPreviousData: true,
|
||||
);
|
||||
|
||||
class QueryPreviousDataExample extends StatefulWidget {
|
||||
const QueryPreviousDataExample({Key? key}) : super(key: key);
|
||||
|
||||
@override
|
||||
State<QueryPreviousDataExample> createState() =>
|
||||
_QueryPreviousDataExampleState();
|
||||
}
|
||||
|
||||
class _QueryPreviousDataExampleState extends State<QueryPreviousDataExample> {
|
||||
int id = 1;
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Column(
|
||||
crossAxisAlignment: CrossAxisAlignment.start,
|
||||
children: [
|
||||
QueryBuilder(
|
||||
job: todoJob(id.toString()),
|
||||
externalData: null,
|
||||
builder: (context, query) {
|
||||
if (query.hasError) return Text(query.error.toString());
|
||||
if (!query.hasData) return const CircularProgressIndicator();
|
||||
return Text(jsonEncode(query.data ?? {}));
|
||||
}),
|
||||
Row(
|
||||
children: [
|
||||
IconButton(
|
||||
icon: const Icon(Icons.remove),
|
||||
onPressed: () {
|
||||
setState(() {
|
||||
id -= 1;
|
||||
});
|
||||
},
|
||||
),
|
||||
IconButton(
|
||||
icon: const Icon(Icons.add),
|
||||
onPressed: () {
|
||||
setState(() {
|
||||
id += 1;
|
||||
});
|
||||
},
|
||||
),
|
||||
],
|
||||
)
|
||||
],
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -9,7 +9,7 @@ Fl-Query is just another Flutter "package" so no extra installation step needed
|
||||
$ flutter pub add fl_query
|
||||
```
|
||||
|
||||
### For using with `flutter_hooks`
|
||||
### Using with `flutter_hooks`
|
||||
|
||||
If you're an ELITE `flutter_hooks` user or want to use `fl_query_hooks` you'll need the `flutter_hooks` & `fl_query_hooks` package
|
||||
|
||||
|
||||
Reference in New Issue
Block a user