react-use-faceapi

This repository has been created to simplify the usage of the face-api package in React, this was created when creating a POC for a client to win a RFP, but we thought we could share this to make life easier for everyone. The example we supplied is pretty basic, but you're able to create really complex and complete applications with the use of your creativity.

Demo

You can try out the hook here by uploading an image: https://nightborn-be.github.io/react-use-faceapi/

Install

npm install --save react-use-faceapi

Usage

!! Important !!

You should have the models folder in your build, development folder in order for face-api to retrieve the information needed to run the model.

You can change the path to the models in the configuration, a more in-depth explanation will come soon.

Please refer to the interface in the index.ts in the meanwhile.

import React, { useRef, useState } from "react";
import { useFaceApi, } from 'react-use-faceapi';

const myFaceApiConfig = {
	input: 'my-image',
	refreshRate: 250
}

const App = () => {

	// Attributes
	const imageRef = useRef();
	const [image, setImage] = useState("");
	const faces = useFaceApi(myFaceApiConfig);

	// Rendering
	return (
		<div>

			<img style={{ width: 500 }} ref={imageRef} id="my-image" src={image} />
			<input type="file" onChange={(event) => setImage(URL.createObjectURL(event.target.files[0]))} />

			{faces && faces.map((face) => {

				// Attributes
				const top = face.relativeBox.top * imageRef.current.offsetHeight;
				const left = face.relativeBox.left * imageRef.current.offsetWidth;
				const width = face.relativeBox.width * imageRef.current.offsetWidth;
				const height = face.relativeBox.height * imageRef.current.offsetHeight;

				// Rendering
				return (
					<div style={{
						position: 'absolute',
						width: width,
						height: height,
						left: left,
						top: top,
						border: '1px solid red',
					}}
					/>
				);
			})}

		</div >
	)
}

export default App;

Result

License

MIT © m-Nightly

This hook is created using create-react-hook.