[Animations] add example to openCntainer#11189
[Animations] add example to openCntainer#11189AbdeMohlbi wants to merge 6 commits intoflutter:mainfrom
openCntainer#11189Conversation
github-actions
bot
added
p: animations
triage-framework
AbdeMohlbi
added
the
override: no versioning needed
|
This change should not require a version bump since it is a documentation change mostly |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a dartdoc example for the OpenContainer widget and updates the CHANGELOG.md to reflect this change. The example demonstrates how to use OpenContainer with openBuilder and closedBuilder. My review provides a suggestion to simplify the example code for clarity and adherence to Dart style conventions.
| /// OpenContainer( | ||
| /// transitionDuration: const Duration(milliseconds: 500), | ||
| /// transitionType: ContainerTransitionType.fadeThrough, | ||
| /// openBuilder: (context, action) { | ||
| /// return Scaffold( | ||
| /// appBar: AppBar(title: const Text("Details Page")), | ||
| /// body: const Center( | ||
| /// child: Text( | ||
| /// "This page opened with Container Transform animation", | ||
| /// style: TextStyle(fontSize: 18), | ||
| /// textAlign: TextAlign.center, | ||
| /// ), | ||
| /// ), | ||
| /// ); | ||
| /// }, | ||
| /// closedBuilder: (context, action) { | ||
| /// return GestureDetector( | ||
| /// onTap: action, | ||
| /// child: Container( | ||
| /// width: 200, | ||
| /// height: 120, | ||
| /// alignment: Alignment.center, | ||
| /// decoration: BoxDecoration( | ||
| /// color: Colors.blue, | ||
| /// borderRadius: BorderRadius.circular(16), | ||
| /// ), | ||
| /// child: const Text( | ||
| /// "Open Details", | ||
| /// style: TextStyle(color: Colors.white, fontSize: 18), | ||
| /// ), | ||
| /// ), | ||
| /// ); | ||
| /// }, | ||
| /// ), |
There was a problem hiding this comment.
For a clearer and more idiomatic example, I have a few suggestions:
- In
closedBuilder, theGestureDetectoris redundant becauseOpenContaineris tappable by default. It's simpler to rely on the default behavior. Theactioncallback is useful for more complex scenarios, like whentappableis set tofalse. - The
actionparameters in bothopenBuilderandclosedBuilderare unused in this example. It's a good practice to rename them to_to signify they are intentionally ignored. - Per the Dart style guide, it's preferred to use single quotes for strings.
I've applied these changes in the suggestion.
/// OpenContainer(
/// transitionDuration: const Duration(milliseconds: 500),
/// transitionType: ContainerTransitionType.fadeThrough,
/// openBuilder: (context, _) {
/// return Scaffold(
/// appBar: AppBar(title: const Text('Details Page')),
/// body: const Center(
/// child: Text(
/// 'This page opened with Container Transform animation',
/// style: TextStyle(fontSize: 18),
/// textAlign: TextAlign.center,
/// ),
/// ),
/// );
/// },
/// closedBuilder: (context, _) {
/// return Container(
/// width: 200,
/// height: 120,
/// alignment: Alignment.center,
/// decoration: BoxDecoration(
/// color: Colors.blue,
/// borderRadius: BorderRadius.circular(16),
/// ),
/// child: const Text(
/// 'Open Details',
/// style: TextStyle(color: Colors.white, fontSize: 18),
/// ),
/// );
/// },
/// ),References
- DO use single quotes for strings. (link)
There was a problem hiding this comment.
valid point.
not sure about the action with _.
valid point for single quotes.
|
Hey @AbdeMohlbi thanks for the PR! Actually, examples do typically require a version bump and release since this is changing the public documentation. |
AbdeMohlbi
removed
the
override: no versioning needed
|
Hi @ @AbdeMohlbi ! Can you bump the version in CHANGELOG.md and pubspec.yaml ? |
I plan on doing that soon, i will mark as draft for the moment, thanks and sorry for the delay. |
There was a problem hiding this comment.
Code Review
This pull request adds a usage example to the OpenContainer widget's documentation, resolving a TODO item. It also increments the package version in pubspec.yaml and adds a corresponding entry to CHANGELOG.md. My review identified a syntax error in the newly added example code which would prevent it from being runnable. I have provided a suggestion to correct this.
| /// child: Text( | ||
| /// 'This page opened with Container Transform animation, | ||
| /// style: TextStyle(fontSize: 18), | ||
| /// textAlign: TextAlign.center, | ||
| /// ), |
There was a problem hiding this comment.
The example code for the Text widget is invalid. The string literal is not properly terminated, and the style and textAlign properties are incorrectly placed within the string instead of being passed as named arguments to the Text constructor. This makes the example code non-functional and will cause a compilation error.
child: const Text(
'This page opened with Container Transform animation.',
style: TextStyle(fontSize: 18),
textAlign: TextAlign.center,
),There was a problem hiding this comment.
nuh uh bad bot you did this last week with another PR, how are tests passing then?
3 participants
Fixes the todo :
TODO(goderbauer): Add example animations and sample code.Pre-Review Checklist
[shared_preferences]///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2