react-mindee-js

react-mindee-js v1.2

React components built on top mindee-js SDK

Computer vision SDK for image segmentation and document processing on top of mindee APIs

Check out the full documentation.

Features

This SDK was made for building interfaces on top of Mindee document parsing APIs and more generally on top of any computer vision detection APIs.

• Work with images and pdfs
• Display interactive shapes on images or pdfs with custom style
• Bind custom functions to shapes mouse events
• Create multi-pages pdfs navigation sidebar
• Zoom in and out in the canvas
• Move the image with the mouse
• Create a lens to zoom around the user's pointer

This SDK was primarily made for document processing but can be used for any type of computer vision interface:

Compatibility

The React SDK is compatible with React 16.8.0 +

Installation

Installing with npm

npm install --save react-mindee-js

installing with yarn

yarn add react-mindee-js

Main component

AnnotationViewer has a set of features to draw a list of shapes on top of a given image.

import dummyImage from 'assets/image.jpg'
const dummy_shapes = [
  {
    id: 1,
    coordinates: [
      [0.479, 0.172],
      [0.611, 0.172],
      [0.611, 0.196],
      [0.479, 0.196],
    ],
  },
  {
    id: 2,
    coordinates: [
      [0.394, 0.068],
      [0.477, 0.068],
      [0.477, 0.087],
      [0.394, 0.087],
    ],
  },
]

const Example = () => {
  return <AnnotationViewer image={dummyImage} shapes={dummy_shapes} />
}

Helpers

Helpers work hand to hand with AnnotationViewer to provide a powerful tool for different use cases

• AnnotationLens component provide a closer vision to the main canvas rendered by AnnotationViewer.

• AnnotationForm display textual data. Introduction can be fully customized and linked to AnnotationViewer through a state to create interactive behavior between shapes and fields.

• getImagesFromPDF This function returns a Promise that resolves with a list of images as base64 format . It takes pdf file (object URL).

Contribute to this repo

Feel free to use github to submit issues, pull requests or general feedback. You can also visit our website or drop us an email.

Please read our Contributing section before contributing.

License

GPLv3 © mindee

Changelog

v1.2.1 (31/08/2021)

Changes

• :memo: change the website docs url in README