Skip to main content

renative.json API Reference

Following Config reference applies to all renative.json files, including:

./renative.json

./appConfigs/base/renative.json

./appConfigs/\<APP_ID\>/renative.json

\<WORKSPACE\>/renative.json

\<WORKSPACE\>/\<PROJECT_ID\>/renative.json

\<WORKSPACE\>/\<PROJECT_ID\>/appConfigs/base/renative.json

\<WORKSPACE\>/\<PROJECT_ID\>/appConfigs/\<APP_ID\>/renative.json

common‚Äč

Prop NameTypeDefault ValuePath
commonobjectcommon

Common config props used as default props for all available buildSchemes

examples

{
"common": {
"author": {
"name": "Pavel Jacko",
"email": "Pavel Jacko <[email protected]>",
"url": "https://github.com/pavjacko"
},
"license": "MIT",
"includedPlugins": [
"*"
],
"includedFonts": [
"*"
],
"backgroundColor": "#111111",
"runtime": {
"welcomeMessage": "Hello ReNative!"
}
}
}

common.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringcommon.author

common.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringcommon.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

common.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectcommon.buildSchemes

common.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringcommon.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

common.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarraycommon.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

common.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectcommon.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

common.id‚Äč

Prop NameTypeDefault ValuePath
idstringcommon.id

common.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleancommon.ignoreLogs

common.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleancommon.ignoreWarnings

common.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarraycommon.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

common.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarraycommon.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

common.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarraycommon.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

common.license‚Äč

Prop NameTypeDefault ValuePath
licensestringcommon.license

common.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarraycommon.permissions

> DEPRECATED in favor of includedPermissions


common.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectcommon.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

common.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleancommon.splashScreen

common.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleancommon.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

common.title‚Äč

Prop NameTypeDefault ValuePath
titlestringcommon.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

common.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleancommon.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

crypto‚Äč

Prop NameTypeDefault ValuePath
cryptoobjectcrypto

This prop enables automatic encrypt and decrypt of sensitive information in your project


crypto.decrypt‚Äč

Prop NameTypeDefault ValuePath
decryptobjectcrypto.decrypt

crypto.decrypt.source‚Äč

Prop NameTypeDefault ValuePath
sourcestringcrypto.decrypt.source

Location of encrypted file in your project used as source of decryption into your workspace

examples

{
"source": "PROJECT_HOME/ci/privateConfigs.enc"
}

crypto.encrypt‚Äč

Prop NameTypeDefault ValuePath
encryptobjectcrypto.encrypt

crypto.encrypt.dest‚Äč

Prop NameTypeDefault ValuePath
deststringcrypto.encrypt.dest

Location of encrypted file in your project used as destination of encryption from your workspace

examples

{
"dest": "PROJECT_HOME/ci/privateConfigs.enc"
}

crypto.optional‚Äč

Prop NameTypeDefault ValuePath
optionalbooleancrypto.optional

currentTemplate‚Äč

Prop NameTypeDefault ValuePath
currentTemplatestringcurrentTemplate

Currently active template used in this project. this allows you to re-bootstrap whole project by running rnv template apply

examples

{
"currentTemplate": "renative-template-hello-world"
}

defaultTargets‚Äč

Prop NameTypeDefault ValuePath
defaultTargetsobjectdefaultTargets

List of default target simulators and emulators

examples

{
"defaultTargets": {
"android": "Nexus_5X_API_26",
"androidtv": "Android_TV_1080p_API_22",
"androidwear": "Android_Wear_Round_API_28",
"ios": "iPhone 8",
"tvos": "Apple TV 4K",
"tizen": "T-samsung-5.5-x86",
"tizenwatch": "W-5.5-circle-x86",
"tizenmobile": "M-5.5-x86",
"webos": "emulator"
}
}

defaults‚Äč

Prop NameTypeDefault ValuePath
defaultsobjectdefaults

Default system config for this project


defaults.ports‚Äč

Prop NameTypeDefault ValuePath
portsobjectdefaults.ports

Allows you to assign custom port per each supported platform specific to this project. this is useful if you foten switch between multiple projects and do not want to experience constant port conflicts

examples

{
"ports": {
"ios": 8182,
"android": 8183,
"androidtv": 8184,
"tvos": 8185,
"macos": 8186,
"web": 8180,
"tizen": 8187,
"webos": 8188,
"androidwear": 8189,
"tizenwatch": 8190,
"tizenmobile": 8191,
"windows": 8192,
"kaios": 8193,
"firefoxos": 8194,
"firefoxtv": 8114,
"webtv": 8195
}
}

defaults.schemes‚Äč

Prop NameTypeDefault ValuePath
schemesobjectdefaults.schemes

List of default schemes for each platform. This is useful if you want to avoid specifying -s ... every time your run rnv command. bu default rnv uses -s debug. NOTE: you can only use schemes you defined in buildSchemes

examples

{
"schemes": {
"ios": "myCustomScheme",
"android": "otherCustomScheme"
}
}

defaults.supportedPlatforms‚Äč

Prop NameTypeDefault ValuePath
supportedPlatformsarraydefaults.supportedPlatforms

Array list of all supported platforms in current project

examples

{
"supportedPlatforms": [
"ios",
"android",
"androidtv",
"web",
"macos",
"tvos",
"androidwear"
]
}

defaults.targets‚Äč

Prop NameTypeDefault ValuePath
targetsobjectdefaults.targets

Override of default targets specific to this project

examples

{
"targets": {
"ios": "iPhone 8",
"tvos": "Apple TV 4K"
}
}

description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringdescription

enableAnalytics‚Äč

Prop NameTypeDefault ValuePath
enableAnalyticsbooleanenableAnalytics

Enable or disable sending analytics to improve ReNative

examples

{
"enableAnalytics": "true"
}
{
"enableAnalytics": "false"
}

enableHookRebuild‚Äč

Prop NameTypeDefault ValuePath
enableHookRebuildbooleanenableHookRebuild

If set to true in ./renative.json build hooks will be compiled at each rnv command run. If set to false (default) rebuild will be triggered only if dist folder is missing, -r has been passed or you run rnv hooks run directly making your rnv commands faster

examples

{
"enableHookRebuild": "true"
}
{
"enableHookRebuild": "false"
}

engines‚Äč

Prop NameTypeDefault ValuePath
enginesobjectengines

List of engines available in this project

examples

{
"engines": {
"@rnv/engine-rn": "source:rnv",
"@rnv/engine-rn-tvos": "source:rnv",
"@rnv/engine-rn-web": "source:rnv",
"@rnv/engine-rn-next": "source:rnv",
"@rnv/engine-lightning": "source:rnv",
"@rnv/engine-rn-electron": "source:rnv",
"@rnv/engine-rn-windows": "source:rnv"
}
}
{
"engines": {
"@rnv/engine-rn": "source:rnv",
"custom-engine": {
"version": "1.0.0"
}
}
}

env‚Äč

Prop NameTypeDefault ValuePath
envobjectenv

ext‚Äč

Prop NameTypeDefault ValuePath
extobjectext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

extend‚Äč

Prop NameTypeDefault ValuePath
extendstringextend

hidden‚Äč

Prop NameTypeDefault ValuePath
hiddenbooleanhidden

If set to true in ./appConfigs/[APP_ID]/renative.json the APP_ID will be hidden from list of appConfigs -c

examples

{
"hidden": "true"
}
{
"hidden": "false"
}

id‚Äč

Prop NameTypeDefault ValuePath
idstringid

ID of the app in ./appConfigs/[APP_ID]/renative.json. MUST match APP_ID name of the folder

examples

{
"id": "helloworld"
}
{
"id": "someapp"
}

integrations‚Äč

Prop NameTypeDefault ValuePath
integrationsobjectintegrations

isMonorepo‚Äč

Prop NameTypeDefault ValuePath
isMonorepobooleanisMonorepo

isWrapper‚Äč

Prop NameTypeDefault ValuePath
isWrapperbooleanisWrapper

monoRepo‚Äč

Prop NameTypeDefault ValuePath
monoRepostringmonoRepo

Define custom path to monorepo root where starting point is project directory


paths‚Äč

Prop NameTypeDefault ValuePath
pathsobjectpaths

Define custom paths for RNV to look into


paths.appConfigsDir‚Äč

Prop NameTypeDefault ValuePath
appConfigsDirstringpaths.appConfigsDir

Custom path to appConfigs. defaults to ./appConfigs

examples

{
"appConfigsDir": "./appConfigs"
}

paths.platformAssetsDir‚Äč

Prop NameTypeDefault ValuePath
platformAssetsDirstringpaths.platformAssetsDir

Custom path to platformAssets folder. defaults to ./platformAssets

examples

{
"platformAssetsDir": "./platformAssets"
}

paths.platformBuildsDir‚Äč

Prop NameTypeDefault ValuePath
platformBuildsDirstringpaths.platformBuildsDir

Custom path to platformBuilds folder. defaults to ./platformBuilds

examples

{
"platformBuildsDir": "./platformBuilds"
}

paths.pluginTemplates‚Äč

Prop NameTypeDefault ValuePath
pluginTemplatesobjectpaths.pluginTemplates

Allows you to define custom plugin template scopes. default scope for all plugins is rnv. this custom scope can then be used by plugin via "source:myCustomScope" value

those will allow you to use direct pointer to preconfigured plugin:

"plugin-name": "source:myCustomScope"

NOTE: by default every plugin you define with scope will also merge any files defined in overrides automatically to your project. To skip file overrides coming from source plugin you need to detach it from the scope:

{
"plugins": {
"plugin-name": {
"source": ""
}
}
}

examples

{
"pluginTemplates": {
"myCustomScope": {
"npm": "some-renative-template-package",
"path": "./pluginTemplates"
}
}
}

permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsobjectpermissions

Permission definititions which can be used by app configs via includedPermissions and excludedPermissions to customize permissions for each app

examples

{
"permissions": {
"ios": {},
"android": {}
}
}

permissions.android‚Äč

Prop NameTypeDefault ValuePath
androidobjectpermissions.android

Android SDK specific permissions

