Google Git
Sign in
android / platform / external / accessibility-test-framework / 29e67733e7dfcdbaff85974ae3ae15fb121d1edd
commit29e67733e7dfcdbaff85974ae3ae15fb121d1edd[log] [tgz]
authorAndroid Build Coastguard Worker <[email protected]>Tue May 28 23:05:01 2024 +0000
committerAndroid Build Coastguard Worker <[email protected]>Tue May 28 23:05:01 2024 +0000
tree1e03ac9360b87dcca1c4cea1d82ae6e25cfe4e45
parent021bb95fd6546377c885bb986609a2de604a0e0b [diff]
parent05d9fd79972f3a48318a12b4c98178dccc1f087a [diff]
Snap for 11896415 from 05d9fd79972f3a48318a12b4c98178dccc1f087a to 24Q3-release

Change-Id: Ib2d33e60dc94e2a3f75a9af2c4813face38a8938
tree: 1e03ac9360b87dcca1c4cea1d82ae6e25cfe4e45
  1. .github/
  2. gradle/
  3. src/
  4. .gitignore
  5. Android.bp
  6. build.gradle
  7. gradle.properties
  8. gradlew
  9. gradlew.bat
  10. LICENSE
  11. METADATA
  12. MODULE_LICENSE_APACHE2
  13. OWNERS
  14. README.md
README.md

Accessibility Test Framework for Android

To help people with disabilities access Android apps, developers of those apps need to consider how their apps will be presented to accessibility services. Some good practices can be checked by automated tools, such as if a View has a contentDescription. Other rules require human judgment, such as whether or not a contentDescription makes sense to all users.

For more information about Mobile Accessibility, see http://www.w3.org/WAI/mobile/.

This library collects various accessibility-related checks on View objects as well as AccessibilityNodeInfo objects (which the Android framework derives from Views and sends to AccessibilityServices).

Building the Library

The supplied gradle wrapper and build.gradle file can be used to build the Accessibility Test Framework or import the project into Android Studio.

$ ./gradlew build

Sample Usage

Given a view, the following code runs all accessibility checks on all views in the hierarchy rooted at that view and throws an exception if any errors are found:

ImmutableSet<AccessibilityHierarchyCheck> checks =
    AccessibilityCheckPreset.getAccessibilityHierarchyChecksForPreset(
        AccessibilityCheckPreset.LATEST);
AccessibilityHierarchyAndroid hierarchy = AccessibilityHierarchyAndroid.newBuilder(view).build();
List<AccessibilityHierarchyCheckResult> results = new ArrayList<>();
for (AccessibilityHierarchyCheck check : checks) {
  results.addAll(check.runCheckOnHierarchy(hierarchy));
}
List<AccessibilityHierarchyCheckResult> errors =
    AccessibilityCheckResultUtils.getResultsForType(
        results, AccessibilityCheckResultType.ERROR);
if (!errors.isEmpty()) {
  throw new RuntimeException(errors.get(0).getMessage().toString());
}