call autoDisposefamily AsyncNotifierProviderBuilder"AsyncNotifierProviderFamilyBuilder'AutoDisposeAsyncNotifierProviderBuilder-AutoDisposeAsyncNotifierProviderFamilyBuilderNotifierProviderBuilderNotifierProviderFamilyBuilder"AutoDisposeNotifierProviderBuilder(AutoDisposeNotifierProviderFamilyBuilderStreamNotifierProviderBuilder#StreamNotifierProviderFamilyBuilder(AutoDisposeStreamNotifierProviderBuilder.AutoDisposeStreamNotifierProviderFamilyBuilderStateProviderBuilderStateProviderFamilyBuilderStateNotifierProviderBuilder"StateNotifierProviderFamilyBuilderProviderBuilderProviderFamilyBuilderFutureProviderBuilderFutureProviderFamilyBuilderStreamProviderBuilderStreamProviderFamilyBuilderAutoDisposeStateProviderBuilder%AutoDisposeStateProviderFamilyBuilder'AutoDisposeStateNotifierProviderBuilder-AutoDisposeStateNotifierProviderFamilyBuilderAutoDisposeProviderBuilder AutoDisposeProviderFamilyBuilder AutoDisposeFutureProviderBuilder&AutoDisposeFutureProviderFamilyBuilder AutoDisposeStreamProviderBuilder&AutoDisposeStreamProviderFamilyBuilder@AsyncNotifierProvider AsyncNotifierStringIterableProviderOrFamilyname dependenciesAsyncNotifierProviderFamilyFamilyAsyncNotifier AutoDisposeAsyncNotifierProviderAutoDisposeAsyncNotifier&AutoDisposeAsyncNotifierProviderFamilyAutoDisposeFamilyAsyncNotifierNotifierProviderNotifierNotifierProviderFamilyFamilyNotifierAutoDisposeNotifierProviderAutoDisposeNotifier!AutoDisposeNotifierProviderFamilyAutoDisposeFamilyNotifierStreamNotifierProviderStreamNotifierStreamNotifierProviderFamilyFamilyStreamNotifier!AutoDisposeStreamNotifierProviderAutoDisposeStreamNotifier'AutoDisposeStreamNotifierProviderFamilyAutoDisposeFamilyStreamNotifier StateProviderStreamProviderCreateStateProviderRefFutureProviderStateProviderFamily FamilyCreateStateNotifierProvider StateNotifierStateNotifierProviderRefStateNotifierProviderFamilyProvider ProviderRefProviderFamilyFutureOrFutureProviderRefFutureProviderFamilyStreamStreamProviderRefStreamProviderFamilyAutoDisposeStateProviderAutoDisposeStateProviderRefAutoDisposeStateProviderFamily AutoDisposeStateNotifierProvider#AutoDisposeStateNotifierProviderRef&AutoDisposeStateNotifierProviderFamilyAutoDisposeProviderAutoDisposeProviderRefAutoDisposeProviderFamilyAutoDisposeFutureProviderAutoDisposeFutureProviderRefAutoDisposeFutureProviderFamilyAutoDisposeStreamProviderAutoDisposeStreamProviderRefAutoDisposeStreamProviderFamily&'m\1@ dart:async*package:state_notifier/state_notifier.dartinternals.dartS>9*-ǁOǁ=bׂ0Seʃ؃ zFն -ZжݶSYi(xȸθݸ1ֹ _ !/iѻٻFLZμּ7ƽԽf'-~@@j@p@v@@AAAnAzAAAAAB.B4BBBCCC*CRCCCCCD2DBDSDDDDE EEEzEEEEFFFQFFFFG;GHGRG^GdGGGGHH>HLHRHnHHHHHHIIInIIIIIJ JYJJJK KK!K-KBKlKKKKKKLL5L6LULLMMM@MGMsMMMMMMMNNYN]N_N`NNNNNO OIOOPPPDPKP~PPPPPPPQ,QhQlQmQQQQQQR(RSRRRRSSBSySSSTTT[TiT{TTTTTUUQUUUWUXUqUUUUUVV:VjV|VVVVVWWWWW?WnWWWWWXXXXX6XTXuXXXXYYWYiYYYYYZZZZZ7ZlZZZZZZ[['[([L[q[[[\(\/\Q\_\q\\\\\\]-]1]2]Q]|]]]]]]^#^J^K^j^^_!_3_a_h_______``B`}``````aaa(aMaaabb b+b9bKbmbtbxbybbcc c c+cVcccccccd$d%dDdydde e9e@eme{eeeeeeffUfYf[f\fffggg(gWggghhhAhOhahhhhhhii!i#i$iSiiiijjBjyjjkk kBkPkbkkkkkkkl&lYlZl~llm#mnmmmmnnn%nGnNnRnSnrnnnnno/oeoooop6puppqq q2q`qgqqqqqqqrr$rGrmrrrrssTsfssssstt ttt/t_ttttttuuFuGufuuvv/v]vdvvvvvvvvww9wewwwwxxhxzxxxxxyy%y)y*yIyyyyyyz zRzzzz{{g{y{{{{|||:|A|E|G|H|r||||}}H}}}~~~<~J~\~~~~~~~ !QD{Vdv ddM%/// Builds a [AsyncNotifierProvider].j!/// {@macro riverpod.autoDispose}/// {@macro riverpod.family}",,,44IWW _ii(a!/// {@macro riverpod.autoDispose}/C%/// Builds a [AsyncNotifierProvider].Y+/// Builds a [AsyncNotifierProviderFamily].!/// {@macro riverpod.autoDispose}WW-W Ȇ(R/// {@macro riverpod.family}HHz+/// Builds a [AsyncNotifierProviderFamily].c0/// Builds a [AutoDisposeAsyncNotifierProvider]./// {@macro riverpod.family}YY-Y ʼn(T!/// {@macro riverpod.autoDispose}11h0/// Builds a [AutoDisposeAsyncNotifierProvider].o6/// Builds a [AutoDisposeAsyncNotifierProviderFamily].jj8jԌ (e/// {@macro riverpod.family}$$a6/// Builds a [AutoDisposeAsyncNotifierProviderFamily].0C /// Builds a [NotifierProvider].!/// {@macro riverpod.autoDispose}44u/// {@macro riverpod.family}!ێ ( 77b!/// {@macro riverpod.autoDispose} /// Builds a [NotifierProvider].5RO&/// Builds a [NotifierProviderFamily].1!/// {@macro riverpod.autoDispose},ߑ %%(AYY/// {@macro riverpod.family}&/// Builds a [NotifierProviderFamily].2ܓY+/// Builds a [AutoDisposeNotifierProvider]. /// {@macro riverpod.family},ĔД (!99!/// {@macro riverpod.autoDispose}+/// Builds a [AutoDisposeNotifierProvider]. e1/// Builds a [AutoDisposeNotifierProviderFamily].7×ʗԗ  (%''/// {@macro riverpod.family}YYt1/// Builds a [AutoDisposeNotifierProviderFamily].MjO&/// Builds a [StreamNotifierProvider].ٚـ*!/// {@macro riverpod.autoDispose}||/// {@macro riverpod.family}ř# ''(Cqqd!/// {@macro riverpod.autoDispose}Ϙσ:&/// Builds a [StreamNotifierProvider].ff[,/// Builds a [StreamNotifierProviderFamily].NN!/// {@macro riverpod.autoDispose}.OOORRR\\q (ŜŁ/// {@macro riverpod.family} >,/// Builds a [StreamNotifierProviderFamily].bbe1/// Builds a [AutoDisposeStreamNotifierProvider].TT/// {@macro riverpod.family}**.*ZZZbbw (˟ˁ%!/// {@macro riverpod.autoDispose}51/// Builds a [AutoDisposeStreamNotifierProvider].jjq7/// Builds a [AutoDisposeStreamNotifierProviderFamily].DD9D (ߢ߁?/// {@macro riverpod.family}77/// Builds a [AutoDisposeStreamNotifierProviderFamily].Ƥ=/// Builds a [StateProvider].ZZ!/// {@macro riverpod.autoDispose}뜳Kc/// {@template riverpod.family} /// A group of providers that builds their value from an external parameter. /// /// Families can be useful to connect a provider with values that it doesn't /// have access to. For example: /// /// - Allowing a "title provider" access the `Locale` /// /// ```dart /// final titleFamily = Provider.family((ref, locale) { /// if (locale == const Locale('en')) { /// return 'English title'; /// } else if (locale == const Locale('fr')) { /// return 'Titre Français'; /// } /// }); /// /// // ... /// /// @override /// Widget build(BuildContext context, WidgetRef ref) { /// final locale = Localizations.localeOf(context); /// /// // Obtains the title based on the current Locale. /// // Will automatically update the title when the Locale changes. /// final title = ref.watch(titleFamily(locale)); /// /// return Text(title); /// } /// ``` /// /// - Have a "user provider" that receives the user ID as a parameter /// /// ```dart /// final userFamily = FutureProvider.family((ref, userId) async { /// final userRepository = ref.read(userRepositoryProvider); /// return await userRepository.fetch(userId); /// }); /// /// // ... /// /// @override /// Widget build(BuildContext context, WidgetRef ref) { /// int userId; // Read the user ID from somewhere /// /// // Read and potentially fetch the user with id `userId`. /// // When `userId` changes, this will automatically update the UI /// // Similarly, if two widgets tries to read `userFamily` with the same `userId` /// // then the user will be fetched only once. /// final user = ref.watch(userFamily(userId)); /// /// return user.when( /// data: (user) => Text(user.name), /// loading: () => const CircularProgressIndicator(), /// error: (err, stack) => const Text('error'), /// ); /// } /// ``` /// /// - Connect a provider with another provider without having a direct reference on it. /// /// ```dart /// final repositoryProvider = Provider.family>((ref, configurationsProvider) { /// // Read a provider without knowing what that provider is. /// final configurations = await ref.read(configurationsProvider.future); /// return Repository(host: configurations.host); /// }); /// ``` /// /// ## Usage /// /// The way families works is by adding an extra parameter to the provider. /// This parameter can then be freely used in our provider to create some state. /// /// For example, we could combine `family` with [FutureProvider] to fetch /// a `Message` from its ID: /// /// ```dart /// final messagesFamily = FutureProvider.family((ref, id) async { /// return dio.get('http://my_api.dev/messages/$id'); /// }); /// ``` /// /// Then, when using our `messagesFamily` provider, the syntax is slightly modified. /// The usual: /// /// ```dart /// Widget build(BuildContext context, WidgetRef ref) { /// // Error – messagesFamily is not a provider /// final response = ref.watch(messagesFamily); /// } /// ``` /// /// will not work anymore. /// Instead, we need to pass a parameter to `messagesFamily`: /// /// ```dart /// Widget build(BuildContext context, WidgetRef ref) { /// final response = ref.watch(messagesFamily('id')); /// } /// ``` /// /// **NOTE**: It is totally possible to use a family with different parameters /// simultaneously. For example, we could use a `titleFamily` to read both /// the french and english translations at the same time: /// /// ```dart /// @override /// Widget build(BuildContext context, WidgetRef ref) { /// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); /// final englishTitle = ref.watch(titleFamily(const Locale('en'))); /// /// return Text('fr: $frenchTitle en: $englishTitle'); /// } /// ``` /// /// # Parameter restrictions /// /// For families to work correctly, it is critical for the parameter passed to /// a provider to have a consistent `hashCode` and `==`. /// /// Ideally the parameter should either be a primitive (bool/int/double/String), /// a constant (providers), or an immutable object that override `==` and `hashCode`. /// /// /// - **PREFER** using `family` in combination with `autoDispose` if the /// parameter passed to providers is a complex object: /// /// ```dart /// final example = Provider.autoDispose.family((ref, param) { /// }); /// ``` /// /// This ensures that there is no memory leak if the parameter changed and is /// never used again. /// /// # Passing multiple parameters to a family /// /// Families have no built-in support for passing multiple values to a provider. /// /// On the other hand, that value could be _anything_ (as long as it matches with /// the restrictions mentioned previously). /// /// This includes: /// - A tuple (using `package:tuple`) /// - Objects generated with Freezed/built_value /// - Objects based on `package:equatable` /// /// This includes: /// - A tuple (using `package:tuple`) /// - Objects generated with Freezed/built_value, such as: /// ```dart /// @freezed /// abstract class MyParameter with _$MyParameter { /// factory MyParameter({ /// required int userId, /// required Locale locale, /// }) = _MyParameter; /// } /// /// final exampleProvider = Provider.family((ref, myParameter) { /// print(myParameter.userId); /// print(myParameter.locale); /// // Do something with userId/locale /// }); /// /// @override /// Widget build(BuildContext context, WidgetRef ref) { /// int userId; // Read the user ID from somewhere /// final locale = Localizations.localeOf(context); /// /// final something = ref.watch( /// exampleProvider(MyParameter(userId: userId, locale: locale)), /// ); /// } /// ``` /// /// - Objects based on `package:equatable`, such as: /// ```dart /// class MyParameter extends Equatable { /// factory MyParameter({ /// required this.userId, /// requires this.locale, /// }); /// /// final int userId; /// final Local locale; /// /// @override /// List get props => [userId, locale]; /// } /// /// final exampleProvider = Provider.family((ref, myParameter) { /// print(myParameter.userId); /// print(myParameter.locale); /// // Do something with userId/locale /// }); /// /// @override /// Widget build(BuildContext context, WidgetRef ref) { /// int userId; // Read the user ID from somewhere /// final locale = Localizations.localeOf(context); /// /// final something = ref.watch( /// exampleProvider(MyParameter(userId: userId, locale: locale)), /// ); /// } /// ``` /// {@endtemplate}...qq- (O)/// {@template riverpod.autoDispose} /// Marks the provider as automatically disposed when no longer listened to. /// /// Some typical use-cases: /// /// - Combined with [StreamProvider], this can be used as a mean to keep /// the connection with Firebase alive only when truly needed (to reduce costs). /// - Automatically reset a form state when leaving the screen. /// - Automatically retry HTTP requests that failed when the user exit and /// re-enter the screen. /// - Cancel HTTP requests if the user leaves a screen before the request completed. /// /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. /// /// The `keepAlive` function is used to tell Riverpod that the state of the provider /// should be preserved even if no longer listened to. /// /// A use-case would be to set this flag to `true` after an HTTP request have /// completed: /// /// ```dart /// final myProvider = FutureProvider.autoDispose((ref) async { /// final response = await httpClient.get(...); /// ref.keepAlive(); /// return response; /// }); /// ``` /// /// This way, if the request failed and the UI leaves the screen then re-enters /// it, then the request will be performed again. /// But if the request completed successfully, the state will be preserved /// and re-entering the screen will not trigger a new request. /// /// It can be combined with `ref.onDispose` for more advanced behaviors, such /// as cancelling pending HTTP requests when the user leaves a screen. /// For example, modifying our previous snippet and using `dio`, we would have: /// /// ```diff /// final myProvider = FutureProvider.autoDispose((ref) async { /// + final cancelToken = CancelToken(); /// + ref.onDispose(() => cancelToken.cancel()); /// /// + final response = await dio.get('path', cancelToken: cancelToken); /// - final response = await dio.get('path'); /// ref.keepAlive(); /// return response; /// }); /// ``` /// {@endtemplate}/// Builds a [StateProvider].LL1KKI#/// Builds a [StateProviderFamily].MMÀN!/// {@macro riverpod.autoDispose}L|L|L|LLLLL8LMM M MM(M2L8L8Lw/// {@macro riverpod.family}KKK#/// Builds a [StateProviderFamily].NNNNM%/// Builds a [StateNotifierProvider].PP΀Q!/// {@macro riverpod.autoDispose}QoQoQ/// {@macro riverpod.family}OTOT%OTO{O{O{OOBOPP PPP(P6NNOO!/// {@macro riverpod.autoDispose}N`N`N%/// Builds a [StateNotifierProvider].RRRURUY+/// Builds a [StateNotifierProviderFamily].TTU!/// {@macro riverpod.autoDispose}SS%SS5S5S5S<S<S<S}S}USSS SSS(TRRS /// {@macro riverpod.family}QQZR.+/// Builds a [StateNotifierProviderFamily].UUUU3/// Builds a [Provider].WWW`!/// {@macro riverpod.autoDispose}WWoW/// {@macro riverpod.family}UUUV>V>(V`VnVn VvVV(VUUWU!/// {@macro riverpod.autoDispose}UXUXUw/// Builds a [Provider].X}XXVXV?/// Builds a [ProviderFamily].ZZZ^!/// {@macro riverpod.autoDispose}XXXXXXY Y 3YMY[Y[ YcYmYm(YXXxX/// {@macro riverpod.family}XXX</// Builds a [ProviderFamily].[[#ZZ?/// Builds a [FutureProvider].\\\!/// {@macro riverpod.autoDispose}]4]4{]s/// {@macro riverpod.family}[i[i[i[[8[[[ [[[(\[*[*s[d!/// {@macro riverpod.autoDispose}ZZ Z/// Builds a [FutureProvider].^+^F]]K$/// Builds a [FutureProviderFamily].__倛`4!/// {@macro riverpod.autoDispose}^^^^^^^^C__%_% _-_7_7(_S^M^M^/// {@macro riverpod.family}]]]$/// Builds a [FutureProviderFamily].````?/// Builds a [StreamProvider].b{b{b!/// {@macro riverpod.autoDispose}cc{cM/// {@macro riverpod.family}aEaEaEaa6aaa aaa(aaaqa@!/// {@macro riverpod.autoDispose}```/// Builds a [StreamProvider].dd ccK$/// Builds a [StreamProviderFamily].eef !/// {@macro riverpod.autoDispose}dldldldsdsdsddAddd eee(e+d'd'dg/// {@macro riverpod.family}ccc$/// Builds a [StreamProviderFamily].ffffS(/// Builds a [AutoDisposeStateProvider].hhh/// {@macro riverpod.family}gOgOgOgg8ggg ggg(hgggJ!/// {@macro riverpod.autoDispose}f\f\f(/// Builds a [AutoDisposeStateProvider].iiii_./// Builds a [AutoDisposeStateProviderFamily].j5j5j5j<j<j<j}j}Cjjj jjj(jii恨j0/// {@macro riverpod.family}i$i$liY./// Builds a [AutoDisposeStateProviderFamily].l.lUkkc0/// Builds a [AutoDisposeStateNotifierProvider].nUnUn/// {@macro riverpod.family}ll%llllm'm'Umvmm mmm(ml\l\l!/// {@macro riverpod.autoDispose}kkdk0/// Builds a [AutoDisposeStateNotifierProvider].ooogogo6/// Builds a [AutoDisposeStateNotifierProviderFamily].pApA%pAphphphpopopopplqq$q$ q,q6q6(qRooڂ"p</// {@macro riverpod.family}nno56/// Builds a [AutoDisposeStateNotifierProviderFamily].rurrIrII#/// Builds a [AutoDisposeProvider].tttV/// {@macro riverpod.family}rrrss3sJsXsX s`sjsj(srrxr!/// {@macro riverpod.autoDispose}rrr*#/// Builds a [AutoDisposeProvider].u"uBttU)/// Builds a [AutoDisposeProviderFamily].uuuuuuuu>vv!v! v)v3v3(vOuIuIu/// {@macro riverpod.family}ttIt)/// Builds a [AutoDisposeProviderFamily].wmww;w;U)/// Builds a [AutoDisposeFutureProvider].y,y,yv/// {@macro riverpod.family}wwwx!x!Cx^xlxl xtx~x~(xwww!/// {@macro riverpod.autoDispose}vvw)/// Builds a [AutoDisposeFutureProvider].zZzz"z"a//// Builds a [AutoDisposeFutureProviderFamily].zzzzzz{{V{o{}{} {{{({zzz/// {@macro riverpod.family}yyy//// Builds a [AutoDisposeFutureProviderFamily].||||U)/// Builds a [AutoDisposeStreamProvider].~~~/// {@macro riverpod.family}}@}@}@}}A}}} }}}(}||};!/// {@macro riverpod.autoDispose}|H|H|x)/// Builds a [AutoDisposeStreamProvider].a//// Builds a [AutoDisposeStreamProviderFamily].777>>>T ( 灻2/// {@macro riverpod.family}!!W//// Builds a [AutoDisposeStreamProviderFamily].9*-ǁOǁ=bׂ0Seʃ؃ zFն -ZжݶSYi(xȸθݸ1ֹ _ !/iѻٻFLZμּ7ƽԽf'-~@@j@p@v@@AAAnAzAAAAAB.B4BBBCCC*CRCCCCCD2DBDSDDDDE EEEzEEEEFFFQFFFFG;GHGRG^GdGGGGHH>HLHRHnHHHHHHIIInIIIIIJ JYJJJK KK!K-KBKlKKKKKKLL5L6LULLMMM@MGMsMMMMMMMNNYN]N_N`NNNNNO OIOOPPPDPKP~PPPPPPPQ,QhQlQmQQQQQQR(RSRRRRSSBSySSSTTT[TiT{TTTTTUUQUUUWUXUqUUUUUVV:VjV|VVVVVWWWWW?WnWWWWWXXXXX6XTXuXXXXYYWYiYYYYYZZZZZ7ZlZZZZZZ[['[([L[q[[[\(\/\Q\_\q\\\\\\]-]1]2]Q]|]]]]]]^#^J^K^j^^_!_3_a_h_______``B`}``````aaa(aMaaabb b+b9bKbmbtbxbybbcc c c+cVcccccccd$d%dDdydde e9e@eme{eeeeeeffUfYf[f\fffggg(gWggghhhAhOhahhhhhhii!i#i$iSiiiijjBjyjjkk kBkPkbkkkkkkkl&lYlZl~llm#mnmmmmnnn%nGnNnRnSnrnnnnno/oeoooop6puppqq q2q`qgqqqqqqqrr$rGrmrrrrssTsfssssstt ttt/t_ttttttuuFuGufuuvv/v]vdvvvvvvvvww9wewwwwxxhxzxxxxxyy%y)y*yIyyyyyyz zRzzzz{{g{y{{{{|||:|A|E|G|H|r||||}}H}}}~~~<~J~\~~~~~~~ !QD{Vdv AsyncNotifierProviderBuilder"AsyncNotifierProviderFamilyBuilder'AutoDisposeAsyncNotifierProviderBuilder-AutoDisposeAsyncNotifierProviderFamilyBuilderNotifierProviderBuilderNotifierProviderFamilyBuilder"AutoDisposeNotifierProviderBuilder(AutoDisposeNotifierProviderFamilyBuilderStreamNotifierProviderBuilder#StreamNotifierProviderFamilyBuilder(AutoDisposeStreamNotifierProviderBuilder.AutoDisposeStreamNotifierProviderFamilyBuilderStateProviderBuilderStateProviderFamilyBuilderStateNotifierProviderBuilder"StateNotifierProviderFamilyBuilderProviderBuilderProviderFamilyBuilderFutureProviderBuilderFutureProviderFamilyBuilderStreamProviderBuilderStreamProviderFamilyBuilderAutoDisposeStateProviderBuilder%AutoDisposeStateProviderFamilyBuilder'AutoDisposeStateNotifierProviderBuilder-AutoDisposeStateNotifierProviderFamilyBuilderAutoDisposeProviderBuilder AutoDisposeProviderFamilyBuilder AutoDisposeFutureProviderBuilder&AutoDisposeFutureProviderFamilyBuilder AutoDisposeStreamProviderBuilder&AutoDisposeStreamProviderFamilyBuilderriverpod.autoDisposeMarks the provider as automatically disposed when no longer listened to. Some typical use-cases: - Combined with [StreamProvider], this can be used as a mean to keep the connection with Firebase alive only when truly needed (to reduce costs). - Automatically reset a form state when leaving the screen. - Automatically retry HTTP requests that failed when the user exit and re-enter the screen. - Cancel HTTP requests if the user leaves a screen before the request completed. Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. The `keepAlive` function is used to tell Riverpod that the state of the provider should be preserved even if no longer listened to. A use-case would be to set this flag to `true` after an HTTP request have completed: ```dart final myProvider = FutureProvider.autoDispose((ref) async { final response = await httpClient.get(...); ref.keepAlive(); return response; }); ``` This way, if the request failed and the UI leaves the screen then re-enters it, then the request will be performed again. But if the request completed successfully, the state will be preserved and re-entering the screen will not trigger a new request. It can be combined with `ref.onDispose` for more advanced behaviors, such as cancelling pending HTTP requests when the user leaves a screen. For example, modifying our previous snippet and using `dio`, we would have: ```diff final myProvider = FutureProvider.autoDispose((ref) async { + final cancelToken = CancelToken(); + ref.onDispose(() => cancelToken.cancel()); + final response = await dio.get('path', cancelToken: cancelToken); - final response = await dio.get('path'); ref.keepAlive(); return response; }); ```riverpod.familyyA group of providers that builds their value from an external parameter. Families can be useful to connect a provider with values that it doesn't have access to. For example: - Allowing a "title provider" access the `Locale` ```dart final titleFamily = Provider.family((ref, locale) { if (locale == const Locale('en')) { return 'English title'; } else if (locale == const Locale('fr')) { return 'Titre Français'; } }); // ... @override Widget build(BuildContext context, WidgetRef ref) { final locale = Localizations.localeOf(context); // Obtains the title based on the current Locale. // Will automatically update the title when the Locale changes. final title = ref.watch(titleFamily(locale)); return Text(title); } ``` - Have a "user provider" that receives the user ID as a parameter ```dart final userFamily = FutureProvider.family((ref, userId) async { final userRepository = ref.read(userRepositoryProvider); return await userRepository.fetch(userId); }); // ... @override Widget build(BuildContext context, WidgetRef ref) { int userId; // Read the user ID from somewhere // Read and potentially fetch the user with id `userId`. // When `userId` changes, this will automatically update the UI // Similarly, if two widgets tries to read `userFamily` with the same `userId` // then the user will be fetched only once. final user = ref.watch(userFamily(userId)); return user.when( data: (user) => Text(user.name), loading: () => const CircularProgressIndicator(), error: (err, stack) => const Text('error'), ); } ``` - Connect a provider with another provider without having a direct reference on it. ```dart final repositoryProvider = Provider.family>((ref, configurationsProvider) { // Read a provider without knowing what that provider is. final configurations = await ref.read(configurationsProvider.future); return Repository(host: configurations.host); }); ``` ## Usage The way families works is by adding an extra parameter to the provider. This parameter can then be freely used in our provider to create some state. For example, we could combine `family` with [FutureProvider] to fetch a `Message` from its ID: ```dart final messagesFamily = FutureProvider.family((ref, id) async { return dio.get('http://my_api.dev/messages/$id'); }); ``` Then, when using our `messagesFamily` provider, the syntax is slightly modified. The usual: ```dart Widget build(BuildContext context, WidgetRef ref) { // Error – messagesFamily is not a provider final response = ref.watch(messagesFamily); } ``` will not work anymore. Instead, we need to pass a parameter to `messagesFamily`: ```dart Widget build(BuildContext context, WidgetRef ref) { final response = ref.watch(messagesFamily('id')); } ``` **NOTE**: It is totally possible to use a family with different parameters simultaneously. For example, we could use a `titleFamily` to read both the french and english translations at the same time: ```dart @override Widget build(BuildContext context, WidgetRef ref) { final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); final englishTitle = ref.watch(titleFamily(const Locale('en'))); return Text('fr: $frenchTitle en: $englishTitle'); } ``` # Parameter restrictions For families to work correctly, it is critical for the parameter passed to a provider to have a consistent `hashCode` and `==`. Ideally the parameter should either be a primitive (bool/int/double/String), a constant (providers), or an immutable object that override `==` and `hashCode`. - **PREFER** using `family` in combination with `autoDispose` if the parameter passed to providers is a complex object: ```dart final example = Provider.autoDispose.family((ref, param) { }); ``` This ensures that there is no memory leak if the parameter changed and is never used again. # Passing multiple parameters to a family Families have no built-in support for passing multiple values to a provider. On the other hand, that value could be _anything_ (as long as it matches with the restrictions mentioned previously). This includes: - A tuple (using `package:tuple`) - Objects generated with Freezed/built_value - Objects based on `package:equatable` This includes: - A tuple (using `package:tuple`) - Objects generated with Freezed/built_value, such as: ```dart @freezed abstract class MyParameter with _$MyParameter { factory MyParameter({ required int userId, required Locale locale, }) = _MyParameter; } final exampleProvider = Provider.family((ref, myParameter) { print(myParameter.userId); print(myParameter.locale); // Do something with userId/locale }); @override Widget build(BuildContext context, WidgetRef ref) { int userId; // Read the user ID from somewhere final locale = Localizations.localeOf(context); final something = ref.watch( exampleProvider(MyParameter(userId: userId, locale: locale)), ); } ``` - Objects based on `package:equatable`, such as: ```dart class MyParameter extends Equatable { factory MyParameter({ required this.userId, requires this.locale, }); final int userId; final Local locale; @override List get props => [userId, locale]; } final exampleProvider = Provider.family((ref, myParameter) { print(myParameter.userId); print(myParameter.locale); // Do something with userId/locale }); @override Widget build(BuildContext context, WidgetRef ref) { int userId; // Read the user ID from somewhere final locale = Localizations.localeOf(context); final something = ref.watch( exampleProvider(MyParameter(userId: userId, locale: locale)), ); } ```_