Ask the Community
Auto-generate screen reader testing reports
Automatically generate Screen Reader Reports to help you understand how native screen readers interpret your app’s user interface.
When conducting automated App Accessibility tests on your app, you can generate a Screen Reader Report to evaluate how native screen readers interpret and navigate through your app’s user interface.
The report includes detailed insights such as the screen reader’s spoken output, the focus order of the UI elements, and relevant accessibility metadata. These insights help you identify and fix potential barriers for users who rely on screen readers or other assistive technologies.
Screen Reader Reports are available only for Android apps.
How Screen Reader Reports help
Screen Reader Reports improve your app’s accessibility by providing the following insights:
- Automated report generation: Integrates seamlessly into your test automation runs, enabling continuous accessibility checks across builds.
- Focus checks: Ensures that all relevant elements receive focus during screen reader navigation.
- Spoken output checks: Verifies that the screen reader’s spoken output for each element is accurate and meaningful.
- Reading order checks: Verifies that the screen reader’s reading order follows a logical reading order.
- Accessibility metadata verification: Confirms that all UI elements expose correct labels, roles, and states to assistive technologies.
Generate a Screen Reader Report on BrowserStack App Accessibility testing
To generate a Screen Reader Report during an App Accessibility testing session:
Set the accessibility capability to true in your test suite configuration to enable accessibility testing.
Add the screenReaderAutomationReport capability under accessibilityOptions in your test suite and set it to true.
For example, depending on your test suite framework, include the following configuration to generate the report:
...
accessibility: true # Root level accessibility flag.
accessibilityOptions:
screenReaderAutomationReport: true # Enable Screen Reader Report generation
...
...
services: [
['browserstack', {
...
accessibility: true, // Root level accessibility flag.
accessibilityOptions: {
screenReaderAutomationReport: true // Enable Screen Reader Report generation
}
...
}]
]
...
curl -u "USERNAME:ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/espresso/v2/build" \
-d '{
"app": "bs://$app_id",
"testSuite": "bs://$test_suite_id",
"devices": ["Samsung S24-14.0", "Google Pixel 8-14.0", "Samsung S21-11.0"],
"deviceLogs": true,
"project": "$PROJECT_NAME",
"accessibility": true,
"accessibilityOptions": {
"screenReaderAutomationReport": true
}
}' \
-H "Content-Type: application/json"
The screenReaderAutomationReport capability runs independently. Other configuration options for App Accessibility testing do not apply to Screen Reader Reports.
Screen Reader Report checks
The following checks are performed on your app’s user interface when you enable the screenReaderAutomationReport capability:
| Check | Description |
|---|---|
| Focus order for interactive elements | Ensure interactive elements are focused by the screen reader |
| Focus order for non-interactive elements | Ensure non-interactive elements are focused by the screen reader |
| Meaningful reading order | Reading sequence follows a logical visual order |
| Meaningful spoken output | Spoken text is meaningful for focused elements |
| Meaningful spoken output for images | Images have meaningful spoken text |
| Duplicate state info | State information is not repeated in spoken output |
| Duplicate type info | Element type is not repeated in spoken output |
| Missing visible label | Visible label is present in spoken output |
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!