0.0.5 • Published 11 months ago

@equinor/react-native-mad-tag-ocr v0.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
11 months ago

React Native Mad Optical Character Recognition (OCR)

Mad Tag Optical Character Recognition (OCR) adds a camera component that recognizes and highlights text in real-time. The highlighted text can also be selected by the user. This is useful for tasks such as scanning tags on Equinor facilities, but can also be used to scan other types of text.

🖌️ How to use

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 only supports viewing in portrait mode.

⚙️ Installation

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.

0.0.5

11 months ago

0.0.4

11 months ago

0.0.3

12 months ago

0.0.2

12 months ago

0.0.1

1 year ago