This is an experimental feature that helps you to listen on events within the browser. It
is currently only supported in Chrome browser (other browser will eventually follow).
To register an event call the
addEventListener command. If an event gets invoked it returns
almost the complete event object that got caught within the browser. Only the
will be removed to avoid circular references. All objects from type
HTMLElement will be
replaced by their xPath. This will help you to query and identify this element with WebdriverIO.
First install this plugin via NPM by executing
$ npm install browserevent
Then just require the module and enhance your client object.
var client =browserevent = ;// by passing the client object as argument the module enhances it with// the `addEventListener` and `removeEventListener` commandbrowserevent;
After that you can use
addEventListener to register events on one or multiple elements
removeEventListener to remove them.
client// triggers event;
Note: this is still an experimental feature. Some events like
hover will not be recorded
by the browser. But events like
doubleClick or custom events are working flawlessly.
You can also use this feature in cloud environments like Sauce Labs
when using a secured tunnel that proxies the port
5555. But be aware of possible delays due
to slow connections between client and cloud server. Your click listener could outlast some
selenium requests until it gets fired. I haven't faced this problem if the standalone server
runs on my local machine.
Please fork, add specs, and send pull requests! In lieu of a formal styleguide, take care to maintain the existing coding style.
- 2013-04-22 v0.1.0 ported feature from WebdriverIO project
- 2015-02-05 v0.2.0 fixed path to extension, break test if connection didn't get established