puppeteer/assets/js/c5b9fc0c.c02e1fc4.js

/*! For license information please see c5b9fc0c.c02e1fc4.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[63596],{21178:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=r(85893),o=r(11151);const i={sidebar_label:"LocatorOptions"},s="LocatorOptions interface",l={id:"api/puppeteer.locatoroptions",title:"LocatorOptions interface",description:"Signature:",source:"@site/versioned_docs/version-21.6.0/api/puppeteer.locatoroptions.md",sourceDirName:"api",slug:"/api/puppeteer.locatoroptions",permalink:"/api/puppeteer.locatoroptions",draft:!1,unlisted:!1,tags:[],version:"21.6.0",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",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,o.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)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Property"}),(0,n.jsx)(t.th,{children:"Modifiers"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"ensureElementIsInTheViewport"}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"boolean"}),(0,n.jsx)(t.td,{children:"Whether to scroll the element into viewport if not in the viewprot already."}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"true"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"timeout"}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsxs)(t.td,{children:[(0,n.jsx)("p",{children:"Total timeout for the entire locator operation."}),(0,n.jsxs)("p",{children:["Pass ",(0,n.jsx)("code",{children:"0"})," to disable timeout."]})]}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"Page.getDefaultTimeout()"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"visibility"}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/api/puppeteer.visibilityoption",children:"VisibilityOption"})}),(0,n.jsxs)(t.td,{children:["Whether to wait for the element to be ",(0,n.jsx)("code",{children:"visible"})," or ",(0,n.jsx)("code",{children:"hidden"}),". ",(0,n.jsx)("code",{children:"null"})," to disable visibility checks."]}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"waitForEnabled"}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"boolean"}),(0,n.jsxs)(t.td,{children:["Whether to wait for input elements to become enabled before the action. Applicable to ",(0,n.jsx)("code",{children:"click"})," and ",(0,n.jsx)("code",{children:"fill"})," actions."]}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"true"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"waitForStableBoundingBox"}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"boolean"}),(0,n.jsx)(t.td,{children:"Whether to wait for the element's bounding box to be same between two animation frames."}),(0,n.jsx)(t.td,{children:(0,n.jsx)("code",{children:"true"})})]})]})]})]})}function p(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},75251:(e,t,r)=>{var n=r(67294),o=Symbol.for("react.element"),i=Symbol.for("react.fragment"),s=Object.prototype.hasOwnProperty,l=n.__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 n,i={},d=null,a=null;for(n in void 0!==r&&(d=""+r),void 0!==t.key&&(d=""+t.key),void 0!==t.ref&&(a=t.ref),t)s.call(t,n)&&!c.hasOwnProperty(n)&&(i[n]=t[n]);if(e&&e.defaultProps)for(n in t=e.defaultProps)void 0===i[n]&&(i[n]=t[n]);return{$$typeof:o,type:e,key:d,ref:a,props:i,_owner:l.current}}t.Fragment=i,t.jsx=d,t.jsxs=d},85893:(e,t,r)=>{e.exports=r(75251)},11151:(e,t,r)=>{r.d(t,{Z:()=>l,a:()=>s});var n=r(67294);const o={},i=n.createContext(o);function s(e){const t=n.useContext(i);return n.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(o):e.components||o:s(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);