Skip to content

Commit

Permalink
Support block-based accessibility properties
Browse files Browse the repository at this point in the history
These block-based variants of the UIAccessibility properties were introduced in iOS 17. Resolves #192.
  • Loading branch information
NickEntin committed Jan 24, 2024
1 parent 1b2f58a commit 591d591
Show file tree
Hide file tree
Showing 2 changed files with 253 additions and 26 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
//
// Copyright 2024 Block Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

import Foundation

// TODO: Do the block variants automatically account for the attributed versions into the non-attributed versions?

// TODO: `accessibilityHeaderElements` is tvOS only, but `accessibilityHeaderElementsBlock` is available on iOS. Does it do anything on iOS?

extension NSObject {

var effectiveIsAccessibilityElement: Bool {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return isAccessibilityElementBlock?() ?? isAccessibilityElement
} else {
return isAccessibilityElement
}
#else
return isAccessibilityElement
#endif
}

var effectiveAccessibilityLabel: String? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityLabelBlock?() ?? accessibilityLabel
} else {
return accessibilityLabel
}
#else
return accessibilityLabel
#endif
}

var effectiveAccessibilityValue: String? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityValueBlock?() ?? accessibilityValue
} else {
return accessibilityValue
}
#else
return accessibilityValue
#endif
}

var effectiveAccessibilityHint: String? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityHintBlock?() ?? accessibilityHint
} else {
return accessibilityHint
}
#else
return accessibilityHint
#endif
}

var effectiveAccessibilityTraits: UIAccessibilityTraits {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityTraitsBlock?() ?? accessibilityTraits
} else {
return accessibilityTraits
}
#else
return accessibilityTraits
#endif
}

var effectiveAccessibilityLanguage: String? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityLanguageBlock?() ?? accessibilityLanguage
} else {
return accessibilityLanguage
}
#else
return accessibilityLanguage
#endif
}

var effectiveAccessibilityUserInputLabels: [String] {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityUserInputLabelsBlock?() ?? accessibilityUserInputLabels
} else {
return accessibilityUserInputLabels
}
#else
return accessibilityUserInputLabels
#endif
}

var effectiveAccessibilityElementsHidden: Bool {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityElementsHiddenBlock?() ?? accessibilityElementsHidden
} else {
return accessibilityElementsHidden
}
#else
return accessibilityElementsHidden
#endif
}

var effectiveAccessibilityRespondsToUserInteraction: Bool {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityRespondsToUserInteractionBlock?() ?? accessibilityRespondsToUserInteraction
} else {
return accessibilityRespondsToUserInteraction
}
#else
return accessibilityRespondsToUserInteraction
#endif
}

var effectiveAccessibilityViewIsModal: Bool {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityViewIsModalBlock?() ?? accessibilityViewIsModal
} else {
return accessibilityViewIsModal
}
#else
return accessibilityViewIsModal
#endif
}

var effectiveShouldGroupAccessibilityChildren: Bool {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityShouldGroupAccessibilityChildrenBlock?() ?? shouldGroupAccessibilityChildren
} else {
return shouldGroupAccessibilityChildren
}
#else
return shouldGroupAccessibilityChildren
#endif
}

var effectiveAccessibilityElements: [Any]? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityElementsBlock?() ?? accessibilityElements
} else {
return accessibilityElements
}
#else
return accessibilityElements
#endif
}

var effectiveAccessibilityContainerType: UIAccessibilityContainerType {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityContainerTypeBlock?() ?? accessibilityContainerType
} else {
return accessibilityContainerType
}
#else
return accessibilityContainerType
#endif
}

var effectiveAccessibilityActivationPoint: CGPoint {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityActivationPointBlock?() ?? accessibilityActivationPoint
} else {
return accessibilityActivationPoint
}
#else
return accessibilityActivationPoint
#endif
}

var effectiveAccessibilityFrame: CGRect {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityFrameBlock?() ?? accessibilityFrame
} else {
return accessibilityFrame
}
#else
return accessibilityFrame
#endif
}

