react-native-torch/README.md

Torch/flashlight for react-native

# react-native-torch

[![npm version](https://badge.fury.io/js/react-native-torch.svg)](http://badge.fury.io/js/react-native-torch)

A simple React Native plugin to switch a flashlight on/off.

Currently supports both iOS (>= 8.0) and Android (all versions).

Applies the permission checks on Android API >=25 devices. Below API 25, Android will automatically require the user to accept permissions on install / update.

## Install

```shell
npm install --save react-native-torch
react-native link react-native-torch
```

### Manual install
#### iOS
1. `npm install react-native-torch --save`
2. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
3. Go to `node_modules` ➜ `react-native-torch` and add `RCTTorch.xcodeproj`
4. Expand the `RCTTorch.xcodeproj` ➜ `Products` folder
5. In XCode, in the project navigator, select your project. Add `libRCTTorch.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
6. Click `RCTTorch.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` and `$(SRCROOT)/../../../React` - mark both as `recursive`.


## Usage

### Without permissions check

```js
import Torch from 'react-native-torch';

Torch.switchState(true); // Turn ON
Torch.switchState(false); // Turn OFF
```

### With extra permission check and dialog (Android only)

```js
import Torch from 'react-native-torch';
import { Platform } from 'react-native';

if (Platform.OS === 'ios') {
	Torch.switchState(this.isTorchOn);
} else {
	const cameraAllowed = await Torch.requestCameraPermission(
		'Camera Permissions', // dialog title
		'We require camera permissions to use the torch on the back of your phone.' // dialog body
	);

	if (cameraAllowed) {
		Torch.switchState(this.isTorchOn);
	}
}
```

### Android catch exception accessing Torch e.g. in emulator or if device doesn't have a torch

```js
try {
	await Torch.switchState(newTorchState);
	this.setState({ isTorchOn: newTorchState });
} catch (e) {
	ToastAndroid.show(
		'We seem to have an issue accessing your torch',
		ToastAndroid.SHORT
	);
}
```

NOTE:
iOS fails silently, on Android, you can still call without the try/catch block and it won't cause a crash

A demo application [TorchDemo](https://github.com/ludo/TorchDemo) is also
available.

Android version has flow support.