Protractor Page Object pattern for Protractor.
- encapsulate your page or components interactions and selectors in classes
- allows to abstract elements and components in your tested page, which facilitate refactoring when changing the html structure.
- allows to easily set input fields
npm install --save-dev protractor-pageobject
check the examples folder.
For more examples, you can also check the pages and components created for integration tests.
This is the Page and Component parent class.
A map of element selectors, which defines the elements you want to interact with. Used to retrieve elements or components without having to specify a selector. Check base.element(elName), base.elements(elName) and base.component(elName).
els: {
'searchBox': by.name('q')
}
A map of component classes. Each key should have a corresponding key in els map.
comps: {
searchBox: require('./path/to/component-subclass'), // short version
anotherComponent: {
model: require('./path/to/another-component-subclass'),
opts: {opt1: 'val1'}
}
}
Returns a protractor element. elName should be key in the els map.
Returns a protractor elements (array). elName should be a key in the els map.
Returns a protractor-pageobject Component instance. elNameshould be a key in theels` map.
Returns a promise which resolves to a boolean value.
Sets the value of a field. It will use the following rules (in the specified order):
-
If
elNameis a key incompsand this component has a methodsetValue, then it will call that method. -
If the Page or Component instance has a
setElName. using camelCase. For example, ifelName = 'my-el-1', then the method should be calledsetMyEl1` -
If none of the above works, then it will detect the field type and use the proper selenium command to set the value (
sendKeys(),click()on dropdown or checkboxes...). Here is the list of supported fields for now:- input[type=email]
- input[type=file]
- input[type=number]
- input[type=password]
- input[type=search]
- input[type=tel]
- input[type=text]
- input[type=textarea]
- input[type=url]
- input[type=checkbox]
- input[type=radio]
- select (regular or mutli)
Sets multiple fields at the same time, using setFieldValue(elName, value). Each key should be present in els map.
myComponent.setFields({
elName1: 'value1',
elName2: 'value2',
...
});
Page inherits from Base so all Base methods and properties are inherited. Here is the list of additional methods.
A property or a method that is used to navigate using the get() method below.
Navigate to the url property.
Hook that is called after get(), which can be used to wait for elements (time to use isElementPresent()?...).
returns a promise that will resolve with the current page title (usually the <title> tag in <head>). Alias of browser.getTitle().
returns a promise that will resolve with the current page title. Alias of `browser.getCurrentUrl()
Like Page, Component inherits from Base so all Base methods and properties are inherited.
When creating a new instance of a component, you need to at least provide one property called el which should be a protractor ElementFinder.
Adds a way to retrieve items (as Components_ from a list.
Required configuration properties:
- itemsEl: the name of the selector that needs to be present in
els. - itemClass: the
Componentclass that represent an item in the list.
Returns a list of Components.
MIT.