Skip to content
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

Jump to bottom

Implement support for SemanticsProperties.ProgressBarRangeInfo #830

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Implement support for SemanticsProperties.ProgressBarRangeInfo #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
80 changes: 58 additions & 22 deletions compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/platform/ComposeAccessible.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import androidx.compose.ui.geometry.Rect
import androidx.compose.ui.node.Nodes
import androidx.compose.ui.node.requireCoordinator
import androidx.compose.ui.semantics.AccessibilityAction
import androidx.compose.ui.semantics.ProgressBarRangeInfo
import androidx.compose.ui.semantics.Role
import androidx.compose.ui.semantics.SemanticsActions
import androidx.compose.ui.semantics.SemanticsConfiguration
Expand Down Expand Up @@ -153,6 +154,9 @@ internal class ComposeAccessible(
}
}

val progressBarRangeInfo
get() = semanticsNode.config.getOrNull(SemanticsProperties.ProgressBarRangeInfo)

private fun makeScrollbarChild(
vertical: Boolean
): Accessible {
Expand Down Expand Up @@ -265,29 +269,11 @@ internal class ComposeAccessible(
}

override fun getAccessibleValue(): AccessibleValue? {
if (toggleableState != null) {
return object : AccessibleValue {
override fun getCurrentAccessibleValue(): Number {
return when (toggleableState) {
ToggleableState.On -> 1
else -> 0
}
}

override fun setCurrentAccessibleValue(n: Number?): Boolean {
TODO("Not yet implemented")
}

override fun getMinimumAccessibleValue(): Number {
return 0
}

override fun getMaximumAccessibleValue(): Number {
return 1
}
}
return when {
toggleableState != null -> ToggleableAccessibleValue(this)
progressBarRangeInfo != null -> ProgressBarAccessibleValue(this)
else -> null
}
return null
}

override fun getAccessibleIndexInParent(): Int {
Expand Down Expand Up @@ -401,6 +387,7 @@ internal class ComposeAccessible(
scrollBy != null -> AccessibleRole.SCROLL_PANE
setText != null -> AccessibleRole.TEXT
text != null -> AccessibleRole.LABEL
progressBarRangeInfo != null -> AccessibleRole.PROGRESS_BAR
else -> AccessibleRole.PANEL
}
}
Expand Down Expand Up @@ -800,3 +787,52 @@ internal class ComposeAccessible(
}
}
}

private class ToggleableAccessibleValue(
val component: ComposeAccessible.ComposeAccessibleComponent
): AccessibleValue {
override fun getCurrentAccessibleValue(): Number {
return when (component.toggleableState) {
ToggleableState.On -> 1
else -> 0
}
}

override fun setCurrentAccessibleValue(n: Number?): Boolean {
// TODO: Implement this
return false
}

override fun getMinimumAccessibleValue(): Number {
return 0
}

override fun getMaximumAccessibleValue(): Number {
return 1
}
}

private class ProgressBarAccessibleValue(
val component: ComposeAccessible.ComposeAccessibleComponent
): AccessibleValue {

private val rangeInfo: ProgressBarRangeInfo?
get() = component.progressBarRangeInfo

override fun getCurrentAccessibleValue(): Number {
return rangeInfo?.current ?: 0f
}

override fun setCurrentAccessibleValue(n: Number?): Boolean {
// Can't set the value of a progress bar
return false
}

override fun getMinimumAccessibleValue(): Number {
return rangeInfo?.range?.start ?: 0f
}

override fun getMaximumAccessibleValue(): Number {
return rangeInfo?.range?.endInclusive ?: 1f
}
}
31 changes: 31 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 @@ -16,10 +16,17 @@

package androidx.compose.ui.platform

import androidx.compose.foundation.focusable
import androidx.compose.foundation.layout.height
import androidx.compose.material.Button
import androidx.compose.material.LinearProgressIndicator
import androidx.compose.material.Tab
import androidx.compose.material.TabRow
import androidx.compose.material.Text
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.assertThat
import androidx.compose.ui.isEqualTo
Expand All @@ -29,8 +36,10 @@ import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.test.SemanticsNodeInteraction
import androidx.compose.ui.test.junit4.createComposeRule
import androidx.compose.ui.test.onNodeWithTag
import androidx.compose.ui.unit.dp
import javax.accessibility.AccessibleRole
import javax.accessibility.AccessibleText
import kotlin.test.fail
import org.junit.Assert.assertEquals
import org.junit.Rule
import org.junit.Test
Expand Down Expand Up @@ -99,6 +108,28 @@ class AccessibilityTest {
rule.onNodeWithTag("button").assertHasAccessibleRole(AccessibleRole.COMBO_BOX)
}

@Test
fun progressBarHasCorrectRoleAndValues() {
rule.setContent {
LinearProgressIndicator(
progress = 0.2f,
modifier = Modifier.testTag("progressbar")
)
}

rule.onNodeWithTag("progressbar").apply {
val context = ComposeAccessible(fetchSemanticsNode()).accessibleContext
val value = context.accessibleValue
?: fail("No accessibleValue on LinearProgressIndicator")

assertThat(context.accessibleRole).isEqualTo(AccessibleRole.PROGRESS_BAR)
assertThat(value.minimumAccessibleValue).isEqualTo(0f)
assertThat(value.maximumAccessibleValue).isEqualTo(1f)
assertThat(value.currentAccessibleValue).isEqualTo(0.2f)
}

}

private fun SemanticsNodeInteraction.assertHasAccessibleRole(role: AccessibleRole) {
val accessible = ComposeAccessible(fetchSemanticsNode())
assertThat(accessible.accessibleContext.accessibleRole).isEqualTo(role)
Expand Down