riverpod-hooks-patterns

Riverpod + flutter_hooks Patterns — flutter_core_modules

This package uses hooks_riverpod (v3.x) + flutter_hooks (v0.21.x). Every widget that needs either Riverpod or hooks extends HookConsumerWidget. Every widget that needs only hooks extends HookWidget.

---

1. Provider Type Selection Guide

Use Case	Provider Type	Example in Codebase
Sync read-only value	Provider	sharedPreferencesProvider, amplitudeProvider
Sync read-only, dispose when unused	Provider.autoDispose	cacheRepositoryProvider, getBoolUsecaseProvider
Parameterized provider	Provider.family	navigatiorKeyProvider
Mutable state, no async	StateNotifierProvider	themeStateNotifierProvider, hapticFeedbackStateNotifierProvider
Mutable state, dispose when unused	StateNotifierProvider.autoDispose	—
Mutable state + params	StateNotifierProvider.autoDispose.family	getDownloadUrlStateNotifierProvider, getJsonStateNotifierProvider
Derived/computed value	Provider watching another	isPremiumCustomerProvider

---

2. When to Use autoDispose

Use autoDispose for:

• Use cases (they have no state, just method calls)
• Repository implementations (stateless)
• Feature-specific state that only lives while a screen is visible

Do NOT use autoDispose for:

• Global app state: themeStateNotifierProvider, hapticFeedbackStateNotifierProvider, wakelockStateNotifierProvider
• RevenueCat: customerInfoStateNotifierProvider (persists subscription state)
• In-app review: inAppReviewStateNotifierProvider, launchFeedbackStateNotifierProvider
• Riverpod root providers: sharedPreferencesProvider (singleton)

---

3. State Flow Through Layers

UI (HookConsumerWidget)
    │
    ├── ref.watch(myStateNotifierProvider)        ← subscribe to State<F, S>
    ├── ref.read(myStateNotifierProvider.notifier) ← call methods
    └── ref.read(myUsecaseProvider)               ← direct use case access
          │
          └── StateNotifier (SafeStateNotifier subclass)
                    │
                    └── UseCase.call(...)
                              │
                              └── Repository.method(...)  ← Either<Failure, T>
                                        │
                                        └── DataSource / SDK