Skip to main content
Version: 0.62

AppRegistry

AppRegistry is the JS entry point to running all React Native apps. App root components should register themselves with AppRegistry.registerComponent, then the native system can load the bundle for the app and then actually run the app when it's ready by invoking AppRegistry.runApplication.

import { Text, AppRegistry } from 'react-native';
const App = (props) => (  <View>    <Text>App1</Text>  </View>);
AppRegistry.registerComponent('Appname', () => App);

To "stop" an application when a view should be destroyed, call AppRegistry.unmountApplicationComponentAtRootTag with the tag that was passed into runApplication. These should always be used as a pair.

AppRegistry should be required early in the require sequence to make sure the JS execution environment is setup before other modules are required.

Reference

Methods#

setWrapperComponentProvider()#

static setWrapperComponentProvider(provider)

Parameters:

NameTypeRequired
providerComponentProvideryes

enableArchitectureIndicator()#

static enableArchitectureIndicator(enabled)

Parameters:

NameTypeRequired
enabledbooleanyes

registerConfig()#

static registerConfig([config])

Parameters:

NameTypeRequiredDescription
configAppConfigyesSee below.

Valid AppConfig keys are:

  • 'appKey' (string)- Required.
  • 'component' (ComponentProvider) - Optional.
  • 'run' (Function) - Optional.
  • 'section' (boolean) - Optional.

registerComponent()#

static registerComponent(appKey, componentProvider, section?)

Parameters:

NameTypeRequired
appKeystringyes
componentProviderComponentProvideryes
sectionbooleanno

registerRunnable()#

static registerRunnable(appKey, run)

Parameters:

NameTypeRequired
appKeystringyes
runFunctionyes

registerSection()#

static registerSection(appKey, component)

Parameters:

NameTypeRequired
appKeystringyes
componentComponentProvideryes

getAppKeys()#

static getAppKeys()

Returns an Array of AppKeys

getSectionKeys()#

static getSectionKeys()

Returns an Array of SectionKeys

getSections()#

static getSections()

Returns all Runnables which is an object with key of AppKeys and value of type of Runnable which consist of:

  • 'component' (ComponentProvider).
  • 'run' (Function).

getRunnable()#

static getRunnable(appKey)

Returns a Runnable object which consist of:

  • 'component' (ComponentProvider).
  • 'run' (Function).

getRegistry()#

static getRegistry()

Returns a type Registry which consist of:

  • 'sections' (Array of strings).
  • 'runnables' (Runnables).

setComponentProviderInstrumentationHook()#

static setComponentProviderInstrumentationHook(hook)

Parameters:

NameTypeRequiredDescription
hookFunctionyesSee below.

A valid hook accepts the following as arguments:

  • 'component' (ComponentProvider)- Required.
  • 'scopedPerformanceLogger' (IPerformanceLogger)- Required.

The hook function returns a React Component

runApplication()#

static runApplication(appKey, appParameters)

Loads the JavaScript bundle and runs the app.

Parameters:

NameTypeRequired
appKeystringyes
appParametersanyyes

unmountApplicationComponentAtRootTag()#

static unmountApplicationComponentAtRootTag(rootTag)

Stops an application when a view should be destroyed.

Parameters:

NameTypeRequired
rootTagnumberyes

registerHeadlessTask()#

static registerHeadlessTask(taskKey, taskProvider)

Register a headless task. A headless task is a bit of code that runs without a UI. @param taskKey the key associated with this task @param taskProvider a promise returning function that takes some data passed from the native side as the only argument; when the promise is resolved or rejected the native side is notified of this event and it may decide to destroy the JS context.

This is a way to run tasks in JavaScript while your app is in the background. It can be used, for example, to sync fresh data, handle push notifications, or play music.

Parameters:

NameTypeRequiredDescription
taskKeyStringyesSee below.
taskProviderTaskProvideryesSee below.
  • A valid TaskProvider is a function that returns a Task.
  • A Task is a function that accepts any data as argument and returns a Promise that resolves to undefined.

registerCancellableHeadlessTask()#

static registerCancellableHeadlessTask(taskKey, taskProvider, taskCancelProvider)

Register a headless task which can be cancelled. A headless task is a bit of code that runs without a UI. @param taskKey the key associated with this task @param taskProvider a promise returning function that takes some data passed from the native side as the only argument; when the promise is resolved or rejected the native side is notified of this event and it may decide to destroy the JS context. @param taskCancelProvider a void returning function that takes no arguments; when a cancellation is requested, the function being executed by taskProvider should wrap up and return ASAP.

Parameters:

NameTypeRequiredDescription
taskKeyStringyesSee below.
taskProviderTaskProvideryesSee below.
taskCancelProviderTaskCancelProvideryesSee below.
  • A valid TaskProvider is a function that returns a Task.
  • A Task is a function that accepts any data as argument and returns a Promise that resolves to undefined.
  • A valid TaskCancelProvider is a function that returns a TaskCanceller.
  • A TaskCanceller is a function that accepts no argument and returns void.

startHeadlessTask()#

static startHeadlessTask(taskId, taskKey, data)

Only called from native code. Starts a headless task.

@param taskId the native id for this task instance to keep track of its execution @param taskKey the key for the task to start @param data the data to pass to the task

Parameters:

NameTypeRequired
taskIdnumberyes
taskKeystringyes
dataanyyes

cancelHeadlessTask()#

static cancelHeadlessTask(taskId, taskKey)

Only called from native code. Cancels a headless task.

@param taskId the native id for this task instance that was used when startHeadlessTask was called @param taskKey the key for the task that was used when startHeadlessTask was called

Parameters:

NameTypeRequired
taskIdnumberyes
taskKeystringyes