react-images-uploading - npm Package Compare versions

Comparing version 3.0.1 to 3.1.0

package.json

 {
   "name": "react-images-uploading",
-  "version": "3.0.1",
-  "description": "A simple images uploader without UI. Building by yourself",
-  "author": "imvutoan",
+  "version": "3.1.0",
+  "description": "The simple images uploader applied Render Props pattern. This approach allows you to fully control UI component and behaviours.",
+  "author": {
+    "name": "vutoan266",
+    "email": "[e-mail]",
+    "url": "https://github.com/vutoan266"
+  },
+  "contributors": [
+    {
+      "name": "davidnguyen179",
+      "email": "[e-mail]",
+      "url": "https://github.com/davidnguyen179"
+    },
+    {
+      "name": "conandk",
+      "email": "[e-mail]",
+      "url": "https://github.com/conandk"
+    }
+  ],
   "license": "MIT",
@@ -11,2 +27,5 @@ "repository": {
   },
+  "bugs": {
+    "url": "https://github.com/vutoan266/react-images-uploading/issues"
+  },
   "homepage": "https://github.com/vutoan266/react-images-uploading/blob/master/README.md",
@@ -26,3 +45,6 @@ "main": "dist/index.js",
     "prettier": "prettier --write ./**/*.{js,ts,tsx,md}",
-    "test": "./node_modules/.bin/jest"
+    "test": "./node_modules/.bin/jest",
+    "contributors:add": "./node_modules/.bin/all-contributors add",
+    "contributors:generate": "./node_modules/.bin/all-contributors generate",
+    "toc": "./node_modules/.bin/doctoc --notitle README.md"
   },
@@ -37,2 +59,3 @@ "dependencies": {},
     "@babel/preset-typescript": "^7.10.4",
+    "@testing-library/react": "^10.4.9",
     "@types/jest": "^26.0.10",
@@ -42,2 +65,3 @@ "@types/react": "^16.3.13",
     "@types/sinon": "^9.0.5",
+    "all-contributors-cli": "^6.17.2",
     "babel-core": "^6.26.3",
@@ -51,2 +75,3 @@ "babel-runtime": "^6.26.0",
     "css-loader": "^4.2.2",
+    "doctoc": "^1.4.0",
     "express": "^4.17.1",
@@ -62,4 +87,4 @@ "file-loader": "^6.0.0",
     "prettier": "^2.1.1",
-    "react": "^16.4.1",
-    "react-dom": "^16.4.1",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
     "rimraf": "^3.0.2",
@@ -88,4 +113,9 @@ "sinon": "^9.0.3",
     "drag and drop",
-    "image drag and drop"
+    "image drag and drop",
+    "reactjs",
+    "typescript",
+    "javascript",
+    "render props",
+    "react-component"
   ]
 }

README.md

@@ -13,4 +13,24 @@ # react-images-uploading
 
-[![NPM](https://img.shields.io/npm/v/react-images-uploading.svg)](https://www.npmjs.com/package/react-images-uploading) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest) ![Github_Actions](https://github.com/vutoan266/react-images-uploading/workflows/CI/CD/badge.svg) [![NPM](https://img.shields.io/npm/v/react-images-uploading.svg)](https://www.npmjs.com/package/react-images-uploading) [![NPM](https://img.shields.io/npm/dm/react-images-uploading.svg)](https://www.npmjs.com/package/react-images-uploading) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vutoan266/react-images-uploading/blob/master/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/vutoan266/react-images-uploading/pulls) [![Package Quality](https://npm.packagequality.com/shield/react-images-uploading.svg)](https://packagequality.com/#?package=react-images-uploading) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+[![Package Quality](https://npm.packagequality.com/badge/react-images-uploading.png)](https://packagequality.com/#?package=react-images-uploading)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Props](#props)
+  - [Note](#note)
+- [Exported options](#exported-options)
+- [Contributors ✨](#contributors-)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Installation
@@ -24,4 +44,2 @@
 
-or
-
 **yarn**
@@ -38,2 +56,4 @@
 - Javascript: [https://codesandbox.io/s/react-images-uploading-demo-u0khz](https://codesandbox.io/s/react-images-uploading-demo-u0khz)
+- Typescript: [https://codesandbox.io/s/react-images-uploading-demo-typescript-fr2zm](https://codesandbox.io/s/react-images-uploading-demo-typescript-fr2zm)
+- Server Side rendering (NextJS): [https://codesandbox.io/s/react-images-uploading-ssr-j1qq2](https://codesandbox.io/s/react-images-uploading-ssr-j1qq2)
 
@@ -107,3 +127,3 @@ **Basic**
   {({ imageList, onImageUpload, onImageRemoveAll, errors }) => (
-    <div>
+    errors && <div>
       {errors.maxNumber && <span>Number of selected images exceed maxNumber</span>}
@@ -172,1 +192,24 @@ {errors.acceptType && <span>Your selected file type is not allow</span>}
 | isDragging       | boolean                                   | "true" if an image is being dragged                                 |
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://medium.com/@imvutoan"><img src="https://avatars1.githubusercontent.com/u/18349710?v=4" width="100px;" alt=""/><br /><sub><b>vutoan266</b></sub></a><br /><a href="https://github.com/vutoan266/react-images-uploading/commits?author=vutoan266" title="Code">💻</a> <a href="#ideas-vutoan266" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/vutoan266/react-images-uploading/commits?author=vutoan266" title="Documentation">📖</a> <a href="#maintenance-vutoan266" title="Maintenance">🚧</a> <a href="https://github.com/vutoan266/react-images-uploading/commits?author=vutoan266" title="Tests">⚠️</a> <a href="https://github.com/vutoan266/react-images-uploading/pulls?q=is%3Apr+reviewed-by%3Avutoan266" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://www.dzungnguyen.dev/about"><img src="https://avatars3.githubusercontent.com/u/6290720?v=4" width="100px;" alt=""/><br /><sub><b>David Nguyen</b></sub></a><br /><a href="https://github.com/vutoan266/react-images-uploading/commits?author=davidnguyen179" title="Code">💻</a> <a href="#ideas-davidnguyen179" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/vutoan266/react-images-uploading/commits?author=davidnguyen179" title="Documentation">📖</a> <a href="https://github.com/vutoan266/react-images-uploading/pulls?q=is%3Apr+reviewed-by%3Adavidnguyen179" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/conandk"><img src="https://avatars2.githubusercontent.com/u/12934183?v=4" width="100px;" alt=""/><br /><sub><b>DK</b></sub></a><br /><a href="https://github.com/vutoan266/react-images-uploading/commits?author=conandk" title="Code">💻</a> <a href="#infra-conandk" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-conandk" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/vutoan266/react-images-uploading/pulls?q=is%3Apr+reviewed-by%3Aconandk" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/vutoan266/react-images-uploading/commits?author=conandk" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://masesisaac.me/"><img src="https://avatars2.githubusercontent.com/u/9384060?v=4" width="100px;" alt=""/><br /><sub><b>Isaac Maseruka</b></sub></a><br /><a href="https://github.com/vutoan266/react-images-uploading/commits?author=masesisaac" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

New alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

211

increased by25.6%

Worsened metrics

Total package byte prevSize

16622

decreased by-55.58%

Dev dependency count

38

increased by8.57%

Number of package files

3

decreased by-75%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes