A dependency is a JavaScript package that is listed under dependencies present in the project's package.json and contains native, platform-specific code.
A dependency can define the following react-native.config.js at the root:
module.exports = {
dependency: {
platforms: {
// iOS specific properties go here
ios: {},
// Android specific properties go here
android: {},
},
},
};The following type describes the configuration of a dependency that can be set under dependency key inside react-native.config.js.
type DependencyConfig = {
platforms: {
android?: AndroidDependencyParams;
ios?: IOSDependencyParams;
// There can be additional platforms, such as `windows` present
[key: string]: any;
};
};A map of specific settings that can be set per platform. The exact shape is always defined by the package that provides given platform.
In most cases, as a library author, you should not need to define any of these.
The following settings are available on iOS and Android:
type IOSDependencyConfig = {
scriptPhases?: Array<IOSScriptPhase>;
configurations?: string[];
};
type AndroidDependencyParams = {
sourceDir?: string;
manifestPath?: string;
packageName?: string;
dependencyConfiguration?: string;
packageImportPath?: string;
packageInstance?: string;
buildTypes?: string[];
libraryName?: string | null;
componentDescriptors?: string[] | null;
cmakeListsPath?: string | null;
cxxModuleCMakeListsModuleName?: string | null;
cxxModuleCMakeListsPath?: string | null;
cxxModuleHeaderName?: string | null;
};An array of iOS script phases to add to the project. Specifying a path property with a path relative to the dependency root will load the contents of the file at the path as the script contents.
Example:
// react-native.config.js
module.exports = {
dependency: {
platforms: {
ios: {
scriptPhases: [
{
name: '[MY DEPENDENCY] My Script',
path: './my_script.sh',
execution_position: 'after_compile',
},
],
},
},
},
};See script_phase options for a full list of available object keys.
An array of build configurations which will include the dependency. If the array is empty, your dependency will be installed in all configurations. If you're working on a helper library that should only be included in development, such as a replacement for the React Native development menu, you should set this to ['debug'] to avoid shipping the library in a release build. For more details, see build configurations.
A relative path to a folder with Android project (Gradle root project), e.g. ./path/to/custom-android. By default, CLI searches for ./android as source dir.
Path to a custom AndroidManifest.xml
Custom package name to override one from AndroidManifest.xml
Custom package import. For example: import com.acme.AwesomePackage;.
Custom syntax to instantiate a package. By default, it's a new AwesomePackage(). It can be useful when your package requires additional arguments while initializing.
For settings applicable on other platforms, please consult their respective documentation.
An array of build variants or flavors which will include the dependency. If the array is empty, your dependency will be included in all build types. If you're working on a helper library that should only be included in development, such as a replacement for the React Native development menu, you should set this to ['debug'] to avoid shipping the library in a release build. For more details, see build variants.
A string that defines which method other than implementation do you want to use
for autolinking inside build.gradle i.e: 'embed project(path: ":$dependencyName", configuration: "default")', - "dependencyName will be replaced by the actual package's name. You can achieve the same result by directly defining this key per dependency (without placeholder) and it will have higher priority than this option.
Note: Only applicable when new architecture is turned on.
A string indicating your custom library name. By default it's taken from the libraryName variable in your library's build.gradle.
Note: Only applicable when new architecture is turned on.
An array of custom component descriptor strings. By default they're generated based on codegenNativeComponent calls.
Note: Only applicable when new architecture is turned on.
A relative path to a custom CMakeLists.txt file not registered by codegen. Relative to sourceDir.
Note: Only applicable when new architecture is turned on and for C++ TurboModules.
The name of the CMake target that is building the C++ Turbo Module. This is generally
different from the codegen target which is called react_codegen_<yourlibrary>.
You will need to create a custom CMakeLists.txt, which defines a target, depends on react_codegen_<yourlibrary> and builds your C++ Turbo Module.
Specify the name of the target here so that it can be properly linked to the rest of the app project.
Note: Only applicable when new architecture is turned on and for C++ TurboModules.
A relative path to a custom CMakeLists.txt file that is used to build a C++ TurboModule. Relative to sourceDir.
Note: Only applicable when new architecture is turned on and for C++ TurboModules.
The name of the C++ TurboModule. Your C++ TurboModule generally should implement one of the JSI interface generated by Codegen. You need to specify the name of the class that is implementing the generated interface here, so that it can properly be linked in the rest of the app project.
We expect that your module exposes a field called kModuleName which is a string that contains the name of the module. This field is properly populated by codegen, but if you don't use codegen, you will have to make sure that this field is present.
Say your module name is NativeCxxModuleExample, it will be included in the autolinking logic as follows:
// We will include a header called as your module
#include <NativeCxxModuleExample.h>
...
std::shared_ptr<TurboModule> rncli_cxxModuleProvider(
const std::string& name,
const std::shared_ptr<CallInvoker>& jsInvoker) {
// Here we expect you have a field called kModuleName
if (name == NativeCxxModuleExample::kModuleName) {
// Here we initialize your module
return std::make_shared<NativeCxxModuleExample>(jsInvoker);
}
return nullptr;
}