var effectiveAccessibilityPath: UIBezierPath? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityPathBlock?() ?? accessibilityPath
} else {
return accessibilityPath
}
#else
return accessibilityPath
#endif
}

var effectiveAccessibilityCustomActions: [UIAccessibilityCustomAction]? {
#if swift(>=5.9)
if #available(iOS 17.0, *) {
return accessibilityCustomActionsBlock?() ?? accessibilityCustomActions
} else {
return accessibilityCustomActions
}
#else
return accessibilityCustomActions
#endif
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ extension NSObject {

/// Returns a tuple consisting of the `description` and (optionally) a `hint` that VoiceOver will read for the object.
func accessibilityDescription(context: AccessibilityHierarchyParser.Context?) -> (description: String, hint: String?) {
var accessibilityDescription = accessibilityLabelOverride(for: context) ?? accessibilityLabel ?? ""
var accessibilityDescription = accessibilityLabelOverride(for: context) ?? effectiveAccessibilityLabel ?? ""

var hintDescription = accessibilityHint?.nonEmpty()
var hintDescription = effectiveAccessibilityHint?.nonEmpty()

let strings = Strings(locale: accessibilityLanguage)
let strings = Strings(locale: effectiveAccessibilityLanguage)

let numberFormatter = NumberFormatter()
if let localeIdentifier = accessibilityLanguage {
if let localeIdentifier = effectiveAccessibilityLanguage {
numberFormatter.locale = Locale(identifier: localeIdentifier)
}

Expand All @@ -36,7 +36,7 @@ extension NSObject {
switch context {
case let .dataTableCell(row: row, column: column, width: width, height: height, isFirstInRow: isFirstInRow, rowHeaders: rowHeaders, columnHeaders: columnHeaders):
let headersDescription = (rowHeaders + columnHeaders).map { header -> String in
switch (header.accessibilityLabel?.nonEmpty(), header.accessibilityValue?.nonEmpty()) {
switch (header.effectiveAccessibilityLabel?.nonEmpty(), header.effectiveAccessibilityValue?.nonEmpty()) {
case (nil, nil):
return ""
case let (.some(label), nil):
Expand Down Expand Up @@ -74,7 +74,7 @@ extension NSObject {
descriptionContainsContext = false
}

if let accessibilityValue = accessibilityValue?.nonEmpty(), !hidesAccessibilityValue(for: context) {
if let accessibilityValue = effectiveAccessibilityValue?.nonEmpty(), !hidesAccessibilityValue(for: context) {
if let existingDescription = accessibilityDescription.nonEmpty() {
if descriptionContainsContext {
accessibilityDescription += " \(accessibilityValue)"
Expand All @@ -86,7 +86,7 @@ extension NSObject {
}
}

if accessibilityTraits.contains(.selected) {
if effectiveAccessibilityTraits.contains(.selected) {
if let existingDescription = accessibilityDescription.nonEmpty() {
accessibilityDescription = String(format: strings.selectedTraitFormat, existingDescription)
} else {
Expand All @@ -96,25 +96,25 @@ extension NSObject {

var traitSpecifiers: [String] = []

if accessibilityTraits.contains(.notEnabled) {
if effectiveAccessibilityTraits.contains(.notEnabled) {
traitSpecifiers.append(strings.notEnabledTraitName)
}

let hidesButtonTraitInContext = context?.hidesButtonTrait ?? false
let hidesButtonTraitFromTraits = [UIAccessibilityTraits.keyboardKey, .switchButton, .tabBarItem].contains(where: { accessibilityTraits.contains($0) })
if accessibilityTraits.contains(.button) && !hidesButtonTraitFromTraits && !hidesButtonTraitInContext {
let hidesButtonTraitFromTraits = [UIAccessibilityTraits.keyboardKey, .switchButton, .tabBarItem].contains(where: { effectiveAccessibilityTraits.contains($0) })
if effectiveAccessibilityTraits.contains(.button) && !hidesButtonTraitFromTraits && !hidesButtonTraitInContext {
traitSpecifiers.append(strings.buttonTraitName)
}

if accessibilityTraits.contains(.switchButton) {
if accessibilityTraits.contains(.button) {
if effectiveAccessibilityTraits.contains(.switchButton) {
if effectiveAccessibilityTraits.contains(.button) {
// An element can have the private switch button trait without being a UISwitch (for example, by passing
// through the traits of a contained switch). In this case, VoiceOver will still read the "Switch
// Button." trait, but only if the element's traits also include the `.button` trait.
traitSpecifiers.append(strings.switchButtonTraitName)
}

switch accessibilityValue {
switch effectiveAccessibilityValue {
case "1":
traitSpecifiers.append(strings.switchButtonOnStateName)
case "0":
Expand All @@ -128,27 +128,27 @@ extension NSObject {
}

let showsTabTraitInContext = context?.showsTabTrait ?? false
if accessibilityTraits.contains(.tabBarItem) || showsTabTraitInContext {
if effectiveAccessibilityTraits.contains(.tabBarItem) || showsTabTraitInContext {
traitSpecifiers.append(strings.tabTraitName)
}

if accessibilityTraits.contains(.header) {
if effectiveAccessibilityTraits.contains(.header) {
traitSpecifiers.append(strings.headerTraitName)
}

if accessibilityTraits.contains(.link) {
if effectiveAccessibilityTraits.contains(.link) {
traitSpecifiers.append(strings.linkTraitName)
}

if accessibilityTraits.contains(.adjustable) {
if effectiveAccessibilityTraits.contains(.adjustable) {
traitSpecifiers.append(strings.adjustableTraitName)
}

if accessibilityTraits.contains(.image) {
if effectiveAccessibilityTraits.contains(.image) {
traitSpecifiers.append(strings.imageTraitName)
}

if accessibilityTraits.contains(.searchField) {
if effectiveAccessibilityTraits.contains(.searchField) {
traitSpecifiers.append(strings.searchFieldTraitName)
}

Expand Down Expand Up @@ -221,17 +221,17 @@ extension NSObject {
}
}

if accessibilityTraits.contains(.switchButton) && !accessibilityTraits.contains(.notEnabled) {
if effectiveAccessibilityTraits.contains(.switchButton) && !effectiveAccessibilityTraits.contains(.notEnabled) {
if let existingHintDescription = hintDescription?.nonEmpty()?.strippingTrailingPeriod() {
hintDescription = String(format: strings.switchButtonTraitHintFormat, existingHintDescription)
} else {
hintDescription = strings.switchButtonTraitHint
}
}

let hasHintOnly = (accessibilityHint?.nonEmpty() != nil) && (accessibilityLabel?.nonEmpty() == nil) && (accessibilityValue?.nonEmpty() == nil)
let hidesAdjustableHint = accessibilityTraits.contains(.notEnabled) || accessibilityTraits.contains(.switchButton) || hasHintOnly
if accessibilityTraits.contains(.adjustable) && !hidesAdjustableHint {
let hasHintOnly = (effectiveAccessibilityHint?.nonEmpty() != nil) && (effectiveAccessibilityLabel?.nonEmpty() == nil) && (effectiveAccessibilityValue?.nonEmpty() == nil)
let hidesAdjustableHint = effectiveAccessibilityTraits.contains(.notEnabled) || effectiveAccessibilityTraits.contains(.switchButton) || hasHintOnly
if effectiveAccessibilityTraits.contains(.adjustable) && !hidesAdjustableHint {
if let existingHintDescription = hintDescription?.nonEmpty()?.strippingTrailingPeriod() {
hintDescription = String(format: strings.adjustableTraitHintFormat, existingHintDescription)
} else {
Expand Down Expand Up @@ -259,7 +259,7 @@ extension NSObject {
}

private func hidesAccessibilityValue(for context: AccessibilityHierarchyParser.Context?) -> Bool {
if accessibilityTraits.contains(.switchButton) {
if effectiveAccessibilityTraits.contains(.switchButton) {
return true
}

Expand All @@ -276,8 +276,6 @@ extension NSObject {
}
}

// MARK: - Private Static Properties

// MARK: - Private

private struct Strings {
Expand Down

0 comments on commit 591d591

Please sign in to comment.