Skip to content

Update accessibility label for merged nodes #2539

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

Merged
merged 3 commits into from
Nov 3, 2025
+330 −34
Merged

Update accessibility label for merged nodes #2539

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
05840fd
Update accessibility label for merged nodes
ASalavei Oct 31, 2025
b007ef0
Update API dump
ASalavei Oct 31, 2025
4a0decd
Remove public method
ASalavei Oct 31, 2025
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
224 changes: 221 additions & 3 deletions ...entedTest/kotlin/androidx/compose/ui/accessibility/ComponentsAccessibilitySemanticTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package androidx.compose.ui.accessibility

import androidx.compose.foundation.Image
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.size
Expand Down Expand Up @@ -46,15 +47,18 @@ import androidx.compose.ui.interop.runUIKitInstrumentedTestWithInterop
import androidx.compose.ui.platform.accessibility.CMPAccessibilityTraitTextView
import androidx.compose.ui.platform.testTag
import androidx.compose.ui.semantics.Role
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.heading
import androidx.compose.ui.semantics.isTraversalGroup
import androidx.compose.ui.semantics.role
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.semantics.testTag
import androidx.compose.ui.semantics.text
import androidx.compose.ui.state.ToggleableState
import androidx.compose.ui.test.assertAccessibilityTree
import androidx.compose.ui.test.findNodeWithTag
import androidx.compose.ui.test.runUIKitInstrumentedTest
import androidx.compose.ui.text.AnnotatedString
import androidx.compose.ui.text.buildAnnotatedString
import androidx.compose.ui.unit.dp
import androidx.compose.ui.viewinterop.UIKitInteropProperties
Expand Down Expand Up @@ -718,7 +722,7 @@ class ComponentsAccessibilitySemanticTest {
}

assertAccessibilityTree {
label = "Foo\nBar"
label = "Foo, Bar"
identifier = "row"
isAccessibilityElement = true
traits(UIAccessibilityTraitButton)
Expand Down Expand Up @@ -749,7 +753,7 @@ class ComponentsAccessibilitySemanticTest {
}

assertAccessibilityTree {
value = "Label"
label = "Label"
isAccessibilityElement = true
traits(CMPAccessibilityTraitTextView)
}
Expand All @@ -766,7 +770,7 @@ class ComponentsAccessibilitySemanticTest {
}

assertAccessibilityTree {
value = "Placeholder"
label = "Placeholder"
isAccessibilityElement = true
traits(CMPAccessibilityTraitTextView)
}
Expand All @@ -789,4 +793,218 @@ class ComponentsAccessibilitySemanticTest {
traits(CMPAccessibilityTraitTextView)
}
}

@Test
fun testNodeHierarchyInsideAccessibilityElementShouldNotFlatten() = runUIKitInstrumentedTest {
setContent {
Column(modifier = Modifier.clickable {}) {
Text("Title 1")
Row(modifier = Modifier.testTag("Tag 1")) {
Text("Description 1")
Text("Details 1")
}
}
}

assertAccessibilityTree {
isAccessibilityElement = true
label = "Title 1, Description 1, Details 1"
node {
label = "Title 1"
isAccessibilityElement = false
}
node {
identifier = "Tag 1"
isAccessibilityElement = false
node {
label = "Description 1"
isAccessibilityElement = false
}
node {
label = "Details 1"
isAccessibilityElement = false
}
}
}
}

@Test
fun testNodeHierarchyInsideTraversalGroupShouldFlatten() = runUIKitInstrumentedTest {
setContent {
Column {
Column(modifier = Modifier.semantics { isTraversalGroup = true }) {
Text("Title 1")
Row(modifier = Modifier.testTag("Tag 1")) {
Text("Description 1")
Text("Details 1")
}
}
Column(modifier = Modifier.semantics { isTraversalGroup = true }) {
Text("Title 2")
}
}
}

assertAccessibilityTree {
node {
node {
label = "Title 1"
isAccessibilityElement = true
}
node {
label = "Description 1"
isAccessibilityElement = true
}
node {
identifier = "Tag 1"
isAccessibilityElement = false
}
node {
label = "Details 1"
isAccessibilityElement = true
}
}
node {
label = "Title 2"
isAccessibilityElement = true
}
}
}

@Test
fun testReplacedTextContent() = runUIKitInstrumentedTest {
setContent {
Text("Text", modifier = Modifier.semantics {
text = AnnotatedString("Replaced")
})
}

assertAccessibilityTree {
label = "Replaced"
}
}

@Test
fun testReplacedContentWithMergedSemantics() = runUIKitInstrumentedTest {
setContent {
Box(modifier = Modifier.size(50.dp).semantics(mergeDescendants = true) {
text = AnnotatedString("Text")
contentDescription = "Description"
}) {
Text("Text")
}
}

assertAccessibilityTree {
label = "Description, Text"
isAccessibilityElement = true
node {
label = "Text"
isAccessibilityElement = false
}
}
}

@Test
fun testReplacedContentWithoutMergedSemantics() = runUIKitInstrumentedTest {
setContent {
Box(modifier = Modifier.size(50.dp).semantics {
contentDescription = "Description"
}) {
Text("Text")
}
}

assertAccessibilityTree {
node {
label = "Text"
isAccessibilityElement = true
}
node {
label = "Description"
isAccessibilityElement = true
}
}
}

@Test
fun testContentReplacedSemanticsWithChildElement() = runUIKitInstrumentedTest {
setContent {
Box(modifier = Modifier.semantics(mergeDescendants = true) {
text = AnnotatedString("Text")
contentDescription = "Description"
}) {
Box(modifier = Modifier.size(50.dp).testTag("Child"))
}
}

assertAccessibilityTree {
label = "Description"
isAccessibilityElement = true
node {
identifier = "Child"
}
}
}

@Test
fun testEnclosedComplexContentWithMergedSemantics() = runUIKitInstrumentedTest {
setContent {
Column(modifier = Modifier.semantics(mergeDescendants = true) {
text = AnnotatedString("Text")
contentDescription = "Description"
}) {
Box(modifier = Modifier.size(50.dp).semantics {
contentDescription = "Inner"
}) {
TextField(
value = "",
onValueChange = {},
label = { Text("Label") },
placeholder = { Text("Placeholder") }
)
}
Column(modifier = Modifier.semantics(mergeDescendants = true) {}) {
Text(text = "First Text")
Text(text = "Second Text")
}
Text(text = "Text")
}
}

assertAccessibilityTree {
node {
isAccessibilityElement = true
label = "Label"
node {
label = "Label"
isAccessibilityElement = false
}
}
node {
label = "Description, Inner, Text"
isAccessibilityElement = true
node {
label = "Inner"
isAccessibilityElement = false
}
node {
label = "Text"
isAccessibilityElement = false
}
}
node {
label = "First Text, Second Text"
isAccessibilityElement = true
node {
label = "First Text"
isAccessibilityElement = false
}
node {
label = "Second Text"
isAccessibilityElement = false
}
}
}
}
}
Loading