R?f?rence API
This page summarizes commonly used classes et methods de miniriverpod_core.dart et miniriverpod_flutter.dart.
types de base
noyau state et provider primitives.
AsyncValue<T>
AsyncLoading / AsyncData / AsyncError
Provider<T>
Synchronous provider avec optional autoDispose
AsyncProvider<T>
Asynchronous provider avec .future selector
Reading tip
AsyncValue does not include a when method; use switch pattern matching ou is checks.
Ref et ProviderContainer Methods
Common operational methods pour refresh, invalidation, lifecycle, et mutation execution.
S?quence courante
ref.invalidate(provider, keepPrevious: true);
Carte des m?thodes
read / watch / listen : read and subscribe to providers.
invalidate / refresh / refreshValue : recompute state.
onDispose / keepAlive / emit : lifecycle and stream wiring.
mutation / mutate / invoke : tracked write operations.
scope / overrideWithValue : DI and testing overrides.
Flutter API Snapshot
ProviderScope + WidgetRef entry points used dans application code.
flutter_usage.dart
// Scope
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');
}
}
// Mutation execution
await ref.invoke(userProvider.rename('Alice'));
ProviderScope(container: external) requires manual container.dispose().
UncontrolledProviderScope never disposes injected container.
Consumer, ConsumerWidget, et ConsumerStatefulWidget are all supported.