📷 react-native-vision-camera-ocr-plus

A React Native Vision Camera frame processor for on-device text recognition (OCR) and translation using ML Kit.

✨ Actively maintained fork of react-native-vision-camera-text-recognition, with modern improvements, bug fixes, and support for the latest Vision Camera and React Native versions.

---

🌟 Why Use This Fork?

The original packages are no longer actively maintained.
This fork provides:

• ✅ Ongoing maintenance and compatibility with React Native 0.76+ and Vision Camera v4+
• 🧠 Translation support (not just OCR) powered by ML Kit
• 🛠 Improved stability and error handling
• 🚀 Faster processing and frame optimization
• 📦 TypeScript definitions included
• 🧩 Consistent API that works seamlessly with modern React Native projects

---

🚀 Features

• 🧩 Simple drop-in API
• ⚡ Fast, accurate on-device OCR
• 📱 Works on Android and iOS
• 🌐 Built-in translation via ML Kit
• 📸 Recognize text from live camera or static photos
• 🪄 Written in Kotlin and Swift
• 🔧 Compatible with react-native-vision-camera and react-native-worklets-core
• 🔥 Compatible with Firebase

---

💻 Installation

Peer dependencies:
You must have react-native-vision-camera and react-native-worklets-core installed.

npm install react-native-vision-camera-ocr-plus
# or
yarn add react-native-vision-camera-ocr-plus

🔥 Firebase Compatibility

If you have Firebase in your project, you will need to set your iOS Deployment Target to at least 16.0.

---

🔄 Migration

Previous Package	Replacement	Notes
react-native-vision-camera-text-recognition	✅ react-native-vision-camera-ocr-plus	Drop-in replacement with fixes and updates
vision-camera-ocr	✅ react-native-vision-camera-ocr-plus	Actively maintained alternative

---

💡 Usage

👉 See the example app for a working demo.

📚 Live Text Recognition

import React, { useState } from 'react';
import { StyleSheet } from 'react-native';
import { useCameraDevice } from 'react-native-vision-camera';
import { Camera } from 'react-native-vision-camera-ocr-plus';

export default function App() {
  const [data, setData] = useState(null);
  const device = useCameraDevice('back');

  return (
    <>
      {!!device && (
        <Camera
          style={StyleSheet.absoluteFill}
          device={device}
          isActive
          mode="recognize"
          options={{ language: 'latin' }}
          callback={(result) => setData(result)}
        />
      )}
    </>
  );
}

---

🌍 Translate Text in Real Time

import React, { useState } from 'react';
import { StyleSheet } from 'react-native';
import { useCameraDevice } from 'react-native-vision-camera';
import { Camera } from 'react-native-vision-camera-ocr-plus';

export default function App() {
  const [data, setData] = useState(null);
  const device = useCameraDevice('back');

  return (
    <>
      {!!device && (
        <Camera
          style={StyleSheet.absoluteFill}
          device={device}
          isActive
          mode="translate"
          options={{ from: 'en', to: 'de' }}
          callback={(result) => setData(result)}
        />
      )}
    </>
  );
}

---

⚙️ Using a Frame Processor

import React from 'react';
import { StyleSheet } from 'react-native';
import { Camera, useCameraDevice, useFrameProcessor } from 'react-native-vision-camera';
import { useTextRecognition } from 'react-native-vision-camera-ocr-plus';

export default function App() {
  const device = useCameraDevice('back');
  const { scanText } = useTextRecognition({ language: 'latin' });

  const frameProcessor = useFrameProcessor((frame) => {
    'worklet';
    const data = scanText(frame);
    console.log('Detected text:', data);
  }, []);

  return (
    <>
      {!!device && (
        <Camera
          style={StyleSheet.absoluteFill}
          device={device}
          isActive
          frameProcessor={frameProcessor}
          mode="recognize"
        />
      )}
    </>
  );
}

---

⚙️ Options

Option	Type	Values	Default	Description
language	string	latin, chinese, devanagari, japanese, korean	latin	Text recognition language
mode	string	recognize, translate	recognize	Processing mode
from, to	string	See Supported Languages	en, de	Translation languages
scanRegion	object	{ left, top, width, height }	undefined	Define a specific region to scan (values are string percentage proportions 0-100)
frameSkipThreshold	number	Any positive integer	10	Skip frames for better performance (higher = faster)
useLightweightMode	boolean	true, false	false	(Android Only) Use lightweight processing for better performance

