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: page.waitFor options object defination #5021
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
|
signed |
docs/api.md
Outdated
@@ -1895,6 +1895,12 @@ This is a shortcut for [page.mainFrame().url()](#frameurl) | |||
#### page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]]) | |||
- `selectorOrFunctionOrTimeout` <[string]|[number]|[function]> A [selector], predicate or timeout to wait for | |||
- `options` <[Object]> Optional waiting parameters | |||
- `visible` <[boolean]> wait for element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about the hidden
attribute?
Maybe it's better to not explicitly list the examples (like display: none
or visibility: hidden
) here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed as requested. Examples are not listed anymore. Just shows default value and description.
CLAs look good, thanks! |
LGTM but before we merge this, we should make the linter happy and make sure the CI checks pass. |
To do this, https://github.com/GoogleChrome/puppeteer/blob/1248a19135fe54b8fe42e15435c11c3c8aa949d2/lib/Page.js#L1111 needs to be updated accordingly. |
Checks are 9/10. |
@theeko The remaining failure seems unrelated to your change. I've just restarted the build. |
Thanks! |
Thanks for guidance Mathias. |
Added options descriptiptions for page.waitFor.