puppeteer/assets/js/a94504ec.7e19b70f.js

/*! For license information please see a94504ec.7e19b70f.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[42662],{99193:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>p,contentTitle:()=>d,default:()=>l,frontMatter:()=>t,metadata:()=>i,toc:()=>o});var a=n(85893),s=n(11151);const t={sidebar_label:"Keyboard"},d="Keyboard class",i={id:"api/puppeteer.keyboard",title:"Keyboard class",description:"Keyboard provides an api for managing a virtual keyboard. The high level api is Keyboard.type(), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.",source:"@site/../docs/api/puppeteer.keyboard.md",sourceDirName:"api",slug:"/api/puppeteer.keyboard",permalink:"/next/api/puppeteer.keyboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{sidebar_label:"Keyboard"},sidebar:"api",previous:{title:"Accessibility.snapshot",permalink:"/next/api/puppeteer.accessibility.snapshot"},next:{title:"Keyboard.down",permalink:"/next/api/puppeteer.keyboard.down"}},p={},o=[{value:"Signature:",id:"signature",level:4},{value:"Remarks",id:"remarks",level:2},{value:"Example 1",id:"example-1",level:2},{value:"Example 2",id:"example-2",level:2},{value:"Methods",id:"methods",level:2}];function c(e){const r={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.h1,{id:"keyboard-class",children:"Keyboard class"}),"\n",(0,a.jsxs)(r.p,{children:["Keyboard provides an api for managing a virtual keyboard. The high level api is ",(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.type",children:"Keyboard.type()"}),", which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page."]}),"\n",(0,a.jsx)(r.h4,{id:"signature",children:"Signature:"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-typescript",children:"export declare abstract class Keyboard\n"})}),"\n",(0,a.jsx)(r.h2,{id:"remarks",children:"Remarks"}),"\n",(0,a.jsxs)(r.p,{children:["For finer control, you can use ",(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.down",children:"Keyboard.down()"}),", ",(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.up",children:"Keyboard.up()"}),", and ",(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.sendcharacter",children:"Keyboard.sendCharacter()"})," to manually fire events as if they were generated from a real keyboard."]}),"\n",(0,a.jsxs)(r.p,{children:["On macOS, keyboard shortcuts like ",(0,a.jsx)(r.code,{children:"\u2318 A"})," -> Select All do not work. See ",(0,a.jsx)(r.a,{href:"https://github.com/puppeteer/puppeteer/issues/1313",children:"#1313"}),"."]}),"\n",(0,a.jsxs)(r.p,{children:["The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ",(0,a.jsx)(r.code,{children:"Keyboard"})," class."]}),"\n",(0,a.jsx)(r.h2,{id:"example-1",children:"Example 1"}),"\n",(0,a.jsxs)(r.p,{children:["An example of holding down ",(0,a.jsx)(r.code,{children:"Shift"})," in order to select and delete some text:"]}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-ts",children:"await page.keyboard.type('Hello World!');\nawait page.keyboard.press('ArrowLeft');\n\nawait page.keyboard.down('Shift');\nfor (let i = 0; i < ' World'.length; i++)\n  await page.keyboard.press('ArrowLeft');\nawait page.keyboard.up('Shift');\n\nawait page.keyboard.press('Backspace');\n// Result text will end up saying 'Hello!'\n"})}),"\n",(0,a.jsx)(r.h2,{id:"example-2",children:"Example 2"}),"\n",(0,a.jsxs)(r.p,{children:["An example of pressing ",(0,a.jsx)(r.code,{children:"A"})]}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-ts",children:"await page.keyboard.down('Shift');\nawait page.keyboard.press('KeyA');\nawait page.keyboard.up('Shift');\n"})}),"\n",(0,a.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,a.jsxs)("table",{children:[(0,a.jsx)("thead",{children:(0,a.jsxs)("tr",{children:[(0,a.jsx)("th",{children:(0,a.jsx)(r.p,{children:"Method"})}),(0,a.jsx)("th",{children:(0,a.jsx)(r.p,{children:"Modifiers"})}),(0,a.jsx)("th",{children:(0,a.jsx)(r.p,{children:"Description"})})]})}),(0,a.jsxs)("tbody",{children:[(0,a.jsxs)("tr",{children:[(0,a.jsx)("td",{children:(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.down",children:"down(key, options)"})})}),(0,a.jsx)("td",{}),(0,a.jsx)("td",{children:(0,a.jsxs)(r.p,{children:["Dispatches a ",(0,a.jsx)(r.code,{children:"keydown"})," event."]})})]}),(0,a.jsxs)("tr",{children:[(0,a.jsx)("td",{children:(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.press",children:"press(key, options)"})})}),(0,a.jsx)("td",{}),(0,a.jsx)("td",{children:(0,a.jsxs)(r.p,{children:["Shortcut for ",(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.down",children:"Keyboard.down()"})," and ",(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.up",children:"Keyboard.up()"}),"."]})})]}),(0,a.jsxs)("tr",{children:[(0,a.jsx)("td",{children:(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.sendcharacter",children:"sendCharacter(char)"})})}),(0,a.jsx)("td",{}),(0,a.jsx)("td",{children:(0,a.jsxs)(r.p,{children:["Dispatches a ",(0,a.jsx)(r.code,{children:"keypress"})," and ",(0,a.jsx)(r.code,{children:"input"})," event. This does not send a ",(0,a.jsx)(r.code,{children:"keydown"})," or ",(0,a.jsx)(r.code,{children:"keyup"})," event."]})})]}),(0,a.jsxs)("tr",{children:[(0,a.jsx)("td",{children:(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.type",children:"type(text, options)"})})}),(0,a.jsx)("td",{}),(0,a.jsx)("td",{children:(0,a.jsxs)(r.p,{children:["Sends a ",(0,a.jsx)(r.code,{children:"keydown"}),", ",(0,a.jsx)(r.code,{children:"keypress"}),"/",(0,a.jsx)(r.code,{children:"input"}),", and ",(0,a.jsx)(r.code,{children:"keyup"})," event for each character in the text."]})})]}),(0,a.jsxs)("tr",{children:[(0,a.jsx)("td",{children:(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"/next/api/puppeteer.keyboard.up",children:"up(key)"})})}),(0,a.jsx)("td",{}),(0,a.jsx)("td",{children:(0,a.jsxs)(r.p,{children:["Dispatches a ",(0,a.jsx)(r.code,{children:"keyup"})," event."]})})]})]})]})]})}function l(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},75251:(e,r,n)=>{var a=n(67294),s=Symbol.for("react.element"),t=Symbol.for("react.fragment"),d=Object.prototype.hasOwnProperty,i=a.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,p={key:!0,ref:!0,__self:!0,__source:!0};function o(e,r,n){var a,t={},o=null,c=null;for(a in void 0!==n&&(o=""+n),void 0!==r.key&&(o=""+r.key),void 0!==r.ref&&(c=r.ref),r)d.call(r,a)&&!p.hasOwnProperty(a)&&(t[a]=r[a]);if(e&&e.defaultProps)for(a in r=e.defaultProps)void 0===t[a]&&(t[a]=r[a]);return{$$typeof:s,type:e,key:o,ref:c,props:t,_owner:i.current}}r.Fragment=t,r.jsx=o,r.jsxs=o},85893:(e,r,n)=>{e.exports=n(75251)},11151:(e,r,n)=>{n.d(r,{Z:()=>i,a:()=>d});var a=n(67294);const s={},t=a.createContext(s);function d(e){const r=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),a.createElement(t.Provider,{value:r},e.children)}}}]);