Playwright-elements allows you to create reusable components with child elements and chainable methods. It minimizes boilerplate code in your page objects and even enables you to work without them entirely.
This library makes it easy to represent the tree structure of a web component. Each component can have multiple descendants, and all elements in the tree inherit the Locator API. You can therefore chain calls-mixing element selectors with synchronous methods-to build expressive and concise tests.
Installation:
Run the following command to install the package:
npm install -D playwright-elements
pages/loginPage.ts
import{$}from'playwright-elements';// Component can be defined outside of class and is independent from page lifecicle. constheader=$('.header').with({logo: $('.header-logo'),avatar: $('.avatar')});exportclassLoginPage{readonlyheader=header;// Login form exist only on one page and can be defined only in this page.readonlyform=$('.login-form').with({usernameInput: $('input[name="username"]'),passwordInput: $('input[name="password"]'),loginButton: $('button[type="submit"]'),asyncfillForm(userName: string,password: string){awaitthis.usernameInput.fill(userName);awaitthis.passwordInput.fill(password);awaitthis.loginButton.click();}});}pages/index.ts
export*from'./loginPage';test/fixtures.ts
import{testasbaseTest,buildPageObject,PageObject}from'playwright-elements';import*aspageObjectModulefrom'../pages';// Allows to set page object fixture once and it will extend fixture with new pages in module automatically.typeTestFixtures={pageObject: PageObject<typeofpageObjectModule>};exportconsttest=baseTest.extend({pageObject: [async({},use)=>{awaituse(buildPageObject(pageObjectModule));},{scope: 'test'}],});Now enjoy. test/login.test.ts
import{test}from'./fixtures';test('check login page',async({ pageObject })=>{awaitpageObject.login.form.fillForm('UserName','Pass!');awaitpageObject.login.header.logo.expect().toBeVisible();awaitpageObject.login.header.avatar.expect().toBeVisible();});elements.ts
import{$}from'playwright-elements';// Component can be defined outside of class and is independent from page lifecicle. exportconstheader=$('.header').with({logo: $('.header-logo'),avatar: $('.avatar')});exportconstform=$('.login-form').with({usernameInput: $('input[name="username"]'),passwordInput: $('input[name="password"]'),loginButton: $('button[type="submit"]'),asyncfillForm(userName: string,password: string){awaitthis.usernameInput.fill(userName);awaitthis.passwordInput.fill(password);awaitthis.loginButton.click();}});test/fixtures.ts
import{testasbaseTest}from'playwright-elements';import*aselementsfrom'../elements';typeTestFixtures={elements: typeofelements};exportconsttest=baseTest.extend({elements: [async({},use)=>{awaituse(elements);},{scope: 'test'}],});Now enjoy component driven tests style. test/login.test.ts
import{test}from'./fixtures';test('check login page',async({ elements })=>{awaitelements.form.fillForm('UserName','Pass!');awaitelements.header.logo.expect().toBeVisible();awaitelements.header.avatar.expect().toBeVisible();});