# quick-file-uploader

> Quick file uploader for s3, html form submission

Latest version **1.0.19** (published 2023-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install quick-file-uploader
pnpm add quick-file-uploader
yarn add quick-file-uploader
bun add quick-file-uploader
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.19 |
| Published | 2023-01-20 |
| First published | 2022-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Umer Ali Chishti |
| Maintainers | umer-ali-chishti |
| Keywords | s3, s3 file uploader, file uploader, quick file uploader |

## Links

- npm: https://www.npmjs.com/package/quick-file-uploader
- Repository: https://github.com/umerali-chishti/quick-file-uploader
- Issues: https://github.com/umerali-chishti/quick-file-uploader/issues
- npm.io page: https://npm.io/package/quick-file-uploader

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.1.3
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.1240.0

## Recent versions

- 1.0.19 (latest) — 2023-01-20
- 1.0.18 — 2022-11-10
- 1.0.17 — 2022-11-07
- 1.0.16 — 2022-11-04
- 1.0.15 — 2022-11-04
- 1.0.14 — 2022-11-04
- 1.0.13 — 2022-11-02
- 1.0.12 — 2022-11-02
- 1.0.11 — 2022-10-31
- 1.0.10 — 2022-10-31
- 1.0.9 — 2022-10-31
- 1.0.8 — 2022-10-30
- 1.0.7 — 2022-10-30
- 1.0.6 — 2022-10-30
- 1.0.5 — 2022-10-30
- … 5 more at https://npm.io/package/quick-file-uploader/versions

## README

<a href="https://www.npmjs.com/package/quick-file-uploader"><img alt="npm" src="https://img.shields.io/npm/v/quick-file-uploader"></a>


# Quick File Uploader

> Quick file uploader for s3, html form submission

## Demo

[https://quick-file-uploader.netlify.app](https://quick-file-uploader.netlify.app/)

## Prerequisites

This project requires NodeJS (version 8 or later) and NPM.
[Node](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.
To make sure you have them available on your machine,
try running the following command.

```sh
$ npm -v && node -v
8.19.2
v18.10.0
```
### Getting Started

1) Installation
    ```
    npm install quick-file-uploader
    ```
2) add `upload-container` id where you want to display uploader:
     ```html
    <div id="upload-container"></div>
    ```
3) Now,  import upload class and initialize:
     ```js
    import  Upload from 'quick-file-uploader'
    new Upload();
    ```
## Custom Params
you can customise file input, preview, error and success messages base on your desire.
|  Name|Description  |
|--|--|
|container  | element id, by default `upload-container` is set for uploading |
|input-name| name attribute, default name is `name="file-input"`|
|storage |`s3, local`, by default local is set|
|mime-types | for file type validation `Example: "jpg\|jpeg\|png\|pdf\|svg\|mp4\|3gp\|mov\|avi\|wmv"` |
|preview  | callback function for file preview `Received args: src, type, file number` |
| accept| attribute `Example: accept="image/*,video/*,application/pdf"`|
|size| size in bytes|
|error| callback function whenever error occur `Received args: errors, file number`|
|success| callback function when file successfully upload `Received args: message, file number`|
|progress| callback function for file uploading progress `Received args: progress, file number`|
|multiple|boolean |
|path| file path for s3 upload. by default `tmp/` path is set|
|draggable|boolean|
|onDrag|callback function|
|onDrop|callback function|

### Upload file on s3

1) define s3 credentials before initialize
    ```js
    window.credentials = {
       AWS_ACCESS_KEY_ID: 'xxxxxxx',
       AWS_SECRET_ACCESS_KEY:'xxxxxxx',
       AWS_DEFAULT_REGION:'xxxxxxx',
       AWS_BUCKET:'xxxxxxx',
    }
     ```
2) Now,  import upload class and initialize:
     ```js
    import Upload from 'quick-file-uploader'
    new Upload({storage: 's3'});

### Upload file on server through api

1) define s3 credentials before initialize
    ```js
    window.credentials = {
       UPLOAD_URL: 'xxxxxxx'
    }
     ```
2) Now,  import upload class and initialize:
     ```js
    import Upload from 'quick-file-uploader'
    new Upload({storage: 'api', headers: {'Authorization': 'TOKEN'}});

## License

[MIT license](https://opensource.org/licenses/MIT).

---
_Source: https://npm.io/package/quick-file-uploader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
