A11yoop is a library solution for Accessibility (A11Y) UI testing in Jetpack Compose.
See also A11yoop - Test Components for example usage.
A11yoop leverages Jetpack Compose's modifier semantics to provide Composable-Level data structures for maintaining a11y properties.
Composables are marked with a11yTarget (and possible suffixes for complex Composables) using setA11yTarget(). This allows for pinpoint retrieval and access to composable-local semantic properties. With the composable in hand, A11yoop provides methods for testing common a11y checks within UI instrumented testing.
As test tags and semantics properties are released, they will be publicly available for writing your own UI tests.
- Visit JitPack - A11yoop for the latest release
- Follow the provided instructions for the release version you are implementing
A11yoop uses testTags to isolate a component within a scaffold for a11y testing. .testTag() is used in jetpack compose to mark a specific node within a complex scaffold while .onNodeWithTag() and similar methods are used to retrieve that node.
See also Android Developers - Custom Semantics Properties
A11yoop uses Semantics Properties to internally assign essential information for a11y testing. By locally maintaining these values, developers can easily contextualize values for quicker troubleshooting during UI test flows. A11yoop provides property keys so developers can customize tests or use test provided by the library, all of which use out of the box UI test methods in Jetpack Compose.
Semantics Properties in A11yoop adhere to this format outlined in the above resource:
val {PROPERTY_NAME} = SemanticsPropertyKey<{PROPERTY_TYPE}>("{PROPERTY_NAME}")
var SemanticsPropertyReceiver.{PROPERTY_REFERENCE} by {PROPERTY_NAME}
This allows custom data structures within the semantics scope to better organize a11y properties needed for A11yoop.