Table of contents
Clicking and typing
Users normally access most website functionality through clicks, keystrokes etc. Playwright and Puppeteer allow us to replicate these events by referencing elements on the page using CSS selectors.
Clicking
Clicking is the default way of selecting and activating elements on web pages, and will appear very often in most headless scripts.
const { chromium } = require('playwright')
;(async () => {
const browser = await chromium.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.click('#login')
await browser.close()
})()
const puppeteer = require('puppeteer')
;(async () => {
const browser = await puppeteer.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.waitForSelector('#login')
await page.click('#login')
await browser.close()
})()
For the times when even the humble click fails, you can try the following alternatives:
await page.click('#login', { force: true });to force the click even if the selected element appears not to be accessibleawait page.$eval('#login', elem => elem.click());to run the click inside the webpageawait page.dispatchEvent('#login', 'click');to directly dispatch the click event on the element
Hovering
A popular pattern among web pages is exposing additional information or functionality when the user hovers the mouse cursor over a specific item. Examples include, menus, previews and dialogs containing extra information on the item.
const { chromium } = require('playwright')
;(async () => {
const browser = await chromium.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.hover('a')
await browser.close()
})()
const puppeteer = require('puppeteer')
;(async () => {
const browser = await puppeteer.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.waitForSelector('a')
await page.hover('a')
await browser.close()
})()
Focussing
Focussing on specific UI elements allows the user to interact with them without clicks. It can also result in a proactive reaction from the webapp, such as displaying suggestions.
const { chromium } = require('playwright')
;(async () => {
const browser = await chromium.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.focus('input')
await browser.close()
})()
const puppeteer = require('puppeteer')
;(async () => {
const browser = await puppeteer.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.waitForSelector('input')
await page.focus('input')
await browser.close()
})()
Typing
We can simulate typing on a real keyboard using page.type():
const { chromium } = require('playwright')
;(async () => {
const browser = await chromium.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.fill('input', 'some search terms')
await browser.close()
})()
const puppeteer = require('puppeteer')
;(async () => {
const browser = await puppeteer.launch()
const page = await browser.newPage()
await page.goto('https://danube-web.shop/')
await page.waitForSelector('input')
await page.type('input', 'some search terms')
await browser.close()
})()
Single key presses can also be executed. For example, to press the Enter key:
- Puppeteer:
await page.keyboard.press('Enter'); - Playwright:
await page.press('Enter');
Key presses can also be sent to a specific element:
await (await page.$('input[type="text"]')).press('Enter');
We can also hold down and release one or more keys, possibly combining them to use keyboard shortcuts:
await page.keyboard.down('Control')
await page.keyboard.press('V')
await page.keyboard.up('Control')
You can run (from the terminal) the above examples as follows:
$ node basic-click-type.js
Further reading
- The related official documentation of Playwright and Puppeteer
- Finding effective selectors
You can contribute to this documentation by