Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avishayil/react-native-restart
React Native Package With One Purpose: To Restart Your React Native Project
https://github.com/avishayil/react-native-restart
android bundle ios react-native reload restart
Last synced: 8 days ago
JSON representation
React Native Package With One Purpose: To Restart Your React Native Project
- Host: GitHub
- URL: https://github.com/avishayil/react-native-restart
- Owner: avishayil
- License: mit
- Created: 2016-07-17T06:11:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T11:50:06.000Z (4 months ago)
- Last Synced: 2024-10-30T05:26:11.774Z (11 days ago)
- Topics: android, bundle, ios, react-native, reload, restart
- Language: Java
- Size: 1.99 MB
- Stars: 937
- Watchers: 5
- Forks: 149
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
**On October 7th, 2023 Hamas terrorists launched a unilateral attack on Israel, brutally killing thousands of civilians, including infants and children, taking 240 hostages, and injuring thousands more.**
**MORE THAN 110 HOSTAGES REMAIN IN CAPTIVITY. BRING THEM HOME NOW!**
**[#BringThemHomeNow](https://stories.bringthemhomenow.net/)**
# React Native Restart
[](https://www.npmjs.com/package/react-native-restart)
[](https://www.npmjs.com/package/react-native-restart)
[](https://github.com/avishayil/react-native-restart/actions/workflows/main.yml)
Sometimes you want to reload your app bundle during app runtime. This package will allow you to do it.
iOS GIF | Android GIF
:-------------------------:|:-------------------------:
| 
## Installation
- Using `react-native < 0.62`? install `[email protected]`
- Using `0.71 > react-native >= 0.62`? install `[email protected]`
- Using `react-native >= 0.71`? install `[email protected]` and above
### With `yarn`
```bash
$ yarn add react-native-restart
```
### With `npm`
```bash
$ npm install --save react-native-restart
```
## Auto-Linking Setup (react-native >= 0.60)
### iOS
```bash
$ cd ios
$ pod install
```
### Android
No further steps should be taken
## Automatic Installation (Without Auto-Linking)
`react-native link react-native-restart` or `npm install -g rnpm && rnpm link react-native-restart`
## Manual Android Installation
In `android/settings.gradle`
```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`
```gradle
...
dependencies {
...
implementation project(':react-native-restart')
}
```
Register module (in `MainApplication.java`)
```java
import com.reactnativerestart.RestartPackage; // <--- 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 getPackages() {
...
return Arrays.asList(
new MainReactPackage(),
new RestartPackage() // Add this line
);
}
};
......
};
```
## Manual iOS Installation
### Importing The Library
* Drag the file `Restart.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 `libRestart.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 `react-native-restart` from the local
`node_modules/`. With that, only your project Pod needs to be linked and
no extra configuration is required:
```ruby
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 react-native-restart, linking with
# the library and setting the Header Search Paths for you
pod 'react-native-restart', :path => '../node_modules/react-native-restart'
end
```
Remember to run `cd ios && pod install` to update files used by Xcode.
## Usage
```javascript
import RNRestart from 'react-native-restart'; // Import package from node modules
// Immediately reload the React Native Bundle
RNRestart.Restart(); // Deprecated
RNRestart.restart();
```
## Contributing
Contributions are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md) if you like to contribute to this library.
## Credits
Thanks to Microsoft CodePush library. I simply extracted the code from their library's logic to reload the React Native Bundle.