refactor(breaking): rename container to UNSAFE_root; introduce root host element
#1298
Conversation
mdjastrzebski
requested review from
AugustinLF,
pierrezimmermannbam,
MattAgn and
thymikee
and removed request for
AugustinLF
thymikee
changed the title
container APIcontainer to UNSAFE_root; introduce root host element
| @@ -16,6 +16,12 @@ const defaultScreen: RenderResult = { | |||
| get container(): ReactTestInstance { | |||
| throw new Error(SCREEN_ERROR); | |||
| }, | |||
| get root(): ReactTestInstance { | |||
There was a problem hiding this comment.
Is this type accurate? Isn't there a narrower type for host elements?
There was a problem hiding this comment.
unfortunately no, though we might think about something like that in the future
mdjastrzebski
force-pushed
the
refactor/container-api
branch
from
205d266 to
f842f8b
Compare
| A reference to the rendered root element. | ||
| Returns the rendered root [host element](testing-env#host-and-composite-components). | ||
|
|
||
| This API is primarily useful in component tests, as it allows you to access root host view without using `*ByTestId` queries or similar methods. |
There was a problem hiding this comment.
I feel like it could be interesting to give more indications on what we think are good use cases for this api (e.g. asserting an element is not rendered) because I don't think it's very intuitive how to use this
Co-authored-by: Pierre Zimmermann <[email protected]>
mdjastrzebski
force-pushed
the
refactor/container-api
branch
from
9e5a590 to
8597706
Compare
Codecov ReportBase: 96.07% // Head: 96.09% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1298 +/- ##
==========================================
+ Coverage 96.07% 96.09% +0.02%
==========================================
Files 49 49
Lines 3308 3333 +25
Branches 497 503 +6
==========================================
+ Hits 3178 3203 +25
Misses 130 130
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Summary
This PR contains breaking changes behind
useBreakingChangesfeature flag.Resolves #1296
containertoUNSAFE_rootcontainer(behinduseBreakingChanges)rootAPI that returns root host element.Test plan
All tests pass.