testing-library-docs icon indicating copy to clipboard operation
testing-library-docs copied to clipboard

ByText API page incorrectly states that it uses `textContent`

Open agos opened this issue 1 year ago • 1 comments

Describe the bug

The docs page for the byText API states that

[it] will search for all elements that have a text node with textContent matching the given TextMatch.

this is not true and will lead to confusion, since it's easy to find situations where trying to use getByText with the textContent of a node and not getting any match

To Reproduce

Here is a minimal codesandbox showing a case of getByText not matching the textContent of a node

Expected behavior

Either

  1. the docs reflect the actual implementation, which does not use textContent
  2. the implementation actually uses textContent for the matching.

Additional context

See also this issue on the dom-testing-library repo

agos avatar Mar 01 '23 17:03 agos

Thanks for opening this one @agos. The code actually does use textContent, except it also gets it from the children and tries to concat them. In some cases, that behavior might have issues but I'm not sure if writing about those issues in the docs will help or cause more confusion. The docs are there to give you the context and information about the behavior and not include a "pseudo-code" of the function.

MatanBobi avatar Mar 02 '23 06:03 MatanBobi