|
|
|
|
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[31749],{59522:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>a,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(85893),i=r(11151);const s={sidebar_label:"LocatorOptions"},o="LocatorOptions interface",c={id:"api/puppeteer.locatoroptions",title:"LocatorOptions interface",description:"Signature:",source:"@site/versioned_docs/version-22.6.2/api/puppeteer.locatoroptions.md",sourceDirName:"api",slug:"/api/puppeteer.locatoroptions",permalink:"/api/puppeteer.locatoroptions",draft:!1,unlisted:!1,tags:[],version:"22.6.2",frontMatter:{sidebar_label:"LocatorOptions"},sidebar:"api",previous:{title:"LocatorEvents",permalink:"/api/puppeteer.locatorevents"},next:{title:"LocatorScrollOptions",permalink:"/api/puppeteer.locatorscrolloptions"}},l={},d=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function p(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"locatoroptions-interface",children:"LocatorOptions interface"}),"\n",(0,n.jsx)(t.h4,{id:"signature",children:"Signature:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-typescript",children:"export interface LocatorOptions\n"})}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsxs)("table",{children:[(0,n.jsx)("thead",{children:(0,n.jsxs)("tr",{children:[(0,n.jsx)("th",{children:(0,n.jsx)(t.p,{children:"Property"})}),(0,n.jsx)("th",{children:(0,n.jsx)(t.p,{children:"Modifiers"})}),(0,n.jsx)("th",{children:(0,n.jsx)(t.p,{children:"Type"})}),(0,n.jsx)("th",{children:(0,n.jsx)(t.p,{children:"Description"})}),(0,n.jsx)("th",{children:(0,n.jsx)(t.p,{children:"Default"})})]})}),(0,n.jsxs)("tbody",{children:[(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"ensureElementIsInTheViewport"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"boolean"})}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"Whether to scroll the element into viewport if not in the viewprot already."})}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"true"})})})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"timeout"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"number"})}),(0,n.jsxs)("td",{children:[(0,n.jsx)(t.p,{children:"Total timeout for the entire locator operation."}),(0,n.jsxs)(t.p,{children:["Pass ",(0,n.jsx)(t.code,{children:"0"})," to disable timeout."]})]}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"Page.getDefaultTimeout()"})})})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"visibility"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"/api/puppeteer.visibilityoption",children:"VisibilityOption"})})}),(0,n.jsx)("td",{children:(0,n.jsxs)(t.p,{children:["Whether to wait for the element to be ",(0,n.jsx)(t.code,{children:"visible"})," or ",(0,n.jsx)(t.code,{children:"hidden"}),". ",(0,n.jsx)(t.code,{children:"null"})," to disable visibility checks."]})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"waitForEnabled"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"boolean"})}),(0,n.jsx)("td",{children:(0,n.jsxs)(t.p,{children:["Whether to wait for input elements to become enabled before the action. Applicable to ",(0,n.jsx)(t.code,{children:"click"})," and ",(0,n.jsx)(t.code,{children:"fill"})," actions."]})}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"true"})})})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"waitForStableBoundingBox"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"boolean"})}),(0,n.jsx)("td",{children:(0,n.jsx)(t.p,{children:"Whether to wait for the element's bounding box to be same be
|
