Giter Club home page Giter Club logo

react-chunked-uploader's Introduction

NPM TypeScript Licence React Yarn

React Chunked Uploader

A react hook for uploading large files that need chunking (for example for uploading to Cloudinary). It uses axios and provides loading state and progress value.

Installation

yarn add react-chunked-uploader

or

npm i react-chunked-uploader

Usage

Import the hook from the package:

import useChunkedUploader from 'react-chunked-uploader';

Into your React component:

const { uploadFile, cancelUpload, isLoading, progress } = useChunkedUploader();

const uploadImage = async (file: File, data: FormData) => {
  try {
    const result = await uploadFile({ file, url: 'YOUR_UPLOAD_URL', data });
    return result;
  } catch (error) {
    console.error(error);
  }
};

API

uploadFile

A function to upload a file with specific form data.

uploadFile({ file, url, data, chunkSize });

Options:

Name Type Required Default value
file File yes -
url string yes -
data FormData no -
chunkSize number (Bytes) no 6 * 1024 * 1024

Return type:

Promise<AxiosResponse[]>;

isLoading

A boolean that indicates the loading status of the uploading data.

Name Type Default value
isLoading boolean false

progress

A number that indicates the progress value of the uploading process.

Name Type Default value
progress number 0

cancelUpload

A function to cancel upload operation.

Name Type
cancelUpload () => void

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Add your changes: git add .
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request ๐Ÿ˜Ž

Versioning

We use SemVer for versioning.

Authors

License

MIT License ยฉ Raffi Dilanchian

react-chunked-uploader's People

Contributors

raffidil avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.