Suggestion for "Hit Testing | renderobjects.com"

[loic-sharma]

Page: https://renderobjects.com/guides/hit-testing/#the-hittest-method

Selected text is bolded below, with the surrounding paragraph(s) for context:

The hitTest Method#

Potential suggestion: A common mistake beginners make is to assume that RenderBox.hitTest returns true if the position is in the current render object. However, that is incorrect. Instead, RenderBox.hitTest returns whether hit testing was concluded by this render object or one of its children. In other words, a render object that is hit should return false if it wants hit testing to continue.

I'd consider adding a quick explanation on this behavior since this is common misunderstanding. In hindsight, perhaps we should've made hitTest return an enum to make this behavior much more obvious (eg HitTestStatus.absorbed, HitTestStatus.continue)

[matthew-carroll]

@loic-sharma that sounds like something that should be clarified on the site. Can you provide any guidance for how a developer should make the decision between absorbing vs not? Superficial guidance could be that you absorb when hitting a non-transparent pixel, and passthrough otherwise. But that's prescriptive rather than a goal.