riverpod_offline

Description:

riverpod offline

Persist riverpod state offline using Hive
Features #
✅ Persist state even when app is killed
✅ Debounce I/O disk operations to improve performances
❌ Support other stores than Hive
Getting started #
Make sure to init Hive before using this package:
Hive.initFlutter();
copied to clipboard
Usage #

Define a state class:

part 'counter_state.freezed.dart';
part 'counter_state.g.dart';

@freezed
class CountersState with _$CountersState implements Serializable {
const factory CountersState({
@Default(0) int counter,
}) = _CountersState;

factory CountersState.fromJson(Map<String, dynamic> json) =>
_$CountersStateFromJson(json);
}
copied to clipboard

Write your provider:

part 'counter_provider.g.dart';

@riverpod
class Counter extends _$Counter with PersistedState<CounterState> {
@override
String get boxName => 'Counter';

@override
CountersState fromJson(Map<String, dynamic> json) =>
CountersState.fromJson(json);

@override
CountersState build() {
// Load previous persisted state from disk
loadPersistedState();
return const CountersState();
}

// Add any state mutations below
increment() {
state = state.copyWith(counter: state.counter + 1);
}
}
copied to clipboard

Use the provider like you usually do:

// Rebuilds UI everytime counter changes
final state = ref.watch(counterProvider.select((s) => s.counter));
print(state.counter);
copied to clipboard
If you don't want to use code generation, you can also use the following syntax:
class CounterNotifier extends PersistedNotifier<CounterState> {
CounterNotifier({
required super.boxName,
required super.defaultState,
required super.fromJson,
});

// Add any state mutations below
increment() {
state = state.copyWith(counter: state.counter + 1);
}
}

final counterProvider = NotifierProvider<CounterNotifier, CounterState>(
() => CounterNotifier(
boxName: 'Counter',
defaultState: const CounterState(length: 0),
fromJson: CounterState.fromJson,
),
);
copied to clipboard