Skip to content

Fix TextField accessibility - contentDescription was ignored #2680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kdroidFilter wants to merge 3 commits into
base: jb-main
Choose a base branch
from
Open

Fix TextField accessibility - contentDescription was ignored #2680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4371bf
Fix TextField unusable with VoiceOver - contentDescription ignored
kdroidFilter Jan 13, 2026
6c5746b
Add tests for TextField accessible name behavior
kdroidFilter Jan 13, 2026
8f4de38
Update accessible name logic for TextField and adjust related test
kdroidFilter Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/platform/a11y/ComposeAccessible.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,8 @@ internal class ComposeAccessible(
}

override fun getAccessibleName(): String? {
return text?.toString()
return semanticsConfig.getOrNull(SemanticsProperties.ContentDescription)?.mergeText()
?: semanticsConfig.getOrNull(SemanticsProperties.Text)?.mergeText()
}

override fun getAccessibleDescription(): String? {
Expand Down
35 changes: 35 additions & 0 deletions compose/ui/ui/src/desktopTest/kotlin/androidx/compose/ui/platform/AccessibilityTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,41 @@ class AccessibilityTest {
.isEqualTo(AccessibleRole.PUSH_BUTTON)
}

@Test
fun textFieldAccessibleNameUsesContentDescription() = runDesktopA11yTest {
test.setContent {
BasicTextField(
value = "typed text",
onValueChange = { },
modifier = Modifier
.testTag("textFieldWithLabel")
.semantics {
contentDescription = "Email"
}
)
}

val context = test.onNodeWithTag("textFieldWithLabel").fetchAccessible().accessibleContext
assertThat(context?.accessibleName).isEqualTo("Email")
assertThat(context?.accessibleDescription).isEqualTo("Email")
}

@Test
fun textFieldAccessibleNameIsNullWithoutContentDescription() = runDesktopA11yTest {
test.setContent {
BasicTextField(
value = "typed text",
onValueChange = { },
modifier = Modifier.testTag("textFieldNoLabel")
)
}

val context = test.onNodeWithTag("textFieldNoLabel").fetchAccessible().accessibleContext
// TextField without contentDescription should have null accessibleName.
// The text content is available through the AccessibleText interface.
assertThat(context?.accessibleName).isEqualTo(null)
}

private fun verifyA11yHierarchyFromAccessible(
window: Window,
@Suppress("SameParameterValue") accessibleName: String
Expand Down
Loading