Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kimmelsg/cj-upload
Higher order React components for file uploading (with progress) react file upload
https://github.com/kimmelsg/cj-upload
file file-upload progress react react-components upload upload-dialog xhr
Last synced: about 1 month ago
JSON representation
Higher order React components for file uploading (with progress) react file upload
- Host: GitHub
- URL: https://github.com/kimmelsg/cj-upload
- Owner: kimmelsg
- License: mit
- Archived: true
- Created: 2016-08-30T03:15:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-09T01:20:28.000Z (about 2 years ago)
- Last Synced: 2024-05-05T20:26:18.497Z (about 2 months ago)
- Topics: file, file-upload, progress, react, react-components, upload, upload-dialog, xhr
- Language: JavaScript
- Homepage:
- Size: 1.11 MB
- Stars: 586
- Watchers: 12
- Forks: 33
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-react-render-props - @navjobs/upload
README
## Deprecated
Please look at [react-use-upload](https://github.com/zackify/react-use-upload) for the same functionality, updated using React hooks.
[](https://circleci.com/gh/navjobs/upload)
[](https://coveralls.io/github/navjobs/upload?branch=master)
## @navjobs/upload
## v4
I'm working on a v4 soon that simplfies the api and removes the children-as-a-function paradigm to something more extendable. Also revamping the test suit. It'll be a complete rewrite.
## What
A set of React components for handling file uploads. If you simply want to turn any component into a file upload dialog, wrap it in our `` component that exposes the files after selection. Need to process a file upload and receive the upload progress? Wrap `` with ``. You can see examples inside [our storybook](/stories/index.js).
## Why this?
- Any component can be an upload dialog. Wrap it in ``. This means you have ultimate styling control.
- Simple component API for upload progress. Pass headers, extra fields, anything.
- Zero dependencies (other than React!)
## Install
```
yarn add @navjobs/upload
```
## In this library
- [UploadField](#uploadfield) gives access to files after drag and drop / clicking on the area wrapped
- [Uploader](#uploader) triggers an xhr upload to a url with file progress
- [SignedUploader](#signed-uploader) same as above, but helps generate a [signed url](https://cloud.google.com/storage/docs/access-control/signed-urls) from your api.
- [Imperative api](#imperative-api) that lets you trigger a file upload with progress outside of react.
### UploadField
```js
import { UploadField } from '@navjobs/upload'
//files object here}
containerProps={{
className: 'resume_import'
}}
uploadProps={{
accept: '.pdf,.doc,.docx,.txt,.rtf',
}}
>
Click here to upload! This can be an image,
or any component you can dream of.
```
### Uploader
Use `` inside of this component; pass the files to it and handle the upload!
```js
import { Uploader } from '@navjobs/upload'
/*do something*/}
//upload on file selection, otherwise use `startUpload`
uploadOnSelection={true}
>
{({ onFiles, progress, complete }) => (
Click here to select a file!
{progress ? `Progress: ${progress}` : null}
{complete ? 'Complete!' : null}
)}
```
### Signed Uploader
This is a useful component for generating signed urls on your backend for a service like [AWS](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-signed-urls.html) or [Google Cloud](https://cloud.google.com/storage/docs/access-control/signed-urls).
The workflow generally involes hitting your own api, then uploading to the url that your api returns. After the fact, you hit your api again to say that the upload is finished.
```js
import { SignedUploader } from '@navjobs/upload'
new Promise(resolve => resolve({ url: 'http://storage.googlecloud.com' }))}
request={({ before, files }) => ({
url: before.url,
method: 'PUT',
headers: {
'Content-Type': files[0].type
}
})}
afterRequest={({ before, status }) => new Promise(resolve => {
resolve('finished the upload!');
})}
>
```
### Imperative API
If you need to upload files and recieve progress, but can't wrap an `Uploader` around where you receive the files, feel free to use this:
```js
import { UploadRequest } from '@navjobs/upload'
async uploadFiles() {
let { response, error, aborted } = await UploadRequest(
{
request: {
url: 'blah' //same as above request object
},
files, //files array
progress: value => console.log('progress!', value)
}
)
//do something with response
}
```
## FAQ
**Q:** Part of the component I'm wrapping isn't cursor pointer?
**A:** You may need to set
```css
::-webkit-file-upload-button { cursor:pointer; }
```
In your css. For some reason file uploads aren't always pointer.
## License
This project is licensed under the terms of the [MIT](/LICENSE.md) license.