feat: improve application accessibility

CHANGELOG.md

@@ -55,6 +55,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ### Changed
 
+- Improved Android UI accessibility with semantic headings, TalkBack live-region announcements, minimum IME touch targets and a large-text IME layout that avoids truncated actions.
 - Grammalecte engine initialization now loads conjugation, phonetic and morphology data required by the full grammar engine.
 - Android spell-checker sessions now own their QuickJS engine lifecycle.
 - Android correction is no longer limited to applications supporting `SpellCheckerService`.

ROADMAP.md

@@ -91,7 +91,7 @@ Exit criterion: correction remains usable in common editable applications even w
 - [x] Application icon and visual identity
 - [x] Improve first-run setup
 - [x] Explain the three correction modes in-app
-- [ ] Improve accessibility of the application UI
+- [x] Improve accessibility of the application UI
 - [ ] Review all user-facing French strings
 - [x] Add compatibility documentation
 - [ ] Add performance regression tests

app/src/androidTest/kotlin/fr/grammalecteandroid/unofficial/AccessibilityInstrumentedTest.kt

@@ -0,0 +1,305 @@
+package fr.grammalecteandroid.unofficial
+
+import android.app.Activity
+import android.content.Context
+import android.content.Intent
+import android.os.Build
+import android.view.View
+import android.view.ViewGroup
+import android.widget.TextView
+import androidx.test.core.app.ActivityScenario
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
+import org.junit.Assert.assertTrue
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+class AccessibilityInstrumentedTest {
+    @Test
+    fun accessibilityHelpersApplyExpectedSemantics() {
+        val context =
+            InstrumentationRegistry
+                .getInstrumentation()
+                .targetContext
+
+        val view =
+            TextView(context)
+
+        view.enablePoliteAccessibilityUpdates()
+
+        assertEquals(
+            View.ACCESSIBILITY_LIVE_REGION_POLITE,
+            view.accessibilityLiveRegion,
+        )
+
+        view.markAsAccessibilityHeading()
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+            assertTrue(
+                view.isAccessibilityHeading,
+            )
+        }
+    }
+
+    @Test
+    fun mainScreenExposesAccessibilitySemantics() {
+        val context =
+            InstrumentationRegistry
+                .getInstrumentation()
+                .targetContext
+
+        val preferences =
+            context.getSharedPreferences(
+                SETUP_PREFERENCES_NAME,
+                Context.MODE_PRIVATE,
+            )
+
+        preferences
+            .edit()
+            .putBoolean(
+                SETUP_GUIDE_SHOWN_KEY,
+                true,
+            ).commit()
+
+        try {
+            ActivityScenario
+                .launch(MainActivity::class.java)
+                .use { scenario ->
+                    scenario.onActivity { activity ->
+                        assertScreenHeading(
+                            activity,
+                            activity.getString(R.string.title),
+                        )
+
+                        assertTrue(
+                            "Expected dynamic accessibility status regions",
+                            countPoliteLiveRegions(
+                                activity.window.decorView,
+                            ) >= 3,
+                        )
+                    }
+                }
+        } finally {
+            preferences
+                .edit()
+                .clear()
+                .commit()
+        }
+    }
+
+    @Test
+    fun setupGuideExposesAccessibilitySemantics() {
+        ActivityScenario
+            .launch(SetupGuideActivity::class.java)
+            .use { scenario ->
+                scenario.onActivity { activity ->
+                    assertScreenHeading(
+                        activity,
+                        "Bien démarrer avec Grammalecte",
+                    )
+
+                    assertTrue(
+                        "Expected setup status live regions",
+                        countPoliteLiveRegions(
+                            activity.window.decorView,
+                        ) >= 2,
+                    )
+                }
+            }
+    }
+
+    @Test
+    fun correctionStatusExposesAccessibilitySemantics() {
+        ActivityScenario
+            .launch(CorrectionStatusActivity::class.java)
+            .use { scenario ->
+                scenario.onActivity { activity ->
+                    assertScreenHeading(
+                        activity,
+                        "État de la correction",
+                    )
+
+                    assertTrue(
+                        "Expected correction status live regions",
+                        countPoliteLiveRegions(
+                            activity.window.decorView,
+                        ) >= 2,
+                    )
+                }
+            }
+    }
+
+    @Test
+    fun ruleSettingsExposesAccessibilitySemantics() {
+        ActivityScenario
+            .launch(RuleSettingsActivity::class.java)
+            .use { scenario ->
+                scenario.onActivity { activity ->
+                    assertScreenHeading(
+                        activity,
+                        "Réglages de correction",
+                    )
+
+                    assertTrue(
+                        "Expected rule settings live region",
+                        countPoliteLiveRegions(
+                            activity.window.decorView,
+                        ) >= 1,
+                    )
+                }
+            }
+    }
+
+    @Test
+    fun personalDictionaryExposesAccessibilitySemantics() {
+        ActivityScenario
+            .launch(PersonalDictionaryActivity::class.java)
+            .use { scenario ->
+                scenario.onActivity { activity ->
+                    assertScreenHeading(
+                        activity,
+                        "Dictionnaire personnel",
+                    )
+
+                    assertTrue(
+                        "Expected personal dictionary live region",
+                        countPoliteLiveRegions(
+                            activity.window.decorView,
+                        ) >= 1,
+                    )
+                }
+            }
+    }
+
+    @Test
+    fun processTextExposesAccessibilitySemantics() {
+        val context =
+            InstrumentationRegistry
+                .getInstrumentation()
+                .targetContext
+
+        val intent =
+            Intent(
+                context,
+                ProcessTextActivity::class.java,
+            ).apply {
+                action = Intent.ACTION_PROCESS_TEXT
+                type = "text/plain"
+
+                putExtra(
+                    Intent.EXTRA_PROCESS_TEXT,
+                    "Je sui aller au magazin.",
+                )
+
+                putExtra(
+                    Intent.EXTRA_PROCESS_TEXT_READONLY,
+                    false,
+                )
+            }
+
+        ActivityScenario
+            .launch<ProcessTextActivity>(
+                intent,
+            ).use { scenario ->
+                scenario.onActivity { activity ->
+                    assertScreenHeading(
+                        activity,
+                        "Corriger avec Grammalecte",
+                    )
+
+                    assertTrue(
+                        "Expected process text live region",
+                        countPoliteLiveRegions(
+                            activity.window.decorView,
+                        ) >= 1,
+                    )
+                }
+            }
+    }
+
+    private fun assertScreenHeading(
+        activity: Activity,
+        text: String,
+    ) {
+        val heading =
+            findTextView(
+                activity.window.decorView,
+                text,
+            )
+
+        assertNotNull(
+            "Expected heading: $text",
+            heading,
+        )
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+            assertTrue(
+                "Expected accessibility heading: $text",
+                requireNotNull(heading)
+                    .isAccessibilityHeading,
+            )
+        }
+    }
+
+    private fun findTextView(
+        view: View,
+        text: String,
+    ): TextView? {
+        if (
+            view is TextView &&
+            view.text.toString() == text
+        ) {
+            return view
+        }
+
+        if (view !is ViewGroup) {
+            return null
+        }
+
+        for (index in 0 until view.childCount) {
+            findTextView(
+                view.getChildAt(index),
+                text,
+            )?.let {
+                return it
+            }
+        }
+
+        return null
+    }
+
+    private fun countPoliteLiveRegions(view: View): Int {
+        var count =
+            if (
+                view is TextView &&
+                view.accessibilityLiveRegion ==
+                View.ACCESSIBILITY_LIVE_REGION_POLITE
+            ) {
+                1
+            } else {
+                0
+            }
+
+        if (view is ViewGroup) {
+            for (index in 0 until view.childCount) {
+                count +=
+                    countPoliteLiveRegions(
+                        view.getChildAt(index),
+                    )
+            }
+        }
+
+        return count
+    }
+
+    private companion object {
+        const val SETUP_PREFERENCES_NAME =
+            "setup_guide"
+
+        const val SETUP_GUIDE_SHOWN_KEY =
+            "setup_guide_shown_v1"
+    }
+}

