Add accessibilityValueDescription support.

Author: Marc Mulcahy

Libraries/Components/View/ReactNativeViewAttributes.js

@@ -21,6 +21,7 @@ const UIView = {
   accessibilityRole: true,
   accessibilityStates: true,
   accessibilityState: true,
+  accessibilityValueDescription: true,
   accessibilityHint: true,
   importantForAccessibility: true,
   nativeID: true,

Libraries/Components/View/ReactNativeViewViewConfig.js

@@ -123,6 +123,7 @@ const ReactNativeViewConfig = {
     accessibilityRole: true,
     accessibilityStates: true,
     accessibilityState: true,
+    accessibilityValueDescription: true,
     accessibilityViewIsModal: true,
     accessible: true,
     alignContent: true,

Libraries/Components/View/ViewAccessibility.js

@@ -74,3 +74,25 @@ export type AccessibilityState = {
   busy?: boolean,
   expanded?: boolean,
 };
+
+export type AccessibilityValueDescription = {
+  /**
+   * The minimum value of this component's range. (should be an integer)
+   */
+  minimum?: number,
+
+  /**
+   * The current value of this component's range. (should be an integer)
+   */
+  current?: number,
+
+  /**
+   * The maximum value of this component's range. (should be an integer)
+   */
+  maximum?: number,
+
+  /**
+   * A textual description of this component's value. (will override minimum, current, and maximum if set)
+   */
+  text?: string,
+};

Libraries/Components/View/ViewPropTypes.js

@@ -19,6 +19,7 @@ import type {
   AccessibilityRole,
   AccessibilityStates,
   AccessibilityState,
+  AccessibilityValueDescription,
   AccessibilityActionEvent,
   AccessibilityActionInfo,
 } from './ViewAccessibility';
@@ -415,6 +416,7 @@ export type ViewProps = $ReadOnly<{|
    */
   accessibilityStates?: ?AccessibilityStates,
   accessibilityState?: ?AccessibilityState,
+  accessibilityValueDescription?: ?AccessibilityValueDescription,
 
   /**
    * Provides an array of custom actions available for accessibility.

Libraries/DeprecatedPropTypes/DeprecatedViewPropTypes.js

@@ -122,6 +122,7 @@ module.exports = {
     >,
   >),
   accessibilityState: PropTypes.object,
+  accessibilityValueDescription: PropTypes.object,
   /**
    * Indicates to accessibility services whether the user should be notified
    * when this view changes. Works for Android API >= 19 only.

RNTester/js/examples/Accessibility/AccessibilityExample.js

@@ -512,6 +512,89 @@ class AccessibilityActionsExample extends React.Component {
     );
   }
 }
+
+class FakeSliderExample extends React.Component {
+  state = {
+    current: 50,
+    textualValue: 'center',
+  };
+
+  increment = () => {
+    let newValue = this.state.current + 2;
+    if (newValue > 100) {
+      newValue = 100;
+    }
+    this.setState({
+      current: newValue,
+    });
+  };
+
+  decrement = () => {
+    let newValue = this.state.current - 2;
+    if (newValue < 0) {
+      newValue = 0;
+    }
+    this.setState({
+      current: newValue,
+    });
+  };
+
+  render() {
+    return (
+      <View>
+        <View
+          accessible={true}
+          accessibilityLabel="Fake Slider"
+          accessibilityRole="adjustable"
+          accessibilityActions={[{name: 'increment'}, {name: 'decrement'}]}
+          onAccessibilityAction={event => {
+            switch (event.nativeEvent.actionName) {
+              case 'increment':
+                this.increment();
+                break;
+              case 'decrement':
+                this.decrement();
+                break;
+            }
+          }}
+          accessibilityValueDescription={{
+            minimum: 0,
+            current: this.state.current,
+            maximum: 100,
+          }}>
+          <Text>Fake Slider</Text>
+        </View>
+        <View
+          accessible={true}
+          accessibilityLabel="Equalizer"
+          accessibilityRole="adjustable"
+          accessibilityActions={[{name: 'increment'}, {name: 'decrement'}]}
+          onAccessibilityAction={event => {
+            switch (event.nativeEvent.actionName) {
+              case 'increment':
+                if (this.state.textualValue === 'center') {
+                  this.setState({textualValue: 'right'});
+                } else if (this.state.textualValue === 'left') {
+                  this.setState({textualValue: 'center'});
+                }
+                break;
+              case 'decrement':
+                if (this.state.textualValue === 'center') {
+                  this.setState({textualValue: 'left'});
+                } else if (this.state.textualValue === 'right') {
+                  this.setState({textualValue: 'center'});
+                }
+                break;
+            }
+          }}
+          accessibilityValueDescription={{text: this.state.textualValue}}>
+          <Text>Equalizer</Text>
+        </View>
+      </View>
+    );
+  }
+}
+
 class ScreenReaderStatusExample extends React.Component<{}> {
   state = {
     screenReaderEnabled: false,
@@ -591,6 +674,12 @@ exports.examples = [
       return <AccessibilityActionsExample />;
     },
   },
+  {
+    title: 'Fake Slider Example',
+    render(): React.Element<typeof FakeSliderExample> {
+      return <FakeSliderExample />;
+    },
+  },
   {
     title: 'Check if the screen reader is enabled',
     render(): React.Element<typeof ScreenReaderStatusExample> {

React/Views/RCTView.m

@@ -284,6 +284,26 @@ - (NSString *)accessibilityValue
       [valueComponents addObject:stateDescriptions[@"busy"]];
     }
   }
+  
+  // handle accessibilityValueDescription
+
+  if (self.accessibilityValueDescription) {
+    id minimum = self.accessibilityValueDescription[@"minimum"];
+    id current = self.accessibilityValueDescription[@"current"];
+    id maximum = self.accessibilityValueDescription[@"maximum"];
+    id text = self.accessibilityValueDescription[@"text"];
+    if (text && [text isKindOfClass:[NSString class]]) {
+      [valueComponents addObject:text];
+    } else if ([minimum isKindOfClass:[NSNumber class]] &&
+        [current isKindOfClass:[NSNumber class]] &&
+        [maximum isKindOfClass:[NSNumber class]] &&
+        ([minimum intValue] < [maximum intValue]) &&
+        ([minimum intValue] <= [current intValue] && [current intValue] <= [maximum intValue])) {
+      int val = ([current intValue]*100)/([maximum intValue]-[minimum intValue]);
+      [valueComponents addObject:[NSString stringWithFormat:@"%d percent", val]];
+    }
+  }
+
   if (valueComponents.count > 0) {
     return [valueComponents componentsJoinedByString:@", "];
   }

React/Views/RCTViewManager.m

@@ -126,6 +126,7 @@ - (RCTShadowView *)shadowView
 RCT_REMAP_VIEW_PROPERTY(accessibilityActions, reactAccessibilityElement.accessibilityActions, NSDictionaryArray)
 RCT_REMAP_VIEW_PROPERTY(accessibilityLabel, reactAccessibilityElement.accessibilityLabel, NSString)
 RCT_REMAP_VIEW_PROPERTY(accessibilityHint, reactAccessibilityElement.accessibilityHint, NSString)
+RCT_REMAP_VIEW_PROPERTY(accessibilityValueDescription, reactAccessibilityElement.accessibilityValueDescription, NSDictionary)
 RCT_REMAP_VIEW_PROPERTY(accessibilityViewIsModal, reactAccessibilityElement.accessibilityViewIsModal, BOOL)
 RCT_REMAP_VIEW_PROPERTY(accessibilityElementsHidden, reactAccessibilityElement.accessibilityElementsHidden, BOOL)
 RCT_REMAP_VIEW_PROPERTY(accessibilityIgnoresInvertColors, reactAccessibilityElement.shouldAccessibilityIgnoresInvertColors, BOOL)

React/Views/UIView+React.h

@@ -120,6 +120,7 @@
 @property (nonatomic, copy) NSArray <NSString *> *accessibilityStates;
 @property (nonatomic, copy) NSDictionary<NSString *, id> *accessibilityState;
 @property (nonatomic, copy) NSArray <NSDictionary *> *accessibilityActions;
+@property (nonatomic, copy) NSDictionary *accessibilityValueDescription;
 
 /**
  * Used in debugging to get a description of the view hierarchy rooted at

React/Views/UIView+React.m

@@ -337,8 +337,17 @@ - (void)setAccessibilityState:(NSDictionary<NSString *, id> *)accessibilityState
   objc_setAssociatedObject(self, @selector(accessibilityState), accessibilityState, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
 }
 
-#pragma mark - Debug
+- (NSDictionary<NSString *, id> *)accessibilityValueDescription
+{
+  return objc_getAssociatedObject(self, _cmd);
+}
 
+- (void)setAccessibilityValueDescription:(NSDictionary<NSString *, id> *)accessibilityValueDescription
+{
+  objc_setAssociatedObject(self, @selector(accessibilityValueDescription), accessibilityValueDescription, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+}
+
+#pragma mark - Debug
 - (void)react_addRecursiveDescriptionToString:(NSMutableString *)string atLevel:(NSUInteger)level
 {
   for (NSUInteger i = 0; i < level; i++) {

ReactAndroid/src/main/java/com/facebook/react/uimanager/BaseViewManager.java

@@ -194,6 +194,7 @@ private void updateViewContentDescription(@NonNull T view) {
     final ReadableMap accessibilityState = (ReadableMap) view.getTag(R.id.accessibility_state);
     final String accessibilityHint = (String) view.getTag(R.id.accessibility_hint);
     final List<String> contentDescription = new ArrayList<>();
+    final ReadableMap accessibilityValueDescription = (ReadableMap) view.getTag(R.id.accessibility_value_description);
     if (accessibilityLabel != null) {
       contentDescription.add(accessibilityLabel);
     }
@@ -228,6 +229,12 @@ private void updateViewContentDescription(@NonNull T view) {
         }
       }
     }
+    if (accessibilityValueDescription != null && accessibilityValueDescription.hasKey("text")) {
+      final Dynamic text = accessibilityValueDescription.getDynamic("text");
+      if (text != null && text.getType() == ReadableType.String) {
+        contentDescription.add(text.asString());
+      }
+    }
     if (accessibilityHint != null) {
       contentDescription.add(accessibilityHint);
     }
@@ -245,6 +252,18 @@ public void setAccessibilityActions(T view, ReadableArray accessibilityActions)
     view.setTag(R.id.accessibility_actions, accessibilityActions);
   }
 
+  @ReactProp(name = ViewProps.ACCESSIBILITY_VALUE_DESCRIPTION)
+  public void setAccessibilityValueDescription(T view, ReadableMap accessibilityValueDescription) {
+    if (accessibilityValueDescription == null) {
+      return;
+    }
+
+    view.setTag(R.id.accessibility_value_description, accessibilityValueDescription);
+    if (accessibilityValueDescription.hasKey("text")) {
+      updateViewContentDescription(view);
+    }
+  }
+
   @ReactProp(name = ViewProps.IMPORTANT_FOR_ACCESSIBILITY)
   public void setImportantForAccessibility(
       @NonNull T view, @Nullable String importantForAccessibility) {