is_first_run 1.0.0 icon indicating copy to clipboard operation
is_first_run: ^1.0.0 copied to clipboard

A simple package to check if it is the first time the app runs.

is_first_run #

A simple package to check if it is the first time the app runs.

Internally it uses the shared_preferences plugin.

Getting Started #

To use this plugin, add is_first_run as a dependency in your pubspec.yaml file.

Usage #

Import is_first_run.dart:

import 'package:is_first_run/is_first_run.dart';

To check if this is the first time the app is run:

bool firstRun = await IsFirstRun.isFirstRun();

If it is the first call of this method since installing the app, the method will return true for as long as the app keeps running.After a restart of the app it returns false.

There is also a method that allows you to check if it is the first time you call it:

bool firstCall = await IsFirstRun.isFirstCall();

Calling this function for the first time after installing the app returns true, after that every function call returns false.

You can reset the plugin by calling

await IsFirstRun.reset();

After calling reset(), calling isFirstRun() will return true as long as the app is running. After a restart, it will return false again. The first call of isFirstCall() will return true, subsequent calls will return false again.

Example #

The example is a simple page showing you the result of the function IsFirstRun.isFirstRun(). A button allows you to call IsFirstRun.isFirstRun() again, the reset button calls IsFirstRun.reset().

Maintainers #

Pull requests are always very welcome.

pub points


unverified uploader

A simple package to check if it is the first time the app runs.

Repository (GitHub)


API reference


Icon for licenses.BSD-3-Clause (LICENSE)


flutter, shared_preferences


Packages that depend on is_first_run