Version: 0.63

PlatformColor

PlatformColor(color1, [color2, ...colorN]);

You can use the PlatformColor function to access native colors on the target platform by supplying the native color’s corresponding string value. You pass a string to the PlatformColor function, and provided it exists on that platform, that native color will be applied to the control or Javascript component specified in your style. All native color logic also translates if applicable, meaning if the native color specified is themes and/or high contrast sensitive, that logic will also transfer to the JavaScript component being colored.

Developer Notes

If you’re familiar with design systems, another way of thinking about this is that PlatformColor lets you tap into the local design system's color tokens so your app can blend right in!

For a full list of the types of system colors supported, see:

Android:
- R.attr - ?attr prefix
- R.color - @android:color prefix
iOS UIColor

Example

import React from 'react';
import {
  Platform,
  PlatformColor,
  StyleSheet,
  Text,
  View
} from 'react-native';

export default (App = () => (
  <View>
    <Text style={styles.labelCell}>
      I am a special label color!
    </Text>
  </View>
));

const styles = StyleSheet.create({
  labelCell: {
    flex: 1,
    alignItems: 'stretch',
    ...Platform.select({
      ios: { color: PlatformColor('label') },
      android: {
        color: PlatformColor('?attr/colorControlNormal')
      },
      default: { color: 'black' }
    })
  }
});

The string value provided to the PlatformColor function must match and agree with the same string as it exists on the native platform the app is being run on. This means to avoid runtime errors the function should be wrapped in a platform check, either through a Platform.OS === 'platform' or a Platform.Select().

Note: You can find a complete example that demonstrates proper, intended use of PlatformColor in PlatformColorExample.js.

Example#

Example