Overview Version History Q & A Rating & Review
Playwright Snippets 2024🎭
Note
This snippet adheres to the Page object model
Typescript or Javascript languages are intended for use with this extension.
Getting Started
This Visual Studio Code extension adds predefined useful code snippets for 🎭 Playwright .
playwright - Playwright is a Node.js library to automate tests cases for various browsers.@playwright/test - Playwright Test provides a test function to declare tests and expect function to write assertions.playwright-core - This package contains the no-browser flavor of Playwright.
Requirements
Visual Studio Code (VS Code) version 1.80.0 or higher.
Installation
Open Visual Studio Code .
Go to Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or using the keyboard shortcut Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac).
Search for "Playwright Snippets Suite" in the Extensions view search box.
Click on the Install button to install the extension.
Reload Visual Studio Code to enable the extension.
Usage
Open a JavaScript or TypeScript file in Visual Studio Code.
Start typing one of the predefined snippets (e.g., p-) to trigger the code snippet suggestion.
Select the desired snippet from the suggestions list, or press Tab to insert the snippet directly.
Replace placeholders (if any) with your custom test code.
Snippets List
Test block
Snippet
Content
p-tdtest.describe()
p-ttest()
p-tstest.step()
p-tbetest.beforeEach()
p-taetest.afterEach()
p-tbatest.beforeAll()
p-taatest.afterAll()
p-tusetest.use()
Imports
Snippet
Content
p-i-pwPlaywright module
p-i-chromiumImport Chromium
p-i-firefoxImport Firefox
p-i-webkitImport Webkit
p-i-devicesImport devices
Browser actions
Snippet
Content
p-browser-newContextbrowser.newContext()
p-browser-newPagebrowser.newPage()
p-connect-chromiumConnect Chromium
p-l-chromiumLaunch Chromium
p-ls-chromiumLaunch Chromium Server
p-connect-firefoxConnect Firefox
p-l-firefoxLaunch Firefox
p-ls-firefoxLaunch Firefox Server
p-connect-webkitConnect Webkit
p-l-webkitLaunch Webkit
p-ls-webkitLaunch Webkit Server
p-b-contextsbrowser.contexts
p-b-closebrowser.close
p-b-isConnectedbrowser.isConnected
p-b-versionbrowser.version
p-b-on-disconnectedbrowser.on('disconnected')
p-bs-closebrowserServer.close
p-bs-killbrowserServer.kill
p-bs-on-closebrowserServer.on('close')
Context actions
Snippet
Content
p-context-newPagecontext.newPage()
p-context-pagescontext.pages()
p-bc-closebrowserContext.close
p-bc-cookiesbrowserContext.cookies
p-bc-routebrowserContext.route
p-bc-unroutebrowserContext.unroute
p-bc-on-closebrowserContext.on('close')
p-bc-on-pagebrowserContext.on('page')
Page actions
Snippet
Content
p-gotopage.goto()
p-clkpage.click()
p-dbclkpage.dblclick()
p-clkipage.nth().click()
p-chkpage.check()
p-uchkpage.uncheck()
p-hoverpage.hover()
p-presspage.press() with options
p-sifpage.setInputFiles()
p-screenshot-fullFull page screenshot
p-screenshot-elementElement screenshot
p-titlepage.title()
p-urlpage.url()
p-fillpage.fill()
p-typepage.type()
p-sopage.selectOption()
p-isvpage.isVisible()
p-ishpage.isHidden()
p-iscpage.isChecked()
p-isenpage.isEnabled()
p-isdpage.isDisabled()
p-isedpage.isEditable()
p-getattrpage.getAttribute()
p-itxtpage.innerText()
p-countpage.count()
p-focuspage.focus()
p-goBackpage.goBack()
p-goFwdpage.goForward()
p-bringToFrontpage.bringToFront
p-closepage.close
p-contentpage.content
p-pdfpage.pdf
p-keyboard-presspage.keyboard.press
p-keyboard-insertTextpage.keyboard.insertText
p-keyboard-uppage.keyboard.up
p-mouse-clkpage.mouse.click
p-mouse-dbclkpage.mouse.dblclick
p-mouse-downpage.mouse.down
p-mouse-movepage.mouse.move
p-mouse-uppage.mouse.up
Page.on snippets
Snippet
Content
p-on-closepage.on('close')
p-on-consolepage.on('console')
p-on-crashpage.on('crash')
p-on-dialogpage.on('dialog')
p-on-domcontentloadedpage.on('domcontentloaded')
p-on-frameattachedpage.on('frameattached')
p-on-framedetachedpage.on('framedetached')
p-on-framenavigatedpage.on('framenavigated')
p-on-loadpage.on('load')
p-on-pageerrorpage.on('pageerror')
p-on-popuppage.on('popup')
p-on-requestpage.on('request')
p-on-requestfailedpage.on('requestfailed')
p-on-requestfinishedpage.on('requestfinished')
p-on-responsepage.on('response')
p-on-workerpage.on('worker')
Page assertion/expect actions
Snippet
Content
p-etbvpage.toBeVisible()
p-etbhpage.toBeHidden()
p-etbepage.toBeEnabled()
p-etbdpage.toBeDisabled()
p-etbcpage.toBeChecked()
p-etbexpect.toBe()
p-ethtexpect.toHaveTitle()
p-etctxtexpect.toContainText()
p-ethattrexpect.toHaveAttribute()
p-ethcexpect.toHaveCount()
p-ethtxtexpect.toHaveText()
p-ethURLexpect.toHaveURL()
p-ethssexpect.toHaveScreenshot()
New Advanced Locators
Snippet
Content
p-get-txtpage.getByText
p-get-rpage.getByRole
p-get-lpage.getByLabel
p-get-tipage.getByTestId
p-get-ppage.getByPlaceholder
p-get-atxtpage.getByAltText
p-get-titlepage.getByTitle
p-locatorpage.locate
p-$page.$
p-$$page.$$
p-$evalpage.$eval
p-$$evalpage.$$eval
p-locator-filterpage.locator.filter
Page wait actions
Snippet
Content
p-wfpage.waitFor()
p-wfspage.waitForSelector()
p-wflspage.waitForLoadState()
p-wftpage.waitForTimeout()
p-wfepage.waitForEvent()
p-wffpage.waitForFunction()
p-wfnpage.waitForNavigation()
p-wfreqpage.waitForRequest()
p-wfrespage.waitForResponse()
Other actions
Snippet
Content
p-pampublic async method() {...}
p-newPageHandle new tab/ page
p-newPopupHandle popups
p-testBlockComplete test block
p-saveHARSave HAR file
p-routepage.route
p-sampleSample playwright test
p-dragdrop-sampledrag and drop example
p-config-expectexpect.configure()
Happy Coding
