react-shape-detect

react-shape-detect _(v0.1)

A React component integration with the Shape Detection API. Provides coordinate data and overlay capabilites_(v0.2).

Install

$ npm i react-shape-detect

Usage

import ShapeDetect from 'react-shape-detect';

const path = 'path-or-url-to-image';

const func = function(data) {
  console.log('objects detected: ', data);
}

export default function App() {
  return (
    <ShapeDetect 
      image={path} 
      onRender={func} 
      options={{ type: 'face' }} />
  );
}

Basic Props

image

string | required

Path to image - network or local.

onRender

function(data: any) | defaults to: (data) => void

Callback is executed with the onLoad event of the <img/> tag.
Returns coordinate data from matches on criteria defined in options object.

options

object

Detector type, custom Shape Detector API options_v0.2, and HTML img tag attributes

{
  "type": "face", // "barcode", "text"
  "attributes": {
     // any normal HTML img tag attributes ... see src/types/ for complete list
  }
}

License

MIT © Sam Parsons