withBuiltChild

mobxjs · Nov 23, 2023 · 4e67b13 · 4e67b13
1 parent 2fdcbcf
commit 4e67b13
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/flutter_mobx/CHANGELOG.md b/flutter_mobx/CHANGELOG.md
@@ -1,13 +1,13 @@
 ## 2.2.0+1
- - renamed `Observer.withChild` to `Observer.excludedChild`
+ - renamed `Observer.withChild` to `Observer.withBuiltChild`
 `
 ## 2.2.0
- - `Observer` is updated with the new `Observer.excludedChild` constructor, so you can exclude child branch from the re-rendering. - [@subzero911](https://github.com/subzero911) \
-   In case if you use `Observer.excludedChild`, you should provide two parameters: `builderWithChild` and `child`:
+ - `Observer` is updated with the new `Observer.withBuiltChild` constructor, so you can exclude child branch from the re-rendering. - [@subzero911](https://github.com/subzero911) \
+   In case if you use `Observer.withBuiltChild`, you should provide two parameters: `builderWithChild` and `child`:
    ```dart
-   Observer.excludedChild(
-     builderWithChild: (context, child) => FooWidget(foo: foo, child: child),
-     child: BarWidget(), // is not rebuilt
+   Observer.withBuiltChild(
+     builderWithChild: (context, child) => FooWidget(foo: foo, bar: child),
+     child: BarWidget(), // won't rebuild
    ),
    ``` 
 

diff --git a/flutter_mobx/lib/src/observer.dart b/flutter_mobx/lib/src/observer.dart
@@ -33,9 +33,9 @@ class Observer extends StatelessObserverWidget {
           warnWhenNoObservables: warnWhenNoObservables,
         );
 
-  /// Observer which excludes the child branch
+  /// Observer which excludes the child branch from being rebuilt
   // ignore: prefer_const_constructors_in_immutables
-  Observer.excludedChild({
+  Observer.withBuiltChild({
     Key? key,
     required this.builderWithChild,
     required this.child,

diff --git a/flutter_mobx/test/flutter_mobx_test.dart b/flutter_mobx/test/flutter_mobx_test.dart
@@ -59,15 +59,15 @@ void main() {
     expect(renderCount, equals(1));
   });
 
-  testWidgets("Observer.excludedChild's child doesn't re-render", (tester) async {
+  testWidgets("Observer.withBuiltChild's child doesn't re-render", (tester) async {
     final message = Observable('Click');
      final key1 = UniqueKey();
      final key2 = UniqueKey();
      final key3 = UniqueKey();
 
      await tester.pumpWidget(
        MaterialApp(
-         home: Observer.excludedChild(
+         home: Observer.withBuiltChild(
            builderWithChild: (context, child) {          
              return Column(
                children: [