🎈 React Native Camera Kit

A high performance, easy to use, rock solid

camera library for React Native apps.

Cross Platform (iOS and Android) Optimized for performance and high photo capture rate QR / Barcode scanning support Camera preview support in iOS simulator

Installation (RN > 0.60)

``bash
yarn add react-native-camera-kit
`

`bash
cd ios && pod install && cd ..
`

Android:
Add Kotlin to your project

Permissions

#### Android

Add the following uses-permission to your AndroidManifest.xml (usually found at: android/src/main/)

`java


`

#### iOS

Add the following usage descriptions to your Info.plist (usually found at: ios/PROJECT_NAME/)

`xml
NSCameraUsageDescription
For taking photos

NSPhotoLibraryUsageDescription
For saving photos
`

Running the example project

- yarn bootstrap
- yarn example ios or yarn example android

Components

$3

Full screen camera component that holds camera state and provides camera controls

`ts
import { CameraScreen } from 'react-native-camera-kit';
`

`tsx
actions={{ rightButtonText: 'Done', leftButtonText: 'Cancel' }}
onBottomButtonPressed={(event) => this.onBottomButtonPressed(event)}
flashImages={{
// optional, images for flash state
on: require('path/to/image'),
off: require('path/to/image'),
auto: require('path/to/image'),
}}
cameraFlipImage={require('path/to/image')} // optional, image for flipping camera button
captureButtonImage={require('path/to/image')} // optional, image capture button
torchOnImage={require('path/to/image')} // optional, image for toggling on flash light
torchOffImage={require('path/to/image')} // optional, image for toggling off flash light
hideControls={false} // (default false) optional, hides camera controls
showCapturedImageCount={false} // (default false) optional, show count for photos taken during that capture session
/>
`

#### Barcode / QR Code Scanning

Additionally, the camera screen can be used for barcode scanning

`tsx
...
// Barcode props
scanBarcode={true}
onReadCode={(event) => Alert.alert('QR code found')} // optional
showFrame={true} // (default false) optional, show frame with transparent layer (qr code or barcode will be read on this area ONLY), start animation for scanner,that stoped when find any code. Frame always at center of the screen
laserColor='red' // (default red) optional, color of laser in scanner frame
frameColor='white' // (default white) optional, color of border of scanner frame
/>
`

$3

Barebones camera component

`ts
import { Camera, CameraType } from 'react-native-camera-kit';
`

`tsx
ref={(ref) => (this.camera = ref)}
cameraType={CameraType.Back} // front/back(default)
/>
`

$3

| Props | Type | Description |
| ------------------------------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| flashMode | 'on'/'off'/'auto' | Camera flash mode. Default: auto |
| focusMode | 'on'/'off' | Camera focus mode. Default: on |
| zoomMode | 'on'/'off' | Enable pinch to zoom camera. Default: on |
| torchMode | 'on'/'off' | Toggle flash light when camera is active. Default: off |
| ratioOverlay | ['int':'int', ...] | Show a guiding overlay in the camera preview for the selected ratio. Does not crop image as of v9.0. Example: ['16:9', '1:1', '3:4'] |
| ratioOverlayColor | Color | Any color with alpha. Default: '#ffffff77' |
| resetFocusTimeout | Number | iOS only. Dismiss tap to focus after this many milliseconds. Default 0 (disabled). Example: 5000 is 5 seconds. |
| resetFocusWhenMotionDetected | Boolean | iOS only. Dismiss tap to focus when focus area content changes. Native iOS feature, see documentation: https://developer.apple.com/documentation/avfoundation/avcapturedevice/1624644-subjectareachangemonitoringenabl?language=objc). Default true. |
| onOrientationChange | Function | Callback when physical device orientation changes. Returned event contains orientation. Ex: onOrientationChange={(event) => console.log(event.nativeEvent.orientation)}. Use import { Orientation } from 'react-native-camera-kit'; if (event.nativeEvent.orientation === Orientation.PORTRAIT) { ... } to understand the new value |

$3

| Props | Type | Description |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| scanBarcode | Boolean | Enable barcode scanner. Default: false |
| showFrame | Boolean | Show frame in barcode scanner. Default: false |
| laserColor | Color | Color of barcode scanner laser visualization. Default: red |
| frameColor | Color | Color of barcode scanner frame visualization. Default: yellow |
| surfaceColor | Color | Color of barcode scanner surface visualization. Default: blue |
| onReadCode | Function | Callback when scanner successfully reads barcode. Returned event contains codeStringValue. Default: null. Ex: onReadCode={(event) => console.log(event.nativeEvent.codeStringValue)} |

$3

_Note: Must be called on a valid camera ref_

#### capture()

Capture image as JPEG.

A temporary file is created. You must move this file to a permanent location (e.g. the app's 'Documents' folder) if you need it beyond the current session of the app as it may be deleted when the user leaves the app. You can move files by using a file system library such as react-native-fs or expo-filesystem.
(On Android we currently have an unsupported outputPath prop but it's subject to change at any time).

Note that the reason you're getting a URL despite it being a file is because Android 10+ encourages URIs. To keep things consistent regardless of settings or platform we always send back a URI.

`ts
const { uri } = await this.camera.capture();
// uri = 'file:///data/user/0/com.myorg.myapp/cache/ckcap123123123123.jpg'
`

If you want to store it permanently, here's an example using react-native-fs:
`ts
import RNFS from 'react-native-fs';
// [...]
let { uri } = await this.camera.capture();
if (uri.startsWith('file://')) {
// Platform dependent, iOS & Android uses '/'
const pathSplitter = '/';
// file:///foo/bar.jpg => /foo/bar.jpg
const filePath = uri.replace('file://', '');
// /foo/bar.jpg => [foo, bar.jpg]
const pathSegments = filePath.split(pathSplitter);
// [foo, bar.jpg] => bar.jpg
const fileName = pathSegments[pathSegments.length - 1];

await RNFS.moveFile(filePath, ${RNFS.DocumentDirectoryPath}/${fileName});
uri = file://${destFilePath};
}
`

#### checkDeviceCameraAuthorizationStatus (iOS only)

`ts
const isCameraAuthorized = await Camera.checkDeviceCameraAuthorizationStatus();
`

return values:

AVAuthorizationStatusAuthorized returns true

AVAuthorizationStatusNotDetermined returns -1

otherwise, returns false

#### requestDeviceCameraAuthorization (iOS only)

`ts
const isUserAuthorizedCamera = await Camera.requestDeviceCameraAuthorization();
`

AVAuthorizationStatusAuthorized returns true

otherwise, returns false`

Contributing

- Pull Requests are welcome, if you open a pull request we will do our best to get to it in a timely manner
- Pull Request Reviews are even more welcome! we need help testing, reviewing, and updating open PRs
- If you are interested in contributing more actively, please contact us.

License

The MIT License.

See LICENSE