Ignore Rules

You can choose to ignore specified rules while testing for accessibility. While we feel that all rules are important, these customizations will allow you to tailor your testing for your business needs.

Ignore Rules by Rule ID

You can ignore select rules while scanning. To do this, add the key ignoreRules to the configuration settings object and set its value to an array containing the IDs of the rules you want to ignore. Each string in the array should be a valid ruleId - in the JavaScript example below you can see the ColorContrast and ScreenTitle rules. Find all ruleIds inside of the axeConf object in the JSON result for any scan.

const axeSettings = {
  apiKey: "<your-api-key-here>",
  ignoreRules: ["ColorContrast", "ScreenTitle"]
}

const result = await driver.execute('mobile: axeScan', axeSettings)

Ignore Experimental Rules

Experimental rules are rulesets that are still in testing and development. To ignore all experimental rules during scanning, add the ignoreExperimental key to the settings object and set its value to 'true'.

const axeSettings = {
  apiKey: "<your-api-key-here>",
  ignoreExperimental: true
}

const result = await driver.execute('mobile: axeScan', axeSettings)