@bbc/nightwatch-commands
v1.1.2
Published
Basic Nightwatch Commands
Downloads
55
Maintainers
Keywords
Readme
Keywords
elementCount
Purpose
Read the number of elements that match a certain criteria
Parameters
- The
elementCount(locateStrategy, selector, count)
keyword has three required parameters:locateStrategy
- can be something likecss selector
orxpath
and is based on the selectorselector
- is way in which we identify the elementcount
- is the number of items that we are expecting there to be
How it works
It checks the number of elements which match the selector and if it does not match the count given then it will fail the assertion.
Example
browser.page.<page>.assert.elementCount('css selector', 'ol li', 7);
getVersionNumbers
Purpose
This extracts the version number of a product from the HTML source
Parameters
The getVersionNumber(['name'])
keyword accepts an array of names.
How it works
It reads in the HTML source of a page and then parses it to look for the name
which is of the format name/xx.yy.zz
. Where xx.yy.zz
are the version numbers.
Example
browser.page.<page>.getVersionNumbers(['name']);
hideElement
Purpose
This can hide an element from the page and is useful for when performing screen comparisons and ignoring certain sections of the page
Parameters
The hideElement(elementId)
keyword accepts an element ID.
How it works
It edits the styling of the HTML in question to turn the opacity to full, so it is transparent.
Example
browser.page.<page>.hideElement(elementId);
screenSize
Purpose
This provides a way of us getting the width of the browser window so we can vary the assertions in a test accordingly. For example the layout of modules is different at different screen widths.
The nightwatch supported way for getting the screen width does not work on Firefox, or the iPhone. This function provides an alternate way of doing this.
How it works
It runs some javascript in the browser which returns the width of the browser window, and returns it in the callback.
Example
browser.screenSize(function (screenSize) {
if (screenSize >= 600) {
// verify something on a large screen
} else {
// verify something on a small screen
}
});
setCheckbox
Purpose
This provides a way of setting a checkbox to either true/false regardless of it's current state
Parameters
- The
setCheckbox(locateStrategy, selector, value)
keyword has three required parameters:locateStrategy
- can be something likecss selector
orxpath
and is based on the selectorselector
- is way in which we identify the elementvalue
- this can either betrue
orfalse
depending on whether we want it checked or not
How it works
It checks the current value of the checkbox and if it does not match the value given then it will change it to be the correct value, however if it is the correct value then it will carry on without changing anything.
Example
browser.page.object.setCheckbox('css selector', '<checkbox selector>', true)
setDropdown
Purpose
This provides a way of setting a select dropdown option
Parameters
- The
setDropdown(selector, value)
keyword has two required parameters:selector
- is way in which we identify the elementvalue
- is the value which is provided inside the<option value="XXX">
How it works
It clicks the dropdown menu to show the options and then selects the appropriate value
Example
browser.page.object.setDropdown('bodyColor', '#77BC30')