Add sample code for AutomaticKeepAliveClientMixin. #154049

SohanRaidev · 2024-08-24T11:22:35Z

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

google-cla · 2024-08-24T11:22:39Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Piinks

Hi @SohanRaidev welcome! Thanks for contributing!

We put sample code in examples/api/lib and then embed them in the docs. Look for {@tool dartpad} for an example.

Thanks!

flutter-dashboard · 2024-09-04T08:49:22Z

This pull request has been changed to a draft. The currently pending flutter-gold status will not be able to resolve until a new commit is pushed or the change is marked ready for review again.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

SohanRaidev · 2024-09-04T19:14:31Z

Hi @Piinks ,

Thank you for the warm welcome and the guidance!

I’ve added the necessary example code to the examples/api/lib directory and embedded it in the documentation. I followed the pattern with {@tool dartpad} for embedding the examples.

If there’s anything else needed or if you have further feedback, please let me know!

Thanks again!

goderbauer · 2024-09-10T22:13:05Z

(triage): Looks like this is failing some checks. Can you please take a look and address those issues? Thank you!

Piinks

Hey @SohanRaidev thanks for the updates, as well as your patience while I was out of town.
I don't know that we need this many samples. We could also reference some of the existing samples like list_view.1.dart or page_view.1.dart.
All new samples should have tests to verify they work as expected.

Can you also take a look at the failing checks here?

examples/api/lib/widgets/automatic_keep_alive/automatic_keep_alive.0.dart

examples/api/lib/widgets/automatic_keep_alive/automatic_keep_alive_client_mixin.0.dart

...ib/widgets/automatic_keep_alive/sliver_child_builder_delegate_add_automatic_keep_alives.dart

...i/lib/widgets/automatic_keep_alive/sliver_child_list_delegate_add_automatic_keep_alives.dart

chunhtai · 2024-10-08T19:10:43Z

(triage) Hi @SohanRaidev , are you still plan to come back to this pr?

Piinks · 2024-10-22T22:05:25Z

@SohanRaidev it looks like there are some failing tests here, can you take a look? Thanks!

nate-thegrate

Hi @SohanRaidev, thanks so much for contributing!
I've been wanting to look into the KeepAlive APIs a bit more, so I feel lucky to have found this :)

At this point, it looks like the number of test files does not match the number of example files. I also saw that Linux Analyze is reporting a few problems:

   info • Sort directive sections alphabetically • examples/api/test/widgets/automatic_keep_alive/automatic_keep_alive.0_test.dart:6:1 • directives_ordering
   info • Unnecessary use of parentheses • examples/api/test/widgets/automatic_keep_alive/automatic_keep_alive.0_test.dart:50:33 • unnecessary_parenthesis
   info • Unnecessary use of parentheses • examples/api/test/widgets/automatic_keep_alive/automatic_keep_alive.0_test.dart:69:33 • unnecessary_parenthesis
   info • Missing a newline at the end of the file • examples/api/test/widgets/automatic_keep_alive/automatic_keep_alive.0_test.dart:103:2 • eol_at_end_of_file

Overall, I think we'd probably have a smoother review process we start with a pull request that just introduces 1 example. But if you don't mind putting a whole bunch of work in here, then that's fine with me!

examples/api/lib/widgets/automatic_keep_alive/automatic_keep_alive.0.dart

examples/api/lib/widgets/automatic_keep_alive/automatic_keep_alive_client_mixin.0.dart

nate-thegrate · 2024-10-30T22:46:18Z

examples/api/lib/widgets/automatic_keep_alive/automatic_keep_alive_client_mixin.0.dart

+    return ListTile(
+      title: Text('Item ${widget.index}'),
+      subtitle: Column(
+        mainAxisAlignment: MainAxisAlignment.center,
+        children: <Widget>[
+          Text('Keep me alive: $_keepAlive'),
+          ElevatedButton(
+            onPressed: () {
+              setState(() {
+                _keepAlive = !_keepAlive;
+                updateKeepAlive(); // Important to call to update the keep-alive status
+              });
+            },
+            child: const Text('Toggle Keep Alive'),
+          ),
+        ],
+      ),
+    );


I have a little bit of an issue here: when wantKeepAlive is switched to false, it doesn't look any different from when the widget is first created, so there's no way to visually tell whether it's behaving correctly.

examples/api/lib/widgets/automatic_keep_alive/automatic_keep_alive_client_mixin.0.dart

nate-thegrate · 2024-10-30T22:54:00Z

...ib/widgets/automatic_keep_alive/sliver_child_builder_delegate_add_automatic_keep_alives.dart

+            // The default value of addAutomaticKeepAlives is true, so we can remove it
+            // Set to false to observe the loss of state in each item when scrolled
+            // out of view. Selected items will revert to their default state if false.


I don't see a way to select an item. Maybe an onTap callback could be added to the list tile?

nate-thegrate · 2024-10-30T22:56:47Z

...i/lib/widgets/automatic_keep_alive/sliver_child_list_delegate_add_automatic_keep_alives.dart

I think it'd be nice if there were some meaningful differences between this file and the one above, aside from whether it uses List<Widget>.generate().

nate-thegrate · 2024-10-30T22:59:32Z

examples/api/lib/widgets/keep_alive/keep_alive.0.dart

I tried running this sample and got the following error:

