Quickstart

Install

Add the package:

dependencies:
  restart_app: ^1.9.1

Then fetch dependencies:

flutter pub get

Requirements

Dart SDK: >=3.4.0 · Flutter: >=3.22.0

Platform	Minimum
Android	`minSdk` 21, Java 17, Android Gradle Plugin 8 or 9
iOS	12.0
macOS	10.15

The Android module builds on Android Gradle Plugin 8 and 9. It applies the Kotlin Gradle Plugin only when nothing else has already provided Kotlin, so it builds on both AGP majors with the Flutter template default android.builtInKotlin=false. Turning built-in Kotlin on is a separate Flutter migration that needs Flutter 3.47 or later; on earlier Flutter releases it fails for every plugin, including Flutter’s own plugin template.

Restart the app

Import the package and call Restart.restartApp():

import 'package:restart_app/restart_app.dart';

await Restart.restartApp();

For production flows, keep the returned result and handle failures:

final result = await Restart.restartApp();

if (!result.success) {
  // Show or log result.code and result.message.
}

Restart.restartApp() returns a RestartResult with success, the resolved mode, and platform error details when the restart cannot be started.

Customize behavior

Default behavior works for normal app restart flows. Pass options only when your app needs a specific platform behavior.

await Restart.restartApp(
  mode: RestartMode.platformDefault,
  webOrigin: '#/home',
  forceKill: false,
  notificationTitle: 'Restart',
  notificationBody: 'Tap to reopen the app.',
);

Check capabilities

Use Restart.restartCapability() when your UI should adapt to the current platform.

final capability = await Restart.restartCapability();

if (capability.flutterEngineRestart) {
  await Restart.restartApp(mode: RestartMode.flutterEngine);
}

Start

Product

Reference

Install

Requirements

Restart the app

Customize behavior

Check capabilities

​Install

​Requirements

​Restart the app

​Customize behavior

​Check capabilities

Install

Requirements

Restart the app

Customize behavior

Check capabilities