Link debugVisitOnstageChildren in Offstage
#111524
Conversation
Piinks
left a comment
There was a problem hiding this comment.
Can you check the failing tests here? Thaks!
|
@Piinks green now :) |
| /// subtly). | ||
| /// * [TickerMode], which can be used to disable animations in a subtree. | ||
| /// * The [catalog of layout widgets](https://flutter.dev/widgets/layout/). | ||
| /// * [Element.debugVisitOnstageChildren], for non-offstage children |
There was a problem hiding this comment.
It isn't clear here why this is being linked. Is this something users would want to use in a test? Why would onstage children be important here?
There was a problem hiding this comment.
Because "offstage" is a term in Flutter. But when I search "flutter offstage", I only get Offstage widget, and then I think Offstage widget's definition is all about "offstage". However, we know that its real definition is in debugVisitOnstageChildren's doc, which is broader.
P.S. searching result
There was a problem hiding this comment.
Thanks! I was referring to the context on which a developer reading the api docs would understand this reference. What does this mean to the user? Can you add more context? When would they use it?
There was a problem hiding this comment.
Thanks for the reply, I will go back to this pr later
There was a problem hiding this comment.
@fzyzcjy will you be returning to this PR? Or should we close it for now?
|
Anyway this is not a big problem, so I will close it now since have a lot of other more important PRs remaining for me to improve :) |
The Offstage has strong relationship with debugVisitOnstageChildren: When using Offstage widget, the widget subtree of debugVisitOnstageChildren is changed, and widget testers will not find an offstage widget. In addition, when we are talking about the word "offstage", we may need to refer to both pages, because they have slightly different meanings.
This origins partially from #111479 (comment). Indeed, when talking about "offstage widgets", I quickly remembered and opened Offstage page, but never realize there is another page about debugVisitOnstageChildren, which even has a bit different explanation from Offstage. This PR fixes this problem.
List which issues are fixed by this PR. You must list at least one issue.
If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.