puppeteer/website/versioned_docs/version-22.8.1/api/puppeteer.locatoroptions.md
release-please[bot] 042d61030c
chore: release main (#12415)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-05-13 08:49:32 +00:00

132 lines
1.5 KiB
Markdown

---
sidebar_label: LocatorOptions
---
# LocatorOptions interface
#### Signature:
```typescript
export interface LocatorOptions
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th><th>
Default
</th></tr></thead>
<tbody><tr><td>
<span id="ensureelementisintheviewport">ensureElementIsInTheViewport</span>
</td><td>
</td><td>
boolean
</td><td>
Whether to scroll the element into viewport if not in the viewprot already.
</td><td>
`true`
</td></tr>
<tr><td>
<span id="timeout">timeout</span>
</td><td>
</td><td>
number
</td><td>
Total timeout for the entire locator operation.
Pass `0` to disable timeout.
</td><td>
`Page.getDefaultTimeout()`
</td></tr>
<tr><td>
<span id="visibility">visibility</span>
</td><td>
</td><td>
[VisibilityOption](./puppeteer.visibilityoption.md)
</td><td>
Whether to wait for the element to be `visible` or `hidden`. `null` to disable visibility checks.
</td><td>
</td></tr>
<tr><td>
<span id="waitforenabled">waitForEnabled</span>
</td><td>
</td><td>
boolean
</td><td>
Whether to wait for input elements to become enabled before the action. Applicable to `click` and `fill` actions.
</td><td>
`true`
</td></tr>
<tr><td>
<span id="waitforstableboundingbox">waitForStableBoundingBox</span>
</td><td>
</td><td>
boolean
</td><td>
Whether to wait for the element's bounding box to be same between two animation frames.
</td><td>
`true`
</td></tr>
</tbody></table>