How to get started

Installation

npm install @equinor/react-native-mad-tag-ocr

This library has the following peer dependencies that you need to install in your project. Please refer to the documentation below for information on how to do this.

• React Native Vision Camera provides the underlying camera component that support frame processor plugins such as OCR.
• Vision Camera OCR is a frame processor plugin for the vision camera package that provides OCR.
• React Native Worklets Core for running frame processors on a seperate thread.
• React Native Skia for drawing on the camera screen Follow.

Usage

This library exports a component called OCRCamera that you can import into your project. The example below shows how it can be used.

import { OCRCamera } from "@equinor/react-native-mad-tag-ocr";

export const MyComponent = () => {
    const { hasPermission, requestPermission } = useCameraPermission();

    useFocusEffect(() => void requestPermission());

    const onScanResult = (tag: string) => {
        // do someting here
    };

    const onScanCancel = () => {
        // do something here
    };

    return <OCRCamera onSelectTag={onScanResult} onClose={onScanCancel} />;
};

Remember to call the requestPermission function from react-native-vision-camera before using the OCR camera. Also, if your project is using the React Navigation package, you can call useFocusEffect to make sure permission is requested every time you navigate to the OCR camera. This ensures the user is always asked for permissions even if the user initially clicked decline.

Note that the OCR camera currently only supports viewing in portrait mode.