Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Better documentation for toContaintHTML #363

Merged
merged 2 commits into from
May 15, 2021
Merged

doc: Better documentation for toContaintHTML #363

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bc9eda
doc: Better documentation for toContaintHTML
gnapse May 5, 2021
dbb0183
Update README.md
gnapse May 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ toContainHTML(htmlText: string)
```

Assert whether a string representing a HTML element is contained in another
element:
element. The string should contain valid html, and not any substrings of html.
Copy link
Member

@eps1lon eps1lon May 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"substrings of html" is a bit unclear to me. It sounds like <p></p> would be considered a "substring" but that's valid HTML. An example would help here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree this is probably not the clearest terms. But the examples are below. Do you think we need examples of what won't work? Like for instance, this:

// These won't work
render(<div class="test">text</div>)
expect(element).toContainHTML('</div>')
expect(element).toContainHTML('class="test"')

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "partial HTML" or "incomplete HTML" is more fitting here.

Oh and move the comment since the render does work.

-// These won't work
render(<div class="test">text</div>)
+// These won't work
expect(element).toContainHTML('</div>')
expect(element).toContainHTML('class="test"')

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Thanks for your advice. I'll do that.


#### Examples

Expand All @@ -501,6 +501,8 @@ element:

```javascript
expect(getByTestId('parent')).toContainHTML('<span data-testid="child"></span>')
expect(getByTestId('parent')).toContainHTML('<span data-testid="child" />')
expect(getByTestId('parent')).not.toContainHTML('<br />')
```

> Chances are you probably do not need to use this matcher. We encourage testing
Expand Down