══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════ The following assertion was thrown while applying parent data.: Incorrect use of ParentDataWidget. The ParentDataWidget KeepAlive(keepAlive: true) wants to apply ParentData of type KeepAliveParentDataMixin to a RenderObject, which has been set up to accept ParentData of incompatible type ParentData. Usually, this means that the KeepAlive widget has the wrong ancestor RenderObjectWidget. Typically, KeepAlive widgets are placed directly inside SliverWithKeepAliveWidget or TwoDimensionalViewport widgets. The offending KeepAlive is currently placed inside a RepaintBoundary widget. The ownership chain for the RenderObject that received the incompatible parent data was: Semantics ← _FocusInheritedScope ← Focus ← _ActionsScope ← Actions ← _ParentInkResponseProvider ← _InkResponseStateWidget ← InkWell ← ListTile ← ListItem ← ⋯

…live.0.dart Co-authored-by: Nate Wilson <nathan.wilson1232@gmail.com>

…live_client_mixin.0.dart Co-authored-by: Nate Wilson <nathan.wilson1232@gmail.com>

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. labels Aug 24, 2024

SohanRaidev mentioned this pull request Aug 24, 2024

Add sample code for AutomaticKeepAliveClientMixin #153860

Open

goderbauer requested a review from Piinks August 28, 2024 22:14

Piinks reviewed Sep 3, 2024

View reviewed changes

SohanRaidev marked this pull request as draft September 4, 2024 08:45

SohanRaidev force-pushed the solution_to_issue#153860 branch from e2f15fb to e36c795 Compare September 4, 2024 17:47

github-actions bot added engine flutter/engine repository. See also e: labels. d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Sep 4, 2024

SohanRaidev closed this Sep 4, 2024

SohanRaidev force-pushed the solution_to_issue#153860 branch from e36c795 to 056c40f Compare September 4, 2024 17:55

SohanRaidev reopened this Sep 4, 2024

github-actions bot removed the engine flutter/engine repository. See also e: labels. label Sep 4, 2024

SohanRaidev marked this pull request as ready for review September 4, 2024 19:08

SohanRaidev requested a review from Piinks September 4, 2024 19:14

Piinks reviewed Sep 24, 2024

View reviewed changes

unknown added 7 commits October 28, 2024 00:45

added sample code for AutomaticKeepAlive

ba2f03e

Corrected docs and example code for KeepAlive

2c85878

example code for AutomaticKeepAliveClientMixin

c6fcb8c

Sample codes for AddAutomaticKeepAlives

dcee356

Fix issues

b3af5ed

Added sample codes

dee4759

add sample code for KeepAlive.

5744b95

test files for sample code

70a02a2

SohanRaidev force-pushed the solution_to_issue#153860 branch from e15a07e to 70a02a2 Compare October 27, 2024 19:15

nate-thegrate self-requested a review October 29, 2024 22:09

nate-thegrate reviewed Oct 30, 2024

View reviewed changes

SohanRaidev and others added 3 commits November 3, 2024 00:22

Update examples/api/lib/widgets/automatic_keep_alive/automatic_keep_a…

dc65059

…live.0.dart Co-authored-by: Nate Wilson <nathan.wilson1232@gmail.com>

Update examples/api/lib/widgets/automatic_keep_alive/automatic_keep_a…

0cc0db1

…live_client_mixin.0.dart Co-authored-by: Nate Wilson <nathan.wilson1232@gmail.com>

Update examples/api/lib/widgets/automatic_keep_alive/automatic_keep_a…

d54692a

…live_client_mixin.0.dart Co-authored-by: Nate Wilson <nathan.wilson1232@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sample code for AutomaticKeepAliveClientMixin. #154049

Add sample code for AutomaticKeepAliveClientMixin. #154049

SohanRaidev commented Aug 24, 2024 •

edited

Loading

google-cla bot commented Aug 24, 2024

Piinks left a comment

flutter-dashboard bot commented Sep 4, 2024

SohanRaidev commented Sep 4, 2024

goderbauer commented Sep 10, 2024

Piinks left a comment

chunhtai commented Oct 8, 2024

Piinks commented Oct 22, 2024

nate-thegrate left a comment

nate-thegrate Oct 30, 2024

nate-thegrate Oct 30, 2024

nate-thegrate Oct 30, 2024

nate-thegrate Oct 30, 2024

Add sample code for AutomaticKeepAliveClientMixin. #154049

Are you sure you want to change the base?

Add sample code for AutomaticKeepAliveClientMixin. #154049

Conversation

SohanRaidev commented Aug 24, 2024 • edited Loading

Pre-launch Checklist

google-cla bot commented Aug 24, 2024

Piinks left a comment

Choose a reason for hiding this comment

flutter-dashboard bot commented Sep 4, 2024

SohanRaidev commented Sep 4, 2024

goderbauer commented Sep 10, 2024

Piinks left a comment

Choose a reason for hiding this comment

chunhtai commented Oct 8, 2024

Piinks commented Oct 22, 2024

nate-thegrate left a comment

Choose a reason for hiding this comment

nate-thegrate Oct 30, 2024

Choose a reason for hiding this comment

nate-thegrate Oct 30, 2024

Choose a reason for hiding this comment

nate-thegrate Oct 30, 2024

Choose a reason for hiding this comment

nate-thegrate Oct 30, 2024

Choose a reason for hiding this comment

SohanRaidev commented Aug 24, 2024 •

edited

Loading