react-native-restart

To use CocoaPods for iOS, add the library to your ios/Podfile pointing to the local node_modules path. This handles linking and Header Search Paths automatically.

After updating the Podfile, run cd ios && pod install.

target 'MyReactApp' do
  # ... other pods
  pod 'react-native-restart', :path => '../node_modules/react-native-restart'
end

With Metro running, open a new terminal window from the root of your project and use one of the following commands to build and run your app on an Android Emulator or connected device:

# Using npm
npm run android

# OR using Yarn
yarn android

To run the app on iOS, you must first ensure CocoaPods dependencies are installed.

1. If this is your first time or you have updated native dependencies, run:

   bundle install
   bundle exec pod install

2. Then, run the app using:

   # Using npm
   npm run ios
   
   # OR using Yarn
   yarn ios

If not using CocoaPods, follow these steps:

1. Drag Restart.xcodeproj from node_modules/react-native-restart/ios into the Libraries group in your Xcode Project navigator. Uncheck Copy items if needed.
2. In Xcode, go to Build Phases > Link Binary With Libraries and ensure libRestart.a is linked.
3. In Build Settings, set Header Search Paths to $(SRCROOT)/../node_modules/react-native-restart and set it to recursive.

Before building or running your app, you must start Metro, the JavaScript build tool for React Native. Run the following command from the root of your project:

# Using npm
npm start

# OR using Yarn
yarn start

While Fast Refresh handles automatic updates, you can perform a full reload to reset the app state:

• Android: Press the <kbd>R</kbd> key twice or select "Reload" from the Dev Menu (accessed via <kbd>Ctrl</kbd> + <kbd>M</kbd> on Windows/Linux or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> on macOS).
• iOS: Press <kbd>R</kbd> in the iOS Simulator.

For React Native versions 0.60 and above, use auto-linking.

iOS: Run pod install in your ios directory.

Android: No additional steps are required for auto-linking.

cd ios
$ pod install

Install the package using your preferred package manager. Choose the version compatible with your React Native version:

• React Native < 0.62: react-native-restart@0.0.17
• 0.62 <= React Native < 0.71: react-native-restart@0.0.24
• 0.72 <= React Native <= 0.84: react-native-restart@0.0.28
• React Native >= 0.85: react-native-restart@0.0.28 or above

# Using yarn
yarn add react-native-restart

# Using npm
npm install --save react-native-restart

Use the restart() method to immediately reload the React Native bundle during app runtime. Note that Restart() is deprecated.

import RNRestart from 'react-native-restart';

// Reload the bundle
RNRestart.restart();

The metro.config.js in the Example directory is configured to support a monorepo structure. It uses watchFolders to include the parent directory in the Metro watcher and configures resolver.nodeModulesPaths to ensure that dependencies can be resolved from both the local Example/node_modules and the root node_modules directory.

const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');
const path = require('path');

const config = {
  watchFolders: [
    path.resolve(__dirname, '..'),
  ],
  resolver: {
    nodeModulesPaths: [
      path.resolve(__dirname, 'node_modules'),
      path.resolve(__dirname, '..', 'node_modules'),
    ],
  },
};

module.exports = mergeConfig(getDefaultConfig(__dirname), config);

The RNRestart module provides methods to reload the React Native application bundle.

• restart(reason?: string): Restarts the application. You can optionally provide a reason string to indicate why the restart is occurring. This is the preferred method.
• Restart(reason?: string): An alias for restart. This method is marked as deprecated; use restart instead.
• getReason(): Returns a Promise<string> that resolves to the reason for the last restart.

import RNRestart from 'react-native-restart';

// Restart without a specific reason
RNRestart.restart();

// Restart with a specific reason
RNRestart.restart('Updating configuration');

// Get the reason for the last restart
RNRestart.getReason().then((reason) => {
  console.log('Last restart reason:', reason);
});