react-images-uploading

Temporary publish of package until PR

Images uploader

A simple images uploader without UI. Building by yourself.

#Demo

Introduce blog

Install

With npm

1npm install --save react-images-uploading

With yarn

1yarn add react-images-uploading

Usage

1import * as React from "react";
2
3import ImageUploading from "react-images-uploading";
4// { ImageUploadingPropsType, ImageListType, ImageType } is type for typescript
5
6const maxNumber = 10;
7const maxMbFileSize = 5 * 1024 * 1024; // 5Mb
8
9class Example extends React.Component {
10  onChange = (imageList) => {
11    // data for submit
12    console.log(imageList);
13  };
14  onError = (errors, files) => {
15    console.log(errors, files);
16  };
17
18  render() {
19    return (
20      <ImageUploading
21        onChange={this.onChange}
22        maxNumber={maxNumber}
23        multiple
24        maxFileSize={maxMbFileSize}
25        acceptType={["jpg", "gif", "png"]}
26        onError={this.onError}
27      >
28        {({ imageList, onImageUpload, onImageRemoveAll }) => (
29          // write your building UI
30          <div>
31            <button onClick={onImageUpload}>Upload images</button>
32            <button onClick={onImageRemoveAll}>Remove all images</button>
33
34            {imageList.map((image) => (
35              <div key={image.key}>
36                <img src={image.dataURL} />
37                <button onClick={image.onUpdate}>Update</button>
38                <button onClick={image.onRemove}>Remove</button>
39              </div>
40            ))}
41          </div>
42        )}
43      </ImageUploading>
44    );
45  }
46}

Validate

...
  {({ imageList, onImageUpload, onImageRemoveAll, errors }) => (
    <div>
      {errors.maxNumber && <span>Number of selected images exceed maxNumber</span>}
      {errors.acceptType && <span>Your selected file type is not allow</span>}
      {errors.maxFileSize && <span>Selected file size exceed maxFileSize</span>}
      {errors.resolution && <span>Selected file is not match your desired resolution</span>}
    </div>
  )}
...

Resolution

• "absolute": resolutionWidth and resolutionHeight is equal with selected image absolutely
• "ratio": resolutionWidth/resolutionHeight ratio is equal with width/height ratio of selected image
• "less: image width must less than resolutionWidth and image height must less than resolutionHeight
• "more: image width must more than resolutionWidth and image height must more than resolutionHeight

Props

parameter	type	options	default	description
multiple	boolean		false	Set true for multiple choose
maxNumber	number		1000	Number of images user can select if mode = "multiple"
onChange	function			Called every update
onError	function	(errors, files) => void		Called if have error on validate each update
defaultValue	array	[{dataURL: ... }, ...]		Init data
acceptType	array	['jpg', 'gif', 'png']	[]	Supported image extension
maxFileSize	number			Max image size(Byte) (will use in the image validation)
resolutionType	string	"absolute" | "less" | "more" | "ratio"		Using for validate image with your width - height resolution that you provide
resolutionWidth	number	> 0
resolutionHeight	number	> 0

Exported options

parameter	type	description
imageList	array	List of images for render. Each item in imageList has some options below.
imageList[index].key	string	Generate filename
imageList[index].dataURL	string	Url image or base64
imageList[index].onUpdate	function	Call function for replace a new image on current position
imageList[index].onRemove	function	Call function for remove current image
onImageUpload	function	Call for upload new image(s)
onImageRemoveAll	function	Call for remove all image(s)
errors	object	Export type of validation

License

MIT ©