|
|
|
|
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[13398],{58268:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var t=n(85893),s=n(11151);const o={sidebar_label:"Keyboard.down"},i="Keyboard.down() method",d={id:"api/puppeteer.keyboard.down",title:"Keyboard.down() method",description:"Dispatches a keydown event.",source:"@site/versioned_docs/version-21.6.0/api/puppeteer.keyboard.down.md",sourceDirName:"api",slug:"/api/puppeteer.keyboard.down",permalink:"/api/puppeteer.keyboard.down",draft:!1,unlisted:!1,tags:[],version:"21.6.0",frontMatter:{sidebar_label:"Keyboard.down"},sidebar:"api",previous:{title:"Keyboard",permalink:"/api/puppeteer.keyboard"},next:{title:"Keyboard.press",permalink:"/api/puppeteer.keyboard.press"}},a={},c=[{value:"Signature:",id:"signature",level:4},{value:"Parameters",id:"parameters",level:2},{value:"Remarks",id:"remarks",level:2}];function p(e){const r={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"keyboarddown-method",children:"Keyboard.down() method"}),"\n",(0,t.jsxs)(r.p,{children:["Dispatches a ",(0,t.jsx)(r.code,{children:"keydown"})," event."]}),"\n",(0,t.jsx)(r.h4,{id:"signature",children:"Signature:"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-typescript",children:"class Keyboard {\n abstract down(\n key: KeyInput,\n options?: Readonly<KeyDownOptions>\n ): Promise<void>;\n}\n"})}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.table,{children:[(0,t.jsx)(r.thead,{children:(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.th,{children:"Parameter"}),(0,t.jsx)(r.th,{children:"Type"}),(0,t.jsx)(r.th,{children:"Description"})]})}),(0,t.jsxs)(r.tbody,{children:[(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"key"}),(0,t.jsx)(r.td,{children:(0,t.jsx)(r.a,{href:"/api/puppeteer.keyinput",children:"KeyInput"})}),(0,t.jsxs)(r.td,{children:["Name of key to press, such as ",(0,t.jsx)("code",{children:"ArrowLeft"}),". See ",(0,t.jsx)(r.a,{href:"/api/puppeteer.keyinput",children:"KeyInput"})," for a list of all key names."]})]}),(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:"options"}),(0,t.jsxs)(r.td,{children:["Readonly<",(0,t.jsx)(r.a,{href:"/api/puppeteer.keydownoptions",children:"KeyDownOptions"}),">"]}),(0,t.jsxs)(r.td,{children:[(0,t.jsx)(r.em,{children:"(Optional)"})," An object of options. Accepts text which, if specified, generates an input event with this text. Accepts commands which, if specified, is the commands of keyboard shortcuts, see ",(0,t.jsx)(r.a,{href:"https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h",children:"Chromium Source Code"})," for valid command names."]})]})]})]}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.strong,{children:"Returns:"})}),"\n",(0,t.jsx)(r.p,{children:"Promise<void>"}),"\n",(0,t.jsx)(r.h2,{id:"remarks",children:"Remarks"}),"\n",(0,t.jsxs)(r.p,{children:["If ",(0,t.jsx)(r.code,{children:"key"})," is a single character and no modifier keys besides ",(0,t.jsx)(r.code,{children:"Shift"})," are being held down, a ",(0,t.jsx)(r.code,{children:"keypress"}),"/",(0,t.jsx)(r.code,{children:"input"})," event will also generated. The ",(0,t.jsx)(r.code,{children:"text"})," option can be specified to force an input event to be generated. If ",(0,t.jsx)(r.code,{children:"key"})," is a modifier key, ",(0,t.jsx)(r.code,{children:"Shift"}),", ",(0,t.jsx)(r.code,{children:"Meta"}),", ",(0,t.jsx)(r.code,{children:"Control"}),", or ",(0,t.jsx)(r.code,{children:"Alt"}),", subsequent key presses will be sent with that modifier active. To release the modifier key, use ",(0,t.jsx)(r.a,{href:"/api/puppeteer.keyboard.up",children:"Keyboard.up()"}),"."]}),"\n",(0,t.jsxs)(r.p,{children:["After the key is pressed once, subsequent calls to ",(0,t.jsx)(r.a,{href:"/api/p
|
