Introduces a new 'shouldCalculateAccessibilityLabelPerLink' property …

…on NIAttributedLabel that allows setting custom accessibility labels. This property defaults to YES. PiperOrigin-RevId: 327479892
Mu-L · Aug 19, 2020 · 5387ace · 5387ace
1 parent 407b47c
commit 5387ace
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 3 deletions.
diff --git a/src/attributedlabel/src/NIAttributedLabel.h b/src/attributedlabel/src/NIAttributedLabel.h
@@ -102,6 +102,18 @@ extern NSString* const NIAttributedLabelLinkAttributeName; // Value is an NSText
 @property (nonatomic) NSTextCheckingType  dataDetectorTypes;  // Default: NSTextCheckingTypeLink
 @property (nonatomic) BOOL                deferLinkDetection; // Default: NO
 
+/**
+ * Determines whether each link's accessibilityLabel will be determined by the label's text.
+ * Defaults to YES.
+ *
+ * If enabled, each link will dynamically determine its accessibilityLabel based on the text to
+ * which the link is attached.
+ *
+ * If disabled, each link will be set to either self.accessibilityLabel or
+ * self.accessibilityAttributedLabel.
+ */
+@property(nonatomic) BOOL shouldCalculateAccessibilityLabelPerLink;
+
 - (void)addLink:(NSURL *)urlLink range:(NSRange)range;
 - (void)removeAllExplicitLinks; // Removes all links that were added by addLink:range:. Does not remove autodetected links.
 

diff --git a/src/attributedlabel/src/NIAttributedLabel.m b/src/attributedlabel/src/NIAttributedLabel.m
@@ -400,6 +400,7 @@ - (void)_configureDefaults {
   self.linkColor = NIIsTintColorGloballySupported() ? self.tintColor : [UIColor blueColor];
   self.dataDetectorTypes = NSTextCheckingTypeLink;
   self.highlightedLinkBackgroundColor = [UIColor colorWithWhite:0.5f alpha:0.5f];
+  self.shouldCalculateAccessibilityLabelPerLink = YES;
 }
 
 - (id)initWithFrame:(CGRect)frame {
@@ -1129,7 +1130,9 @@ - (NIViewAccessibilityElement *)accessibilityElementForRange:(NSRange)range {
       [[NIViewAccessibilityElement alloc] initWithAccessibilityContainer:self
                                                         frameInContainer:bounds
                                                        pointsInContainer:pointsArray];
-  element.accessibilityLabel = [self.mutableAttributedString.string substringWithRange:range];
+  NSString *accessibilityLabel = [self.mutableAttributedString.string substringWithRange:range];
+  [self updateAccessibilityLabelOnElement:element withAccessibilityLabel:accessibilityLabel];
+
   // Set the frame to fallback on if |element|'s accessibility container is changed externally.
   CGRect rectValueInWindowCoordinates = [self convertRect:bounds toView:nil];
   CGRect rectValueInScreenCoordinates =
@@ -1785,6 +1788,19 @@ - (void)invalidateAccessibleElements {
   self.accessibleElements = nil;
 }
 
+- (void)updateAccessibilityLabelOnElement:(NIViewAccessibilityElement *)element
+                   withAccessibilityLabel:(NSString *)accessibilityLabel {
+  if (_shouldCalculateAccessibilityLabelPerLink) {
+    element.accessibilityLabel = accessibilityLabel;
+    return;
+  }
+
+  if (@available(iOS 11, *)) {
+    element.accessibilityAttributedLabel = self.accessibilityAttributedLabel;
+  }
+  element.accessibilityLabel = self.accessibilityLabel;
+}
+
 - (NSArray *)accessibleElements {
   if (nil != _accessibleElements) {
     return _accessibleElements;
@@ -1822,7 +1838,8 @@ - (NSArray *)accessibleElements {
         NIViewAccessibilityElement *element = [[NIViewAccessibilityElement alloc]
             initWithAccessibilityContainer:self
                           frameInContainer:rectValue.CGRectValue];
-        element.accessibilityLabel = label;
+        [self updateAccessibilityLabelOnElement:element withAccessibilityLabel:label];
+
         // Set the frame to fallback on if |element|'s accessibility container is changed
         // externally.
         CGRect rectValueInWindowCoordinates = [self convertRect:rectValue.CGRectValue toView:nil];
@@ -1838,7 +1855,9 @@ - (NSArray *)accessibleElements {
     NIViewAccessibilityElement *element =
         [[NIViewAccessibilityElement alloc] initWithAccessibilityContainer:self
                                                           frameInContainer:self.bounds];
-    element.accessibilityLabel = self.attributedText.string;
+    [self updateAccessibilityLabelOnElement:element
+                     withAccessibilityLabel:self.attributedText.string];
+
     // Set the frame to fallback on if |element|'s accessibility container is changed externally.
     CGRect boundsInWindowCoordinates = [self convertRect:self.bounds toView:nil];
     CGRect boundsInScreenCoordinates =