OpenParable
Skip to content
← Back to skills

Create Playwright Page Objects

Testing & Quality
create-playwright-page-objects

Create Playwright Page Objects is an Agent Skill for testing & quality published in the PrestaShop/PrestaShop repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create BO page object classes in the ui-testing-library for a new migrated page. Follows the Page Object Model pattern: encapsulate selectors and interactions, never assert. Trigger: "create page objects for {Domain}".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/PrestaShop/PrestaShop/blob/HEAD/.ai/Component/Playwright/skills/create-playwright-page-objects/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/create-playwright-page-objects, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

create-playwright-page-objects

Read @.ai/Component/Playwright/CONTEXT.md for the POM pattern and ui-testing-library architecture.

Page objects live in the ui-testing-library, not in the core repo.

1. Listing page object

Create bo{Domain}Page (extends the appropriate BO base page):

  • Selectors: grid table, filter inputs, bulk action checkboxes, row action buttons, toggle switches, pagination
  • Methods: all return values, never assert
    • getNumberOfElementInGrid(page): Promise<number>
    • filterTable(page, filterBy, value): Promise<void>
    • resetAndGetNumberOfLines(page): Promise<number>
    • getTextColumn(page, row, column): Promise<string>
    • goToAddNewPage(page): Promise<void>
    • goToEditPage(page, row): Promise<void>
    • deleteRow(page, row): Promise<string> — returns alert text
    • bulkAction(page, action): Promise<string> — returns alert text
    • getToggleColumnValue(page, row): Promise<boolean>
    • setToggleColumnValue(page, row, value): Promise<string>

Selector naming: {name}{Type} camelCase — e.g. gridTable, filterNameInput, bulkActionDropdownButton, confirmDeleteButton

2. Create/Edit page object

Create bo{Domain}CreatePage (extends BO base page):

  • Selectors: form inputs, dropdowns, file uploads, save button, tab navigation (if tabs)
  • Methods:
    • createEdit{Domain}(page, data): Promise<string> — fills all fields, clicks save, returns alert text
    • getPageTitle(page): Promise<string>
    • getValue(page, inputName): Promise<string> — for verification after reload
  • Properties:
    • pageTitleCreate: string — expected page title for create mode
    • pageTitleEdit: string — expected page title for edit mode
    • successfulCreationMessage: string
    • successfulUpdateMessage: string

3. Conventions

See Playwright/CONTEXT.md for POM conventions (never assert, selector naming, inheritance, library location). Skill-specific reminders:

  • One page object per distinct BO page (listing page, create/edit page)
  • Prefer data-test attribute selectors when available over CSS classes
  • Check if page objects already exist before creating new ones
  • Sort interface / page-object members alphabetically — this is an expected convention in the ui-testing-library
  • Expose expected messages and selectors here, not in the campaign — message strings (success/error) belong as properties on the page object so campaigns assert against them; never hard-code message text in the core campaign
  • Stay compatible with older branches (≥ 9.1.x) — a change must not crash the library on lower versions; branch on version when the DOM differs rather than assuming the latest

Reference: check existing page objects in the ui-testing-library for the exact inheritance pattern and method signatures.