{"id":19845371,"url":"https://github.com/qavajs/po","last_synced_at":"2025-10-30T12:37:28.223Z","repository":{"id":37392617,"uuid":"504790368","full_name":"qavajs/po","owner":"qavajs","description":"Page Object resolver for qavajs wdio binding","archived":false,"fork":false,"pushed_at":"2024-08-08T13:35:26.000Z","size":452,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-08T15:57:29.804Z","etag":null,"topics":["qa","test-automation","testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qavajs.png","metadata":{"files":{"readme":"README.MD","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-18T08:44:33.000Z","updated_at":"2024-08-08T13:35:01.000Z","dependencies_parsed_at":"2023-11-15T10:42:03.265Z","dependency_job_id":"5ea44a71-a9a9-4530-bb5b-d85d66d36a80","html_url":"https://github.com/qavajs/po","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fpo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fpo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fpo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qavajs%2Fpo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qavajs","download_url":"https://codeload.github.com/qavajs/po/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224278484,"owners_count":17285080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["qa","test-automation","testing"],"created_at":"2024-11-12T13:07:31.746Z","updated_at":"2025-10-30T12:37:23.189Z","avatar_url":"https://github.com/qavajs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## @qavajs/po\n\nThis library provides the ability to create hierarchical page objects and access elements using plain-english selectors.\nWorks on top of webdriverIO.\n\n`npm install @qavajs/po`\n## Usage\n\nLib provides getElement method that resolves plain-english selector and return webdriverIO element or array of webdriverIO element.\n```javascript\nconst { po } = require('@qavajs/po');\n\nWhen('I click {string}', async function (alias) {\n    const element = await po.getElement(alias);\n    await element.waitForClickable();\n    await element.click();\n});\n```\n\n```gherkin\nWhen I click '#1 of Multiple Component \u003e Child Item'\nWhen I click '#some text in Multiple Component \u003e Child Item'\nWhen I click '@some exact text in Multiple Component \u003e Child Item'\nWhen I click '/regexp/ in Multiple Component \u003e Child Item'\n```\n\nLib provides capability to get single element from collection by index (#index of Collection) or inner text (#text in Collection).\n\n## Create page object\n\nLib provides two methods $ and $$ that allow registering elements and collections.\nAn element can be defined in form of webdriverIO selector or as an instance of the component class. \n\nEach not top-level component should have selector element in form of webdriverIO selector.\n```javascript\nconst { $, $$, Component } = require('@qavajs/po');\n\nclass MultipleComponent {\n    selector = '.list-components li';\n    ChildItem = $('div');\n}\n\n//component declared via Component extension\nclass MultipleComponent2 extends Component {\n    ChildItem = $('div');\n}\n\nclass SingleComponent {\n    selector = '.container';\n    ChildItem = $('.child-item');\n}\n\nclass App {\n    SingleElement = $('.single-element');\n    List = $$('.list li');\n    SingleComponent = $(new SingleComponent());\n    MultipleComponents = $$(new MultipleComponent());\n    MultupleComponents2 = $$(new MultipleComponent2('.list-components li'));\n}\n\nmodule.exports = new App();\n```\n## Register PO\nBefore using po object need to be initiated and hierarchy of elements needs to be registered\nThe best place to do it is CucumberJS Before hook\n\n```javascript\nconst { po } = require('@qavajs/po');\nconst pos = require('./app.js');\nBefore(async function() {\n    po.init(browser, { timeout: 10000, logger: this });  // browser is webdriverIO browser object\n    po.register(pos); // pos is page object hierarchy\n});\n```\n\n## Ignore hierarchy\nIn case if child element and parent component doesn't have hierarchy dependency \nit's possible to pass extra parameter _ignoreHierarchy_ parameter to start traverse from root\n         \n```javascript\nclass ComponentThatDescribesNotWellDesignedDOMTree {\n    selector = '.container';\n    //ignoreHierarchy will ignore component selector .container and start traverse from root\n    ChildItem = $('.child-item', { ignoreHierarchy: true }); \n}\n```\n\n## Optional selector property\nIf selector property is not provided for Component then parent element will be returned\n\n```javascript\nclass ParentComponent {\n    selector = '.container';\n    ChildComponent = $(new ChildComponent()); \n}\n\nclass ChildComponent {\n    //Element will be searched in parent .container element\n    Element = $('.someElement');\n}\n```\n\n## Immediate option\nIn order, you don't need to retry query for elements exists you can pass { immediate: true } option\n```javascript\nWhen('I wait {string} not to be present', async function (alias) {\n    const element = await po.getElement(alias, { immediate: true }); // in case if element not found dummy not existing element be returned\n    await element.waitForExist({ reverse: true });\n});\n```\n\n## Dynamic selectors\nIn case you need to generate selector based on some data you can use dynamic selectors\n\ne.g\n```javascript\nconst { Selector } = require('@qavajs/po');\n\nclass Component {\n    selector = '.container';\n    Element = $(Selector((index =\u003e `div:nth-child(${index})`))); // function should return valid selector \n}\n```\n\nThen you can pass parameter to this function from Gherkin file\n\n```gherkin\nWhen I click 'Component \u003e Element (2)'\n```\n\n## Native framework selectors\nIt is also possible to use driver-built capabilities to return element. You can pass handler that has access to\ncurrent `browser` and `parent` objects.\n```javascript\nconst { NativeSelector } = require('@qavajs/po');\n\nclass Component {\n    selector = '.container';\n    Element = $(NativeSelector(browser =\u003e browser.$('.single-element')));\n    Element2 = $(NativeSelector((browser, parent) =\u003e parent.$('.single-element')));\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqavajs%2Fpo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqavajs%2Fpo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqavajs%2Fpo/lists"}