Switch: Warn for Deprecated Color Props

Summary: Introduces warnings to `Switch` when the deprecated props are being used. See D9081343 for more details on the specific prop changes. Reviewed By: blairvanderhoof Differential Revision: D9081451 fbshipit-source-id: 7f997fc97d316038f0917d2540b982bd9cf34d03
facebook · Aug 1, 2018 · 9a4fd6b · 9a4fd6b
1 parent 965adee
commit 9a4fd6b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 25 deletions.
diff --git a/Libraries/Components/Switch/Switch.js b/Libraries/Components/Switch/Switch.js
@@ -78,21 +78,6 @@ export type Props = $ReadOnly<{|
    * Identifier used to find this view in tests.
    */
   testID?: ?string,
-
-  /**
-   * @deprecated See `thumbColor`.
-   */
-  thumbTintColor?: ?ColorValue,
-
-  /**
-   * @deprecated See `trackColor.false`.
-   */
-  tintColor?: ?ColorValue,
-
-  /**
-   * @deprecated See `trackColor.true`.
-   */
-  onTintColor?: ?ColorValue,
 |}>;
 
 // @see ReactSwitchManager.java
@@ -146,13 +131,10 @@ class Switch extends React.Component<Props> {
       disabled,
       ios_backgroundColor,
       onChange,
-      onTintColor,
       onValueChange,
       style,
       testID,
       thumbColor,
-      thumbTintColor,
-      tintColor,
       trackColor,
       value,
       ...props
@@ -163,15 +145,31 @@ class Switch extends React.Component<Props> {
     let _trackColorForFalse = trackColor?.false;
     let _trackColorForTrue = trackColor?.true;
 
-    // TODO: Add a warning when used.
+    // TODO: Remove support for these props after a couple releases.
+    const {thumbTintColor, tintColor, onTintColor} = (props: $FlowFixMe);
     if (thumbTintColor != null) {
       _thumbColor = thumbTintColor;
+      if (__DEV__) {
+        console.warn(
+          'Switch: `thumbTintColor` is deprecated, use `_thumbColor` instead.',
+        );
+      }
     }
     if (tintColor != null) {
       _trackColorForFalse = tintColor;
+      if (__DEV__) {
+        console.warn(
+          'Switch: `tintColor` is deprecated, use `trackColor` instead.',
+        );
+      }
     }
     if (onTintColor != null) {
       _trackColorForTrue = onTintColor;
+      if (__DEV__) {
+        console.warn(
+          'Switch: `onTintColor` is deprecated, use `trackColor` instead.',
+        );
+      }
     }
 
     const platformProps =

diff --git a/RNTester/js/SwitchExample.js b/RNTester/js/SwitchExample.js
@@ -59,17 +59,21 @@ class ColorSwitchExample extends React.Component<{}, $FlowFixMeState> {
       <View>
         <Switch
           onValueChange={value => this.setState({colorFalseSwitchIsOn: value})}
-          onTintColor="#00ff00"
           style={{marginBottom: 10}}
-          thumbTintColor="#0000ff"
-          tintColor="#ff0000"
+          thumbColor="#0000ff"
+          trackColor={{
+            false: '#ff0000',
+            true: '#00ff00',
+          }}
           value={this.state.colorFalseSwitchIsOn}
         />
         <Switch
           onValueChange={value => this.setState({colorTrueSwitchIsOn: value})}
-          onTintColor="#00ff00"
-          thumbTintColor="#0000ff"
-          tintColor="#ff0000"
+          thumbColor="#0000ff"
+          trackColor={{
+            false: '#ff0000',
+            true: '#00ff00',
+          }}
           value={this.state.colorTrueSwitchIsOn}
         />
       </View>