Debug Build

axe DevTools Mobile is a development/testing tool and should not be in your production code. We recommend using build configurations or compiler flags to manage how your application adds axe DevTools Mobile.

Android

Within your Android setup when adding the floating action button, wrapping it in a debugging block will ensure you're only adding it in development or testing environments.

if (BuildConfig.DEBUG) {
    axe.showA11yFAB(this)
}

Compatibility with ProGuard

When using ProGuard within your development or testing builds, be sure to enable the library in your ProGuard settings:

1. Inside the proguard-rules.pro, add: -keep class com.deque.** { *; }
2. Clean and rebuild your project.

iOS

Note: axeDevToolsXCUI is only available in UITests and does not apply to this section.

Keep axeDevToolsUIKit in your debug build by utilizing the Debug & Release build configurations available to you by default.

Using conditional compilations, you can keep axe DevTools in your Debug build and out of your Release build at compile time. A conditional compilation block allows code to be compiled only when the condition is met.

Check your compiler flags by navigating to Build Settings in your project and searching for flag. In the Debug row, find an existing flag, or add a new flag, to use for accessibility testing. Use the flag to encase the UIKit implementation.

#if MY_DEBUG_FLAG
    import axeDevToolsUIKit
#endif