react-native-launcher-kit

React Native Launcher Kit is a comprehensive package for building launchers in React Native. It provides features like launching an app, opening device settings, checking app installation, getting default launcher app's bundle ID, opening default alarm app, getting current battery status, and setting the default launcher.

Installation

npm install react-native-launcher-kit

yarn add react-native-launcher-kit

If you're using React Native 0.60 or higher, the package will be automatically linked for you. For older versions, you need to manually link the package.

Manual Linking

1. In your project directory, run the following command:

react-native link react-native-launcher-kit

2. Open the android/app/build.gradle file in your project and add the following line to the dependencies section:

implementation
project(':react-native-launcher-kit')

3. Open the MainApplication.java file in your project and add the following import statement:

import com.launcherkit;

4. Add the package to the list of packages in the getPackages() method:

protected List<ReactPackage> getPackages(){
  return Arrays.asList(
  new MainReactPackage(),
  new LauncherKit() // <-- Add this line
  );
  }

Features

The features of the React Native Launcher Kit include:

1. Get all installed apps (sorted and unsorted).
2. Get the current default launcher.
3. Get the current battery percentage and whether the phone is charging or not.
4. Check if a package (bundle ID) is installed.
5. Open system settings.
6. Open "Set as default launcher" screen directly.
7. Open an app using its bundle ID.
8. Open the alarm app directly.

Demo

Methods

1. getApps(): AppDetail[]

Returns an array of all installed apps on the device.

import { InstalledApps } from 'react-native-launcher-kit';

const result = InstalledApps.getApps();

2. getSortedApps(): AppDetail[]

Returns an array of all installed apps on the device, sorted alphabetically by app label.

import { InstalledApps } from 'react-native-launcher-kit';

const result = InstalledApps.getSortedApps();

AppDetail Interface

interface AppDetail {
  label: string;
  packageName: string;
  icon: string; // base64
}

3. launchApplication

A helper function allow you to launcher application using bundle ID.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

RNLauncherKitHelper.launchApplication('com.example.louay')

4. checkIfPackageInstalled: Promise<boolean>

Checks if an app with the given bundle ID is installed on the device.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

const result = await RNLauncherKitHelper.checkIfPackageInstalled(
  'com.android.settings',
);
console.log(result); // true or false.

5. getDefaultLauncherPackageName: Promise<string>

Checks the default launcher app on the device.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

const result = await RNLauncherKitHelper.getDefaultLauncherPackageName();
console.log(result);

6. openSetDefaultLauncher: Promise<boolean>

Opens the "Set Default Launcher" screen on the device.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

const result = await RNLauncherKitHelper.openSetDefaultLauncher();
console.log(result); // true or false.

7. getBatteryStatus: Promise<BatteryStatus>

Returns the current battery status of the device and if the phone is currently charging or not.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

const result = await RNLauncherKitHelper.getBatteryStatus();
console.log(result); // {"isCharging": false, "level": 100}

BatteryStatus Interface

interface AppDetail {
  level: number;
  isCharging: boolean;
}

8. openAlarmApp: boolean

Opens the default alarm app on the device.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

const result = await RNLauncherKitHelper.getBatteryStatus();
console.log(result);

9. goToSettings

Opens the settings screen of the device.

import { RNLauncherKitHelper } from 'react-native-launcher-kit';

RNLauncherKitHelper.goToSettings();

Demo App

React-Native-Launcher-Kit has been utilized for testing purposes on a launcher known as NoPhoneLauncher. You can experience its functionality in real-time by accessing it on Google Play via the following link.

Example App

You can experience the functionality of the code by exploring the examples provided in our GitHub repository, which can be accessed from the following link.

License

MIT

---