---

🎯 Scan Region

You can specify a specific region of the camera frame to scan for text. This is useful for improving performance, focusing on specific areas, or reducing false positives from background text.

Important: All scanRegion values are percentage proportions from 0 to 100

Example

import React from 'react';
import { StyleSheet } from 'react-native';
import { Camera, useCameraDevice, useFrameProcessor } from 'react-native-vision-camera';
import { useTextRecognition } from 'react-native-vision-camera-ocr-plus';

export default function App() {
  const device = useCameraDevice('back');
  const { scanText } = useTextRecognition({
    language: 'latin',
    scanRegion: {
      left: '5%',    // Start 5% from the left edge
      top: '25%',     // Start 25% from the top edge
      width: '80%',   // Span 80% of frame width
      height: '40%'   // Span 40% of frame height
    }
  });

  const frameProcessor = useFrameProcessor((frame) => {
    'worklet';
    const data = scanText(frame);
    console.log('Detected text in region:', data);
  }, []);

  return (
    <>
      {!!device && (
        <Camera
          style={StyleSheet.absoluteFill}
          device={device}
          isActive
          frameProcessor={frameProcessor}
        />
      )}
    </>
  );
}

🚀 Performance Optimization

For better performance on Android devices, especially mid-range phones, you can adjust these options:

// Higher performance (recommended for real-time scanning)
const { scanText } = useTextRecognition({
  language: 'latin',
  frameSkipThreshold: 10,      // Process every 10th frame
  useLightweightMode: true    // Skip detailed corner points and element processing
});

// Balanced performance/accuracy
const { scanText } = useTextRecognition({
  language: 'latin',
  frameSkipThreshold: 3,      // Process every 3rd frame
  useLightweightMode: true
});

// Maximum accuracy (slower)
const { scanText } = useTextRecognition({
  language: 'latin',
  frameSkipThreshold: 1,      // Process every frame
  useLightweightMode: false   // Full detailed data
});

You can also improve the performance by using runAtTargetFps in your frame processor:

const frameProcessor = useFrameProcessor(
    (frame) => {
        'worklet';
        runAtTargetFps(2, () => {
            const data = scanText(frame);
        });
    },
    [scanText],
);

Performance may also be better in production builds than in dev.

Performance Tips:

• Higher frameSkipThreshold = better performance, less CPU usage
• useLightweightMode: true = faster processing, reduced memory usage
• These optimizations are especially beneficial on Android devices

---

🖼 Recognize Text from a Photo

import { PhotoRecognizer } from 'react-native-vision-camera-ocr-plus';

const result = await PhotoRecognizer({
  uri: asset.uri,
  orientation: 'portrait',
});

console.log(result);

⚠️ Note (iOS only):
The orientation option is available only on iOS and is recommended when using photos captured via the camera.

Property	Type	Values	Required	Default	Platform
uri	string	—	✅ Yes	—	Android, iOS
orientation	string	portrait, portraitUpsideDown, landscapeLeft, landscapeRight	❌ No	portrait	iOS only

---

🧹 Remove Unused Translation Models

import { RemoveLanguageModel } from 'react-native-vision-camera-ocr-plus';

await RemoveLanguageModel('en');

---

🌍 Supported Languages

Language	Code	Flag
Afrikaans	af	🇿🇦
Arabic	ar	🇸🇦
Bengali	bn	🇧🇩
Chinese	zh	🇨🇳
English	en	🇺🇸🇬🇧
French	fr	🇫🇷
German	de	🇩🇪
Hindi	hi	🇮🇳
Japanese	ja	🇯🇵
Korean	ko	🇰🇷
Portuguese	pt	🇵🇹
Russian	ru	🇷🇺
Spanish	es	🇪🇸
...and many more.

---

🧠 Contributing

Contributions, feature requests, and bug reports are always welcome!
Please open an issue or pull request.

---

☕ Support the Project

If this library helps you build awesome apps, consider supporting future maintenance and development 💛

• 💖 Sponsor on GitHub

Your support helps keep the package updated and open source ❤️

---

📄 License

MIT © Jamena McInteer