1.0.6 • Published 12 months ago

use-correction v1.0.6

Weekly downloads
-
License
ISC
Repository
github
Last release
12 months ago

Use Correction

High-level abstraction over use-cropper. With preview, animations and actually correcting images

Usage

With ChakraUI

Requires ChakraUI

yarn add @chakra-ui/react @emotion/react @emotion/styled framer-motion
npm add @chakra-ui/react @emotion/react @emotion/styled framer-motion
import { useCorrection } from 'use-correction'
import Correction from 'use-correction/chakra'
import { prepareWorker } from "opencv-tools/workers/correct"

// see opencv-tools for details
const worker = new Worker(new URL('correct-worker.ts', import.meta.url), { type: 'module' })
const workerApi = prepareWorker(worker)

const { correctionProps, actions, view } = useCorrection('/path/to/my-image.jpg', workerApi)

async function correct() {
  const result = await actions.correct()
  // ...
}

return (
  <div>
    {/* ... */}
    <Correction {...correctionProps} />
    <button onClick={actions.preview}>Preview</button>
    <button onClick={actions.reset}>Reset corners</button>
    <button onClick={correct}>Correct image</button>
  </div>
)

Without ChakraUI

import { useCorrection } from 'use-correction'
import { prepareWorker } from "opencv-tools/workers/correct"

// see opencv-tools for details
const worker = new Worker(new URL('correct-worker.ts', import.meta.url), { type: 'module' })
const workerApi = prepareWorker(worker)

const { Correction, correctionProps, actions, view } = useCorrection('/path/to/my-image.jpg', workerApi)

return (
  <Correction {...correctionProps} />
)