app/src/main/kotlin/fr/grammalecteandroid/unofficial/AccessibilityUi.kt

@@ -0,0 +1,16 @@
+package fr.grammalecteandroid.unofficial
+
+import android.os.Build
+import android.view.View
+import android.widget.TextView
+
+internal fun TextView.markAsAccessibilityHeading() {
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+        isAccessibilityHeading = true
+    }
+}
+
+internal fun TextView.enablePoliteAccessibilityUpdates() {
+    accessibilityLiveRegion =
+        View.ACCESSIBILITY_LIVE_REGION_POLITE
+}

app/src/main/kotlin/fr/grammalecteandroid/unofficial/CorrectionStatusActivity.kt

@@ -61,6 +61,7 @@ class CorrectionStatusActivity : Activity() {
         header.addView(
             TextView(this).apply {
                 text = "État de la correction"
+                markAsAccessibilityHeading()
                 textSize = 24f
 
                 setTypeface(
@@ -341,6 +342,7 @@ class CorrectionStatusActivity : Activity() {
 
     private fun statusTextView(): TextView =
         TextView(this).apply {
+            enablePoliteAccessibilityUpdates()
             textSize = 15f
 
             setTypeface(
@@ -386,6 +388,7 @@ class CorrectionStatusActivity : Activity() {
             addView(
                 TextView(this@CorrectionStatusActivity).apply {
                     text = title
+                    markAsAccessibilityHeading()
                     textSize = 18f
 
                     setTypeface(