examples

{
"android": {
"INTERNET": {
"key": "android.permission.INTERNET",
"security": "normal"
},
"SYSTEM_ALERT_WINDOW": {
"key": "android.permission.SYSTEM_ALERT_WINDOW",
"security": "signature"
}
}
}

permissions.ios‚Äč

Prop NameTypeDefault ValuePath
iosobjectpermissions.ios

iOS SDK specific permissions

examples

{
"ios": {
"NSAppleMusicUsageDescription": {
"desc": "Get favorite music"
},
"NSBluetoothPeripheralUsageDescription": {
"desc": "Allow you to use your bluetooth to play music"
},
"NSCalendarsUsageDescription": {
"desc": "Calendar for add events"
},
"NSCameraUsageDescription": {
"desc": "Need camera to scan QR Codes"
},
"NSLocationWhenInUseUsageDescription": {
"desc": "Geolocation tags for photos"
},
"NSMicrophoneUsageDescription": {
"desc": "Need microphone for videos"
},
"NSMotionUsageDescription": {
"desc": "To know when device is moving"
},
"NSPhotoLibraryAddUsageDescription": {
"desc": "Need library to save images"
},
"NSPhotoLibraryUsageDescription": {
"desc": "Allows to upload images from photo library"
},
"NSSpeechRecognitionUsageDescription": {
"desc": "Speech Recognition to run in app commands"
},
"NSContactsUsageDescription": {
"desc": "Get contacts list"
},
"NSFaceIDUsageDescription": {
"desc": "Requires FaceID access to allows you quick and secure access."
},
"NSLocationAlwaysUsageDescription": {
"desc": "Geolocation tags for photos"
},
"NSBluetoothAlwaysUsageDescription": {
"desc": "Allow you to use your bluetooth to play music"
},
"NSLocationAlwaysAndWhenInUseUsageDescription": {
"desc": "Geolocation tags for photos"
}
}
}

pipes‚Äč

Prop NameTypeDefault ValuePath
pipesarraypipes

To avoid rnv building buildHooks/src every time you can specify which specific pipes should trigger recompile of buildHooks

examples

{
"pipes": [
"configure:after",
"start:before",
"deploy:after",
"export:before",
"export:after"
]
}

platforms‚Äč

Prop NameTypeDefault ValuePath
platformsobjectplatforms

platforms.android‚Äč

Prop NameTypeDefault ValuePath
androidobjectplatforms.android

platforms.android.AndroidManifest‚Äč

Prop NameTypeDefault ValuePath
AndroidManifestobjectplatforms.android.AndroidManifest

Allows you to directly manipulate AndroidManifest.xml via json override mechanism

Injects / Overrides values in AndroidManifest.xml file of generated android based project

> IMPORTANT: always ensure that your object contains tag and android:name to target correct tag to merge into

examples

{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"children": [
{
"tag": "activity",
"android:name": "com.ahmedadeltito.photoeditor.PhotoEditorActivity"
}
]
}
]
}
}
{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"android:allowBackup": true,
"android:largeHeap": true,
"android:usesCleartextTraffic": true,
"tools:targetApi": 28
}
]
}
}

platforms.android.BuildGradle‚Äč

Prop NameTypeDefault ValuePath
BuildGradleobjectplatforms.android.BuildGradle

Allows you to customize build.gradle file


platforms.android.BuildGradle.allprojects‚Äč

Prop NameTypeDefault ValuePath
allprojectsobjectplatforms.android.BuildGradle.allprojects

platforms.android.BuildGradle.allprojects.repositories‚Äč

Prop NameTypeDefault ValuePath
repositoriesobjectplatforms.android.BuildGradle.allprojects.repositories

Customize repositories section of build.gradle

examples

{
"repositories": {
"flatDir { dirs 'libs'}": true
}
}

platforms.android.aab‚Äč

Prop NameTypeDefault ValuePath
aabbooleanplatforms.android.aab

If set to true, android project will generate app.aab instead of apk

examples

{
"aab": "false"
}
{
"aab": "true"
}

platforms.android.app/build.gradle‚Äč

Prop NameTypeDefault ValuePath
app/build.gradleobjectplatforms.android.app/build.gradle

Overrides values in app/build.gradle file of generated android based project

examples

{
"app/build.gradle": {
"apply": [
"plugin: 'io.fabric'"
]
}
}

platforms.android.applyPlugin‚Äč

Prop NameTypeDefault ValuePath
applyPluginarrayplatforms.android.applyPlugin

platforms.android.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.android.author

platforms.android.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.android.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.android.build.gradle‚Äč

Prop NameTypeDefault ValuePath
build.gradleobjectplatforms.android.build.gradle

Overrides values in build.gradle file of generated android based project

examples

{
"build.gradle": {
"allprojects": {
"repositories": {
"maven { url \"https://dl.bintray.com/onfido/maven\" }": true
}
}
}
}

platforms.android.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.android.buildSchemes

platforms.android.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.android.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.android.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.android.bundleIsDev

platforms.android.compileSdkVersion‚Äč

Prop NameTypeDefault ValuePath
compileSdkVersionintegerplatforms.android.compileSdkVersion

Allows you define custom compileSdkVersion equivalent to: compileSdkVersion = [VERSION]

examples

{
"compileSdkVersion": "28"
}
{
"compileSdkVersion": "29"
}

platforms.android.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.android.deploy

platforms.android.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.android.deploy.type

platforms.android.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.android.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.android.enableAndroidX‚Äč

Prop NameTypeDefault ValuePath
enableAndroidXbooleantrueplatforms.android.enableAndroidX

examples

{
"enableAndroidX": "true"
}
{
"enableAndroidX": "false"
}

platforms.android.enableHermes‚Äč

Prop NameTypeDefault ValuePath
enableHermesbooleanplatforms.android.enableHermes

> DEPRECATED in favour of reactNativeEngine

examples

{
"enableHermes": "true"
}
{
"enableHermes": "false"
}

platforms.android.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.android.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.android.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.android.engine

platforms.android.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.android.entryFile

platforms.android.excludedFeatures‚Äč

Prop NameTypeDefault ValuePath
excludedFeaturesarrayplatforms.android.excludedFeatures

platforms.android.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.android.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.android.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.android.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.android.gradle.properties‚Äč

Prop NameTypeDefault ValuePath
gradle.propertiesobjectplatforms.android.gradle.properties

Overrides values in gradle.properties file of generated android based project

examples

{
"gradle.properties": {
"gradle.properties": {
"android.debug.obsoleteApi": true,
"debug.keystore": "debug.keystore",
"org.gradle.daemon": true,
"org.gradle.parallel": true,
"org.gradle.configureondemand": true
}
}
}

platforms.android.gradleBuildToolsVersion‚Äč

Prop NameTypeDefault ValuePath
gradleBuildToolsVersioninteger3.3.1platforms.android.gradleBuildToolsVersion

Allows you define custom gradle build tools version equivalent to: classpath 'com.android.tools.build:gradle:[VERSION]'

examples

{
"gradleBuildToolsVersion": "3.3.1"
}
{
"gradleBuildToolsVersion": "4.1.0"
}

platforms.android.gradleWrapperVersion‚Äč

Prop NameTypeDefault ValuePath
gradleWrapperVersioninteger5.5platforms.android.gradleWrapperVersion

Allows you define custom gradle wrapper version equivalent to: distributionUrl=https\://services.gradle.org/distributions/gradle-[VERSION]-all.zip

examples

{
"gradleWrapperVersion": "5.5"
}
{
"gradleWrapperVersion": "6.7.1"
}

platforms.android.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.android.id

platforms.android.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.android.ignoreLogs

platforms.android.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.android.ignoreWarnings

platforms.android.implementation‚Äč

Prop NameTypeDefault ValuePath
implementationobjectplatforms.android.implementation

platforms.android.includedFeatures‚Äč

Prop NameTypeDefault ValuePath
includedFeaturesarrayplatforms.android.includedFeatures

platforms.android.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.android.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.android.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.android.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.android.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.android.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.android.keyAlias‚Äč

Prop NameTypeDefault ValuePath
keyAliasstringplatforms.android.keyAlias

platforms.android.keyPassword‚Äč

Prop NameTypeDefault ValuePath
keyPasswordstringplatforms.android.keyPassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

keyPassword for keystore file


platforms.android.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.android.license

platforms.android.mainActivity‚Äč

Prop NameTypeDefault ValuePath
mainActivityobject{}platforms.android.mainActivity

Allows you to configure behaviour of MainActivity.kt


platforms.android.mainActivity.onCreate‚Äč

Prop NameTypeDefault ValuePath
onCreatestringsuper.onCreate(savedInstanceState)platforms.android.mainActivity.onCreate

Overrides super.onCreate method handler of MainActivity.kt

examples

{
"onCreate": "super.onCreate(null)"
}
{
"onCreate": "super.onCreate(savedInstanceState)"
}

platforms.android.minSdkVersion‚Äč

Prop NameTypeDefault ValuePath
minSdkVersioninteger21platforms.android.minSdkVersion

examples

{
"minSdkVersion": "21"
}
{
"minSdkVersion": "22"
}

platforms.android.minifyEnabled‚Äč

Prop NameTypeDefault ValuePath
minifyEnabledbooleanplatforms.android.minifyEnabled

Sets minifyEnabled buildType property in app/build.gradle

examples

{
"minifyEnabled": "false"
}
{
"minifyEnabled": "true"
}

platforms.android.multipleAPKs‚Äč

Prop NameTypeDefault ValuePath
multipleAPKsbooleanplatforms.android.multipleAPKs

If set to true, apk will be split into multiple ones for each architecture: "armeabi-v7a", "x86", "arm64-v8a", "x86_64"

examples

{
"multipleAPKs": "true"
}
{
"multipleAPKs": "false"
}

platforms.android.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.android.permissions

> DEPRECATED in favor of includedPermissions


platforms.android.reactNativeEngine‚Äč

Prop NameTypeDefault ValuePath
reactNativeEnginestringdefaultplatforms.android.reactNativeEngine

Allows you to define specific native render engine to be used

examples

{
"reactNativeEngine": "true"
}
{
"reactNativeEngine": "false"
}

platforms.android.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.android.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.android.signingConfig‚Äč

Prop NameTypeDefault ValuePath
signingConfigstringDebugplatforms.android.signingConfig

Equivalent to running ./gradlew/assembleDebug or ./gradlew/assembleRelease

examples

{
"signingConfig": "default"
}
{
"signingConfig": "v8-android"
}
{
"signingConfig": "v8-android-nointl"
}
{
"signingConfig": "v8-android-jit"
}
{
"signingConfig": "v8-android-jit-nointl"
}
{
"signingConfig": "hermes"
}

platforms.android.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.android.splashScreen

platforms.android.storeFile‚Äč

Prop NameTypeDefault ValuePath
storeFilestringplatforms.android.storeFile

platforms.android.storePassword‚Äč

Prop NameTypeDefault ValuePath
storePasswordstringplatforms.android.storePassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

storePassword for keystore file


platforms.android.targetSdkVersion‚Äč

Prop NameTypeDefault ValuePath
targetSdkVersionintegerplatforms.android.targetSdkVersion

Allows you define custom targetSdkVersion equivalent to: targetSdkVersion = [VERSION]

examples

{
"targetSdkVersion": "28"
}
{
"targetSdkVersion": "29"
}

platforms.android.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.android.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.android.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.android.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.android.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.android.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.androidtv‚Äč

Prop NameTypeDefault ValuePath
androidtvobjectplatforms.androidtv

platforms.androidtv.AndroidManifest‚Äč

Prop NameTypeDefault ValuePath
AndroidManifestobjectplatforms.androidtv.AndroidManifest

Allows you to directly manipulate AndroidManifest.xml via json override mechanism

Injects / Overrides values in AndroidManifest.xml file of generated android based project

> IMPORTANT: always ensure that your object contains tag and android:name to target correct tag to merge into

examples

{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"children": [
{
"tag": "activity",
"android:name": "com.ahmedadeltito.photoeditor.PhotoEditorActivity"
}
]
}
]
}
}
{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"android:allowBackup": true,
"android:largeHeap": true,
"android:usesCleartextTraffic": true,
"tools:targetApi": 28
}
]
}
}

platforms.androidtv.BuildGradle‚Äč

Prop NameTypeDefault ValuePath
BuildGradleobjectplatforms.androidtv.BuildGradle

Allows you to customize build.gradle file


platforms.androidtv.BuildGradle.allprojects‚Äč

Prop NameTypeDefault ValuePath
allprojectsobjectplatforms.androidtv.BuildGradle.allprojects

platforms.androidtv.BuildGradle.allprojects.repositories‚Äč

Prop NameTypeDefault ValuePath
repositoriesobjectplatforms.androidtv.BuildGradle.allprojects.repositories

Customize repositories section of build.gradle

examples

{
"repositories": {
"flatDir { dirs 'libs'}": true
}
}

platforms.androidtv.aab‚Äč

Prop NameTypeDefault ValuePath
aabbooleanplatforms.androidtv.aab

If set to true, android project will generate app.aab instead of apk

examples

{
"aab": "false"
}
{
"aab": "true"
}

platforms.androidtv.app/build.gradle‚Äč

Prop NameTypeDefault ValuePath
app/build.gradleobjectplatforms.androidtv.app/build.gradle

Overrides values in app/build.gradle file of generated android based project

examples

{
"app/build.gradle": {
"apply": [
"plugin: 'io.fabric'"
]
}
}

platforms.androidtv.applyPlugin‚Äč

Prop NameTypeDefault ValuePath
applyPluginarrayplatforms.androidtv.applyPlugin

platforms.androidtv.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.androidtv.author

platforms.androidtv.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.androidtv.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.androidtv.build.gradle‚Äč

Prop NameTypeDefault ValuePath
build.gradleobjectplatforms.androidtv.build.gradle

Overrides values in build.gradle file of generated android based project

examples

{
"build.gradle": {
"allprojects": {
"repositories": {
"maven { url \"https://dl.bintray.com/onfido/maven\" }": true
}
}
}
}

platforms.androidtv.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.androidtv.buildSchemes

platforms.androidtv.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.androidtv.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.androidtv.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.androidtv.bundleIsDev

platforms.androidtv.compileSdkVersion‚Äč

Prop NameTypeDefault ValuePath
compileSdkVersionintegerplatforms.androidtv.compileSdkVersion

Allows you define custom compileSdkVersion equivalent to: compileSdkVersion = [VERSION]

examples

{
"compileSdkVersion": "28"
}
{
"compileSdkVersion": "29"
}

platforms.androidtv.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.androidtv.deploy

platforms.androidtv.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.androidtv.deploy.type

platforms.androidtv.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.androidtv.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.androidtv.enableAndroidX‚Äč

Prop NameTypeDefault ValuePath
enableAndroidXbooleantrueplatforms.androidtv.enableAndroidX

examples

{
"enableAndroidX": "true"
}
{
"enableAndroidX": "false"
}

platforms.androidtv.enableHermes‚Äč

Prop NameTypeDefault ValuePath
enableHermesbooleanplatforms.androidtv.enableHermes

> DEPRECATED in favour of reactNativeEngine

examples

{
"enableHermes": "true"
}
{
"enableHermes": "false"
}

platforms.androidtv.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.androidtv.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.androidtv.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.androidtv.engine

platforms.androidtv.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.androidtv.entryFile

platforms.androidtv.excludedFeatures‚Äč

Prop NameTypeDefault ValuePath
excludedFeaturesarrayplatforms.androidtv.excludedFeatures

platforms.androidtv.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.androidtv.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.androidtv.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.androidtv.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.androidtv.gradle.properties‚Äč

Prop NameTypeDefault ValuePath
gradle.propertiesobjectplatforms.androidtv.gradle.properties

Overrides values in gradle.properties file of generated android based project

examples

{
"gradle.properties": {
"gradle.properties": {
"android.debug.obsoleteApi": true,
"debug.keystore": "debug.keystore",
"org.gradle.daemon": true,
"org.gradle.parallel": true,
"org.gradle.configureondemand": true
}
}
}

platforms.androidtv.gradleBuildToolsVersion‚Äč

Prop NameTypeDefault ValuePath
gradleBuildToolsVersioninteger3.3.1platforms.androidtv.gradleBuildToolsVersion

Allows you define custom gradle build tools version equivalent to: classpath 'com.android.tools.build:gradle:[VERSION]'

examples

{
"gradleBuildToolsVersion": "3.3.1"
}
{
"gradleBuildToolsVersion": "4.1.0"
}

platforms.androidtv.gradleWrapperVersion‚Äč

Prop NameTypeDefault ValuePath
gradleWrapperVersioninteger5.5platforms.androidtv.gradleWrapperVersion

Allows you define custom gradle wrapper version equivalent to: distributionUrl=https\://services.gradle.org/distributions/gradle-[VERSION]-all.zip

examples

{
"gradleWrapperVersion": "5.5"
}
{
"gradleWrapperVersion": "6.7.1"
}

platforms.androidtv.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.androidtv.id

platforms.androidtv.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.androidtv.ignoreLogs

platforms.androidtv.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.androidtv.ignoreWarnings

platforms.androidtv.implementation‚Äč

Prop NameTypeDefault ValuePath
implementationobjectplatforms.androidtv.implementation

platforms.androidtv.includedFeatures‚Äč

Prop NameTypeDefault ValuePath
includedFeaturesarrayplatforms.androidtv.includedFeatures

platforms.androidtv.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.androidtv.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.androidtv.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.androidtv.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.androidtv.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.androidtv.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.androidtv.keyAlias‚Äč

Prop NameTypeDefault ValuePath
keyAliasstringplatforms.androidtv.keyAlias

platforms.androidtv.keyPassword‚Äč

Prop NameTypeDefault ValuePath
keyPasswordstringplatforms.androidtv.keyPassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

keyPassword for keystore file


platforms.androidtv.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.androidtv.license

platforms.androidtv.mainActivity‚Äč

Prop NameTypeDefault ValuePath
mainActivityobject{}platforms.androidtv.mainActivity

Allows you to configure behaviour of MainActivity.kt


platforms.androidtv.mainActivity.onCreate‚Äč

Prop NameTypeDefault ValuePath
onCreatestringsuper.onCreate(savedInstanceState)platforms.androidtv.mainActivity.onCreate

Overrides super.onCreate method handler of MainActivity.kt

examples

{
"onCreate": "super.onCreate(null)"
}
{
"onCreate": "super.onCreate(savedInstanceState)"
}

platforms.androidtv.minSdkVersion‚Äč

Prop NameTypeDefault ValuePath
minSdkVersioninteger21platforms.androidtv.minSdkVersion

examples

{
"minSdkVersion": "21"
}
{
"minSdkVersion": "22"
}

platforms.androidtv.minifyEnabled‚Äč

Prop NameTypeDefault ValuePath
minifyEnabledbooleanplatforms.androidtv.minifyEnabled

Sets minifyEnabled buildType property in app/build.gradle

examples

{
"minifyEnabled": "false"
}
{
"minifyEnabled": "true"
}

platforms.androidtv.multipleAPKs‚Äč

Prop NameTypeDefault ValuePath
multipleAPKsbooleanplatforms.androidtv.multipleAPKs

If set to true, apk will be split into multiple ones for each architecture: "armeabi-v7a", "x86", "arm64-v8a", "x86_64"

examples

{
"multipleAPKs": "true"
}
{
"multipleAPKs": "false"
}

platforms.androidtv.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.androidtv.permissions

> DEPRECATED in favor of includedPermissions


platforms.androidtv.reactNativeEngine‚Äč

Prop NameTypeDefault ValuePath
reactNativeEnginestringdefaultplatforms.androidtv.reactNativeEngine

Allows you to define specific native render engine to be used

examples

{
"reactNativeEngine": "true"
}
{
"reactNativeEngine": "false"
}

platforms.androidtv.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.androidtv.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.androidtv.signingConfig‚Äč

Prop NameTypeDefault ValuePath
signingConfigstringDebugplatforms.androidtv.signingConfig

Equivalent to running ./gradlew/assembleDebug or ./gradlew/assembleRelease

examples

{
"signingConfig": "default"
}
{
"signingConfig": "v8-android"
}
{
"signingConfig": "v8-android-nointl"
}
{
"signingConfig": "v8-android-jit"
}
{
"signingConfig": "v8-android-jit-nointl"
}
{
"signingConfig": "hermes"
}

platforms.androidtv.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.androidtv.splashScreen

platforms.androidtv.storeFile‚Äč

Prop NameTypeDefault ValuePath
storeFilestringplatforms.androidtv.storeFile

platforms.androidtv.storePassword‚Äč

Prop NameTypeDefault ValuePath
storePasswordstringplatforms.androidtv.storePassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

storePassword for keystore file


platforms.androidtv.targetSdkVersion‚Äč

Prop NameTypeDefault ValuePath
targetSdkVersionintegerplatforms.androidtv.targetSdkVersion

Allows you define custom targetSdkVersion equivalent to: targetSdkVersion = [VERSION]

examples

{
"targetSdkVersion": "28"
}
{
"targetSdkVersion": "29"
}

platforms.androidtv.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.androidtv.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.androidtv.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.androidtv.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.androidtv.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.androidtv.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.androidwear‚Äč

Prop NameTypeDefault ValuePath
androidwearobjectplatforms.androidwear

platforms.androidwear.AndroidManifest‚Äč

Prop NameTypeDefault ValuePath
AndroidManifestobjectplatforms.androidwear.AndroidManifest

Allows you to directly manipulate AndroidManifest.xml via json override mechanism

Injects / Overrides values in AndroidManifest.xml file of generated android based project

> IMPORTANT: always ensure that your object contains tag and android:name to target correct tag to merge into

examples

{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"children": [
{
"tag": "activity",
"android:name": "com.ahmedadeltito.photoeditor.PhotoEditorActivity"
}
]
}
]
}
}
{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"android:allowBackup": true,
"android:largeHeap": true,
"android:usesCleartextTraffic": true,
"tools:targetApi": 28
}
]
}
}

platforms.androidwear.BuildGradle‚Äč

Prop NameTypeDefault ValuePath
BuildGradleobjectplatforms.androidwear.BuildGradle

Allows you to customize build.gradle file


platforms.androidwear.BuildGradle.allprojects‚Äč

Prop NameTypeDefault ValuePath
allprojectsobjectplatforms.androidwear.BuildGradle.allprojects

platforms.androidwear.BuildGradle.allprojects.repositories‚Äč

Prop NameTypeDefault ValuePath
repositoriesobjectplatforms.androidwear.BuildGradle.allprojects.repositories

Customize repositories section of build.gradle

examples

{
"repositories": {
"flatDir { dirs 'libs'}": true
}
}

platforms.androidwear.aab‚Äč

Prop NameTypeDefault ValuePath
aabbooleanplatforms.androidwear.aab

If set to true, android project will generate app.aab instead of apk

examples

{
"aab": "false"
}
{
"aab": "true"
}

platforms.androidwear.app/build.gradle‚Äč

Prop NameTypeDefault ValuePath
app/build.gradleobjectplatforms.androidwear.app/build.gradle

Overrides values in app/build.gradle file of generated android based project

examples

{
"app/build.gradle": {
"apply": [
"plugin: 'io.fabric'"
]
}
}

platforms.androidwear.applyPlugin‚Äč

Prop NameTypeDefault ValuePath
applyPluginarrayplatforms.androidwear.applyPlugin

platforms.androidwear.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.androidwear.author

platforms.androidwear.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.androidwear.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.androidwear.build.gradle‚Äč

Prop NameTypeDefault ValuePath
build.gradleobjectplatforms.androidwear.build.gradle

Overrides values in build.gradle file of generated android based project

examples

{
"build.gradle": {
"allprojects": {
"repositories": {
"maven { url \"https://dl.bintray.com/onfido/maven\" }": true
}
}
}
}

platforms.androidwear.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.androidwear.buildSchemes

platforms.androidwear.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.androidwear.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.androidwear.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.androidwear.bundleIsDev

platforms.androidwear.compileSdkVersion‚Äč

Prop NameTypeDefault ValuePath
compileSdkVersionintegerplatforms.androidwear.compileSdkVersion

Allows you define custom compileSdkVersion equivalent to: compileSdkVersion = [VERSION]

examples

{
"compileSdkVersion": "28"
}
{
"compileSdkVersion": "29"
}

platforms.androidwear.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.androidwear.deploy

platforms.androidwear.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.androidwear.deploy.type

platforms.androidwear.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.androidwear.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.androidwear.enableAndroidX‚Äč

Prop NameTypeDefault ValuePath
enableAndroidXbooleantrueplatforms.androidwear.enableAndroidX

examples

{
"enableAndroidX": "true"
}
{
"enableAndroidX": "false"
}

platforms.androidwear.enableHermes‚Äč

Prop NameTypeDefault ValuePath
enableHermesbooleanplatforms.androidwear.enableHermes

> DEPRECATED in favour of reactNativeEngine

examples

{
"enableHermes": "true"
}
{
"enableHermes": "false"
}

platforms.androidwear.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.androidwear.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.androidwear.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.androidwear.engine

platforms.androidwear.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.androidwear.entryFile

platforms.androidwear.excludedFeatures‚Äč

Prop NameTypeDefault ValuePath
excludedFeaturesarrayplatforms.androidwear.excludedFeatures

platforms.androidwear.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.androidwear.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.androidwear.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.androidwear.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.androidwear.gradle.properties‚Äč

Prop NameTypeDefault ValuePath
gradle.propertiesobjectplatforms.androidwear.gradle.properties

Overrides values in gradle.properties file of generated android based project

examples

{
"gradle.properties": {
"gradle.properties": {
"android.debug.obsoleteApi": true,
"debug.keystore": "debug.keystore",
"org.gradle.daemon": true,
"org.gradle.parallel": true,
"org.gradle.configureondemand": true
}
}
}

platforms.androidwear.gradleBuildToolsVersion‚Äč

Prop NameTypeDefault ValuePath
gradleBuildToolsVersioninteger3.3.1platforms.androidwear.gradleBuildToolsVersion

Allows you define custom gradle build tools version equivalent to: classpath 'com.android.tools.build:gradle:[VERSION]'

examples

{
"gradleBuildToolsVersion": "3.3.1"
}
{
"gradleBuildToolsVersion": "4.1.0"
}

platforms.androidwear.gradleWrapperVersion‚Äč

Prop NameTypeDefault ValuePath
gradleWrapperVersioninteger5.5platforms.androidwear.gradleWrapperVersion

Allows you define custom gradle wrapper version equivalent to: distributionUrl=https\://services.gradle.org/distributions/gradle-[VERSION]-all.zip

examples

{
"gradleWrapperVersion": "5.5"
}
{
"gradleWrapperVersion": "6.7.1"
}

platforms.androidwear.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.androidwear.id

platforms.androidwear.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.androidwear.ignoreLogs

platforms.androidwear.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.androidwear.ignoreWarnings

platforms.androidwear.implementation‚Äč

Prop NameTypeDefault ValuePath
implementationobjectplatforms.androidwear.implementation

platforms.androidwear.includedFeatures‚Äč

Prop NameTypeDefault ValuePath
includedFeaturesarrayplatforms.androidwear.includedFeatures

platforms.androidwear.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.androidwear.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.androidwear.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.androidwear.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.androidwear.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.androidwear.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.androidwear.keyAlias‚Äč

Prop NameTypeDefault ValuePath
keyAliasstringplatforms.androidwear.keyAlias

platforms.androidwear.keyPassword‚Äč

Prop NameTypeDefault ValuePath
keyPasswordstringplatforms.androidwear.keyPassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

keyPassword for keystore file


platforms.androidwear.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.androidwear.license

platforms.androidwear.mainActivity‚Äč

Prop NameTypeDefault ValuePath
mainActivityobject{}platforms.androidwear.mainActivity

Allows you to configure behaviour of MainActivity.kt


platforms.androidwear.mainActivity.onCreate‚Äč

Prop NameTypeDefault ValuePath
onCreatestringsuper.onCreate(savedInstanceState)platforms.androidwear.mainActivity.onCreate

Overrides super.onCreate method handler of MainActivity.kt

examples

{
"onCreate": "super.onCreate(null)"
}
{
"onCreate": "super.onCreate(savedInstanceState)"
}

platforms.androidwear.minSdkVersion‚Äč

Prop NameTypeDefault ValuePath
minSdkVersioninteger21platforms.androidwear.minSdkVersion

examples

{
"minSdkVersion": "21"
}
{
"minSdkVersion": "22"
}

platforms.androidwear.minifyEnabled‚Äč

Prop NameTypeDefault ValuePath
minifyEnabledbooleanplatforms.androidwear.minifyEnabled

Sets minifyEnabled buildType property in app/build.gradle

examples

{
"minifyEnabled": "false"
}
{
"minifyEnabled": "true"
}

platforms.androidwear.multipleAPKs‚Äč

Prop NameTypeDefault ValuePath
multipleAPKsbooleanplatforms.androidwear.multipleAPKs

If set to true, apk will be split into multiple ones for each architecture: "armeabi-v7a", "x86", "arm64-v8a", "x86_64"

examples

{
"multipleAPKs": "true"
}
{
"multipleAPKs": "false"
}

platforms.androidwear.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.androidwear.permissions

> DEPRECATED in favor of includedPermissions


platforms.androidwear.reactNativeEngine‚Äč

Prop NameTypeDefault ValuePath
reactNativeEnginestringdefaultplatforms.androidwear.reactNativeEngine

Allows you to define specific native render engine to be used

examples

{
"reactNativeEngine": "true"
}
{
"reactNativeEngine": "false"
}

platforms.androidwear.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.androidwear.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.androidwear.signingConfig‚Äč

Prop NameTypeDefault ValuePath
signingConfigstringDebugplatforms.androidwear.signingConfig

Equivalent to running ./gradlew/assembleDebug or ./gradlew/assembleRelease

examples

{
"signingConfig": "default"
}
{
"signingConfig": "v8-android"
}
{
"signingConfig": "v8-android-nointl"
}
{
"signingConfig": "v8-android-jit"
}
{
"signingConfig": "v8-android-jit-nointl"
}
{
"signingConfig": "hermes"
}

platforms.androidwear.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.androidwear.splashScreen

platforms.androidwear.storeFile‚Äč

Prop NameTypeDefault ValuePath
storeFilestringplatforms.androidwear.storeFile

platforms.androidwear.storePassword‚Äč

Prop NameTypeDefault ValuePath
storePasswordstringplatforms.androidwear.storePassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

storePassword for keystore file


platforms.androidwear.targetSdkVersion‚Äč

Prop NameTypeDefault ValuePath
targetSdkVersionintegerplatforms.androidwear.targetSdkVersion

Allows you define custom targetSdkVersion equivalent to: targetSdkVersion = [VERSION]

examples

{
"targetSdkVersion": "28"
}
{
"targetSdkVersion": "29"
}

platforms.androidwear.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.androidwear.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.androidwear.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.androidwear.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.androidwear.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.androidwear.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.chromecast‚Äč

Prop NameTypeDefault ValuePath
chromecastobjectplatforms.chromecast

platforms.chromecast.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.chromecast.author

platforms.chromecast.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.chromecast.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.chromecast.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.chromecast.buildSchemes

platforms.chromecast.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.chromecast.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.chromecast.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.chromecast.bundleIsDev

platforms.chromecast.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.chromecast.deploy

platforms.chromecast.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.chromecast.deploy.type

platforms.chromecast.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.chromecast.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.chromecast.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.chromecast.devServerHost

platforms.chromecast.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.chromecast.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.chromecast.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.chromecast.engine

platforms.chromecast.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.chromecast.entryFile

platforms.chromecast.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.chromecast.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.chromecast.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.chromecast.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.chromecast.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.chromecast.id

platforms.chromecast.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.chromecast.ignoreLogs

platforms.chromecast.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.chromecast.ignoreWarnings

platforms.chromecast.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.chromecast.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.chromecast.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.chromecast.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.chromecast.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.chromecast.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.chromecast.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.chromecast.license

platforms.chromecast.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.chromecast.permissions

> DEPRECATED in favor of includedPermissions


platforms.chromecast.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.chromecast.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.chromecast.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.chromecast.splashScreen

platforms.chromecast.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.chromecast.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.chromecast.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.chromecast.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.chromecast.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.chromecast.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.chromecast.webpackConfig‚Äč

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.chromecast.webpackConfig

platforms.chromecast.webpackConfig.customScripts‚Äč

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.chromecast.webpackConfig.customScripts

platforms.chromecast.webpackConfig.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.chromecast.webpackConfig.devServerHost

platforms.chromecast.webpackConfig.extend‚Äč

Prop NameTypeDefault ValuePath
extendobjectplatforms.chromecast.webpackConfig.extend

Allows you to directly extend/override webpack config of your current platform

examples

{
"extend": {
"devtool": "source-map"
}
}
{
"extend": {
"module": {
"rules": [
{
"test": {},
"use": [
"source-map-loader"
],
"enforce": "pre"
}
]
}
}
}

platforms.chromecast.webpackConfig.metaTags‚Äč

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.chromecast.webpackConfig.metaTags

platforms.firefoxos‚Äč

Prop NameTypeDefault ValuePath
firefoxosobjectplatforms.firefoxos

platforms.firefoxos.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.firefoxos.author

platforms.firefoxos.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.firefoxos.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.firefoxos.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.firefoxos.buildSchemes

platforms.firefoxos.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.firefoxos.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.firefoxos.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.firefoxos.bundleIsDev

platforms.firefoxos.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.firefoxos.deploy

platforms.firefoxos.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.firefoxos.deploy.type

platforms.firefoxos.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.firefoxos.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.firefoxos.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.firefoxos.devServerHost

platforms.firefoxos.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.firefoxos.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.firefoxos.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.firefoxos.engine

platforms.firefoxos.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.firefoxos.entryFile

platforms.firefoxos.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.firefoxos.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.firefoxos.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.firefoxos.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.firefoxos.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.firefoxos.id

platforms.firefoxos.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.firefoxos.ignoreLogs

platforms.firefoxos.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.firefoxos.ignoreWarnings

platforms.firefoxos.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.firefoxos.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.firefoxos.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.firefoxos.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.firefoxos.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.firefoxos.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.firefoxos.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.firefoxos.license

platforms.firefoxos.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.firefoxos.permissions

> DEPRECATED in favor of includedPermissions


platforms.firefoxos.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.firefoxos.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.firefoxos.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.firefoxos.splashScreen

platforms.firefoxos.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.firefoxos.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.firefoxos.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.firefoxos.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.firefoxos.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.firefoxos.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.firefoxos.webpackConfig‚Äč

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.firefoxos.webpackConfig

platforms.firefoxos.webpackConfig.customScripts‚Äč

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.firefoxos.webpackConfig.customScripts

platforms.firefoxos.webpackConfig.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.firefoxos.webpackConfig.devServerHost

platforms.firefoxos.webpackConfig.extend‚Äč

Prop NameTypeDefault ValuePath
extendobjectplatforms.firefoxos.webpackConfig.extend

Allows you to directly extend/override webpack config of your current platform

examples

{
"extend": {
"devtool": "source-map"
}
}
{
"extend": {
"module": {
"rules": [
{
"test": {},
"use": [
"source-map-loader"
],
"enforce": "pre"
}
]
}
}
}

platforms.firefoxos.webpackConfig.metaTags‚Äč

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.firefoxos.webpackConfig.metaTags

platforms.firefoxtv‚Äč

Prop NameTypeDefault ValuePath
firefoxtvobjectplatforms.firefoxtv

platforms.firefoxtv.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.firefoxtv.author

platforms.firefoxtv.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.firefoxtv.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.firefoxtv.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.firefoxtv.buildSchemes

platforms.firefoxtv.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.firefoxtv.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.firefoxtv.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.firefoxtv.bundleIsDev

platforms.firefoxtv.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.firefoxtv.deploy

platforms.firefoxtv.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.firefoxtv.deploy.type

platforms.firefoxtv.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.firefoxtv.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.firefoxtv.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.firefoxtv.devServerHost

platforms.firefoxtv.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.firefoxtv.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.firefoxtv.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.firefoxtv.engine

platforms.firefoxtv.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.firefoxtv.entryFile

platforms.firefoxtv.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.firefoxtv.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.firefoxtv.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.firefoxtv.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.firefoxtv.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.firefoxtv.id

platforms.firefoxtv.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.firefoxtv.ignoreLogs

platforms.firefoxtv.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.firefoxtv.ignoreWarnings

platforms.firefoxtv.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.firefoxtv.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.firefoxtv.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.firefoxtv.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.firefoxtv.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.firefoxtv.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.firefoxtv.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.firefoxtv.license

platforms.firefoxtv.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.firefoxtv.permissions

> DEPRECATED in favor of includedPermissions


platforms.firefoxtv.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.firefoxtv.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.firefoxtv.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.firefoxtv.splashScreen

platforms.firefoxtv.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.firefoxtv.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.firefoxtv.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.firefoxtv.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.firefoxtv.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.firefoxtv.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.firefoxtv.webpackConfig‚Äč

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.firefoxtv.webpackConfig

platforms.firefoxtv.webpackConfig.customScripts‚Äč

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.firefoxtv.webpackConfig.customScripts

platforms.firefoxtv.webpackConfig.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.firefoxtv.webpackConfig.devServerHost

platforms.firefoxtv.webpackConfig.extend‚Äč

Prop NameTypeDefault ValuePath
extendobjectplatforms.firefoxtv.webpackConfig.extend

Allows you to directly extend/override webpack config of your current platform

examples

{
"extend": {
"devtool": "source-map"
}
}
{
"extend": {
"module": {
"rules": [
{
"test": {},
"use": [
"source-map-loader"
],
"enforce": "pre"
}
]
}
}
}

platforms.firefoxtv.webpackConfig.metaTags‚Äč

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.firefoxtv.webpackConfig.metaTags

platforms.firetv‚Äč

Prop NameTypeDefault ValuePath
firetvobjectplatforms.firetv

platforms.firetv.AndroidManifest‚Äč

Prop NameTypeDefault ValuePath
AndroidManifestobjectplatforms.firetv.AndroidManifest

Allows you to directly manipulate AndroidManifest.xml via json override mechanism

Injects / Overrides values in AndroidManifest.xml file of generated android based project

> IMPORTANT: always ensure that your object contains tag and android:name to target correct tag to merge into

examples

{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"children": [
{
"tag": "activity",
"android:name": "com.ahmedadeltito.photoeditor.PhotoEditorActivity"
}
]
}
]
}
}
{
"AndroidManifest": {
"children": [
{
"tag": "application",
"android:name": ".MainApplication",
"android:allowBackup": true,
"android:largeHeap": true,
"android:usesCleartextTraffic": true,
"tools:targetApi": 28
}
]
}
}

platforms.firetv.BuildGradle‚Äč

Prop NameTypeDefault ValuePath
BuildGradleobjectplatforms.firetv.BuildGradle

Allows you to customize build.gradle file


platforms.firetv.BuildGradle.allprojects‚Äč

Prop NameTypeDefault ValuePath
allprojectsobjectplatforms.firetv.BuildGradle.allprojects

platforms.firetv.BuildGradle.allprojects.repositories‚Äč

Prop NameTypeDefault ValuePath
repositoriesobjectplatforms.firetv.BuildGradle.allprojects.repositories

Customize repositories section of build.gradle

examples

{
"repositories": {
"flatDir { dirs 'libs'}": true
}
}

platforms.firetv.aab‚Äč

Prop NameTypeDefault ValuePath
aabbooleanplatforms.firetv.aab

If set to true, android project will generate app.aab instead of apk

examples

{
"aab": "false"
}
{
"aab": "true"
}

platforms.firetv.app/build.gradle‚Äč

Prop NameTypeDefault ValuePath
app/build.gradleobjectplatforms.firetv.app/build.gradle

Overrides values in app/build.gradle file of generated android based project

examples

{
"app/build.gradle": {
"apply": [
"plugin: 'io.fabric'"
]
}
}

platforms.firetv.applyPlugin‚Äč

Prop NameTypeDefault ValuePath
applyPluginarrayplatforms.firetv.applyPlugin

platforms.firetv.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.firetv.author

platforms.firetv.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.firetv.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.firetv.build.gradle‚Äč

Prop NameTypeDefault ValuePath
build.gradleobjectplatforms.firetv.build.gradle

Overrides values in build.gradle file of generated android based project

examples

{
"build.gradle": {
"allprojects": {
"repositories": {
"maven { url \"https://dl.bintray.com/onfido/maven\" }": true
}
}
}
}

platforms.firetv.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.firetv.buildSchemes

platforms.firetv.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.firetv.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.firetv.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.firetv.bundleIsDev

platforms.firetv.compileSdkVersion‚Äč

Prop NameTypeDefault ValuePath
compileSdkVersionintegerplatforms.firetv.compileSdkVersion

Allows you define custom compileSdkVersion equivalent to: compileSdkVersion = [VERSION]

examples

{
"compileSdkVersion": "28"
}
{
"compileSdkVersion": "29"
}

platforms.firetv.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.firetv.deploy

platforms.firetv.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.firetv.deploy.type

platforms.firetv.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.firetv.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.firetv.enableAndroidX‚Äč

Prop NameTypeDefault ValuePath
enableAndroidXbooleantrueplatforms.firetv.enableAndroidX

examples

{
"enableAndroidX": "true"
}
{
"enableAndroidX": "false"
}

platforms.firetv.enableHermes‚Äč

Prop NameTypeDefault ValuePath
enableHermesbooleanplatforms.firetv.enableHermes

> DEPRECATED in favour of reactNativeEngine

examples

{
"enableHermes": "true"
}
{
"enableHermes": "false"
}

platforms.firetv.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.firetv.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.firetv.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.firetv.engine

platforms.firetv.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.firetv.entryFile

platforms.firetv.excludedFeatures‚Äč

Prop NameTypeDefault ValuePath
excludedFeaturesarrayplatforms.firetv.excludedFeatures

platforms.firetv.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.firetv.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.firetv.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.firetv.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.firetv.gradle.properties‚Äč

Prop NameTypeDefault ValuePath
gradle.propertiesobjectplatforms.firetv.gradle.properties

Overrides values in gradle.properties file of generated android based project

examples

{
"gradle.properties": {
"gradle.properties": {
"android.debug.obsoleteApi": true,
"debug.keystore": "debug.keystore",
"org.gradle.daemon": true,
"org.gradle.parallel": true,
"org.gradle.configureondemand": true
}
}
}

platforms.firetv.gradleBuildToolsVersion‚Äč

Prop NameTypeDefault ValuePath
gradleBuildToolsVersioninteger3.3.1platforms.firetv.gradleBuildToolsVersion

Allows you define custom gradle build tools version equivalent to: classpath 'com.android.tools.build:gradle:[VERSION]'

examples

{
"gradleBuildToolsVersion": "3.3.1"
}
{
"gradleBuildToolsVersion": "4.1.0"
}

platforms.firetv.gradleWrapperVersion‚Äč

Prop NameTypeDefault ValuePath
gradleWrapperVersioninteger5.5platforms.firetv.gradleWrapperVersion

Allows you define custom gradle wrapper version equivalent to: distributionUrl=https\://services.gradle.org/distributions/gradle-[VERSION]-all.zip

examples

{
"gradleWrapperVersion": "5.5"
}
{
"gradleWrapperVersion": "6.7.1"
}

platforms.firetv.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.firetv.id

platforms.firetv.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.firetv.ignoreLogs

platforms.firetv.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.firetv.ignoreWarnings

platforms.firetv.implementation‚Äč

Prop NameTypeDefault ValuePath
implementationobjectplatforms.firetv.implementation

platforms.firetv.includedFeatures‚Äč

Prop NameTypeDefault ValuePath
includedFeaturesarrayplatforms.firetv.includedFeatures

platforms.firetv.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.firetv.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.firetv.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.firetv.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.firetv.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.firetv.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.firetv.keyAlias‚Äč

Prop NameTypeDefault ValuePath
keyAliasstringplatforms.firetv.keyAlias

platforms.firetv.keyPassword‚Äč

Prop NameTypeDefault ValuePath
keyPasswordstringplatforms.firetv.keyPassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

keyPassword for keystore file


platforms.firetv.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.firetv.license

platforms.firetv.mainActivity‚Äč

Prop NameTypeDefault ValuePath
mainActivityobject{}platforms.firetv.mainActivity

Allows you to configure behaviour of MainActivity.kt


platforms.firetv.mainActivity.onCreate‚Äč

Prop NameTypeDefault ValuePath
onCreatestringsuper.onCreate(savedInstanceState)platforms.firetv.mainActivity.onCreate

Overrides super.onCreate method handler of MainActivity.kt

examples

{
"onCreate": "super.onCreate(null)"
}
{
"onCreate": "super.onCreate(savedInstanceState)"
}

platforms.firetv.minSdkVersion‚Äč

Prop NameTypeDefault ValuePath
minSdkVersioninteger21platforms.firetv.minSdkVersion

examples

{
"minSdkVersion": "21"
}
{
"minSdkVersion": "22"
}

platforms.firetv.minifyEnabled‚Äč

Prop NameTypeDefault ValuePath
minifyEnabledbooleanplatforms.firetv.minifyEnabled

Sets minifyEnabled buildType property in app/build.gradle

examples

{
"minifyEnabled": "false"
}
{
"minifyEnabled": "true"
}

platforms.firetv.multipleAPKs‚Äč

Prop NameTypeDefault ValuePath
multipleAPKsbooleanplatforms.firetv.multipleAPKs

If set to true, apk will be split into multiple ones for each architecture: "armeabi-v7a", "x86", "arm64-v8a", "x86_64"

examples

{
"multipleAPKs": "true"
}
{
"multipleAPKs": "false"
}

platforms.firetv.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.firetv.permissions

> DEPRECATED in favor of includedPermissions


platforms.firetv.reactNativeEngine‚Äč

Prop NameTypeDefault ValuePath
reactNativeEnginestringdefaultplatforms.firetv.reactNativeEngine

Allows you to define specific native render engine to be used

examples

{
"reactNativeEngine": "true"
}
{
"reactNativeEngine": "false"
}

platforms.firetv.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.firetv.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.firetv.signingConfig‚Äč

Prop NameTypeDefault ValuePath
signingConfigstringDebugplatforms.firetv.signingConfig

Equivalent to running ./gradlew/assembleDebug or ./gradlew/assembleRelease

examples

{
"signingConfig": "default"
}
{
"signingConfig": "v8-android"
}
{
"signingConfig": "v8-android-nointl"
}
{
"signingConfig": "v8-android-jit"
}
{
"signingConfig": "v8-android-jit-nointl"
}
{
"signingConfig": "hermes"
}

platforms.firetv.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.firetv.splashScreen

platforms.firetv.storeFile‚Äč

Prop NameTypeDefault ValuePath
storeFilestringplatforms.firetv.storeFile

platforms.firetv.storePassword‚Äč

Prop NameTypeDefault ValuePath
storePasswordstringplatforms.firetv.storePassword

> WARNING. this prop is sensitive and should not be stored in standard renative.json configs. use renative.private.json files instead!

storePassword for keystore file


platforms.firetv.targetSdkVersion‚Äč

Prop NameTypeDefault ValuePath
targetSdkVersionintegerplatforms.firetv.targetSdkVersion

Allows you define custom targetSdkVersion equivalent to: targetSdkVersion = [VERSION]

examples

{
"targetSdkVersion": "28"
}
{
"targetSdkVersion": "29"
}

platforms.firetv.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.firetv.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.firetv.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.firetv.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.firetv.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.firetv.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.ios‚Äč

Prop NameTypeDefault ValuePath
iosobjectplatforms.ios

platforms.ios.Podfile‚Äč

Prop NameTypeDefault ValuePath
Podfileobjectplatforms.ios.Podfile

platforms.ios.appDelegateApplicationMethods‚Äč

Prop NameTypeDefault ValuePath
appDelegateApplicationMethodsobjectplatforms.ios.appDelegateApplicationMethods

platforms.ios.appDelegateApplicationMethods.didConnectCarInterfaceController‚Äč

Prop NameTypeDefault ValuePath
didConnectCarInterfaceControllerarrayplatforms.ios.appDelegateApplicationMethods.didConnectCarInterfaceController

platforms.ios.appDelegateApplicationMethods.didDisconnectCarInterfaceController‚Äč

Prop NameTypeDefault ValuePath
didDisconnectCarInterfaceControllerarrayplatforms.ios.appDelegateApplicationMethods.didDisconnectCarInterfaceController

platforms.ios.appDelegateApplicationMethods.didFailToRegisterForRemoteNotificationsWithError‚Äč

Prop NameTypeDefault ValuePath
didFailToRegisterForRemoteNotificationsWithErrorarrayplatforms.ios.appDelegateApplicationMethods.didFailToRegisterForRemoteNotificationsWithError

platforms.ios.appDelegateApplicationMethods.didFinishLaunchingWithOptions‚Äč

Prop NameTypeDefault ValuePath
didFinishLaunchingWithOptionsarrayplatforms.ios.appDelegateApplicationMethods.didFinishLaunchingWithOptions

platforms.ios.appDelegateApplicationMethods.didReceive‚Äč

Prop NameTypeDefault ValuePath
didReceivearrayplatforms.ios.appDelegateApplicationMethods.didReceive

platforms.ios.appDelegateApplicationMethods.didReceiveRemoteNotification‚Äč

Prop NameTypeDefault ValuePath
didReceiveRemoteNotificationarrayplatforms.ios.appDelegateApplicationMethods.didReceiveRemoteNotification

platforms.ios.appDelegateApplicationMethods.didRegister‚Äč

Prop NameTypeDefault ValuePath
didRegisterarrayplatforms.ios.appDelegateApplicationMethods.didRegister

platforms.ios.appDelegateApplicationMethods.didRegisterForRemoteNotificationsWithDeviceToken‚Äč

Prop NameTypeDefault ValuePath
didRegisterForRemoteNotificationsWithDeviceTokenarrayplatforms.ios.appDelegateApplicationMethods.didRegisterForRemoteNotificationsWithDeviceToken

platforms.ios.appDelegateApplicationMethods.open‚Äč

Prop NameTypeDefault ValuePath
openarrayplatforms.ios.appDelegateApplicationMethods.open

platforms.ios.appDelegateApplicationMethods.supportedInterfaceOrientationsFor‚Äč

Prop NameTypeDefault ValuePath
supportedInterfaceOrientationsForarrayplatforms.ios.appDelegateApplicationMethods.supportedInterfaceOrientationsFor

platforms.ios.appDelegateExtensions‚Äč

Prop NameTypeDefault ValuePath
appDelegateExtensionsarrayplatforms.ios.appDelegateExtensions

platforms.ios.appDelegateImports‚Äč

Prop NameTypeDefault ValuePath
appDelegateImportsarrayplatforms.ios.appDelegateImports

platforms.ios.appDelegateMethods‚Äč

Prop NameTypeDefault ValuePath
appDelegateMethodsobjectplatforms.ios.appDelegateMethods

platforms.ios.appleId‚Äč

Prop NameTypeDefault ValuePath
appleIdstringplatforms.ios.appleId

platforms.ios.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.ios.author

platforms.ios.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.ios.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.ios.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.ios.buildSchemes

platforms.ios.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.ios.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.ios.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.ios.bundleIsDev

platforms.ios.codeSignIdentity‚Äč

Prop NameTypeDefault ValuePath
codeSignIdentitystringplatforms.ios.codeSignIdentity

Special property which tells Xcode how to build your project

examples

{
"codeSignIdentity": "iPhone Developer"
}
{
"codeSignIdentity": "iPhone Distribution"
}

platforms.ios.commandLineArguments‚Äč

Prop NameTypeDefault ValuePath
commandLineArgumentsarrayplatforms.ios.commandLineArguments

Allows you to pass launch arguments to active scheme

examples

{
"commandLineArguments": [
"-FIRAnalyticsDebugEnabled",
"MyCustomLaunchArgument"
]
}

platforms.ios.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.ios.deploy

platforms.ios.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.ios.deploy.type

platforms.ios.deploymentTarget‚Äč

Prop NameTypeDefault ValuePath
deploymentTargetstringplatforms.ios.deploymentTarget

platforms.ios.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.ios.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.ios.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.ios.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.ios.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.ios.engine

platforms.ios.entitlements‚Äč

Prop NameTypeDefault ValuePath
entitlementsobjectplatforms.ios.entitlements

platforms.ios.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.ios.entryFile

platforms.ios.excludedArchs‚Äč

Prop NameTypeDefault ValuePath
excludedArchsarrayplatforms.ios.excludedArchs

Defines excluded architectures. This transforms to xcodeproj: EXCLUDED_ARCHS="&lt;VAL VAL ...&gt;"

examples

{
"excludedArchs": [
"arm64"
]
}

platforms.ios.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.ios.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.ios.exportOptions‚Äč

Prop NameTypeDefault ValuePath
exportOptionsobjectplatforms.ios.exportOptions

platforms.ios.exportOptions.compileBitcode‚Äč

Prop NameTypeDefault ValuePath
compileBitcodebooleanplatforms.ios.exportOptions.compileBitcode

platforms.ios.exportOptions.method‚Äč

Prop NameTypeDefault ValuePath
methodstringplatforms.ios.exportOptions.method

platforms.ios.exportOptions.provisioningProfiles‚Äč

Prop NameTypeDefault ValuePath
provisioningProfilesobjectplatforms.ios.exportOptions.provisioningProfiles

platforms.ios.exportOptions.signingCertificate‚Äč

Prop NameTypeDefault ValuePath
signingCertificatestringplatforms.ios.exportOptions.signingCertificate

platforms.ios.exportOptions.signingStyle‚Äč

Prop NameTypeDefault ValuePath
signingStylestringplatforms.ios.exportOptions.signingStyle

platforms.ios.exportOptions.teamID‚Äč

Prop NameTypeDefault ValuePath
teamIDstringplatforms.ios.exportOptions.teamID

platforms.ios.exportOptions.uploadBitcode‚Äč

Prop NameTypeDefault ValuePath
uploadBitcodebooleanplatforms.ios.exportOptions.uploadBitcode

platforms.ios.exportOptions.uploadSymbols‚Äč

Prop NameTypeDefault ValuePath
uploadSymbolsbooleanplatforms.ios.exportOptions.uploadSymbols

platforms.ios.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.ios.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.ios.firebaseId‚Äč

Prop NameTypeDefault ValuePath
firebaseIdstringplatforms.ios.firebaseId

platforms.ios.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.ios.id

platforms.ios.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.ios.ignoreLogs

platforms.ios.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.ios.ignoreWarnings

platforms.ios.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.ios.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.ios.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.ios.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.ios.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.ios.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.ios.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.ios.license

platforms.ios.orientationSupport‚Äč

Prop NameTypeDefault ValuePath
orientationSupportobjectplatforms.ios.orientationSupport

examples

{
"orientationSupport": {
"phone": [
"UIInterfaceOrientationPortrait",
"UIInterfaceOrientationPortraitUpsideDown",
"UIInterfaceOrientationLandscapeLeft",
"UIInterfaceOrientationLandscapeRight"
],
"tab": [
"UIInterfaceOrientationPortrait",
"UIInterfaceOrientationPortraitUpsideDown",
"UIInterfaceOrientationLandscapeLeft",
"UIInterfaceOrientationLandscapeRight"
]
}
}

platforms.ios.orientationSupport.phone‚Äč

Prop NameTypeDefault ValuePath
phonearrayplatforms.ios.orientationSupport.phone

platforms.ios.orientationSupport.tab‚Äč

Prop NameTypeDefault ValuePath
tabarrayplatforms.ios.orientationSupport.tab

platforms.ios.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.ios.permissions

> DEPRECATED in favor of includedPermissions


platforms.ios.plist‚Äč

Prop NameTypeDefault ValuePath
plistobjectplatforms.ios.plist

platforms.ios.provisionProfileSpecifier‚Äč

Prop NameTypeDefault ValuePath
provisionProfileSpecifierstringplatforms.ios.provisionProfileSpecifier

platforms.ios.provisioningProfiles‚Äč

Prop NameTypeDefault ValuePath
provisioningProfilesobjectplatforms.ios.provisioningProfiles

platforms.ios.provisioningStyle‚Äč

Prop NameTypeDefault ValuePath
provisioningStylestringplatforms.ios.provisioningStyle

platforms.ios.runScheme‚Äč

Prop NameTypeDefault ValuePath
runSchemestringplatforms.ios.runScheme

platforms.ios.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.ios.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.ios.scheme‚Äč

Prop NameTypeDefault ValuePath
schemestringplatforms.ios.scheme

platforms.ios.sdk‚Äč

Prop NameTypeDefault ValuePath
sdkstringplatforms.ios.sdk

platforms.ios.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.ios.splashScreen

platforms.ios.systemCapabilities‚Äč

Prop NameTypeDefault ValuePath
systemCapabilitiesobjectplatforms.ios.systemCapabilities

examples

{
"systemCapabilities": {
"com.apple.SafariKeychain": false,
"com.apple.Wallet": false,
"com.apple.HealthKit": false,
"com.apple.ApplicationGroups.iOS": false,
"com.apple.iCloud": true,
"com.apple.DataProtection": false,
"com.apple.HomeKit": false,
"com.apple.ClassKit": false,
"com.apple.VPNLite": false,
"com.apple.AutoFillCredentialProvider": false,
"com.apple.AccessWiFi": false,
"com.apple.InAppPurchase": false,
"com.apple.HotspotConfiguration": false,
"com.apple.Multipath": false,
"com.apple.GameCenter.iOS": false,
"com.apple.BackgroundModes": false,
"com.apple.InterAppAudio": false,
"com.apple.WAC": false,
"com.apple.Push": true,
"com.apple.NearFieldCommunicationTagReading": false,
"com.apple.ApplePay": false,
"com.apple.Keychain": false,
"com.apple.Maps.iOS": false,
"com.apple.Siri": false,
"com.apple.NetworkExtensions.iOS": false
}
}

platforms.ios.teamID‚Äč

Prop NameTypeDefault ValuePath
teamIDstringplatforms.ios.teamID

platforms.ios.teamIdentifier‚Äč

Prop NameTypeDefault ValuePath
teamIdentifierstringplatforms.ios.teamIdentifier

platforms.ios.testFlightId‚Äč

Prop NameTypeDefault ValuePath
testFlightIdstringplatforms.ios.testFlightId

platforms.ios.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.ios.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.ios.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.ios.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.ios.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.ios.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.ios.xcodeproj‚Äč

Prop NameTypeDefault ValuePath
xcodeprojobjectplatforms.ios.xcodeproj

platforms.kaios‚Äč

Prop NameTypeDefault ValuePath
kaiosobjectplatforms.kaios

platforms.kaios.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.kaios.author

platforms.kaios.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.kaios.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.kaios.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.kaios.buildSchemes

platforms.kaios.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.kaios.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.kaios.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.kaios.bundleIsDev

platforms.kaios.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.kaios.deploy

platforms.kaios.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.kaios.deploy.type

platforms.kaios.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.kaios.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.kaios.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.kaios.devServerHost

platforms.kaios.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.kaios.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.kaios.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.kaios.engine

platforms.kaios.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.kaios.entryFile

platforms.kaios.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.kaios.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.kaios.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.kaios.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.kaios.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.kaios.id

platforms.kaios.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.kaios.ignoreLogs

