Fix depreciation

rrousselGit · Apr 8, 2024 · d6146c1 · d6146c1
1 parent e4c5360
commit d6146c1
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 5 deletions.
diff --git a/examples/todos/lib/main.dart b/examples/todos/lib/main.dart
@@ -157,7 +157,7 @@ class Toolbar extends HookConsumerWidget {
               style: ButtonStyle(
                 visualDensity: VisualDensity.compact,
                 foregroundColor:
-                    MaterialStateProperty.all(textColorFor(TodoListFilter.all)),
+                    WidgetStateProperty.all(textColorFor(TodoListFilter.all)),
               ),
               child: const Text('All'),
             ),
@@ -170,7 +170,7 @@ class Toolbar extends HookConsumerWidget {
                   TodoListFilter.active,
               style: ButtonStyle(
                 visualDensity: VisualDensity.compact,
-                foregroundColor: MaterialStateProperty.all(
+                foregroundColor: WidgetStateProperty.all(
                   textColorFor(TodoListFilter.active),
                 ),
               ),
@@ -185,7 +185,7 @@ class Toolbar extends HookConsumerWidget {
                   TodoListFilter.completed,
               style: ButtonStyle(
                 visualDensity: VisualDensity.compact,
-                foregroundColor: MaterialStateProperty.all(
+                foregroundColor: WidgetStateProperty.all(
                   textColorFor(TodoListFilter.completed),
                 ),
               ),

diff --git a/packages/riverpod/lib/src/framework/scheduler.dart b/packages/riverpod/lib/src/framework/scheduler.dart
@@ -54,8 +54,14 @@ class ProviderScheduler {
   final _stateToRefresh = <ProviderElementBase>[];
 
   Completer<void>? _pendingTaskCompleter;
+
+  /// A future that completes when the next task is done.
   Future<void>? get pendingFuture => _pendingTaskCompleter?.future;
 
+  /// Schedules a provider to be refreshed.
+  ///
+  /// The refresh will happen at the end of the next event-loop,
+  /// and only if the provider is active.
   void scheduleProviderRefresh(ProviderElementBase element) {
     _stateToRefresh.add(element);
 
@@ -95,6 +101,9 @@ class ProviderScheduler {
     }
   }
 
+  /// Schedules a provider to be disposed.
+  ///
+  /// The provider will be disposed at the end of the next event-loop,
   void scheduleProviderDispose(
     AutoDisposeProviderElementMixin<Object?> element,
   ) {
@@ -129,6 +138,7 @@ class ProviderScheduler {
     }
   }
 
+  /// Disposes the scheduler.
   void dispose() {
     _disposed = true;
     _pendingTaskCompleter?.complete();

diff --git a/website/docs/essentials/side_effects/raw/render_add_todo.dart b/website/docs/essentials/side_effects/raw/render_add_todo.dart
@@ -47,7 +47,7 @@ class _ExampleState extends ConsumerState<Example> {
             ElevatedButton(
               style: ButtonStyle(
                 // If there is an error, we show the button in red
-                backgroundColor: MaterialStateProperty.all(
+                backgroundColor: WidgetStateProperty.all(
                   isErrored ? Colors.red : null,
                 ),
               ),

diff --git a/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart
@@ -41,7 +41,7 @@ class Example extends HookConsumerWidget {
         ElevatedButton(
           style: ButtonStyle(
             // If there is an error, we show the button in red
-            backgroundColor: MaterialStateProperty.all(
+            backgroundColor: WidgetStateProperty.all(
               isErrored ? Colors.red : null,
             ),
           ),