Accessibility stage 1 (#1025)

## Proposed Changes MVP for UIAccessibility integration on iOS ## Testing Test: TODO ## API changes Added to iOS source set: ``` @ExperimentalComposeApi sealed class AccessibilitySyncOptions ``` ``` @ExperimentalComposeApi var ComposeUIViewControllerConfiguration.accessibilitySyncOptions: AccessibilitySyncOptions ``` ``` @ExperimentalComposeApi interface AccessibilityDebugLogger ```
JetBrains · Feb 2, 2024 · 85539a8 · 85539a8
1 parent d5808c9
commit 85539a8
Show file tree

Hide file tree

Showing 17 changed files with 704 additions and 305 deletions.
diff --git a/compose/mpp/demo/src/commonMain/kotlin/androidx/compose/mpp/demo/App.kt b/compose/mpp/demo/src/commonMain/kotlin/androidx/compose/mpp/demo/App.kt
@@ -27,6 +27,7 @@ import androidx.compose.material.Scaffold
 import androidx.compose.material.Text
 import androidx.compose.material.TopAppBar
 import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.automirrored.filled.ArrowBack
 import androidx.compose.material.icons.filled.ArrowBack
 import androidx.compose.mpp.demo.bug.BugReproducers
 import androidx.compose.mpp.demo.components.Components
@@ -150,7 +151,7 @@ class App(
                     },
                     navigationIcon = {
                         Icon(
-                            Icons.Filled.ArrowBack,
+                            Icons.AutoMirrored.Filled.ArrowBack,
                             contentDescription = "Back",
                             modifier = Modifier.backButton()
                         )

diff --git a/compose/mpp/demo/src/uikitMain/kotlin/androidx/compose/mpp/demo/main.uikit.kt b/compose/mpp/demo/src/uikitMain/kotlin/androidx/compose/mpp/demo/main.uikit.kt
@@ -6,16 +6,29 @@ import SwiftUIInteropExample
 import UIKitViewOrder
 import androidx.compose.runtime.*
 import androidx.compose.ui.main.defaultUIKitMain
+import androidx.compose.ui.platform.AccessibilityDebugLogger
+import androidx.compose.ui.platform.AccessibilitySyncOptions
 import androidx.compose.ui.window.ComposeUIViewController
 import bugs.IosBugs
 import bugs.ProperContainmentDisposal
 import bugs.StartRecompositionCheck
 import platform.UIKit.UIViewController
 
 
+@OptIn(ExperimentalComposeApi::class)
 fun main(vararg args: String) {
     val arg = args.firstOrNull() ?: ""
-    defaultUIKitMain("ComposeDemo", ComposeUIViewController {
+    defaultUIKitMain("ComposeDemo", ComposeUIViewController(configure = {
+        accessibilitySyncOptions = AccessibilitySyncOptions.WhenRequiredByAccessibilityServices(object: AccessibilityDebugLogger {
+            override fun log(message: Any?) {
+                if (message == null) {
+                    println()
+                } else {
+                    println("[a11y]: $message")
+                }
+            }
+        })
+    }) {
         IosDemo(arg)
     })
 }

diff --git a/...se/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityContainer.h b/...se/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityContainer.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...se/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityContainer.m b/...se/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityContainer.m
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityElement.h b/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityElement.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,7 +29,27 @@ NS_ASSUME_NONNULL_BEGIN
 // Redeclared to make it visible to Kotlin for override purposes, workaround for the following issue:
 // https://youtrack.jetbrains.com/issue/KT-56001/Kotlin-Native-import-Objective-C-category-members-as-class-members-if-the-category-is-located-in-the-same-file
 
--(BOOL)accessibilityActivate CMP_MUST_BE_OVERRIDED;
+- (NSArray<UIAccessibilityCustomAction *> *)accessibilityCustomActions CMP_MUST_BE_OVERRIDED;
+
+- (UIAccessibilityTraits)accessibilityTraits CMP_MUST_BE_OVERRIDED;
+
+- (NSString *__nullable)accessibilityIdentifier CMP_MUST_BE_OVERRIDED;
+
+- (NSString *__nullable)accessibilityHint CMP_MUST_BE_OVERRIDED;
+
+- (NSString *__nullable)accessibilityLabel CMP_MUST_BE_OVERRIDED;
+
+- (NSString *__nullable)accessibilityValue CMP_MUST_BE_OVERRIDED;
+
+- (CGRect)accessibilityFrame CMP_MUST_BE_OVERRIDED;
+
+- (BOOL)isAccessibilityElement CMP_MUST_BE_OVERRIDED;
+
+- (BOOL)accessibilityActivate CMP_MUST_BE_OVERRIDED;
+
+- (void)accessibilityElementDidBecomeFocused;
+
+- (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction CMP_MUST_BE_OVERRIDED;
 
 @end
 

diff --git a/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityElement.m b/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPAccessibilityElement.m
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ - (void)setAccessibilityContainer:(__nullable id)accessibilityContainer {
 // Overrides default accessibilityContainer implementation.
 - (__nullable id)accessibilityContainer {
     // see https://github.com/flutter/flutter/issues/87247
-    // TODO: investigate if this bug is still present on supported iOS versions, if it's not, fuse `accessibilityContainer` and `resolveAccessibilityContainer` implementations into a single one (like in `CMPAccessibilityContainer`)
+    // TODO: investigate if this bug is still present on iOS versions supported by Compose, if it's not, fuse `accessibilityContainer` and `resolveAccessibilityContainer` implementations into a single one (like in `CMPAccessibilityContainer`)
     if (_inDealloc) {
         return nil;
     }
@@ -60,10 +60,50 @@ + (__nullable id)accessibilityContainerOfObject:(id)object {
     return [object accessibilityContainer];
 }
 
+- (NSArray<UIAccessibilityCustomAction *> *)accessibilityCustomActions {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (UIAccessibilityTraits)accessibilityTraits {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (NSString *__nullable)accessibilityIdentifier {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (NSString *__nullable)accessibilityHint {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (NSString *__nullable)accessibilityLabel {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (NSString *__nullable)accessibilityValue {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (CGRect)accessibilityFrame {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (BOOL)isAccessibilityElement {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
 - (BOOL)accessibilityActivate {
     CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
 }
 
+- (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
+    CMP_MUST_BE_OVERRIDED_INVARIANT_VIOLATION
+}
+
+- (void)accessibilityElementDidBecomeFocused {
+    [super accessibilityElementDidBecomeFocused];
+}
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPMacros.h b/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPMacros.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPUIKitUtils.h b/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPUIKitUtils.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPViewController.h b/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPViewController.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPViewController.m b/compose/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtils/CMPViewController.m
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -114,7 +114,7 @@ - (void)transitLifecycleToStarted {
 - (void)scheduleHierarchyContainmentCheck {
     double delayInSeconds = 0.5;
 
-    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(delayInSeconds * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{        
+    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(delayInSeconds * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
         switch (self->_lifecycleState) {
             case CMPViewControllerLifecycleStateInitalized:
             case CMPViewControllerLifecycleStateDestroyed:

diff --git a/.../src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/CMPUIKitUtilsTests-Bridging-Header.h b/.../src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/CMPUIKitUtilsTests-Bridging-Header.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/CMPViewControllerTests.swift b/...ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/CMPViewControllerTests.swift
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/.../ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/Utils/MockAppDelegate.swift b/.../ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/Utils/MockAppDelegate.swift
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...se/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/Utils/XCTestCase.swift b/...se/ui/ui-uikit/src/uikitMain/objc/CMPUIKitUtils/CMPUIKitUtilsTests/Utils/XCTestCase.swift
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Android Open Source Project
+ * Copyright 2023 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.