puppeteer/assets/js/54edece3.2f996ade.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[10723],{3905:function(e,t,r){r.d(t,{Zo:function(){return u},kt:function(){return m}});var n=r(67294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function p(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),s=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},u=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),f=s(r),m=o,d=f["".concat(l,".").concat(m)]||f[m]||c[m]||a;return r?n.createElement(d,p(p({ref:t},u),{},{components:r})):n.createElement(d,p({ref:t},u))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,p=new Array(a);p[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:o,p[1]=i;for(var s=2;s<a;s++)p[s]=r[s];return n.createElement.apply(null,p)}return n.createElement.apply(null,r)}f.displayName="MDXCreateElement"},900:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return i},contentTitle:function(){return l},metadata:function(){return s},toc:function(){return u},default:function(){return f}});var n=r(87462),o=r(63366),a=(r(67294),r(3905)),p=["components"],i={},l=void 0,s={unversionedId:"puppeteer.page.waitforfilechooser",id:"version-10.0.0/puppeteer.page.waitforfilechooser",isDocsHomePage:!1,title:"puppeteer.page.waitforfilechooser",description:"Home &gt; puppeteer &gt; Page &gt; waitForFileChooser",source:"@site/versioned_docs/version-10.0.0/puppeteer.page.waitforfilechooser.md",sourceDirName:".",slug:"/puppeteer.page.waitforfilechooser",permalink:"/puppeteer/docs/10.0.0/puppeteer.page.waitforfilechooser",editUrl:"https://github.com/facebook/puppeteer/edit/main/website/versioned_docs/version-10.0.0/puppeteer.page.waitforfilechooser.md",version:"10.0.0",frontMatter:{},sidebar:"version-10.0.0/docs",previous:{title:"puppeteer.page.waitfor",permalink:"/puppeteer/docs/10.0.0/puppeteer.page.waitfor"},next:{title:"puppeteer.page.waitforfunction",permalink:"/puppeteer/docs/10.0.0/puppeteer.page.waitforfunction"}},u=[{value:"Page.waitForFileChooser() method",id:"pagewaitforfilechooser-method",children:[]},{value:"Parameters",id:"parameters",children:[]},{value:"Remarks",id:"remarks",children:[]}],c={toc:u};function f(e){var t=e.components,r=(0,o.Z)(e,p);return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/index"},"Home")," ",">"," ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer"},"puppeteer")," ",">"," ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.page"},"Page")," ",">"," ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.page.waitforfilechooser"},"waitForFileChooser")),(0,a.kt)("h2",{id:"pagewaitforfilechooser-method"},"Page.waitForFileChooser() method"),(0,a.kt)("p",null,"This method is typically coupled with an action that triggers file choosing. The following example clicks a button that issues a file chooser and then responds with ",(0,a.kt)("inlineCode",{parentName:"p"},"/tmp/myfile.pdf")," as if a user has selected this file."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const [fileChooser] = await Promise.all([\npage.waitForFileChooser(),\npage.click('#upload-file-button'),\n// some button that triggers file selection\n]);\nawait fileChooser.accept(['/tmp/myfile.pdf']);\n\n")),(0,a.kt)("p",null,"NOTE: This must be called before the file chooser is launched. It will not return a currently active file chooser."),(0,a.kt)("b",null,"Signature:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"waitForFileChooser(options?: WaitTimeoutOptions): Promise<FileChooser>;\n")),(0,a.kt)("h2",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"options"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"/puppeteer/docs/10.0.0/puppeteer.waittimeoutoptions"},"WaitTimeoutOptions")),(0,a.kt)("td",{parentName:"tr",align:null},"Optional waiting parameters")))),(0,a.kt)("b",null,"Returns:"),(0,a.kt)("p",null,"Promise","<",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.filechooser"},"FileChooser"),">"),(0,a.kt)("p",null,"Resolves after a page requests a file picker."),(0,a.kt)("h2",{id:"remarks"},"Remarks"),(0,a.kt)("p",null,"NOTE: In non-headless Chromium, this method results in the native file picker dialog ",(0,a.kt)("inlineCode",{parentName:"p"},"not showing up")," for the user."))}f.isMDXComponent=!0}}]);