add within API #111
add within API #111
Conversation
src/index.js
Outdated
| @@ -44,4 +44,10 @@ syntheticEvents.forEach(eventName => { | |||
|
|
|||
| // just re-export everything from dom-testing-library | |||
| export * from 'dom-testing-library' | |||
There was a problem hiding this comment.
I was actually hoping this PR would be made to dom-testing-library. Then we'll get it automatically in react-testing-library because of this.
There was a problem hiding this comment.
Hi @kentcdodds, I noticed that dom-testing-library already exported getQueriesForElement as something else:
export {getQueriesForElement as bindElementToQueries}
Is it okay to still export it as yet another thing? like:
export {getQueriesForElement as bindElementToQueries}
export {getQueriesForElement as within}
I've not done such export before 😄
There was a problem hiding this comment.
Yup, that works just fine 👍 You can even do it in a single line:
export {getQueriesForElement as bindElementToQueries, getQueriesForElement as within}There was a problem hiding this comment.
Thanks man!
How about the docs, should I also move it to dom-testing-library?
There was a problem hiding this comment.
Might be good to have it in both places actually. I think we really need a documentation website to consolidate this, but I don't have time to build it right now 😅
There was a problem hiding this comment.
Have updated this to add only docs.
|
Could you resolve merge conflicts please? Thanks! |
| @@ -620,6 +621,22 @@ expect(submitButtons).toHaveLength(3) // expect 3 elements | |||
| expect(submitButtons[0]).toBeInTheDOM() | |||
| ``` | |||
|
|
|||
| ## `within` API | |||
|
|
|||
| Sometimes, there is no garauntee that the text, placeholder, or label you want to query is unique on the page. So you might want to explicity tell react-render-dom to get an element **only within** a particular section of the page. `within` is a helper function for this case. | |||
There was a problem hiding this comment.
Small typo in here, garauntee should be guarantee 🎉
|
🎉 This issue has been resolved in version 4.0.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
What: Add a
withinAPIWhy: Kindly see issue #53 of dom-testing-library
How: Exported
getQueriesForElementaswithinfrom the index.js fileChecklist: