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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringcommon.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

common.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarraycommon.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarraycommon.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumbercommon.portOffset

Offset each port default value by increment


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": "@rnv/template-starter"
}

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 14",
"tvos": "Apple TV",
"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,
"linux": 8200
}
}

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 14",
"tvos": "Apple TV"
}
}

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

extendsTemplate

Prop NameTypeDefault ValuePath
extendsTemplatestringextendsTemplate

You can extend another renative.json file of currently applied template by providing relative or full package name path

examples

{
"extendsTemplate": "renative.json"
}
{
"extendsTemplate": "@rnv/template-starter/renative.json"
}

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

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-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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.android.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.android.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.android.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.extraGradleParams

Prop NameTypeDefault ValuePath
extraGradleParamsstringplatforms.android.extraGradleParams

Allows passing extra params to gradle command

examples

{
"extraGradleParams": "assembleAndroidTest -DtestBuildType=debug"
}

platforms.android.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.android.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.android.portOffset

Offset each port default value by increment


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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.androidtv.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.androidtv.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.androidtv.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.extraGradleParams

Prop NameTypeDefault ValuePath
extraGradleParamsstringplatforms.androidtv.extraGradleParams

Allows passing extra params to gradle command

examples

{
"extraGradleParams": "assembleAndroidTest -DtestBuildType=debug"
}

platforms.androidtv.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.androidtv.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.androidtv.portOffset

Offset each port default value by increment


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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.androidwear.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.androidwear.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.androidwear.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.extraGradleParams

Prop NameTypeDefault ValuePath
extraGradleParamsstringplatforms.androidwear.extraGradleParams

Allows passing extra params to gradle command

examples

{
"extraGradleParams": "assembleAndroidTest -DtestBuildType=debug"
}

platforms.androidwear.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.androidwear.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.androidwear.portOffset

Offset each port default value by increment


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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.chromecast.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.chromecast.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.chromecast.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.chromecast.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.chromecast.portOffset

Offset each port default value by increment


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.chromecast.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.chromecast.webpackConfig.publicUrl

platforms.firefoxos

Prop NameTypeDefault ValuePath
firefoxosobjectplatforms.firefoxos

platforms.firefoxos.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.firefoxos.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.firefoxos.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.firefoxos.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.firefoxos.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.firefoxos.portOffset

Offset each port default value by increment


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.firefoxos.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.firefoxos.webpackConfig.publicUrl

platforms.firefoxtv

Prop NameTypeDefault ValuePath
firefoxtvobjectplatforms.firefoxtv

platforms.firefoxtv.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.firefoxtv.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.firefoxtv.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.firefoxtv.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.firefoxtv.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.firefoxtv.portOffset

Offset each port default value by increment


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.firefoxtv.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.firefoxtv.webpackConfig.publicUrl

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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.firetv.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.firetv.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.firetv.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.extraGradleParams

Prop NameTypeDefault ValuePath
extraGradleParamsstringplatforms.firetv.extraGradleParams

Allows passing extra params to gradle command

examples

{
"extraGradleParams": "assembleAndroidTest -DtestBuildType=debug"
}

platforms.firetv.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.firetv.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.firetv.portOffset

Offset each port default value by increment


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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.ios.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.ios.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.ios.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.ios.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.ios.portOffset

Offset each port default value by increment


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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.kaios.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.kaios.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.kaios.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.kaios.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.kaios.portOffset

Offset each port default value by increment


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.kaios.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.kaios.webpackConfig.publicUrl

platforms.linux

Prop NameTypeDefault ValuePath
linuxobjectplatforms.linux

platforms.linux.BrowserWindow

Prop NameTypeDefault ValuePath
BrowserWindowobjectplatforms.linux.BrowserWindow

Allows you to configure electron wrapper app window

examples

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

platforms.linux.BrowserWindow.height

Prop NameTypeDefault ValuePath
heightintegerplatforms.linux.BrowserWindow.height

Default height of electron app


platforms.linux.BrowserWindow.webPreferences

Prop NameTypeDefault ValuePath
webPreferencesobjectplatforms.linux.BrowserWindow.webPreferences

Extra web preferences of electron app

examples

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

platforms.linux.BrowserWindow.width

Prop NameTypeDefault ValuePath
widthintegerplatforms.linux.BrowserWindow.width

Default width of electron app


platforms.linux.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.linux.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.linux.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.linux.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.linux.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.linux.author

platforms.linux.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.linux.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.linux.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.linux.buildSchemes

platforms.linux.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.linux.bundleAssets

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


platforms.linux.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.linux.bundleIsDev

platforms.linux.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.linux.deploy

platforms.linux.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.linux.deploy.type

platforms.linux.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.linux.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.linux.electronConfig

Prop NameTypeDefault ValuePath
electronConfigobjectplatforms.linux.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
},
"mainInjection": "console.log(\"Hello from main.js!\");",
"mainHeadInjection": "console.log(\"Hello from main.js!\");"
}
}

platforms.linux.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.linux.enableSourceMaps

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


platforms.linux.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.linux.engine

platforms.linux.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.linux.entryFile

platforms.linux.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.linux.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.linux.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.linux.ext

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

examples

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

platforms.linux.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.linux.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.linux.id

Prop NameTypeDefault ValuePath
idstringplatforms.linux.id

platforms.linux.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.linux.ignoreLogs

platforms.linux.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.linux.ignoreWarnings

platforms.linux.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.linux.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.linux.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.linux.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.linux.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.linux.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.linux.license

Prop NameTypeDefault ValuePath
licensestringplatforms.linux.license

platforms.linux.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.linux.permissions

> DEPRECATED in favor of includedPermissions


platforms.linux.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.linux.portOffset

Offset each port default value by increment


platforms.linux.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.linux.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.linux.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.linux.splashScreen

platforms.linux.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.linux.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.linux.title

Prop NameTypeDefault ValuePath
titlestringplatforms.linux.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.linux.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.linux.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.linux.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.linux.webpackConfig

platforms.linux.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.linux.webpackConfig.customScripts

platforms.linux.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.linux.webpackConfig.devServerHost

platforms.linux.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.linux.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.linux.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.linux.webpackConfig.metaTags

platforms.linux.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.linux.webpackConfig.publicUrl

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.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.macos.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.macos.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.macos.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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
},
"mainInjection": "console.log(\"Hello from main.js!\");",
"mainHeadInjection": "console.log(\"Hello from main.js!\");"
}
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.macos.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.macos.portOffset

Offset each port default value by increment


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.macos.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.macos.webpackConfig.publicUrl

platforms.tizen

Prop NameTypeDefault ValuePath
tizenobjectplatforms.tizen

platforms.tizen.appName

Prop NameTypeDefault ValuePath
appNamestringplatforms.tizen.appName

platforms.tizen.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.tizen.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.tizen.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.tizen.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

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.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.tizen.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

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

{
"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.tizen.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.tizen.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.tizen.license

Prop NameTypeDefault ValuePath
licensestringplatforms.tizen.license

platforms.tizen.package

Prop NameTypeDefault ValuePath
packagestringplatforms.tizen.package

platforms.tizen.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.tizen.permissions

> DEPRECATED in favor of includedPermissions


platforms.tizen.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.tizen.portOffset

Offset each port default value by increment


platforms.tizen.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.tizen.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.tizen.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.tizen.splashScreen

platforms.tizen.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.tizen.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.tizen.title

Prop NameTypeDefault ValuePath
titlestringplatforms.tizen.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.tizen.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.tizen.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.tizen.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.tizen.webpackConfig

platforms.tizen.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.tizen.webpackConfig.customScripts

platforms.tizen.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.tizen.webpackConfig.devServerHost

platforms.tizen.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.tizen.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.tizen.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.tizen.webpackConfig.metaTags

platforms.tizen.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.tizen.webpackConfig.publicUrl

platforms.tizenmobile

Prop NameTypeDefault ValuePath
tizenmobileobjectplatforms.tizenmobile

platforms.tizenmobile.appName

Prop NameTypeDefault ValuePath
appNamestringplatforms.tizenmobile.appName

platforms.tizenmobile.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.tizenmobile.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.tizenmobile.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.tizenmobile.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.tizenmobile.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.tizenmobile.author

platforms.tizenmobile.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.tizenmobile.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.tizenmobile.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.tizenmobile.buildSchemes

platforms.tizenmobile.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.tizenmobile.bundleAssets

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


platforms.tizenmobile.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.tizenmobile.bundleIsDev

platforms.tizenmobile.certificateProfile

Prop NameTypeDefault ValuePath
certificateProfilestringplatforms.tizenmobile.certificateProfile

platforms.tizenmobile.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.tizenmobile.deploy

platforms.tizenmobile.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.tizenmobile.deploy.type

platforms.tizenmobile.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.tizenmobile.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.tizenmobile.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.tizenmobile.devServerHost

platforms.tizenmobile.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.tizenmobile.enableSourceMaps

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


platforms.tizenmobile.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.tizenmobile.engine

platforms.tizenmobile.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.tizenmobile.entryFile

platforms.tizenmobile.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.tizenmobile.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.tizenmobile.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.tizenmobile.ext

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

examples

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

platforms.tizenmobile.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.tizenmobile.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.tizenmobile.id

Prop NameTypeDefault ValuePath
idstringplatforms.tizenmobile.id

platforms.tizenmobile.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.tizenmobile.ignoreLogs

platforms.tizenmobile.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.tizenmobile.ignoreWarnings

platforms.tizenmobile.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.tizenmobile.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.tizenmobile.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.tizenmobile.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.tizenmobile.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.tizenmobile.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.tizenmobile.license

Prop NameTypeDefault ValuePath
licensestringplatforms.tizenmobile.license

platforms.tizenmobile.package

Prop NameTypeDefault ValuePath
packagestringplatforms.tizenmobile.package

platforms.tizenmobile.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.tizenmobile.permissions

> DEPRECATED in favor of includedPermissions


platforms.tizenmobile.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.tizenmobile.portOffset

Offset each port default value by increment


platforms.tizenmobile.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.tizenmobile.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.tizenmobile.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.tizenmobile.splashScreen

platforms.tizenmobile.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.tizenmobile.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.tizenmobile.title

Prop NameTypeDefault ValuePath
titlestringplatforms.tizenmobile.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.tizenmobile.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.tizenmobile.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.tizenmobile.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.tizenmobile.webpackConfig

platforms.tizenmobile.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.tizenmobile.webpackConfig.customScripts

platforms.tizenmobile.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.tizenmobile.webpackConfig.devServerHost

platforms.tizenmobile.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.tizenmobile.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.tizenmobile.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.tizenmobile.webpackConfig.metaTags

platforms.tizenmobile.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.tizenmobile.webpackConfig.publicUrl

platforms.tizenwatch

Prop NameTypeDefault ValuePath
tizenwatchobjectplatforms.tizenwatch

platforms.tizenwatch.appName

Prop NameTypeDefault ValuePath
appNamestringplatforms.tizenwatch.appName

platforms.tizenwatch.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.tizenwatch.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.tizenwatch.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.tizenwatch.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.tizenwatch.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.tizenwatch.author

platforms.tizenwatch.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.tizenwatch.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.tizenwatch.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.tizenwatch.buildSchemes

platforms.tizenwatch.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.tizenwatch.bundleAssets

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


platforms.tizenwatch.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.tizenwatch.bundleIsDev

platforms.tizenwatch.certificateProfile

Prop NameTypeDefault ValuePath
certificateProfilestringplatforms.tizenwatch.certificateProfile

platforms.tizenwatch.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.tizenwatch.deploy

platforms.tizenwatch.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.tizenwatch.deploy.type

platforms.tizenwatch.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.tizenwatch.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.tizenwatch.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.tizenwatch.devServerHost

platforms.tizenwatch.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.tizenwatch.enableSourceMaps

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


platforms.tizenwatch.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.tizenwatch.engine

platforms.tizenwatch.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.tizenwatch.entryFile

platforms.tizenwatch.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.tizenwatch.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.tizenwatch.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.tizenwatch.ext

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

examples

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

platforms.tizenwatch.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.tizenwatch.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.tizenwatch.id

Prop NameTypeDefault ValuePath
idstringplatforms.tizenwatch.id

platforms.tizenwatch.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.tizenwatch.ignoreLogs

platforms.tizenwatch.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.tizenwatch.ignoreWarnings

platforms.tizenwatch.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.tizenwatch.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.tizenwatch.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.tizenwatch.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.tizenwatch.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.tizenwatch.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.tizenwatch.license

Prop NameTypeDefault ValuePath
licensestringplatforms.tizenwatch.license

platforms.tizenwatch.package

Prop NameTypeDefault ValuePath
packagestringplatforms.tizenwatch.package

platforms.tizenwatch.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.tizenwatch.permissions

> DEPRECATED in favor of includedPermissions


platforms.tizenwatch.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.tizenwatch.portOffset

Offset each port default value by increment


platforms.tizenwatch.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.tizenwatch.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.tizenwatch.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.tizenwatch.splashScreen

platforms.tizenwatch.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.tizenwatch.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.tizenwatch.title

Prop NameTypeDefault ValuePath
titlestringplatforms.tizenwatch.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.tizenwatch.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.tizenwatch.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.tizenwatch.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.tizenwatch.webpackConfig

platforms.tizenwatch.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.tizenwatch.webpackConfig.customScripts

platforms.tizenwatch.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.tizenwatch.webpackConfig.devServerHost

platforms.tizenwatch.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.tizenwatch.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.tizenwatch.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.tizenwatch.webpackConfig.metaTags

platforms.tizenwatch.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.tizenwatch.webpackConfig.publicUrl

platforms.tvos

Prop NameTypeDefault ValuePath
tvosobjectplatforms.tvos

platforms.tvos.Podfile

Prop NameTypeDefault ValuePath
Podfileobjectplatforms.tvos.Podfile

platforms.tvos.appDelegateApplicationMethods

Prop NameTypeDefault ValuePath
appDelegateApplicationMethodsobjectplatforms.tvos.appDelegateApplicationMethods

platforms.tvos.appDelegateApplicationMethods.didConnectCarInterfaceController

Prop NameTypeDefault ValuePath
didConnectCarInterfaceControllerarrayplatforms.tvos.appDelegateApplicationMethods.didConnectCarInterfaceController

platforms.tvos.appDelegateApplicationMethods.didDisconnectCarInterfaceController

Prop NameTypeDefault ValuePath
didDisconnectCarInterfaceControllerarrayplatforms.tvos.appDelegateApplicationMethods.didDisconnectCarInterfaceController

platforms.tvos.appDelegateApplicationMethods.didFailToRegisterForRemoteNotificationsWithError

Prop NameTypeDefault ValuePath
didFailToRegisterForRemoteNotificationsWithErrorarrayplatforms.tvos.appDelegateApplicationMethods.didFailToRegisterForRemoteNotificationsWithError

platforms.tvos.appDelegateApplicationMethods.didFinishLaunchingWithOptions

Prop NameTypeDefault ValuePath
didFinishLaunchingWithOptionsarrayplatforms.tvos.appDelegateApplicationMethods.didFinishLaunchingWithOptions

platforms.tvos.appDelegateApplicationMethods.didReceive

Prop NameTypeDefault ValuePath
didReceivearrayplatforms.tvos.appDelegateApplicationMethods.didReceive

platforms.tvos.appDelegateApplicationMethods.didReceiveRemoteNotification

Prop NameTypeDefault ValuePath
didReceiveRemoteNotificationarrayplatforms.tvos.appDelegateApplicationMethods.didReceiveRemoteNotification

platforms.tvos.appDelegateApplicationMethods.didRegister

Prop NameTypeDefault ValuePath
didRegisterarrayplatforms.tvos.appDelegateApplicationMethods.didRegister

platforms.tvos.appDelegateApplicationMethods.didRegisterForRemoteNotificationsWithDeviceToken

Prop NameTypeDefault ValuePath
didRegisterForRemoteNotificationsWithDeviceTokenarrayplatforms.tvos.appDelegateApplicationMethods.didRegisterForRemoteNotificationsWithDeviceToken

platforms.tvos.appDelegateApplicationMethods.open

Prop NameTypeDefault ValuePath
openarrayplatforms.tvos.appDelegateApplicationMethods.open

platforms.tvos.appDelegateApplicationMethods.supportedInterfaceOrientationsFor

Prop NameTypeDefault ValuePath
supportedInterfaceOrientationsForarrayplatforms.tvos.appDelegateApplicationMethods.supportedInterfaceOrientationsFor

platforms.tvos.appDelegateExtensions

Prop NameTypeDefault ValuePath
appDelegateExtensionsarrayplatforms.tvos.appDelegateExtensions

platforms.tvos.appDelegateImports

Prop NameTypeDefault ValuePath
appDelegateImportsarrayplatforms.tvos.appDelegateImports

platforms.tvos.appDelegateMethods

Prop NameTypeDefault ValuePath
appDelegateMethodsobjectplatforms.tvos.appDelegateMethods

platforms.tvos.appleId

Prop NameTypeDefault ValuePath
appleIdstringplatforms.tvos.appleId

platforms.tvos.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.tvos.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.tvos.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.tvos.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.tvos.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.tvos.author

platforms.tvos.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.tvos.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.tvos.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.tvos.buildSchemes

platforms.tvos.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.tvos.bundleAssets

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


platforms.tvos.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.tvos.bundleIsDev

platforms.tvos.codeSignIdentity

Prop NameTypeDefault ValuePath
codeSignIdentitystringplatforms.tvos.codeSignIdentity

Special property which tells Xcode how to build your project

examples

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

platforms.tvos.commandLineArguments

Prop NameTypeDefault ValuePath
commandLineArgumentsarrayplatforms.tvos.commandLineArguments

Allows you to pass launch arguments to active scheme

examples

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

platforms.tvos.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.tvos.deploy

platforms.tvos.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.tvos.deploy.type

platforms.tvos.deploymentTarget

Prop NameTypeDefault ValuePath
deploymentTargetstringplatforms.tvos.deploymentTarget

platforms.tvos.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.tvos.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.tvos.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.tvos.enableSourceMaps

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


platforms.tvos.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.tvos.engine

platforms.tvos.entitlements

Prop NameTypeDefault ValuePath
entitlementsobjectplatforms.tvos.entitlements

platforms.tvos.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.tvos.entryFile

platforms.tvos.excludedArchs

Prop NameTypeDefault ValuePath
excludedArchsarrayplatforms.tvos.excludedArchs

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

examples

{
"excludedArchs": [
"arm64"
]
}

platforms.tvos.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.tvos.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.tvos.exportOptions

Prop NameTypeDefault ValuePath
exportOptionsobjectplatforms.tvos.exportOptions

platforms.tvos.exportOptions.compileBitcode

Prop NameTypeDefault ValuePath
compileBitcodebooleanplatforms.tvos.exportOptions.compileBitcode

platforms.tvos.exportOptions.method

Prop NameTypeDefault ValuePath
methodstringplatforms.tvos.exportOptions.method

platforms.tvos.exportOptions.provisioningProfiles

Prop NameTypeDefault ValuePath
provisioningProfilesobjectplatforms.tvos.exportOptions.provisioningProfiles

platforms.tvos.exportOptions.signingCertificate

Prop NameTypeDefault ValuePath
signingCertificatestringplatforms.tvos.exportOptions.signingCertificate

platforms.tvos.exportOptions.signingStyle

Prop NameTypeDefault ValuePath
signingStylestringplatforms.tvos.exportOptions.signingStyle

platforms.tvos.exportOptions.teamID

Prop NameTypeDefault ValuePath
teamIDstringplatforms.tvos.exportOptions.teamID

platforms.tvos.exportOptions.uploadBitcode

Prop NameTypeDefault ValuePath
uploadBitcodebooleanplatforms.tvos.exportOptions.uploadBitcode

platforms.tvos.exportOptions.uploadSymbols

Prop NameTypeDefault ValuePath
uploadSymbolsbooleanplatforms.tvos.exportOptions.uploadSymbols

platforms.tvos.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.tvos.ext

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

examples

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

platforms.tvos.firebaseId

Prop NameTypeDefault ValuePath
firebaseIdstringplatforms.tvos.firebaseId

platforms.tvos.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.tvos.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.tvos.id

Prop NameTypeDefault ValuePath
idstringplatforms.tvos.id

platforms.tvos.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.tvos.ignoreLogs

platforms.tvos.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.tvos.ignoreWarnings

platforms.tvos.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.tvos.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.tvos.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.tvos.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.tvos.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.tvos.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.tvos.license

Prop NameTypeDefault ValuePath
licensestringplatforms.tvos.license

platforms.tvos.orientationSupport

Prop NameTypeDefault ValuePath
orientationSupportobjectplatforms.tvos.orientationSupport

examples

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

platforms.tvos.orientationSupport.phone

Prop NameTypeDefault ValuePath
phonearrayplatforms.tvos.orientationSupport.phone

platforms.tvos.orientationSupport.tab

Prop NameTypeDefault ValuePath
tabarrayplatforms.tvos.orientationSupport.tab

platforms.tvos.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.tvos.permissions

> DEPRECATED in favor of includedPermissions


platforms.tvos.plist

Prop NameTypeDefault ValuePath
plistobjectplatforms.tvos.plist

platforms.tvos.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.tvos.portOffset

Offset each port default value by increment


platforms.tvos.provisionProfileSpecifier

Prop NameTypeDefault ValuePath
provisionProfileSpecifierstringplatforms.tvos.provisionProfileSpecifier

platforms.tvos.provisioningProfiles

Prop NameTypeDefault ValuePath
provisioningProfilesobjectplatforms.tvos.provisioningProfiles

platforms.tvos.provisioningStyle

Prop NameTypeDefault ValuePath
provisioningStylestringplatforms.tvos.provisioningStyle

platforms.tvos.runScheme

Prop NameTypeDefault ValuePath
runSchemestringplatforms.tvos.runScheme

platforms.tvos.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.tvos.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.tvos.scheme

Prop NameTypeDefault ValuePath
schemestringplatforms.tvos.scheme

platforms.tvos.sdk

Prop NameTypeDefault ValuePath
sdkstringplatforms.tvos.sdk

platforms.tvos.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.tvos.splashScreen

platforms.tvos.systemCapabilities

Prop NameTypeDefault ValuePath
systemCapabilitiesobjectplatforms.tvos.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.tvos.teamID

Prop NameTypeDefault ValuePath
teamIDstringplatforms.tvos.teamID

platforms.tvos.teamIdentifier

Prop NameTypeDefault ValuePath
teamIdentifierstringplatforms.tvos.teamIdentifier

platforms.tvos.testFlightId

Prop NameTypeDefault ValuePath
testFlightIdstringplatforms.tvos.testFlightId

platforms.tvos.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.tvos.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.tvos.title

Prop NameTypeDefault ValuePath
titlestringplatforms.tvos.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.tvos.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.tvos.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.tvos.xcodeproj

Prop NameTypeDefault ValuePath
xcodeprojobjectplatforms.tvos.xcodeproj

platforms.web

Prop NameTypeDefault ValuePath
webobjectplatforms.web

platforms.web.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.web.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.web.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.web.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.web.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.web.author

platforms.web.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.web.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.web.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.web.buildSchemes

platforms.web.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.web.bundleAssets

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


platforms.web.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.web.bundleIsDev

platforms.web.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.web.deploy

platforms.web.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.web.deploy.type

platforms.web.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.web.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.web.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.web.devServerHost

platforms.web.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.web.enableSourceMaps

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


platforms.web.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.web.engine

platforms.web.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.web.entryFile

platforms.web.environment

Prop NameTypeDefault ValuePath
environmentstringplatforms.web.environment

platforms.web.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.web.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.web.exportDir

Prop NameTypeDefault ValuePath
exportDirstringplatforms.web.exportDir

Custom export directory used by nextjs equivalent to "npx next export --outdir <exportDir>". Use relative paths

examples

{
"exportDir": "output"
}
{
"exportDir": "custom/location"
}

platforms.web.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.web.ext

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

examples

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

platforms.web.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.web.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.web.id

Prop NameTypeDefault ValuePath
idstringplatforms.web.id

platforms.web.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.web.ignoreLogs

platforms.web.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.web.ignoreWarnings

platforms.web.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.web.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.web.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.web.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.web.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.web.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.web.license

Prop NameTypeDefault ValuePath
licensestringplatforms.web.license

platforms.web.outputDir

Prop NameTypeDefault ValuePath
outputDirstringplatforms.web.outputDir

Custom output directory used by nextjs equivalent to "npx next build" with custom outputDir. Use relative paths

examples

{
"outputDir": ".next"
}
{
"outputDir": "custom/location"
}

platforms.web.pagesDir

Prop NameTypeDefault ValuePath
pagesDirstringplatforms.web.pagesDir

Custom pages directory used by nextjs. Use relative paths

examples

{
"pagesDir": "src/customFolder/pages"
}

platforms.web.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.web.permissions

> DEPRECATED in favor of includedPermissions


platforms.web.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.web.portOffset

Offset each port default value by increment


platforms.web.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.web.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.web.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.web.splashScreen

platforms.web.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.web.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.web.title

Prop NameTypeDefault ValuePath
titlestringplatforms.web.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.web.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.web.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.web.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.web.webpackConfig

platforms.web.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.web.webpackConfig.customScripts

platforms.web.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.web.webpackConfig.devServerHost

platforms.web.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.web.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.web.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.web.webpackConfig.metaTags

platforms.web.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.web.webpackConfig.publicUrl

platforms.webos

Prop NameTypeDefault ValuePath
webosobjectplatforms.webos

platforms.webos.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.webos.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.webos.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.webos.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.webos.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.webos.author

platforms.webos.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.webos.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.webos.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.webos.buildSchemes

platforms.webos.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.webos.bundleAssets

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


platforms.webos.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.webos.bundleIsDev

platforms.webos.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.webos.deploy

platforms.webos.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.webos.deploy.type

platforms.webos.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.webos.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.webos.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.webos.devServerHost

platforms.webos.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.webos.enableSourceMaps

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


platforms.webos.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.webos.engine

platforms.webos.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.webos.entryFile

platforms.webos.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.webos.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.webos.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.webos.ext

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

examples

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

platforms.webos.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.webos.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.webos.id

Prop NameTypeDefault ValuePath
idstringplatforms.webos.id

platforms.webos.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.webos.ignoreLogs

platforms.webos.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.webos.ignoreWarnings

platforms.webos.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.webos.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.webos.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.webos.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.webos.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.webos.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.webos.license

Prop NameTypeDefault ValuePath
licensestringplatforms.webos.license

platforms.webos.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.webos.permissions

> DEPRECATED in favor of includedPermissions


platforms.webos.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.webos.portOffset

Offset each port default value by increment


platforms.webos.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.webos.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.webos.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.webos.splashScreen

platforms.webos.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.webos.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.webos.title

Prop NameTypeDefault ValuePath
titlestringplatforms.webos.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.webos.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.webos.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.webos.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.webos.webpackConfig

platforms.webos.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.webos.webpackConfig.customScripts

platforms.webos.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.webos.webpackConfig.devServerHost

platforms.webos.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.webos.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.webos.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.webos.webpackConfig.metaTags

platforms.webos.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.webos.webpackConfig.publicUrl

platforms.webtv

Prop NameTypeDefault ValuePath
webtvobjectplatforms.webtv

platforms.webtv.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.webtv.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.webtv.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.webtv.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.webtv.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.webtv.author

platforms.webtv.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.webtv.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.webtv.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.webtv.buildSchemes

platforms.webtv.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.webtv.bundleAssets

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


platforms.webtv.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.webtv.bundleIsDev

platforms.webtv.deploy

Prop NameTypeDefault ValuePath
deployobjectplatforms.webtv.deploy

platforms.webtv.deploy.type

Prop NameTypeDefault ValuePath
typestringplatforms.webtv.deploy.type

platforms.webtv.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.webtv.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.webtv.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.webtv.devServerHost

platforms.webtv.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.webtv.enableSourceMaps

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


platforms.webtv.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.webtv.engine

platforms.webtv.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.webtv.entryFile

platforms.webtv.environment

Prop NameTypeDefault ValuePath
environmentstringplatforms.webtv.environment

platforms.webtv.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.webtv.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.webtv.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.webtv.ext

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

examples

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

platforms.webtv.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.webtv.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.webtv.id

Prop NameTypeDefault ValuePath
idstringplatforms.webtv.id

platforms.webtv.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.webtv.ignoreLogs

platforms.webtv.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.webtv.ignoreWarnings

platforms.webtv.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.webtv.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.webtv.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.webtv.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.webtv.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.webtv.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.webtv.license

Prop NameTypeDefault ValuePath
licensestringplatforms.webtv.license

platforms.webtv.pagesDir

Prop NameTypeDefault ValuePath
pagesDirstringplatforms.webtv.pagesDir

platforms.webtv.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.webtv.permissions

> DEPRECATED in favor of includedPermissions


platforms.webtv.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.webtv.portOffset

Offset each port default value by increment


platforms.webtv.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.webtv.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.webtv.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.webtv.splashScreen

platforms.webtv.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.webtv.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.webtv.title

Prop NameTypeDefault ValuePath
titlestringplatforms.webtv.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.webtv.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.webtv.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.webtv.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.webtv.webpackConfig

platforms.webtv.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.webtv.webpackConfig.customScripts

platforms.webtv.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.webtv.webpackConfig.devServerHost

platforms.webtv.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.webtv.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.webtv.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.webtv.webpackConfig.metaTags

platforms.webtv.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.webtv.webpackConfig.publicUrl

platforms.windows

Prop NameTypeDefault ValuePath
windowsobjectplatforms.windows

platforms.windows.BrowserWindow

Prop NameTypeDefault ValuePath
BrowserWindowobjectplatforms.windows.BrowserWindow

Allows you to configure electron wrapper app window

examples

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

platforms.windows.BrowserWindow.height

Prop NameTypeDefault ValuePath
heightintegerplatforms.windows.BrowserWindow.height

Default height of electron app


platforms.windows.BrowserWindow.webPreferences

Prop NameTypeDefault ValuePath
webPreferencesobjectplatforms.windows.BrowserWindow.webPreferences

Extra web preferences of electron app

examples

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

platforms.windows.BrowserWindow.width

Prop NameTypeDefault ValuePath
widthintegerplatforms.windows.BrowserWindow.width

Default width of electron app


platforms.windows.additionalMetroOptions

Prop NameTypeDefault ValuePath
additionalMetroOptionsobjectplatforms.windows.additionalMetroOptions

platforms.windows.appPath

Prop NameTypeDefault ValuePath
appPathstringplatforms.windows.appPath

Full path to windows plaform build directory


platforms.windows.arch

Prop NameTypeDefault ValuePath
archstringplatforms.windows.arch

Specification of targeted architecture

examples

{
"arch": "x86"
}
{
"arch": "x64"
}
{
"arch": "ARM"
}
{
"arch": "ARM64"
}

platforms.windows.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.windows.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.windows.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.windows.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.windows.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.windows.author

Prop NameTypeDefault ValuePath
autolinkbooleanplatforms.windows.autolink

Launches the application once the build process is finished


platforms.windows.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.windows.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.windows.build

Prop NameTypeDefault ValuePath
buildbooleanplatforms.windows.build

Builds the application before launching it


platforms.windows.buildLogDirectory

Prop NameTypeDefault ValuePath
buildLogDirectorystringplatforms.windows.buildLogDirectory

Full path to directory where builds logs should be stored, default - project path


platforms.windows.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.windows.buildSchemes

platforms.windows.bundle

Prop NameTypeDefault ValuePath
bundlebooleanplatforms.windows.bundle

platforms.windows.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.windows.bundleAssets

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


platforms.windows.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.windows.bundleIsDev

platforms.windows.deploy

Prop NameTypeDefault ValuePath
deploybooleanplatforms.windows.deploy

platforms.windows.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.windows.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.windows.devPort

Prop NameTypeDefault ValuePath
devPortstringplatforms.windows.devPort

platforms.windows.device

Prop NameTypeDefault ValuePath
devicebooleanplatforms.windows.device

platforms.windows.directDebugging

Prop NameTypeDefault ValuePath
directDebuggingbooleanplatforms.windows.directDebugging

platforms.windows.electronConfig

Prop NameTypeDefault ValuePath
electronConfigobjectplatforms.windows.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
},
"mainInjection": "console.log(\"Hello from main.js!\");",
"mainHeadInjection": "console.log(\"Hello from main.js!\");"
}
}

platforms.windows.emulator

Prop NameTypeDefault ValuePath
emulatorbooleanplatforms.windows.emulator

platforms.windows.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.windows.enableSourceMaps

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


platforms.windows.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.windows.engine

platforms.windows.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.windows.entryFile

platforms.windows.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.windows.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.windows.experimentalNuGetDependency

Prop NameTypeDefault ValuePath
experimentalNuGetDependencybooleanplatforms.windows.experimentalNuGetDependency

platforms.windows.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.windows.ext

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

examples

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

platforms.windows.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.windows.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.windows.id

Prop NameTypeDefault ValuePath
idstringplatforms.windows.id

platforms.windows.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.windows.ignoreLogs

platforms.windows.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.windows.ignoreWarnings

platforms.windows.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.windows.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.windows.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.windows.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.windows.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.windows.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.windows.info

Prop NameTypeDefault ValuePath
infobooleanplatforms.windows.info

Print information about the build machine to console


platforms.windows.language

Prop NameTypeDefault ValuePath
languagestringplatforms.windows.language

Specify generated project language: cpp for C++ or cs for C#


platforms.windows.launch

Prop NameTypeDefault ValuePath
launchbooleanplatforms.windows.launch

Launches the application once the build process is finished


platforms.windows.license

Prop NameTypeDefault ValuePath
licensestringplatforms.windows.license

platforms.windows.logging

Prop NameTypeDefault ValuePath
loggingbooleanplatforms.windows.logging

Logging all the build proccesses to console


platforms.windows.msbuildprops

Prop NameTypeDefault ValuePath
msbuildpropsstringplatforms.windows.msbuildprops

Comma separated props to pass to msbuild, eg: prop1=value1,prop2=value2


platforms.windows.nuGetTestFeed

Prop NameTypeDefault ValuePath
nuGetTestFeedstringplatforms.windows.nuGetTestFeed

platforms.windows.nuGetTestVersion

Prop NameTypeDefault ValuePath
nuGetTestVersionstringplatforms.windows.nuGetTestVersion

platforms.windows.overwrite

Prop NameTypeDefault ValuePath
overwritebooleanplatforms.windows.overwrite

Whether to attempt to override the existing builds files when running a build once more


platforms.windows.packageExtension

Prop NameTypeDefault ValuePath
packageExtensionstringplatforms.windows.packageExtension

platforms.windows.packager

Prop NameTypeDefault ValuePath
packagerbooleanplatforms.windows.packager

platforms.windows.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.windows.permissions

> DEPRECATED in favor of includedPermissions


platforms.windows.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.windows.portOffset

Offset each port default value by increment


platforms.windows.proj

Prop NameTypeDefault ValuePath
projstringplatforms.windows.proj

Root project directory for your React Native Windows project (not Visual Studio project)


platforms.windows.reactNativeEngine

Prop NameTypeDefault ValuePath
reactNativeEnginestringplatforms.windows.reactNativeEngine

platforms.windows.release

Prop NameTypeDefault ValuePath
releasebooleanplatforms.windows.release

Enables full packaging of the app for release


platforms.windows.remoteDebugging

Prop NameTypeDefault ValuePath
remoteDebuggingbooleanplatforms.windows.remoteDebugging

platforms.windows.root

Prop NameTypeDefault ValuePath
rootstringplatforms.windows.root

Project root folder location (not the app itself, which is in platformBuilds)


platforms.windows.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.windows.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.windows.singleproc

Prop NameTypeDefault ValuePath
singleprocbooleanplatforms.windows.singleproc

Opt out of multi-proc builds (only available in 0.64 and newer versions of react-native-windows)


platforms.windows.sln

Prop NameTypeDefault ValuePath
slnstringplatforms.windows.sln

Location of Visual Studio solution .sln file (wraps multiple projects)


platforms.windows.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.windows.splashScreen

platforms.windows.target

Prop NameTypeDefault ValuePath
targetstringplatforms.windows.target

