POMWright

POMWright is a lightweight TypeScript framework that layers the Page Object Model on top of Playwright. It keeps locators, page objects, and fixtures organised so that UI tests stay readable and maintainable.

POMWright provides a way of abstracting the implementation details of a web page and encapsulating them into a reusable page object. This approach makes the tests easier to read, write, and maintain, and helps reduce duplicated code by breaking down the code into smaller, reusable components, making the code more maintainable and organized.

Key capabilities

• Quickly build maintainable Page Object Classes.
• Define any Playwright Locator through type-safe LocatorSchemas.
• Automatic chaining of locators with dot-delimited paths that map directly to Playwright locator methods.
• Auto-completion of LocatorSchemaPaths and sub-paths.
• Adjust locators on the fly without mutating the original definitions.
• Attach structured logs directly to the Playwright HTML report.
• Manage sessionStorage for browser setup and state hand‑off.
• Multiple Domains/BaseURLs
• Validate elements position in DOM through chaining

Why POMWright?

• Stronger reliability – centralised locator definitions reduce brittle inline selectors and make refactors visible at compile time.
• Faster authoring – strongly typed schema paths provide instant auto-complete, even for deeply nested segments and reusable fragments.
• Easier maintenance – shared helper patterns keep page objects, fixtures, and API clients aligned so teams can extend coverage without duplicating boilerplate.
• Incremental adoption – each helper sits on top of Playwright primitives, making it straightforward to migrate existing tests component by component.

Installation

Install POMWright alongside Playwright:

pnpm add -D pomwright
# or
npm install --save-dev pomwright

Documentation

Start with the introduction and continue through the topics:

1. Intro to using POMWright
2. BasePage
3. LocatorSchemaPath
4. LocatorSchema
5. Locator schema helper methods
6. BaseApi
7. PlaywrightReportLogger
8. Session storage helpers
9. Tips for structuring locator files

Troubleshooting and Support

If you encounter any issues or have questions, please check our issues page or reach out to us directly.

Contributing

Pull Requests are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.

License

POMWright is open-source software licensed under the Apache-2.0 license.