JSPM

react-native-nice-learning-torch

0.2.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q37536F
  • License MIT

Torch/flashlight for react-native

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-native-nice-learning-torch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    react-native-torch

    npm version

    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

    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 LibrariesAdd Files to [your project's name]
    3. Go to node_modulesreact-native-torch and add RCTTorch.xcodeproj
    4. Expand the RCTTorch.xcodeprojProducts folder
    5. In XCode, in the project navigator, select your project. Add libRCTTorch.a to your project's Build PhasesLink 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

    import Torch from 'react-native-torch';
    
    Torch.switchState(true); // Turn ON
    Torch.switchState(false); // Turn OFF

    With extra permission check and dialog (Android only)

    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

    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

    Android version has flow support.