Installations

npm install @mikhail2404/react-avatar-edit

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.0.0

NPM Version

8.6.0 Pull Requests

Open

5

Total

58

Closed

31

Merged

22

Issues

Open

15

Total

56

Closed

41

Releases

7

1.2.0

Updated on Apr 25, 2022

1.0.0

Updated on Mar 09, 2021

0.9.0

Updated on Oct 01, 2020

0.8.3

Updated on Jun 24, 2019

0.7.1

Updated on Dec 16, 2018

0.7.0

Updated on Dec 13, 2018

View All 7 releases

Languages

2

JavaScript

HTML

JavaScript (98.29%)

HTML (1.71%)

Developer

kirill3333

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

565 Stars

154 Commits

102 Forks

8 Watchers

5 Branches

18 Contributors

Updated on Jul 10, 2025

Maintainers

1

View All 18 Contributors

Package Meta Information

Latest Version

1.3.6

Package Id

@mikhail2404/react-avatar-edit@1.3.6

Unpacked Size

221.43 kB

Size

96.16 kB

File Count

7

NPM Version

8.6.0

Node Version

18.0.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Dependencies

3

blueimp-load-image exif-js konva

Peer Dependencies

1

react

Dev Dependencies

16

@babel/cli @babel/core @babel/plugin-proposal-class-properties @babel/preset-env @babel/preset-es2015 @babel/preset-react babel-loader compression-webpack-plugin html-webpack-plugin react react-dom rollup-webpack-loader webpack webpack-bundle-analyzer webpack-cli webpack-dev-server

react-avatar-edit

👤 Load, crop and preview avatar with ReactJS component

Works from the box
Fully typed with TypeScript
Drag and Drop support
A lot of customization
Powered with KonvaJS

Demo

Demo website

Install

npm i react-avatar-edit

Usage

1import React from 'react'
2import ReactDOM from 'react-dom'
3import Avatar from 'react-avatar-edit'
4
5class App extends React.Component {
6
7  constructor(props) {
8    super(props)
9    const src = './example/einshtein.jpg'
10    this.state = {
11      preview: null,
12      src
13    }
14    this.onCrop = this.onCrop.bind(this)
15    this.onClose = this.onClose.bind(this)
16    this.onBeforeFileLoad = this.onBeforeFileLoad.bind(this)
17  }
18  
19  onClose() {
20    this.setState({preview: null})
21  }
22  
23  onCrop(preview) {
24    this.setState({preview})
25  }
26
27  onBeforeFileLoad(elem) {
28    if(elem.target.files[0].size > 71680){
29      alert("File is too big!");
30      elem.target.value = "";
31    };
32  }
33  
34  render () {
35    return (
36      <div>
37        <Avatar
38          width={390}
39          height={295}
40          onCrop={this.onCrop}
41          onClose={this.onClose}
42          onBeforeFileLoad={this.onBeforeFileLoad}
43          src={this.state.src}
44        />
45        <img src={this.state.preview} alt="Preview" />
46      </div>
47    )
48  }
49}
50
51ReactDOM.render(<App /> , document.getElementById('root'))

Component properties

Prop	Type	Description
img	Image	The Image object to display
src	String/Base64	The url to base64 string to load (use urls from your domain to prevent security errors)
width	Number	The width of the editor
height	Number	The height of the editor (image will fit to this height if neither imageHeight, nor imageWidth is set)
imageWidth	Number	The desired width of the image, can not be used together with imageHeight
imageHeight	Number	The desired height of the image, can not be used together with imageWidth
cropRadius	Number	The crop area radius in px (default: calculated as min image with/height / 3)
cropColor	String	The crop border color (default: white)
lineWidth	Number	The crop border width (default: 4)
minCropRadius	Number	The min crop area radius in px (default: 30)
backgroundColor	String	The color of the image background (default: white)
closeIconColor	String	The close button color (default: white)
shadingColor	String	The shading color (default: grey)
shadingOpacity	Number	The shading area opacity (default: 0.6)
mimeTypes	String	The mime types used to filter loaded files (default: image/jpeg,image/png)
label	String	Label text (default: Choose a file)
labelStyle	Object	The style object for preview label (use camel case for css properties fore example: fontSize)
borderStyle	Object	The style for object border preview (use camel case for css properties fore example: fontSize)
onImageLoad(image)	Function	Invoked when image based on src prop finish loading
onCrop(image)	Function	Invoked when user drag&drop event stop and return cropped image in base64 string
onBeforeFileLoad(file)	Function	Invoked when user before upload file with internal file loader (etc. check file size)
onFileLoad(file)	Function	Invoked when user upload file with internal file loader
onClose()	Function	Invoked when user clicks on close editor button
exportAsSquare	Boolean	The exported image is a square and the circle is not cut-off from the image
exportSize	Number	The size the exported image should have (width and height equal). The cropping will be made on the original image to ensure a high quality.
exportMimeType	String	The mime type that should be used to export the image, supported are: image/jpeg, image/png (Default: image/png)
exportQuality	Number	The quality that should be used when exporting in image/jpeg. A value between 0.0 and 1.0.

Contributing

To start developer server please use npm run start
To build production bundle use npm run build

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@mikhail2404/react-avatar-edit

Installations

Developer Guide

Yes

CommonJS

18.0.0

8.6.0

Pull Requests

5

58

31

22

Issues

15

56

41

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Dependencies

Peer Dependencies

Dev Dependencies

react-avatar-edit

Demo

Demo website

Install

Usage

Component properties

Contributing

10

10

4

0

0

0

0

0

0

2.6

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads