Rujukan API pantas untuk kerja harian.
Halaman ini merangkum kelas dan kaedah yang paling kerap digunakan daripada miniriverpod_core.dart dan miniriverpod_flutter.dart.
Jenis teras
State teras dan primitive provider.
AsyncValue<T>
AsyncLoading / AsyncData / AsyncError
Provider<T>
Provider segerak dengan autoDispose pilihan
AsyncProvider<T>
Provider tak segerak dengan pemilih .future
Petua bacaan
AsyncValue tidak menyertakan kaedah when; gunakan switch pattern matching atau semakan is.
Kaedah Ref dan ProviderContainer
Kaedah operasi biasa untuk refresh, invalidation, lifecycle, dan pelaksanaan mutation.
Urutan biasa
Peta kaedah
read / watch / listen : baca dan langgan provider.
invalidate / refresh / refreshValue : kira semula state.
onDispose / keepAlive / emit : sambungan lifecycle dan stream.
mutation / mutate / invoke : operasi tulis yang dijejak.
scope / overrideWithValue : override untuk DI dan ujian.
Ringkasan API Flutter
Titik masuk ProviderScope dan WidgetRef yang digunakan dalam kod aplikasi.
// Skop
ProviderScope(
child: const App(),
);
// ConsumerWidget
class Header extends ConsumerWidget {
const Header({super.key});
@override
Widget build(BuildContext context, WidgetRef ref) {
final user = ref.watch(currentUser);
return Text('$user');
}
}
// Pelaksanaan mutation
await ref.invoke(userProvider.rename('Alice'));
ProviderScope(container: external) memerlukan container.dispose() secara manual.
UncontrolledProviderScope tidak pernah memanggil dispose pada container yang disuntik.
Consumer, ConsumerWidget, dan ConsumerStatefulWidget semuanya disokong.