Giter VIP home page Giter VIP logo

tesseract-with-html5-camera's Introduction

tesseract-with-html5-camera

The objective of this package is to recongnize text from captured image from mobile camera or webcam. This package also have same look and feel of a native mobile camera app but with a react component.

Requirement

  • react: >=16.8.0
  • react-dom: >=16.8.0

Demo link

Required Working Environment for getUserMedia()

  • https or localhost : The getUserMedia() method is only available in secure contexts (https or localhost). If a document isn't loaded in a secure context, the navigator.mediaDevices property is undefined, making access to getUserMedia() impossible. Attempting to access getUserMedia() in this situation will result in a TypeError. See developer.mozilla.org

  • iOS >= 11 WebRTC issue with webkit (Chrome & Firefox) : Apple restricts WebRTC to Safari only so it mean that you can't use the getUserMedia() with Firefox and Chrome. So getUserMedia() is not supported yet, for "security reasons". See Stackoverflow

Installation

npm install --save tesseract-with-html5-camera
yarn add tesseract-with-html5-camera

Both Yarn and npm download packages from the npm registry.

Getting started

parameter Description
onTextRecognize(text): Event function called when a photo is taken and text get recognized . the text is passed as a parameter.

Minimum ES6 example

import React from 'react';
import CameraTesseract from 'tesseract-with-html5-camera/dist/lib/index.js';

function App (props) {
  const handleTakePhoto = (text) => {
    // Do stuff with recognized text...
    console.log('Recognize text: ', text);
  }

  return (
    <>
      <h3>Check result in console</h3>
      <CameraTesseract
        onTextRecognize = { (text) => { handleTakePhoto(text); } }
      />
    </>
  );
}

export default App;

API

PropTypes

Properties Type Default Description
onTextRecognize(text): (Optional) Event The function called when a photo is taken. the text is passed as a parameter after recognizing the text.
showLogsOnConsole: (optional) Boolean true If true, Show text recognizing logs in console
isFullscreen: (Optional) Boolean false If true, Show full screen camera view
isImageMirror: (Optional) Boolean true If is true, the camera image will be mirror.
imageType:: (Optional) String png String used to get the desired image type between jpg or png. to specify the imageType use the constant IMAGE_TYPES, for example to specify jpg format use IMAGE_TYPES.JPG. Use IMAGE_TYPES constant to get the right image type Example:. IMAGE_TYPES.JPG or IMAGE_TYPES.PNG
onCameraError(error): (Optional) Event Callback called with the error object as parameter when error occur while opening the camera. Often the permission.
onCameraStart(): (optional) Event Callback called when the camera is started.
onCameraStop(): (optional) Event Callback called when the camera is stopped.

tesseract-with-html5-camera's People

Contributors

payal13 avatar

Forkers

andrewhmtang

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.