platforms.windows.telemetry

Prop NameTypeDefault ValuePath
telemetrybooleanplatforms.windows.telemetry

Send analytics data of @react-native-windows/cli usage to Microsoft


platforms.windows.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.windows.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.windows.title

Prop NameTypeDefault ValuePath
titlestringplatforms.windows.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.windows.useWinUI3

Prop NameTypeDefault ValuePath
useWinUI3booleanplatforms.windows.useWinUI3

platforms.windows.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.windows.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.windows.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.windows.webpackConfig

platforms.windows.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.windows.webpackConfig.customScripts

platforms.windows.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.windows.webpackConfig.devServerHost

platforms.windows.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.windows.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.windows.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.windows.webpackConfig.metaTags

platforms.windows.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.windows.webpackConfig.publicUrl

platforms.xbox

Prop NameTypeDefault ValuePath
xboxobjectplatforms.xbox

platforms.xbox.BrowserWindow

Prop NameTypeDefault ValuePath
BrowserWindowobjectplatforms.xbox.BrowserWindow

Allows you to configure electron wrapper app window

examples

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

platforms.xbox.BrowserWindow.height

Prop NameTypeDefault ValuePath
heightintegerplatforms.xbox.BrowserWindow.height

Default height of electron app


platforms.xbox.BrowserWindow.webPreferences

Prop NameTypeDefault ValuePath
webPreferencesobjectplatforms.xbox.BrowserWindow.webPreferences

Extra web preferences of electron app

examples

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

platforms.xbox.BrowserWindow.width

Prop NameTypeDefault ValuePath
widthintegerplatforms.xbox.BrowserWindow.width

Default width of electron app


platforms.xbox.additionalMetroOptions

Prop NameTypeDefault ValuePath
additionalMetroOptionsobjectplatforms.xbox.additionalMetroOptions

platforms.xbox.appPath

Prop NameTypeDefault ValuePath
appPathstringplatforms.xbox.appPath

Full path to windows plaform build directory


platforms.xbox.arch

Prop NameTypeDefault ValuePath
archstringplatforms.xbox.arch

Specification of targeted architecture

examples

{
"arch": "x86"
}
{
"arch": "x64"
}
{
"arch": "ARM"
}
{
"arch": "ARM64"
}

platforms.xbox.assetFolderPlatform

Prop NameTypeDefault ValuePath
assetFolderPlatformstringplatforms.xbox.assetFolderPlatform

Alternative platform assets. This is useful for example when you want to use same android assets in androidtv and want to avoid duplicating assets

examples

{
"assetFolderPlatform": "android"
}

platforms.xbox.assetSources

Prop NameTypeDefault ValuePath
assetSourcesarrayplatforms.xbox.assetSources

Array of paths to alternative external assets. this will take priority over ./appConfigs/base/assets folder on your local project

examples

{
"assetSources": [
"{{resolvePackage(@flexn/template-starter)}}/appConfigs/base/assets"
]
}

platforms.xbox.author

Prop NameTypeDefault ValuePath
authorobject,stringplatforms.xbox.author

Prop NameTypeDefault ValuePath
autolinkbooleanplatforms.xbox.autolink

Launches the application once the build process is finished


platforms.xbox.backgroundColor

Prop NameTypeDefault ValuePath
backgroundColorstringplatforms.xbox.backgroundColor

Defines root view backgroundColor for all platforms in HEX format

examples

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

platforms.xbox.build

Prop NameTypeDefault ValuePath
buildbooleanplatforms.xbox.build

Builds the application before launching it


platforms.xbox.buildLogDirectory

Prop NameTypeDefault ValuePath
buildLogDirectorystringplatforms.xbox.buildLogDirectory

Full path to directory where builds logs should be stored, default - project path


platforms.xbox.buildSchemes

Prop NameTypeDefault ValuePath
buildSchemesobjectplatforms.xbox.buildSchemes

platforms.xbox.bundle

Prop NameTypeDefault ValuePath
bundlebooleanplatforms.xbox.bundle

platforms.xbox.bundleAssets

Prop NameTypeDefault ValuePath
bundleAssetsbooleanplatforms.xbox.bundleAssets

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


platforms.xbox.bundleIsDev

Prop NameTypeDefault ValuePath
bundleIsDevbooleanplatforms.xbox.bundleIsDev

platforms.xbox.deploy

Prop NameTypeDefault ValuePath
deploybooleanplatforms.xbox.deploy

platforms.xbox.description

Prop NameTypeDefault ValuePath
descriptionstringplatforms.xbox.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.xbox.devPort

Prop NameTypeDefault ValuePath
devPortstringplatforms.xbox.devPort

platforms.xbox.device

Prop NameTypeDefault ValuePath
devicebooleanplatforms.xbox.device

platforms.xbox.directDebugging

Prop NameTypeDefault ValuePath
directDebuggingbooleanplatforms.xbox.directDebugging

platforms.xbox.electronConfig

