puppeteer/assets/js/1e8ce503.e3279e4f.js

/*! For license information please see 1e8ce503.e3279e4f.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[95771],{37778:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=r(85893),n=r(11151);const s={sidebar_label:"LocatorOptions"},o="LocatorOptions interface",l={id:"api/puppeteer.locatoroptions",title:"LocatorOptions interface",description:"Signature:",source:"@site/versioned_docs/version-22.8.2/api/puppeteer.locatoroptions.md",sourceDirName:"api",slug:"/api/puppeteer.locatoroptions",permalink:"/api/puppeteer.locatoroptions",draft:!1,unlisted:!1,tags:[],version:"22.8.2",frontMatter:{sidebar_label:"LocatorOptions"},sidebar:"api",previous:{title:"LocatorEvents",permalink:"/api/puppeteer.locatorevents"},next:{title:"LocatorScrollOptions",permalink:"/api/puppeteer.locatorscrolloptions"}},c={},d=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function a(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",...(0,n.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"locatoroptions-interface",children:"LocatorOptions interface"}),"\n",(0,i.jsx)(t.h4,{id:"signature",children:"Signature:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"export interface LocatorOptions\n"})}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsxs)("table",{children:[(0,i.jsx)("thead",{children:(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Property"})}),(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Modifiers"})}),(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Type"})}),(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Description"})}),(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Default"})})]})}),(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:(0,i.jsx)("span",{id:"ensureelementisintheviewport",children:"ensureElementIsInTheViewport"})}),(0,i.jsx)("td",{}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"boolean"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"Whether to scroll the element into viewport if not in the viewprot already."})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"true"})})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:(0,i.jsx)("span",{id:"timeout",children:"timeout"})}),(0,i.jsx)("td",{}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"number"})}),(0,i.jsxs)("td",{children:[(0,i.jsx)(t.p,{children:"Total timeout for the entire locator operation."}),(0,i.jsxs)(t.p,{children:["Pass ",(0,i.jsx)(t.code,{children:"0"})," to disable timeout."]})]}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"Page.getDefaultTimeout()"})})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:(0,i.jsx)("span",{id:"visibility",children:"visibility"})}),(0,i.jsx)("td",{}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"/api/puppeteer.visibilityoption",children:"VisibilityOption"})})}),(0,i.jsx)("td",{children:(0,i.jsxs)(t.p,{children:["Whether to wait for the element to be ",(0,i.jsx)(t.code,{children:"visible"})," or ",(0,i.jsx)(t.code,{children:"hidden"}),". ",(0,i.jsx)(t.code,{children:"null"})," to disable visibility checks."]})}),(0,i.jsx)("td",{})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:(0,i.jsx)("span",{id:"waitforenabled",children:"waitForEnabled"})}),(0,i.jsx)("td",{}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"boolean"})}),(0,i.jsx)("td",{children:(0,i.jsxs)(t.p,{children:["Whether to wait for input elements to become enabled before the action. Applicable to ",(0,i.jsx)(t.code,{children:"click"})," and ",(0,i.jsx)(t.code,{children:"fill"})," actions."]})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"true"})})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:(0,i.jsx)("span",{id:"waitforstableboundingbox",children:"waitForStableBoundingBox"})}),(0,i.jsx)("td",{}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"boolean"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"Whether to wait for the element's bounding box to be same between two animation frames."})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"true"})})})]})]})]})]})}function p(e={}){const{wrapper:t}={...(0,n.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},75251:(e,t,r)=>{var i=r(67294),n=Symbol.for("react.element"),s=Symbol.for("react.fragment"),o=Object.prototype.hasOwnProperty,l=i.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,c={key:!0,ref:!0,__self:!0,__source:!0};function d(e,t,r){var i,s={},d=null,a=null;for(i in void 0!==r&&(d=""+r),void 0!==t.key&&(d=""+t.key),void 0!==t.ref&&(a=t.ref),t)o.call(t,i)&&!c.hasOwnProperty(i)&&(s[i]=t[i]);if(e&&e.defaultProps)for(i in t=e.defaultProps)void 0===s[i]&&(s[i]=t[i]);return{$$typeof:n,type:e,key:d,ref:a,props:s,_owner:l.current}}t.Fragment=s,t.jsx=d,t.jsxs=d},85893:(e,t,r)=>{e.exports=r(75251)},11151:(e,t,r)=>{r.d(t,{Z:()=>l,a:()=>o});var i=r(67294);const n={},s=i.createContext(n);function o(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]);