npmpackage.info

Gathering detailed insights and metrics for @gfnork/react-images-uploading

@gfnork/react-images-uploading - 3.1.7 | npmpackage.info

@gfnork/react-images-uploading

The simple images uploader applied Render Props pattern that allows you to fully control UI component and behaviors.

3.1.7

321

MIT

TypeScript

42.63 kB

5.3

Installations

npm install @gfnork/react-images-uploading

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=8

Node Version

16.15.1

NPM Version

8.12.2 Pull Requests

Open

25

Total

70

Closed

9

Merged

36

Issues

Open

30

Total

93

Closed

63

Releases

3.1.7

Updated on Jul 09, 2022

3.1.6

Updated on Apr 20, 2022

3.1.5

Updated on Apr 17, 2022

3.1.3

Updated on Jul 31, 2021

Version 3.1.2

3.1.2

Updated on Oct 05, 2020

3.0.1

Updated on Aug 29, 2020

View All 6 releases

Languages

TypeScript

JavaScript

Shell

HTML

Dockerfile

TypeScript (76.85%)

JavaScript (19.13%)

Shell (2.25%)

HTML (0.93%)

Dockerfile (0.83%)

Developer

vutoan266

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

321 Stars

141 Commits

53 Forks

2 Watchers

22 Branches

5 Contributors

Updated on Apr 21, 2025

Maintainers

View All 5 Contributors

Package Meta Information

Latest Version

3.1.7

Package Id

@gfnork/react-images-uploading@3.1.7

Unpacked Size

42.63 kB

Size

10.52 kB

File Count

NPM Version

8.12.2

Node Version

16.15.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

react-images-uploading

The simple images uploader applied Render Props pattern. (You can read more about this pattern here).

This approach allows you to fully control UI component and behaviours.

See the intro blog post

Installation
Usage
Props
- Note
Exported options
Contributors ✨

Installation

npm

1npm install --save react-images-uploading

yarn

1yarn add react-images-uploading

Usage

You can check out the basic demo here:

Javascript: https://codesandbox.io/s/react-images-uploading-demo-u0khz
Typescript: https://codesandbox.io/s/react-images-uploading-demo-typescript-fr2zm
Server Side rendering (NextJS): https://codesandbox.io/s/react-images-uploading-ssr-j1qq2

Basic

1import React from 'react';
2import ImageUploading from 'react-images-uploading';
3
4export function App() {
5  const [images, setImages] = React.useState([]);
6  const maxNumber = 69;
7
8  const onChange = (imageList, addUpdateIndex) => {
9    // data for submit
10    console.log(imageList, addUpdateIndex);
11    setImages(imageList);
12  };
13
14  return (
15    <div className="App">
16      <ImageUploading
17        multiple
18        value={images}
19        onChange={onChange}
20        maxNumber={maxNumber}
21        dataURLKey="data_url"
22      >
23        {({
24          imageList,
25          onImageUpload,
26          onImageRemoveAll,
27          onImageUpdate,
28          onImageRemove,
29          isDragging,
30          dragProps,
31        }) => (
32          // write your building UI
33          <div className="upload__image-wrapper">
34            <button
35              style={isDragging ? { color: 'red' } : undefined}
36              onClick={onImageUpload}
37              {...dragProps}
38            >
39              Click or Drop here
40            </button>
41            &nbsp;
42            <button onClick={onImageRemoveAll}>Remove all images</button>
43            {imageList.map((image, index) => (
44              <div key={index} className="image-item">
45                <img src={image['data_url']} alt="" width="100" />
46                <div className="image-item__btn-wrapper">
47                  <button onClick={() => onImageUpdate(index)}>Update</button>
48                  <button onClick={() => onImageRemove(index)}>Remove</button>
49                </div>
50              </div>
51            ))}
52          </div>
53        )}
54      </ImageUploading>
55    </div>
56  );
57}

Validation

1...
2  {({ imageList, onImageUpload, onImageRemoveAll, errors }) => (
3    errors && <div>
4      {errors.maxNumber && <span>Number of selected images exceed maxNumber</span>}
5      {errors.acceptType && <span>Your selected file type is not allow</span>}
6      {errors.maxFileSize && <span>Selected file size exceed maxFileSize</span>}
7      {errors.resolution && <span>Selected file is not match your desired resolution</span>}
8    </div>
9  )}
10...

Drag and Drop

1...
2  {({ imageList, dragProps, isDragging }) => (
3    <div {...dragProps}>
4      {isDragging ? "Drop here please" : "Upload space"}
5      {imageList.map((image, index) => (
6        <img key={index} src={image.data_url} />
7      ))}
8    </div>
9  )}
10...

Props

parameter	type	options	default	description
value	array		[]	List of images
onChange	function	(imageList, addUpdateIndex) => void		Called when add, update or delete action is called
dataURLKey	string		dataURL	Customized field name that base64 of selected image is assigned to
multiple	boolean		false	Set `true` for multiple chooses
maxNumber	number		1000	Number of images user can select if mode = `multiple`
onError	function	(errors, files) => void		Called when it has errors
acceptType	array	['jpg', 'gif', 'png']	[]	The file extension(s) to upload
maxFileSize	number			Max image size (Byte) and it is used in validation
resolutionType	string	'absolute' \| 'less' \| 'more' \| 'ratio'		Using for image validation with provided width & height
resolutionWidth	number	> 0
resolutionHeight	number	> 0
inputProps	React.HTMLProps<HTMLInputElement>

Note

resolutionType

value	description
absolute	image's width === resolutionWidth && image's height === resolutionHeight
ratio	(resolutionWidth / resolutionHeight) === (image width / image height)
less	image's width < resolutionWidth && image's height < resolutionHeight
more	image's width > resolutionWidth && image's height > resolutionHeight

Exported options

parameter	type	description
imageList	array	List of images to render.
onImageUpload	function	Called when an element is clicks and triggers to open a file dialog
onImageRemoveAll	function	Called when removing all images
onImageUpdate	(updateIndex: number) => void	Called when updating an image at `updateIndex`.
onImageRemove	(deleteIndex: number \| number[]) => void	Called when removing one or list image.
errors	object	Exported object of validation
dragProps	object	Native element props for drag and drop feature
isDragging	boolean	"true" if an image is being dragged

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_vutoan266
💻 🤔 📖 🚧 ⚠️ 👀

_{David Nguyen}
💻 🤔 📖 👀

_DK
💻 🚇 🤔 👀 📖

_{Isaac Maseruka}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

No vulnerabilities found.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

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

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

7

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

5

Maintained

Determines if the project is "actively maintained".

2

Code-Review

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

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.3

/10

Last Scanned on 2022-08-15

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

@gfnork/react-images-uploading

Installations

Developer Guide

Yes

CommonJS

>=8

16.15.1

8.12.2

Pull Requests

25

70

9

36

Issues

30

93

63

Releases

Languages

Developer

vutoan266

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

react-images-uploading

Installation

Usage

Props

Note

Exported options

Contributors ✨

10

10

10

10

10

7

5

2

0

0

0

0

0

5.3

/10