Prop NameTypeDefault ValuePath
electronConfigobjectplatforms.xbox.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
},
"mainInjection": "console.log(\"Hello from main.js!\");",
"mainHeadInjection": "console.log(\"Hello from main.js!\");"
}
}

platforms.xbox.emulator

Prop NameTypeDefault ValuePath
emulatorbooleanplatforms.xbox.emulator

platforms.xbox.enableSourceMaps

Prop NameTypeDefault ValuePath
enableSourceMapsbooleanplatforms.xbox.enableSourceMaps

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


platforms.xbox.engine

Prop NameTypeDefault ValuePath
enginestringplatforms.xbox.engine

platforms.xbox.entryFile

Prop NameTypeDefault ValuePath
entryFilestringplatforms.xbox.entryFile

platforms.xbox.excludedPlugins

Prop NameTypeDefault ValuePath
excludedPluginsarrayplatforms.xbox.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.xbox.experimentalNuGetDependency

Prop NameTypeDefault ValuePath
experimentalNuGetDependencybooleanplatforms.xbox.experimentalNuGetDependency

platforms.xbox.ext

Prop NameTypeDefault ValuePath
extobjectplatforms.xbox.ext

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

examples

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

platforms.xbox.fontSources

Prop NameTypeDefault ValuePath
fontSourcesarrayplatforms.xbox.fontSources

Array of paths to location of external Fonts

examples

{
"fontSources": [
"{{resolvePackage(react-native-vector-icons)}}/Fonts"
]
}

platforms.xbox.id

Prop NameTypeDefault ValuePath
idstringplatforms.xbox.id

platforms.xbox.ignoreLogs

Prop NameTypeDefault ValuePath
ignoreLogsbooleanplatforms.xbox.ignoreLogs

platforms.xbox.ignoreWarnings

Prop NameTypeDefault ValuePath
ignoreWarningsbooleanplatforms.xbox.ignoreWarnings

platforms.xbox.includedFonts

Prop NameTypeDefault ValuePath
includedFontsarrayplatforms.xbox.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.xbox.includedPermissions

Prop NameTypeDefault ValuePath
includedPermissionsarrayplatforms.xbox.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.xbox.includedPlugins

Prop NameTypeDefault ValuePath
includedPluginsarrayplatforms.xbox.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.xbox.info

Prop NameTypeDefault ValuePath
infobooleanplatforms.xbox.info

Print information about the build machine to console


platforms.xbox.language

Prop NameTypeDefault ValuePath
languagestringplatforms.xbox.language

Specify generated project language: cpp for C++ or cs for C#


platforms.xbox.launch

Prop NameTypeDefault ValuePath
launchbooleanplatforms.xbox.launch

Launches the application once the build process is finished


platforms.xbox.license

Prop NameTypeDefault ValuePath
licensestringplatforms.xbox.license

platforms.xbox.logging

Prop NameTypeDefault ValuePath
loggingbooleanplatforms.xbox.logging

Logging all the build proccesses to console


platforms.xbox.msbuildprops

Prop NameTypeDefault ValuePath
msbuildpropsstringplatforms.xbox.msbuildprops

Comma separated props to pass to msbuild, eg: prop1=value1,prop2=value2


platforms.xbox.nuGetTestFeed

Prop NameTypeDefault ValuePath
nuGetTestFeedstringplatforms.xbox.nuGetTestFeed

platforms.xbox.nuGetTestVersion

Prop NameTypeDefault ValuePath
nuGetTestVersionstringplatforms.xbox.nuGetTestVersion

platforms.xbox.overwrite

Prop NameTypeDefault ValuePath
overwritebooleanplatforms.xbox.overwrite

Whether to attempt to override the existing builds files when running a build once more


platforms.xbox.packageExtension

Prop NameTypeDefault ValuePath
packageExtensionstringplatforms.xbox.packageExtension

platforms.xbox.packager

Prop NameTypeDefault ValuePath
packagerbooleanplatforms.xbox.packager

platforms.xbox.permissions

Prop NameTypeDefault ValuePath
permissionsarrayplatforms.xbox.permissions

> DEPRECATED in favor of includedPermissions


platforms.xbox.portOffset

Prop NameTypeDefault ValuePath
portOffsetnumberplatforms.xbox.portOffset

Offset each port default value by increment


platforms.xbox.proj

Prop NameTypeDefault ValuePath
projstringplatforms.xbox.proj

Root project directory for your React Native Windows project (not Visual Studio project)


platforms.xbox.reactNativeEngine

Prop NameTypeDefault ValuePath
reactNativeEnginestringplatforms.xbox.reactNativeEngine

platforms.xbox.release

Prop NameTypeDefault ValuePath
releasebooleanplatforms.xbox.release

Enables full packaging of the app for release


platforms.xbox.remoteDebugging

Prop NameTypeDefault ValuePath
remoteDebuggingbooleanplatforms.xbox.remoteDebugging

platforms.xbox.root

Prop NameTypeDefault ValuePath
rootstringplatforms.xbox.root

Project root folder location (not the app itself, which is in platformBuilds)


platforms.xbox.runtime

Prop NameTypeDefault ValuePath
runtimeobjectplatforms.xbox.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.xbox.singleproc

Prop NameTypeDefault ValuePath
singleprocbooleanplatforms.xbox.singleproc

Opt out of multi-proc builds (only available in 0.64 and newer versions of react-native-windows)


platforms.xbox.sln

Prop NameTypeDefault ValuePath
slnstringplatforms.xbox.sln

Location of Visual Studio solution .sln file (wraps multiple projects)


platforms.xbox.splashScreen

Prop NameTypeDefault ValuePath
splashScreenbooleanplatforms.xbox.splashScreen

platforms.xbox.target

Prop NameTypeDefault ValuePath
targetstringplatforms.xbox.target

platforms.xbox.telemetry

Prop NameTypeDefault ValuePath
telemetrybooleanplatforms.xbox.telemetry

Send analytics data of @react-native-windows/cli usage to Microsoft


platforms.xbox.timestampAssets

Prop NameTypeDefault ValuePath
timestampAssetsbooleanplatforms.xbox.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.xbox.title

Prop NameTypeDefault ValuePath
titlestringplatforms.xbox.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.xbox.useWinUI3

Prop NameTypeDefault ValuePath
useWinUI3booleanplatforms.xbox.useWinUI3

platforms.xbox.versionedAssets

Prop NameTypeDefault ValuePath
versionedAssetsbooleanplatforms.xbox.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.xbox.webpackConfig

Prop NameTypeDefault ValuePath
webpackConfigobjectplatforms.xbox.webpackConfig

platforms.xbox.webpackConfig.customScripts

Prop NameTypeDefault ValuePath
customScriptsarrayplatforms.xbox.webpackConfig.customScripts

platforms.xbox.webpackConfig.devServerHost

Prop NameTypeDefault ValuePath
devServerHoststringplatforms.xbox.webpackConfig.devServerHost

platforms.xbox.webpackConfig.extend

Prop NameTypeDefault ValuePath
extendobjectplatforms.xbox.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.xbox.webpackConfig.metaTags

