Fetching State
A small package that helps easily to work with UI changes base on the state of fetching remote data
Features
- Get rid of
if
else
statements in UI when state change. Hence, cleaner UI code - Decide what to display when fetching remote data in 4 states
[init, loading,done, error, loadingMore]
- Option to pass the data or error objects in
onDone
andonError
Getting started
Installing the library:
Like any other package, add the library to your pubspec.yaml dependencies:
dependencies:
fetching_state:
Then import it wherever you want to use it:
import 'package:fetching_state/fetching_state.dart';
Usage
see full example in example
folder
1 . FetchingState
Future<void> getDone() async {
setState(() {
_fetching = _fetching.copyWhenLoading();
});
await Future.delayed(const Duration(milliseconds: 500));
setState(() {
_fetching = _fetching.copyWhenDone(data: 'DONE IN STATE');
});
}
Future<void> loadMoreText() async {
setState(() {
_fetching = _fetching.copyWhenLoadingMore();
});
await Future.delayed(const Duration(milliseconds: 500));
if (_fetching.data == null) {
setState(() {
_fetching = _fetching.copyWhenError(error: 'No current data');
});
return;
}
setState(() {
_fetching =
_fetching.copyWhenDone(data: '${_fetching.data} - extra text');
});
}
Future<void> getError() async {
setState(() {
_fetching = _fetching.copyWhenLoadingMore();
});
await Future.delayed(const Duration(milliseconds: 500));
setState(() {
_fetching = _fetching.copyWhenError(error: 'Error IN STATE');
});
}
Future<void> getInit() async {
setState(() {
_fetching = _fetching.copyWhenLoadingMore();
});
await Future.delayed(const Duration(milliseconds: 500));
setState(() {
_fetching = FetchingState.init(data: '');
});
}
1.2 capture change in UI
return _fetching.when(
onInit: () => const Text(
'INIT',
style: TextStyle(color: Colors.blue),
),
onDone: (text, isLoadingMore) => Text(
'${text ?? ''} ${isLoadingMore ? '....' : ''}',
style: const TextStyle(color: Colors.green),
),
onError: (error) => Text(
error!.toString(),
style: const TextStyle(color: Colors.red),
),
onLoading: () => const CircularProgressIndicator(),
);
2. LoadStatus
declare a class with LoadStatus
mixin
class Counter with LoadStatusMixin {
final int value;
Counter(this.value);
Counter copyWith({int? value}) {
return Counter(value ?? this.value);
}
}
manipulate state
void increase() async {
setState(() {
_counter.setLoadStatusLoading();
});
await Future.delayed(const Duration(milliseconds: 500));
setState(() {
_counter = _counter.copyWith(value: _counter.value + 1);
_counter.setLoadStatusDone();
});
}
UI implement:
return _counter.whenOrElse(
onLoading: () => const CircularProgressIndicator(),
onDone: (_) => Text(_counter.value.toString()),
onInit: () => const Text('Init'),
onError: () => const Text('Error'),
orElse: () => const Text('Nothing'),
);
Appreciate Your Feedbacks
If you find anything need to be improve or want to request a feature. Please go ahead and create an issue in the Github repo
Libraries
- fetching_state
- A small package that helps easily to work with UI changes base on the state of fetching remote data