0.0.2 • Published 4 years ago

@marcioferlan/react-profile-picture v0.0.2

Weekly downloads
3
License
MIT
Repository
-
Last release
4 years ago

Profile Picture (React Component)

Demo | jQuery Version

demo gif

Setup

The better option would be to add this component into your project by cloning this repository and building it yourself with the design changes that you might want to make. I'm not sure if this is going to be published on NPM.

Anyway, you can always add it to your project also by installing using NPM + Github:

npm i --save git+https://github.com/dsalvagni/react-profile-picture.git

Example

import React, { Component } from 'react';

import ProfilePicture from "profile-picture"
import "profile-picture/build/ProfilePicture.css"

class App extends Component {
  constructor(props) {
    super(props)

    this.profilePictureRef = React.createRef();
  }

  handleUpload() {
    const PP = this.profilePicture.current;
    const imageData = PP.getData();
    const file = imageData.file;
    const imageAsDataURL = PP.getImageAsDataUrl();

    ...
    //add here the upload logic...
  }

  render() {
    return <ProfilePicture
      ref={this.profilePictureRef}
      useHelper={true}
      debug={true}
    />

    <button onClick={this.handleUpload.bind(this)}>Upload</button>
  }
}

Options

PropertyTypeDescription
imagePropTypes.stringSet an startup image
frameSizePropTypes.number.isRequiredSet the app editor preview size
frameFormatPropTypes.oneOf(["circle", "square", "rounded-square"])Set the app editor preview format
cropSizePropTypes.number.isRequiredSet the size of cropped image.
minZoomPropTypes.number.isRequiredMinimum zoom required.
maxZoomPropTypes.number.isRequiredMaximum zoom required.
minImageSizePropTypes.number.isRequiredMinimum image size desired.
maxImageSizePropTypes.number.isRequiredMaximum image size desired.
useHelperPropTypes.bool.isRequiredEnable/Disable the use of a background helper image.
debugPropTypes.bool.isRequiredEnable/Disable logging events on console

Callbacks

CallbackDescription
onImagePropertiesChangeTriggered always that any image property changes: Zoom, Position, etc.. Returns image data object.
onImageLoadingTriggered while the image is being processed.
onImageLoadedTriggered when the image processing is finished.
onImageRemovedTriggered when the user removes the image.
onErrorTriggered when something goes wrong. Returns an error code.
onZoomChangeTriggered when the image scale is changed.
onStatusChangeTriggered when the app status changes, e.g: empty, loaded, drag over, etc.

Methods

MethodParametersDescription
getImageAsDataUrlquality. Image quality from 0.1 to 1 where 1 is the max quality.Returns the image result as a Base64 image string. Use this if you want to use an image string to upload.
getDataReturns the image data. Use this to upload an image to be cropped by backend.
setImageimage url/FileSet a new image to app trough API.

Contributing

Contributions, issues and feature requests are very welcome. Please make sure to read the Contributing Guide before making a pull request.

Code of conduct

Find here our code of conduct.