iOS Sample App for Axe DevTools Mobile by Deque

This sample application is built solely to showcase the Axe DevTools Mobile implementation. It is non-functional and has been built inaccessibly by design.

Helpful Links

• Library documentation and more information on automated or manual testing can be found at docs.deque.com.
• Learn more about Deque and Axe DevTools Mobile here.

---

Two ways to test

This sample demonstrates both ways to run accessibility scans with Axe DevTools Mobile. Each lives in its own folder under axe-devtools-ios-sample-appUITests/ so you can find the pattern you need at a glance.

Approach	What it does	Where to look	Credentials
Targeted scanning	You choose exactly which screens to scan with axe.run(onElement:), then report via an HTML report and/or upload to the dashboard.	TargetedScan/TargetedScanUITests.swift	Login.swift
AutoScan	Zero-code: your test alone drives the app (no imports, no scan calls). The framework automatically captures, de-duplicates, and scans each unique screen, then writes one HTML report.	AutoScan/AutoScanUITests.swift	axe_config.json

Both approaches produce a self-contained HTML report locally. With targeted scanning, you call generateHtmlReportAndSummary() yourself; with AutoScan the report is generated automatically when the test bundle finishes. AutoScan ships disabled ("axeAutoScanMode": false) in this sample; set it to true and add your credentials in axe_config.json to try it.

---

Get Started:

Prerequisites:

• Xcode 15 +
• Optional: If running locally on iPhone device, must use iOS 16+

This project uses Swift Package Manager to pull in the frameworks from axe-devtools-ios.

1. Add your Deque API Key and your Axe Developer Hub Project ID to Login.swift (for the targeted-scanning tests) and to axe-devtools-ios-sample-appUITests/axe_config.json (for the AutoScan tests).

2. Once you have a device or simulator ready to go, open either TargetedScan/TargetedScanUITests.swift or AutoScan/AutoScanUITests.swift, and tap on the diamond to run the suite. The simulator will launch, and the tests will run.

For Automated Testing with Sauce Labs

Note: This project requires a device on iOS 16.0 or later. Additionally, Virtual Devices running iOS 17.0 may experience hanging during testing. Use an iOS 16.2 Virtual Device to see a successful test run.

To run a test with this project, or to setup your own project, follow our online guide to get started with XCUITesting on SauceLabs.

These steps run the targeted-scanning tests. Assuming you have already downloaded the sample project to your computer:

1. Add your Deque API Key and your Axe Developer Hub Project ID to Login.swift. (To exercise the AutoScan path instead, enable this in axe-devtools-ios-sample-appUITests/axe_config.json as described above.)
2. Open a Terminal window, enter cd , then drag and drop the axe-devtools-ios-sample-app from Finder into the Terminal window. Hit return/enter.

To run on Real Devices, type sh prepareForSauceRealDevice.sh in the same window. Hit return/enter.

To run on Virtual Devices, type sh prepareForSauceVirtualDevice.sh in the same window. Hit return/enter.

These scripts will build the app for the appropriate device type and begin executing automated tests in your Sauce Labs environment.

Have a Question? Found a bug?

Reach out to us, we'd love to help!