Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrimatic/restart_app
A Flutter plugin that helps you to restart the whole Flutter app with a single function call by using native APIs.
https://github.com/gabrimatic/restart_app
dart dartlang flutter flutter-package flutter-restart library
Last synced: 8 days ago
JSON representation
A Flutter plugin that helps you to restart the whole Flutter app with a single function call by using native APIs.
- Host: GitHub
- URL: https://github.com/gabrimatic/restart_app
- Owner: gabrimatic
- License: mit
- Created: 2021-05-18T09:25:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T11:41:54.000Z (about 2 months ago)
- Last Synced: 2024-10-27T22:24:44.483Z (11 days ago)
- Topics: dart, dartlang, flutter, flutter-package, flutter-restart, library
- Language: Dart
- Homepage: https://pub.dev/packages/restart_app
- Size: 163 KB
- Stars: 73
- Watchers: 1
- Forks: 65
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Restart app in Flutter
A Flutter plugin that helps you to restart the whole Flutter app with a single function call by using **Native APIs**.
## How to use it?
**1. Add the package to pubspec.yaml dependency:**
```yaml
dependencies:
restart_app: ^1.3.2
```
**2. Import package:**
```dart
import 'package:restart_app/restart_app.dart';
```
**3. Call the restartApp method wherever you want:**
```dart
onPressed: () {
Restart.restartApp(
/// In Web Platform, Fill webOrigin only when your new origin is different than the app's origin
// webOrigin: 'http://example.com',
// Customizing the restart notification message (only needed on iOS)
notificationTitle: 'Restarting App',
notificationBody: 'Please tap here to open the app again.',
);
}
```
## iOS Platform Config
In order to restart your Flutter application on iOS, due to the platform's limitations, the app will exit and send a local notification to the user. The user can then tap this notification to reopen the app.
This is not a full app restart, but it's the **closest workaround possible** on iOS.
##### Customization:
You can configure the notification’s title and body by passing the `notificationTitle` and `notificationBody` parameters to the `.restartApp` method. These parameters allow you to customize the content of the local notification triggered upon app exit.
##### Notification Permission:
RestartApp package requests local notification permissions just before the app restarts. If granted, a notification will be displayed to the user, prompting them to reopen the app.
While this permission request is handled within the swift code by default, it's recommended that you handle the notification permissions at an earlier point in your app's lifecycle.
This is because there could be a delay in iOS granting notification permissions, especially if the user needs to manually allow it in their device's settings. Furthermore, if permissions are requested without context, the user might deny them, resulting in a poor user experience.
To handle the notification permissions earlier and provide context to the user, you can use packages like [permission_handler](https://pub.dev/packages/permission_handler "permission_handler").
**Here is the configuration you need to add:**
Add the following to the project /ios/Runner/Info.plist file. This will allow the app to send local notifications. Replace PRODUCT_BUNDLE_IDENTIFIER and example with your actual bundle identifier and URL scheme:
```
CFBundleURLTypes
CFBundleTypeRole
Editor
CFBundleURLName
[Your project PRODUCT_BUNDLE_IDENTIFIER value]
CFBundleURLSchemes
example
```
> The CFBundleURLTypes key is used to define URL schemes that your app can handle. URL schemes are used to open your app from another app, a webpage, or even the same app. In this case, it is used to reopen the app from the local notification.
## Developer
By [Hossein Yousefpour](https://gabrimatic.info "Hossein Yousefpour")
© All rights reserved.
## Donate
