React Native Restart

Restart Your React Native Project

Contributers wanted

My email is on GitHub, anyone interested in helping keeping this library useful, don't hesitate to contact me!

• React Native Restart
  • Installing The Library
    • RN < 0.40
    • RN >= 0.40
  • Automatic Installation
  • Manual Android Installation
    • RN < 0.29
    • RN >= 0.29
  • Manual iOS Installation
    • Importing The Library
  • CocoaPod iOS Installation
  • Usage
  • CREDITS
  • TODO

Installing The Library

Using React Native version below 0.40? use version 0.0.1. Otherwise, use version 0.0.2.

RN < 0.40

npm install react-native-restart@0.0.1 --save

RN >= 0.40

npm install react-native-restart --save

Automatic Installation

react-native link react-native-restart or npm install -g rnpm && rnpm link react-native-restart

Manual Android Installation

In android/settings.gradle

...

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

In android/app/build.gradle

...

dependencies {
    ...

    implementation project(':react-native-restart')
}

RN < 0.29

Register module (in MainActivity.java)

import com.avishayil.rnrestart.ReactNativeRestartPackage;  // <--- Import

public class MainActivity extends ReactActivity {
  ......

      /**
     * A list of packages used by the app. If the app uses additional views
     * or modules besides the default ones, add more packages here.
     */
    @Override
    protected List<ReactPackage> getPackages() {
        ...
        return Arrays.<ReactPackage>asList(
                new MainReactPackage(),
                new ReactNativeRestartPackage() // Add this line
        );
    }
  ......

}

RN >= 0.29

Register module (in MainApplication.java)

import com.avishayil.rnrestart.ReactNativeRestartPackage;  // <--- Import

public class MainApplication extends Application implements ReactApplication {

    private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
        ......

          /**
         * A list of packages used by the app. If the app uses additional views
         * or modules besides the default ones, add more packages here.
         */
        @Override
        protected List<ReactPackage> getPackages() {
            ...
            return Arrays.<ReactPackage>asList(
                    new MainReactPackage(),
                    new ReactNativeRestartPackage() // Add this line
            );
        }
    };
    ......
    @Override
    public ReactNativeHost getReactNativeHost() {
        return mReactNativeHost;
    }
};

Manual iOS Installation

Importing The Library

• Drag the file RCTRestart.xcodeproj from /node_modules/react-native-restart/ios into the Libraries group in the Project navigator. Ensure that Copy items if needed is UNCHECKED!

• Ensure that libRCTRestart.a is linked through Link Binary With Libraries on Build Phases:

• Ensure that Header Search Paths on Build Settings has the path $(SRCROOT)/../node_modules/react-native-restart set to recursive:

• You're All Set!

CocoaPod iOS Installation

In your ios/Podfile make sure to use RCTRestart from the local node_modules/. With that, only your project Pod needs to be linked and no extra configuration is required:

target 'MyReactApp' do
  # Make sure you're also using React-Native from ../node_modules
  pod 'React', :path => '../node_modules/react-native', :subspecs => [
    'Core',
    'RCTActionSheet',
    # ... whatever else you use
  ]
  # React-Native dependencies such as yoga:
  pod 'yoga', path: '../node_modules/react-native/ReactCommon/yoga'

  # The following line uses RCTRestart, linking with
  # the library and setting the Header Search Paths for you
  pod 'RCTRestart', :path => '../node_modules/react-native-restart/ios'
end

Remember to run cd ios && pod install to update files used by Xcode.

Usage

import RNRestart from 'react-native-restart'; // Import package from node modules

// Immediately reload the React Native Bundle
RNRestart.Restart();

CREDITS

Thanks to Microsoft CodePush library. I simply extracted the code from their library's logic to reload the React Native Bundle.

TODO

• Tell me?