repository·main·Indexed 20 days ago
https://github.com/expo/config-pluginsA collection of community-maintained Expo Config Plugins used to configure native projects during the npx expo prebuild process. It provides plugins for packages that do not yet ship their own built-in config plugins, including support for Apple settings UI (@config-plugins/apple-settings), iOS iMessage stickers (@config-plugins/ios-stickers), react-native-adjust, react-native-blob-util, react-native-branch, and Android JSC internationalization (@config-plugins/android-jsc-intl).
This config plugin is used to configure the JavaScriptCore (JSC) engine on Android with internationalization support.
Important Note: React Native uses the Hermes engine by default. If you are looking for a general replacement for Hermes, you should instead use the config plugin in react-native-community/jsc-android-buildscripts.
Expo Config Plugins are used to configure the npx expo prebuild command. They allow you to automate the modification of native project files (like iOS .xcodeproj or Android AndroidManifest.xml) during the prebuild process.
While many React Native libraries ship their own built-in config plugins, this repository serves as a collection of community-maintained plugins for packages that do not yet have a built-in plugin.
To use a plugin from this repository, you typically add it to the plugins array in your app.json or app.config.js file.
If you want to avoid custom native code or the complexity of react-native-pdf, consider these alternatives:
expo-web-browserOpen the PDF in an in-app browser session.
react-native-webviewEmbed the PDF within a contained WebView component.
Share APILet users open the PDF in their preferred system PDF viewer app (similar to UIDocumentInteractionController on iOS).
Utilize Expo's DOM Components for a custom web-based experience.
// Example: Using expo-web-browser
import * as WebBrowser from "expo-web-browser";
import { Text } from "react-native";
export default function HomeScreen() {
return (
<Text
onPress={() => {
WebBrowser.openBrowserAsync(
"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
);
}}
>
Open in-app browser
</Text>
);
}This config plugin automates the configuration of react-native-adjust during the npx expo prebuild process.
Note: This package cannot be used in the standard Expo Go app because it requires custom native code. You must use a Development Build.
To install, run:
npx expo install react-native-adjust @config-plugins/react-native-adjustAfter installation, add the plugin to the plugins array in your app.json or app.config.js.
{
"plugins": ["@config-plugins/react-native-adjust"]
}After installing the package, add @config-plugins/%CONFIG_PLUGIN% to the plugins array in your app.json or app.config.js.
If you need to provide configuration options, pass them as an array where the second element is an object containing the plugin's props. Every time you modify these props, you must rebuild your native app (run npx expo prebuild).
{
"expo": {
"plugins": [
[
"@config-plugins/%CONFIG_PLUGIN%",
{
"foobar": true
}
]
]
}
}To auto-configure react-native-blob-util during native code generation (npx expo prebuild), install both the library and its corresponding config plugin using npx expo install.
Important Notes:
react-native-pdf.npx expo install react-native-blob-util @config-plugins/react-native-blob-util@config-plugins/react-native-dynamic-app-icon plugin is deprecated. For managing dynamic app icons, you should use expo-quick-actions/icon instead.To use react-native-webrtc with Expo, you must install both the library and its corresponding config plugin. Note that this package requires custom native code and cannot be used in the Expo Go app; you must use Development Builds.
npx expo install.app.json or app.config.js.npx expo prebuild and your preferred build method.npx expo install react-native-webrtc @config-plugins/react-native-webrtc@config-plugins/tv package has moved. For continued support and updates, you must use the new package located at https://github.com/react-native-tvos/config-tv.This config plugin auto-configures react-native-branch during the native code generation process (npx expo prebuild).
Note: This package cannot be used in the standard Expo Go app because it requires custom native code. You must use a Development Client.
Install both the library and the config plugin using npx expo install:
npx expo install react-native-branch @config-plugins/react-native-branchAdd @config-plugins/react-native-branch to the plugins array in your app.json or app.config.js.
After installation and configuration, you must rebuild your app (e.g., using npx expo run:ios or npx expo run:android) to apply the native changes.
Use this config plugin to auto-configure react-native-pdf when running npx expo prebuild.
Note: This package requires custom native code and cannot be used in the Expo Go app. You must rebuild your development client after installation.
Install the required packages using npx expo install to ensure compatible versions:
npx expo install react-native-pdf react-native-blob-util @config-plugins/react-native-pdf @config-plugins/react-native-blob-utilAdd the config plugins to the plugins array in your app.json or app.config.js:
{
"plugins": [
"@config-plugins/react-native-blob-util",
"@config-plugins/react-native-pdf"
]
}Rebuild your app to apply the native configuration changes.
To use Siri Shortcuts in an Expo project, you must install both the base library and the config plugin. Note that this package requires custom native code and cannot be used in the Expo Go app.
Install the dependencies using npx expo install:
npx expo install react-native-siri-shortcut @config-plugins/react-native-siri-shortcutAfter installation, you must rebuild your app (e.g., using npx expo run:ios) to generate the necessary native code.