Get the axeDevToolsXCUI Framework

Link to Get the axeDevToolsXCUI Framework copied to clipboard

Initialize and configure the axeDevToolsXCUI framework within your UI tests

Not for use with personal data

Setup

Requires:

Sample Application

You can download our sample application on GitHub to see a working example of the axeDevToolsXCUI framework implemented within a simple UI test. Add your Deque credentials and follow the README to begin scanning. This application is inaccessible to showcase the axe DevTools Mobile implementation steps and accessibility issue detection.

Download & Embed the axeDevToolsXCUI Framework

Using Swift Package Manager

Package URL: https://github.com/dequelabs/axe-devtools-ios.

  1. In Xcode, select your main project to open project settings.
  2. In the settings pane, ensure the main project is selected and not a target.
  3. Select the Package Dependencies tab.
  4. Select the plus icon to add a package dependency.
  5. Insert the package URL, and select the axe-devtools-ios package.
  6. For the Dependency Rule, choose the exact version and enter the tag to retrieve.
  7. Select the Add Package button.
  8. You'll be prompted to choose a target to add the framework to. For axeDevToolsXCUI, select the checkbox to the left, then select your UITest target.
  9. Select the Add Package button again, and Xcode will begin fetching the assets.


Screenshot of Xcode's Swift Package Window to select a target where the framework will be added.

Using Artifactory

View the instructions for using Artifactory.

Embed Framework

  1. Drag the axeDevToolsXCUI.xcframework to your project's Frameworks folder.
  2. Add it to your application's UI Test target.
  3. In project settings, select your application's UI Test target.
  4. Select the Build Phases tab.
  5. Add the framework to Copy Frameworks. (It should already be in Link Binary With Libraries).


screenshot of Xcode highlighting steps to embed the framework.

Stay Up to Date

Doublecheck that your version of axe DevTools Mobile for iOS is up to date, to ensure you have the latest rules and features. It does not automatically update, so you should check for a new version periodically. See How to Update axe DevTools Mobile for iOS for details.

What's next? Automated Tests

Next, you'll set up your set up your automated tests with XCTest to scan for accessibility issues.

Is this page helpful?

Help us improve this page

Still need help?