axe DevTools Watir

The axe-devtools-watir gem provides a chainable axe API for Watir and automatically injects into all frames.

Setup and Usage

Ensure you have access to Deque's registry. If not, refer to the setup documentation.

Follow the steps below to set up the axe-devtools-watir gem:

• Add axe-devtools-watir to your Gemfile:

  gem "axe-devtools-watir"

  Or add it to your gemspec file:

  spec.add_dependency "axe-devtools-watir"

  Run bundle install to download and install the gem.

• Require the gem and configure.

require 'axe-watir' # Note that this shouldn't be 'axe-devtools-watir'

# configure `AxeWatir`
driver = AxeWatir.configure(:firefox) do |c|
  # see below for a full list of configurations
  c.jslib_path = "next-version/axe.js"
end

# use the driver configuration instance
driver.page.navigate.to 'https://www.deque.com/'

API

AxeWatir.configure

The configure method takes one optional argument as a symbol and a configuration block object: configure(*arg, &block)

The optional argument is a browser name for watir. The valid browser names are:

• :firefox (default)
• :chrome
• :safari
• :internet_explorer
• :edge

The block configuration object contains the following properties:

Additionally, the configuration block can also take parameters for advanced AxeDevTools configuration