RootPageObject

RootPageObject is the base for top-level page objects. It is constructed with Page and pairs with a root decorator (@RootSelector, @RootSelectorByRole, etc.).

import {
  PageObject,
  RootPageObject,
  RootSelector,
  Selector,
} from "playwright-page-object";

@RootSelector("CheckoutPage")
class CheckoutPage extends RootPageObject {
  @Selector("PromoCode")
  accessor PromoCode = new PageObject();
}

const checkout = new CheckoutPage(page);

Constructor

new CheckoutPage(page);

The first argument must be a Playwright Page. The root decorator wires the resolved root locator into the instance — without a root decorator, the class will not resolve children correctly.

Inherited members

RootPageObject extends PageObject, so all the PageObject members are available:

• .$ — raw Locator for the root.
• .page — getter for the underlying Page.
• .expect(options?) — Playwright assertion API on .$.
• waitVisible(), waitText(), waitValue(), etc.

await checkout.expect().toBeVisible();
await checkout.waitVisible();
const page = checkout.page;

When to extend RootPageObject

• You want wait helpers and .expect() on the page itself.
• The class has nested PageObject accessors that rely on the root decorator's scope.

For plain page objects without those needs, use a plain class with @RootSelector(...). See Plain Classes.

Constraint: must pair with a root decorator

// Without @RootSelector — child accessors will not resolve correctly.
class A extends RootPageObject {}

// With @RootSelector — fully wired.
@RootSelector("Page")
class B extends RootPageObject {}

If you need a RootPageObject scoped to the whole page (no container), use @RootSelector() with no argument:

@RootSelector()
class AppPage extends RootPageObject {}
// Scope: page.locator("body")

Static guards

Used internally to distinguish RootPageObject subclasses from generic PageObject subclasses when applying root decorators.

See also

• PageObject — the base class.
• Decorator API — all root decorators.
• Built-In POM guide — walkthrough.