Archive Expo Snack Discord Forums Changelog

Expo BuildProperties
GitHub
npm

expo-build-properties is a config plugin configuring the native build properties of your android/gradle.properties and ios/Podfile.properties.json directories during Prebuild.

This config plugin configures how Prebuild command generates the native android and ios folders and therefore cannot be used with projects that don't run npx expo prebuild (bare projects).

Platform Compatibility

Android Device	Android Emulator	iOS Device	iOS Simulator	Web

Installation

Terminal

- npx expo install expo-build-properties

Usage

Example app.json with config plugin

app.json

{
  "expo": {
    "plugins": [
      [
        "expo-build-properties",
        {
          "android": {
            "compileSdkVersion": 31,
            "targetSdkVersion": 31,
            "buildToolsVersion": "31.0.0"
          },
          "ios": {
            "deploymentTarget": "13.0"
          }
        }
      ]
    ]
  }
}

Example app.config.js usage

app.config.js

export default {
  expo: {
    plugins: [
      [
        'expo-build-properties',
        {
          android: {
            compileSdkVersion: 31,
            targetSdkVersion: 31,
            buildToolsVersion: '31.0.0',
          },
          ios: {
            deploymentTarget: '13.0',
          },
        },
      ],
    ],
  },
};

All configurable properties

PluginConfigType interface represents currently available configuration properties.

API

Methods

`BuildProperties.withBuildProperties(config, props)`

Name	Type	Description
config	`ExpoConfig`	Expo config for application.
props	`PluginConfigType`	Configuration for the build properties plugin.

Config plugin allowing customizing native Android and iOS build properties for managed apps.

Returns

ExpoConfig

Interfaces

`PluginConfigType`

Interface representing base build properties configuration.

PluginConfigType Properties

Name	Type	Description
android (optional)	`PluginConfigTypeAndroid`	Only for: Android Interface representing available configuration for Android native build properties.
ios (optional)	`PluginConfigTypeIos`	Only for: iOS Interface representing available configuration for iOS native build properties.

Only for:

Android

`PluginConfigTypeAndroid`

Interface representing available configuration for Android native build properties.

PluginConfigTypeAndroid Properties

Name	Type	Description
buildToolsVersion (optional)	`string`	Override the default `buildToolsVersion` version number in build.gradle.
compileSdkVersion (optional)	`number`	Override the default `compileSdkVersion` version number in build.gradle.
enableProguardInReleaseBuilds (optional)	`boolean`	Enable Proguard or R8 in release builds to obfuscate Java code and reduce app size.
enableShrinkResourcesInReleaseBuilds (optional)	`boolean`	Enable `shrinkResources` in release builds to remove unused resources from the app. This property should be used in combination with `enableProguardInReleaseBuilds`.
extraProguardRules (optional)	`string`	Append custom Proguard rules to android/app/proguard-rules.pro.
flipper (optional)	`string`	By default, Flipper is enabled with the version that comes bundled with `react-native`. Use this to change the Flipper version when running your app on Android. You can set the `flipper` property to a semver string and specify an alternate Flipper version.
kotlinVersion (optional)	`string`	Override the Kotlin version used when building the app.
minSdkVersion (optional)	`number`	Override the default `minSdkVersion` version number in build.gradle.
newArchEnabled (optional)	`boolean`	Enable React Native new architecture for Android platform.
packagingOptions (optional)	`PluginConfigTypeAndroidPackagingOptions`	Interface representing available configuration for Android Gradle plugin PackagingOptions.
targetSdkVersion (optional)	`number`	Override the default `targetSdkVersion` version number in build.gradle.

Only for:

Android

`PluginConfigTypeAndroidPackagingOptions`

Interface representing available configuration for Android Gradle plugin PackagingOptions.

PluginConfigTypeAndroidPackagingOptions Properties

Name	Type	Description
doNotStrip (optional)	`string[]`	Array of patterns for native libraries that should not be stripped of debug symbols.
exclude (optional)	`string[]`	Array of patterns for native libraries that should be excluded from being packaged in the APK.
merge (optional)	`string[]`	Array of patterns for native libraries where all occurrences are concatenated and packaged in the APK.
pickFirst (optional)	`string[]`	Array of patterns for native libraries where only the first occurrence is packaged in the APK.

Only for:

iOS

`PluginConfigTypeIos`

Interface representing available configuration for iOS native build properties.

PluginConfigTypeIos Properties

Name	Type	Description
deploymentTarget (optional)	`string`	Override the default iOS "Deployment Target" version in the following projects: in CocoaPods projects, `PBXNativeTarget` with "com.apple.product-type.application" `productType` in the app project.
flipper (optional)	`string \| boolean`	Enable Flipper when running your app on iOS in Debug mode. Setting `true` enables the default version of Flipper, while setting a semver string will enable a specific version of Flipper you've declared in your package.json. The default for this configuration is `false`. You cannot use `flipper` at the same time as `useFrameworks`, and doing so will generate an error.
newArchEnabled (optional)	`boolean`	Enable React Native new architecture for iOS platform.
useFrameworks (optional)	`'static' \| 'dynamic'`	Enable `use_frameworks!` in `Podfile` to use frameworks instead of static libraries for Pods. You cannot use `useFrameworks` and `flipper` at the same time , and doing so will generate an error.