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.

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

docs: fix typo in README.md #1

Merged
merged 1 commit into from
Sep 23, 2021
Merged

docs: fix typo in README.md #1

merged 1 commit into from
Sep 23, 2021

Conversation

gkalpak
Copy link
Contributor

@gkalpak gkalpak commented Sep 23, 2021

The example using getClientRects() was using the returned value as if it were a single DOMRect object. However, getClientRects() returns a list for DOMRect objects.

This commit fixes the example by instead using getBoundingClientRect(), which does return a single DOMRect object.

The example using `getClientRects()` was using the returned value as if
it were a single `DOMRect` object. However, [getClientRects()][1]
returns a list for `DOMRect` objects.

This commit fixes the example by instead using
[getBoundingClientRect()][2], which _does_ return a single `DOMRect`
object.

[1]: https://developer.mozilla.org/en-US/docs/Web/API/Element/getClientRects
[2]: https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect
@vercel
Copy link

vercel bot commented Sep 23, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/builder-io/partytown/cYTnTMgWCRvdF5pZnn3FFvLxBhTF
✅ Preview: https://partytown-git-fork-gkalpak-docs-readme-example-typo-builder-io.vercel.app

@adamdbradley
Copy link
Contributor

thanks!

@gkalpak gkalpak deleted the docs-readme-example-typo branch September 24, 2021 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants