Features

Update Scan Name

Scans uploaded to the dashboard from axe DevTools Mobile for Appium are named using the screen's name or title when avaialble. You can set the name to something more specific using the scanName key within the settings dictionary.

const axeSettings = { 
  apiKey: '<your-api-key-here>', 
  scanName: '<your-scan-name-here>'
}

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

Ignore Rules

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 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)

Tagging Results

Tagging is a helpful feature to organize, share and search for scans within the axe DevTools Mobile Dashboard. Some helpful tags for your team may be the team name, build number, simulator version, etc.

Tagged scans are visible to everyone within your organization, whereas scans without tags are visible only to the user that created them.

Send a Scan with a Tag

Add the key tags with the value of any tag you'd like to add. The below example will push a scan to the dashboard with two tags, "v0.0.1" and "iOS 17.4". Note it can be added to the settings object with or without the scanName key.

const axeSettings = { 
  apiKey: '<your-api-key-here>', 
  scanName: '<your-scan-name-here>', 
  tags: ['v0.0.1', 'iOS 17.4'] 
}

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