react-crop

An accessible image cropper where the image is stationary and a resizable, draggable box represents the cropped image

For example usage check out the docs folder. Demo: http://instructure-react.github.io/react-crop/

Basic usage

import React from 'react'
import Cropper from 'react-crop'

export default class Wrapper extends React.Component {
  state = {
    image: null,
    previewUrl: null
  }

  onChange = evt => {
    this.setState({
      image: evt.target.files[0]
    })
  }

  crop = () => {
    return this.cropper.cropImage().then(image => {
      this.setState({
        previewUrl: window.URL.createObjectURL(image)
      })
    })
  }

  clear = () => {
    this.file.value = null
    this.setState({
      previewUrl: null,
      image: null
    })
  }

  imageLoaded(img) {
    if (
      img.naturalWidth &&
      img.naturalWidth < 262 &&
      img.naturalHeight &&
      img.naturalHeight < 147
    ) {
      this.crop()
    }
  }

  render() {
    return (
      <div>
        <input ref={e => this.file = e} type="file" onChange={this.onChange} />
        <div className="Wrapper">
          {this.state.image && (
            <div>
              <Cropper
                ref={e => this.cropper = e}
                image={this.state.image}
                width={WIDTH}
                height={HEIGHT}
                onImageLoaded={this.imageLoaded}
              />
            </div>
          )}
        </div>
        <div>
          <button onClick={this.crop}>Crop</button>
          <button onClick={this.clear}>Clear</button>
        </div>
        {this.state.previewUrl && <img src={this.state.previewUrl} />}
      </div>
    )
  }
}

Props

width

This is the desired width that you would like the image to be cropped to. The width of the cropper will be scaled to fit this size. This prop also helps determine the minimum width that the cropper can be.

height

This is the desired height that you would like the image to be cropped to. The height of the cropper will be scaled to fit this size. This prop also helps determine the minimum height that the cropper can be. The width and height aspect ratio will be preserved while resizing the cropper.

image

A blob of the original image that you wish to crop.

widthLabel

The label to use next to the width input used for keyboard users. This is especially useful if you need to localize the text. The default is "Width".

heightLabel

The label to use next to the height input used for keyboard users. This is especially useful if you need to localize the text. The default is "Height".

offsetXLabel

The label to use next to the offset X input used for keyboard users. This is especially useful if you need to localize the text. The default is "Offset X".

offsetYLabel

The label to use next to the offset Y input used for keyboard users. This is especially useful if you need to localize the text. The default is "Offset Y".

Running the Example

• Clone the repo
• npm i
• npm run docs
• Visit localhost:8080