Skip to content

Latest commit

 

History

History
274 lines (183 loc) · 8.07 KB

KOTLIN.md

File metadata and controls

274 lines (183 loc) · 8.07 KB
Raw

Kotlin

React Native Brownfield provides first-class support for Kotlin.

Linking

The library is meant to work with auto linking. In case you can't use this feature, please check out the following options:

react-native link Run the following command in your terminal: 
  react-native link @callstack/react-native-brownfield
Manually link the library on Android

android/settings.gradle

include ':react-native-brownfield'
project(':react-native-brownfield').projectDir = new File(rootProject.projectDir, '../node_modules/@callstack/react-native-brownfield/android')

android/app/build.gradle

dependencies {
   ...
   implementation project(':react-native-brownfield')
}

android/app/src/main/.../MainApplication.kt

On top, where imports are:

import com.callstack.reactnativebrownfield.ReactNativeBrownfieldPackage

Add the ReactNativeBrownfieldPackage class to your list of exported packages.

val packages = listOf<ReactPackage>(MainReactPackage(), ReactNativeBrownfieldPackage())

API Reference

ReactNativeBrownfield

You can import the object from:

  import com.callstack.reactnativebrownfield.ReactNativeBrownfield

Statics:

initialize

A function used to initialize a React Native Brownfield singleton. Keep in mind that it doesn't load React Native bundle.

Params:

Param Required Type Description
application Yes Application Main application.
rnHost No* ReactNativeHost An instance of ReactNativeHost.
packages No* List List of your React Native Native modules.
options No* HashMap<String, Any> Map of initial options. Options listed below.
    • Those fields aren't itself required, but at least one of them is. See examples below.

Available options:

  • useDeveloperSupport: Boolean - Flag to use dev support.
  • packages: List - List of your React Native Native modules.
  • mainModuleName: String - Path to react native entry file.

Examples:

  val mReactNativeHost = object : ReactNativeHost(application) {
    override fun getUseDeveloperSupport(): Boolean {
      return BuildConfig.DEBUG
    }

    override fun getPackages(): List<ReactPackage> {
      return listOf<ReactPackage>(PackageList(this).getPackages())
    }

    override fun getJSMainModuleName(): String {
      return "index"
    }
  }

  ReactNativeBrownfield.initialize(this, mReactNativeHost)
  val packages = PackageList(this).getPackages()

  ReactNativeBrownfield.initialize(this, packages)
  val packages = PackageList(this).getPackages()
  val options = hashMapOf<String, Any>(
    "packages" to packages, 
    "mainModuleName" to "example/index"
  )

  ReactNativeBrownfield.initialize(this, options)

shared

A singleton that keeps an instance of ReactNativeBrownfield object.

Examples:

  ReactNativeBrownfield.shared

Properties:

Property Type Default Description
reactNativeHost ReactNativeHost null An instance of ReactNativeHost.

Methods:

startReactNative

Starts React Native, produces an instance of a bridge. You can use it to initialize React Native in your app.

Params:

Param Required Type Description
startReactNative No (loaded: boolean) -> Unit Callback invoked after JS bundle is fully loaded.

Examples:

    ReactNativeBrownfield.shared.startReactNative()
    ReactNativeBrownfield.shared.startReactNative {
        Log.d("loaded", "React Native loaded");
    }

ReactNativeActivity

An activity rendering ReactRootView with a given module name. It automatically uses an instance of a bridge created in startReactNative method. It works well with exposed JavaScript module. All the lifecycles are proxied to ReactInstanceManager.

  import com.callstack.reactnativebrownfield.ReactNativeActivity

Statics:

createReactActivityIntent

Creates an Intent with ReactNativeActivity, you can use it as a parameter in the startActivity method in order to push a new activity with embedded React Native.

Params:

Param Required Type Description
context Yes Context Application context.
moduleName Yes String Name of React Native component registered to AppRegistry.
initialProps No Bundle

Examples:

  ReactNativeActivity.createReactActivityIntent(context, "ReactNative")
  val bundle = Bundle()
  bundle.putInt("score", 12)

  ReactNativeActivity.createReactActivityIntent(context, "ReactNative", bundle)
  val map =  hasnMapOf<String, *>("score" to 12)

  ReactNativeActivity.createReactActivityIntent(context, "ReactNative", map)
  val map = WritableMap();
  map.putInt("score", 12);

  ReactNativeActivity.createReactActivityIntent(context, "ReactNative", map)

ReactNativeFragment

An fragment rendering ReactRootView with a given module name. It automatically uses an instance of a bridge created in startReactNative method. It works well with exposed JavaScript module. All the lifecycles are proxied to ReactInstanceManager. It's the simplest way to embed React Native into your navigation stack.

  import com.callstack.reactnativebrownfield.ReactNativeFragment

Statics:

createReactNativeFragment

Creates a Fragment with ReactNativeActivity, you can use it as a parameter in the startActivity method in order to push a new activity with embedded React Native.

Params:

Param Required Type Description
moduleName Yes String Name of React Native component registered to AppRegistry.
initialProps No Bundle

Examples:

  ReactNativeFragment.createReactNativeFragment("ReactNative")
  val bundle = new Bundle()
  bundle.putInt("score", 12)

  ReactNativeFragment.createReactNativeFragment("ReactNative", bundle)
  val map = hashMapOf<String, *>("score" to 12)

  ReactNativeFragment.createReactNativeFragment("ReactNative", map)
  val map = WritableMap()
  map.putInt("score", 12)

  ReactNativeFragment.createReactActivityIntent(context, "ReactNative", map)

Example

You can find an example app here.