# @halfmester-labs/react-images-upload

> Simple component for upload and validate (client side) images with preview built with React.js. This package use ['react-flip-move'](https://github.com/joshwcomeau/react-flip-move) for animate the file preview images.

Latest version **0.2.4** (published 2021-10-12) · 0 weekly downloads

## Install

```sh
npm install @halfmester-labs/react-images-upload
pnpm add @halfmester-labs/react-images-upload
yarn add @halfmester-labs/react-images-upload
bun add @halfmester-labs/react-images-upload
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2021-10-12 |
| First published | 2021-10-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 159.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 339 |
| Maintainers | halfmester |

## Links

- npm: https://www.npmjs.com/package/@halfmester-labs/react-images-upload
- Repository: https://github.com/jakehartnell/react-images-upload
- Homepage: https://jakehartnell.github.io/react-images-upload/
- Issues: https://github.com/jakehartnell/react-images-upload/issues
- npm.io page: https://npm.io/package/@halfmester-labs/react-images-upload

## Dependencies (5)

- [react](https://npm.io/package/react.md) ^16.12.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.12.0
- [react-scripts](https://npm.io/package/react-scripts.md) ^4.0.3
- [react-flip-move](https://npm.io/package/react-flip-move.md) ^3.0.4
- [react-syntax-highlighter](https://npm.io/package/react-syntax-highlighter.md) ^7.0.4

## Recent versions

- 0.2.4 (latest) — 2021-10-12
- 0.2.3 — 2021-10-12
- 0.2.2 — 2021-10-12
- 0.2.1 — 2021-10-12

## README

# Images uploader UI component

Simple component for upload and validate (client side) images with preview built with React.js.
This package use ['react-flip-move'](https://github.com/joshwcomeau/react-flip-move) for animate the file preview images.

## Installation

```bash
npm install --save react-images-upload
```

## Usage
### Using Classes
```javascript
import React from "react";
import ImageUploader from "react-images-upload";

class App extends React.Component {
  constructor(props) {
    super(props);
    this.state = { pictures: [] };
    this.onDrop = this.onDrop.bind(this);
  }

  onDrop(pictureFiles, pictureDataURLs) {
    this.setState({
      pictures: this.state.pictures.concat(pictureFiles)
    });
  }

  render() {
    return (
      <ImageUploader
        withIcon={true}
        buttonText="Choose images"
        onChange={this.onDrop}
        imgExtension={[".jpg", ".gif", ".png", ".gif"]}
        maxFileSize={5242880}
      />
    );
  }
}
```
### Using Hooks
```javascript
import React, { useState } from "react";
import ImageUploader from "react-images-upload";

const App = props => {
  const [pictures, setPictures] = useState([]);

  const onDrop = picture => {
    setPictures([...pictures, picture]);
  };
  return (
    <ImageUploader
      {...props}
      withIcon={true}
      onChange={onDrop}
      imgExtension={[".jpg", ".gif", ".png", ".gif"]}
      maxFileSize={5242880}
    />
  );
};

export default App;
```
### Available Options

|    parameter    |   type   |              default               | description                                                     |
| :-------------: | :------: | :--------------------------------: | :---------------------------------------------------------------|
|    className    |  String  |                 -                  | Class name for the input.                                       |
|    onChange     | Function |                 -                  | On change handler for the input.                                |
| buttonClassName |  String  |                 -                  | Class name for upload button.                                   |
|  buttonStyles   |  Object  |                 -                  | Inline styles for upload button.                                |
|   withPreview   | Boolean  |               false                | Show preview of selected images.                                |
|  defaultImages  |  Array   |       ['imgUrl1', 'imgUrl2']       | Pre-populate with default images.                               |
|     accept      |  String  |         "accept=image/\*"          | Accept attribute for file input.                                |
|      name       |  String  |                 -                  | Input name.                                                     |
|    withIcon     | Boolean  |                true                | If true, show upload icon on top                                |
|   customIcon    |  Object  |                 -                  | Override default icon. e.g Dark-mode icon (included), or custom |
|   buttonText    |  String  |          'Choose images'           | The text that display in the button.                            |
|   buttonType    |  String  |              'submit'              | The value of the button's "type" attribute.                     |
|    withLabel    | Boolean  |                true                | Show instruction label                                          |
|      label      |  String  | 'Max file size: 5mb, accepted: jpg, gif, png |         Label text                                    |
|   labelStyles   |  Object  |                 -                  | Inline styles for the label.                                    |
|   labelClass    |  string  |                 -                  | Class name for the label                                        |
|  imgExtension   |  Array   |  ['.jpg', '.gif', '.png', '.gif']  | Supported image extension (will use in the image validation).   |
|   maxFileSize   |  Number  |              5242880               | Max image size.                                                 |
|  fileSizeError  |  String  |      " file size is too big"       | Label for file size error message.                              |
|  fileTypeError  |  String  | " is not supported file extension" | Label for file extension error message.                         |
|   errorClass    |  String  |                 -                  | Class for error messages                                        |
|   errorStyle    |  Object  |                 -                  | Inline styles for errors                                        |
|   singleImage   | Boolean  |               false                | Upload one single image                                         |

### Development

Clone the repo and run `npm ci`. Start development server with `npm start`.

### License

MIT

---
_Source: https://npm.io/package/@halfmester-labs/react-images-upload · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._