Prop NameTypeDefault ValuePath
metaTagsobjectplatforms.xbox.webpackConfig.metaTags

platforms.xbox.webpackConfig.publicUrl

Prop NameTypeDefault ValuePath
publicUrlstringplatforms.xbox.webpackConfig.publicUrl

pluginTemplates

Prop NameTypeDefault ValuePath
pluginTemplatesobjectpluginTemplates

plugins

Prop NameTypeDefault ValuePath
pluginsobjectplugins

Define all plugins available in your project. you can then use includedPlugins and excludedPlugins props to define active and inactive plugins per each app config

examples

{
"plugins": {
"renative": "source:rnv",
"react": "source:rnv",
"react-native-cached-image": "source:rnv",
"react-native-web-image-loader": "source:rnv",
"react-native-gesture-handler": {
"version": "1.0.0"
}
}
}

private

Prop NameTypeDefault ValuePath
privateobjectprivate

Special object which contains private info. this object should be used only in renative.private.json files and never commited to your repository. Private files usually reside in your workspace and are subject to crypto encryption if enabled. RNV will warn you if it finds private key in your regular renative.json file

examples

{
"private": {
"myPrivateKy": "6568347563858739"
}
}

projectName

Prop NameTypeDefault ValuePath
projectNamestringprojectName

Name of the project which will be used in workspace as folder name. this will also be used as part of the KEY in crypto env var generator

examples

{
"projectName": "my-project"
}
{
"projectName": "myProject"
}

projectTemplates

Prop NameTypeDefault ValuePath
projectTemplatesobjectprojectTemplates

Custom list of renative templates (NPM package names) which will be displayed during rnv new project bootstrap. This prop usually resides in workspace config.

examples

{
"projectTemplates": {
"my-custom-template": {}
}
}

publish

Prop NameTypeDefault ValuePath
publishobjectpublish

runtime

Prop NameTypeDefault ValuePath
runtimeobjectruntime

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"
}
}

sdks

Prop NameTypeDefault ValuePath
sdksobjectsdks

List of SDK locations used by RNV. This property is usually located in your WORKSPACE/renative.json

examples

{
"sdks": {
"ANDROID_SDK": "/Users/paveljacko/Library/Android/sdk",
"ANDROID_NDK": "/Users/paveljacko/Library/Android/sdk/ndk-bundle",
"TIZEN_SDK": "/Users/paveljacko/tizen-studio",
"WEBOS_SDK": "/opt/webOS_TV_SDK",
"KAIOS_SDK": "/Applications/Kaiosrt.app"
}
}

tasks

Prop NameTypeDefault ValuePath
tasksobjecttasks

Allows to override specific task within renative toolchain. (currently only install supported). this is useful if you want to change specific behaviour of built-in task. ie install task triggers yarn/npm install by default. but that might not be desirable installation trigger

examples

{
"tasks": {
"install": {
"script": "yarn bootstrap"
}
}
}

templateConfig

Prop NameTypeDefault ValuePath
templateConfigobjecttemplateConfig

Used in renative.template.json allows you to define template behaviour.


templateConfig.bootstrapQuestions

Prop NameTypeDefault ValuePath
bootstrapQuestionsarraytemplateConfig.bootstrapQuestions

Defines list of custom bootstrap questions

examples

{
"bootstrapQuestions": [
{
"title": "Which service to use?",
"type": "list",
"configProp": {
"key": "runtime.myServiceConfig",
"file": "renative.json"
},
"options": [
{
"title": "Service 1",
"value": {
"id": "xxx1"
}
},
{
"title": "Service 2",
"value": {
"id": "xxx2"
}
}
]
}
]
}

templateConfig.includedPaths

Prop NameTypeDefault ValuePath
includedPathsarraytemplateConfig.includedPaths

Defines list of all file/dir paths you want to include in template

examples

{
"includedPaths": [
"next.config.js",
"babel.config.js",
"appConfigs",
"public",
"src"
]
}

templates

Prop NameTypeDefault ValuePath
templatesobjecttemplates

Stores installed templates info in your project.

NOTE: This prop will be updated by rnv if you run rnv template install

examples

{
"templates": {
"@rnv/template-starter": {
"version": "0.31.0"
}
}
}

version

Prop NameTypeDefault ValuePath
versionstringversion

Semver style version of your app.

examples

{
"version": "0.1.0"
}
{
"version": "1.0.0"
}
{
"version": "1.0.0-alpha.1"
}
{
"version": "1.0.0-RC.7"
}
{
"version": "1.0.0-feature-x.0"
}

versionCode

Prop NameTypeDefault ValuePath
versionCodestringversionCode

Manual verride of generated version code

examples

{
"versionCode": "1000"
}
{
"versionCode": "10023"
}

versionCodeFormat

Prop NameTypeDefault ValuePath
versionCodeFormatstringversionCodeFormat

Allows you to fine-tune auto generated version codes.

Version code is autogenerated from app version defined in package.json or renative.json.

NOTE: If you define versionCode manually this formatting will not apply.

EXAMPLE 1:

default value: 00.00.00

IN: 1.2.3-rc.4+build.56 OUT: 102030456

IN: 1.2.3 OUT: 10203

EXAMPLE 2:

"versionCodeFormat" : "00.00.00.00.00"

IN: 1.2.3-rc.4+build.56 OUT: 102030456

IN: 1.2.3 OUT: 102030000

EXAMPLE 3:

"versionCodeFormat" : "00.00.00.0000"

IN: 1.0.23-rc.15 OUT: 100230015

IN: 1.0.23 OUT: 100230000

examples

{
"versionCodeFormat": "00.00.00"
}
{
"versionCodeFormat": "00.00.00.00.00"
}
{
"versionCodeFormat": "00.00.00.0000"
}

versionFormat

Prop NameTypeDefault ValuePath
versionFormatstringversionFormat

Allows you to fine-tune app version defined in package.json or renative.json.

If you do not define versionFormat, no formatting will apply to version.

"versionFormat" : "0.0.0"

IN: 1.2.3-rc.4+build.56 OUT: 1.2.3

IN: 1.2.3 OUT: 1.2.3

"versionFormat" : "0.0.0.0.0"

IN: 1.2.3-rc.4+build.56 OUT: 1.2.3.4.56

IN: 1.2.3 OUT: 1.2.3

"versionFormat" : "0.0.0.x.x.x.x"

IN: 1.2.3-rc.4+build.56 OUT: 1.2.3.rc.4.build.56

IN: 1.2.3 OUT: 1.2.3

examples

{
"versionFormat": "0.0.0"
}
{
"versionFormat": "0.0.0.0.0"
}
{
"versionFormat": "0.0.0.x.x.x.x"
}

workspaceID

Prop NameTypeDefault ValuePath
workspaceIDstringworkspaceID

Workspace ID your project belongs to. This will mach same folder name in the root of your user directory. ie ~/ on macOS

examples

{
"workspaceID": "rnv"
}
{
"workspaceID": "myCustomWorkspace"
}