platforms.kaios.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.kaios.ignoreWarnings

platforms.kaios.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.kaios.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.kaios.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.kaios.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.kaios.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.kaios.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.kaios.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.kaios.license

platforms.kaios.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.kaios.permissions

> DEPRECATED in favor of includedPermissions


platforms.kaios.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.kaios.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.kaios.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.kaios.splashScreen

platforms.kaios.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.kaios.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.kaios.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.kaios.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.kaios.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.kaios.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.kaios.webpackConfig‚Äč

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.kaios.webpackConfig

platforms.kaios.webpackConfig.customScripts‚Äč

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.kaios.webpackConfig.customScripts

platforms.kaios.webpackConfig.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.kaios.webpackConfig.devServerHost

platforms.kaios.webpackConfig.extend‚Äč

Prop NameTypeDefault ValuePath
extendobjectplatforms.kaios.webpackConfig.extend

Allows you to directly extend/override webpack config of your current platform

examples

{
"extend": {
"devtool": "source-map"
}
}
{
"extend": {
"module": {
"rules": [
{
"test": {},
"use": [
"source-map-loader"
],
"enforce": "pre"
}
]
}
}
}

platforms.kaios.webpackConfig.metaTags‚Äč

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.kaios.webpackConfig.metaTags

platforms.macos‚Äč

Prop NameTypeDefault ValuePath
macosobjectplatforms.macos

platforms.macos.BrowserWindow‚Äč

Prop NameTypeDefault ValuePath
BrowserWindowobjectplatforms.macos.BrowserWindow

Allows you to configure electron wrapper app window

examples

{
"BrowserWindow": {
"width": 1310,
"height": 800,
"webPreferences": {
"devTools": true
}
}
}

platforms.macos.BrowserWindow.height‚Äč

Prop NameTypeDefault ValuePath
heightintegerplatforms.macos.BrowserWindow.height

Default height of electron app


platforms.macos.BrowserWindow.webPreferences‚Äč

Prop NameTypeDefault ValuePath
webPreferencesobjectplatforms.macos.BrowserWindow.webPreferences

Extra web preferences of electron app

examples

{
"webPreferences": {
"devTools": true
}
}

platforms.macos.BrowserWindow.width‚Äč

Prop NameTypeDefault ValuePath
widthintegerplatforms.macos.BrowserWindow.width

Default width of electron app


platforms.macos.appleId‚Äč

Prop NameTypeDefault ValuePath
appleIdstringplatforms.macos.appleId

platforms.macos.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.macos.author

platforms.macos.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.macos.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.macos.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.macos.buildSchemes

platforms.macos.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.macos.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.macos.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.macos.bundleIsDev

platforms.macos.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.macos.deploy

platforms.macos.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.macos.deploy.type

platforms.macos.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.macos.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.macos.electronConfig‚Äč

Prop NameTypeDefault ValuePath
electronConfigobjectplatforms.macos.electronConfig

Allows you to configure electron app as per https://www.electron.build/

examples

{
"electronConfig": {
"mac": {
"target": [
"dmg",
"mas",
"mas-dev"
],
"hardenedRuntime": true
},
"dmg": {
"sign": false
},
"mas": {
"type": "distribution",
"hardenedRuntime": false
}
}
}

platforms.macos.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.macos.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.macos.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.macos.engine

platforms.macos.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.macos.entryFile

platforms.macos.environment‚Äč

Prop NameTypeDefault ValuePath
environmentstringplatforms.macos.environment

platforms.macos.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.macos.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.macos.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.macos.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.macos.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.macos.id

platforms.macos.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.macos.ignoreLogs

platforms.macos.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.macos.ignoreWarnings

platforms.macos.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.macos.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.macos.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.macos.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples

{
"includedPermissions": [
"*"
]
}
{
"includedPermissions": [
"INTERNET",
"CAMERA",
"SYSTEM_ALERT_WINDOW",
"RECORD_AUDIO",
"RECORD_VIDEO",
"READ_EXTERNAL_STORAGE",
"WRITE_EXTERNAL_STORAGE",
"ACCESS_FINE_LOCATION",
"ACCESS_COARSE_LOCATION",
"VIBRATE",
"ACCESS_NETWORK_STATE",
"ACCESS_WIFI_STATE",
"RECEIVE_BOOT_COMPLETED",
"WRITE_CONTACTS",
"READ_CONTACTS"
]
}

platforms.macos.includedPlugins‚Äč

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.macos.includedPlugins

Defines an array of all included plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: includedPlugins is evaluated before excludedPlugins

examples

{
"includedPlugins": [
"*"
]
}
{
"includedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.macos.license‚Äč

Prop NameTypeDefault ValuePath
licensestringplatforms.macos.license

platforms.macos.permissions‚Äč

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.macos.permissions

> DEPRECATED in favor of includedPermissions


platforms.macos.runtime‚Äč

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.macos.runtime

This object will be automatically injected into ./platfromAssets/renative.runtime.json making it possible to inject the values directly to JS source code

examples

{
"runtime": {
"someRuntimeProperty": "foo"
}
}

platforms.macos.splashScreen‚Äč

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.macos.splashScreen

platforms.macos.timestampAssets‚Äč

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.macos.timestampAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-12345678.js) every new build. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new build you deploy

examples

{
"timestampAssets": "true"
}
{
"timestampAssets": "false"
}

platforms.macos.title‚Äč

Prop NameTypeDefault ValuePath
titlestringplatforms.macos.title

Title of your app will be used to create title of the binary. ie App title of installed app iOS/Android app or Tab title of the website

examples

{
"title": "Awesome App"
}

platforms.macos.versionedAssets‚Äč

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.macos.versionedAssets

If set to true generated js (bundle.js) files will be timestamped and named (bundle-1.0.0.js) every new version. This is useful if you want to enforce invalidate cache agains standard CDN cache policies every new version you deploy

examples

{
"versionedAssets": "true"
}
{
"versionedAssets": "false"
}

platforms.macos.webpackConfig‚Äč

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.macos.webpackConfig

platforms.macos.webpackConfig.customScripts‚Äč

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.macos.webpackConfig.customScripts

platforms.macos.webpackConfig.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.macos.webpackConfig.devServerHost

platforms.macos.webpackConfig.extend‚Äč

Prop NameTypeDefault ValuePath
extendobjectplatforms.macos.webpackConfig.extend

Allows you to directly extend/override webpack config of your current platform

examples

{
"extend": {
"devtool": "source-map"
}
}
{
"extend": {
"module": {
"rules": [
{
"test": {},
"use": [
"source-map-loader"
],
"enforce": "pre"
}
]
}
}
}

platforms.macos.webpackConfig.metaTags‚Äč

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.macos.webpackConfig.metaTags

platforms.tizen‚Äč

Prop NameTypeDefault ValuePath
tizenobjectplatforms.tizen

platforms.tizen.appName‚Äč

Prop NameTypeDefault ValuePath
appNamestringplatforms.tizen.appName

platforms.tizen.author‚Äč

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.tizen.author

platforms.tizen.backgroundColor‚Äč

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.tizen.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

{
"backgroundColor": "#FFFFFF"
}
{
"backgroundColor": "#222222"
}

platforms.tizen.buildSchemes‚Äč

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.tizen.buildSchemes

platforms.tizen.bundleAssets‚Äč

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.tizen.bundleAssets

If set to true compiled js bundle file will generated. this is needed if you want to make production like builds


platforms.tizen.bundleIsDev‚Äč

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.tizen.bundleIsDev

platforms.tizen.certificateProfile‚Äč

Prop NameTypeDefault ValuePath
certificateProfilestringplatforms.tizen.certificateProfile

platforms.tizen.deploy‚Äč

Prop NameTypeDefault ValuePath
deployobjectplatforms.tizen.deploy

platforms.tizen.deploy.type‚Äč

Prop NameTypeDefault ValuePath
typestringplatforms.tizen.deploy.type

platforms.tizen.description‚Äč

Prop NameTypeDefault ValuePath
descriptionstringplatforms.tizen.description

General description of your app. This prop will be injected to actual projects where description field is applicable

examples

{
"description": "This app does awesome things"
}

platforms.tizen.devServerHost‚Äč

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.tizen.devServerHost

platforms.tizen.enableSourceMaps‚Äč

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.tizen.enableSourceMaps

If set to true dedicated source map file will be generated alongside of compiled js bundle


platforms.tizen.engine‚Äč

Prop NameTypeDefault ValuePath
enginestringplatforms.tizen.engine

platforms.tizen.entryFile‚Äč

Prop NameTypeDefault ValuePath
entryFilestringplatforms.tizen.entryFile

platforms.tizen.excludedPlugins‚Äč

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.tizen.excludedPlugins

Defines an array of all excluded plugins for specific config or buildScheme. only full keys as defined in plugin should be used.

NOTE: excludedPlugins is evaluated after includedPlugins

examples

{
"excludedPlugins": [
"*"
]
}
{
"excludedPlugins": [
"react-native-google-cast",
"react-navigation-tabs"
]
}

platforms.tizen.ext‚Äč

Prop NameTypeDefault ValuePath
extobjectplatforms.tizen.ext

Object ysed to extend your renative with custom props. This allows renative json schema to be validated

examples

{
"ext": {
"myCustomRenativeProp": "foo"
}
}

platforms.tizen.id‚Äč

Prop NameTypeDefault ValuePath
idstringplatforms.tizen.id

platforms.tizen.ignoreLogs‚Äč

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.tizen.ignoreLogs

platforms.tizen.ignoreWarnings‚Äč

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.tizen.ignoreWarnings

platforms.tizen.includedFonts‚Äč

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.tizen.includedFonts

Array of fonts you want to include in specific app or scheme. Should use exact font file (without the extension) located in ./appConfigs/base/fonts or * to mark all

examples

{
"includedFonts": [
"*"
]
}
{
"includedFonts": [
"TimeBurner",
"Entypo"
]
}

platforms.tizen.includedPermissions‚Äč

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.tizen.includedPermissions

Allows you to include specific permissions by their KEY defined in permissions object

examples