Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/silverwind/uppie
Cross-browser directory and multi-file upload library
https://github.com/silverwind/uppie
browser directory-upload file-upload javascript
Last synced: 29 days ago
JSON representation
Cross-browser directory and multi-file upload library
- Host: GitHub
- URL: https://github.com/silverwind/uppie
- Owner: silverwind
- Created: 2015-07-26T15:49:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T19:12:35.000Z (8 months ago)
- Last Synced: 2024-04-14T09:50:09.155Z (8 months ago)
- Topics: browser, directory-upload, file-upload, javascript
- Language: JavaScript
- Homepage:
- Size: 528 KB
- Stars: 158
- Watchers: 6
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ccamel - silverwind/uppie - Cross-browser directory and multi-file upload library (JavaScript)
README
# uppie
[](https://www.npmjs.org/package/uppie) [](https://www.npmjs.org/package/uppie) [](https://bundlephobia.com/package/uppie) [](https://packagephobia.com/result?p=uppie)
> Cross-browser file and directory and upload library
`uppie` is a tiny JavaScript library which helps you with file and directory uploads in browsers. It supports all current and past implementations of multi-file and directory uploads and provides you with a `FormData` object you can submit directly to a server through either `XMLHttpRequest` or `fetch`. Both the `` element and drag-and-drop are supported.
## Usage
```bash
npm install uppie
```
```js
import {uppie} from 'uppie';
uppie(document.querySelector('#file'), async (e, formData, files) => {
await fetch('/upload', {method: 'POST', body: formData});
});
```
## Browser support
|| files via input[type=file] | files via DnD | directories via input[type=file] | directories via DnD |
|---------|---------------------- |---------------|----------------------|--------------|
| Firefox | yes | yes | yes (50+) | yes (50+) |
| Chrome | yes | yes | yes (29+) | yes (29+) |
| Edge | yes | yes | yes (13+) | yes (14+) |
| Safari | yes | yes | yes (11.1+) | yes (11.1+) |
## Notes
- Empty directories are excluded from the results by all browsers as dictated by the spec.
- Firefox and Safari exclude files and directories starting with a `.`.
## API
### uppie(node, [opts], callback)
- `node` *Node* or *NodeList*: One or more DOM nodes. If a `` is given, uppie will monitor it for `change` events. Any other element type will be enabled as a dropzone and watched for `drop` events. If you want to use both on the same element, use a hidden `` and forward the click event.
- `opts` *Object*: A options object which can contain:
- `name`: The `name` attribute for creating the FormData entries. Default: `"files[]"`.
- `callback` *Function*: callback which is called every time the selected files change or when files are dropped in the dropzone.
The callback receives
- `event` *Event*: the original event. Useful for calling `event.stopPropagation()`.
- `formData` *FormData*: FormData object to be used for XHR2 uploading.
- `files` *Array*: Array of paths for preview purposes.
#### FormData format
`name` defaults to `"files[]"`, `filename` will be the full path to the file, with `/` used as path separator. Does not include a leading slash. Make sure to sanitize `filename` on the server before writing it to the disk to prevent exploits involving `..` in the path. Example FormData:
```
------Boundary
Content-Disposition: form-data; name="files[]"; filename="docs/1.txt"
Content-Type: text/plain
[DATA]
------Boundary
Content-Disposition: form-data; name="files[]"; filename="docs/path/2.txt"
Content-Type: text/plain
[DATA]
------Boundary
Content-Disposition: form-data; name="files[]"; filename="docs/path/to/3.txt"
Content-Type: text/plain
```
## Recommended `input` element attributes
- `multiple`: allow multiple files or directories to be selected.
- `webkitdirectory`: enable directory uploads.
## PHP example
Below is example for PHP 7.0 and possibly earlier versions. PHP does not parse the path from the `filename` field, so it is necessary to submit the path through other means, like as separate FormData fields as done in the example.
````js
import {uppie} from 'uppie';
const uppie = new Uppie();
uppie(document.documentElement, (event, formData, files) => {
files.forEach(path => {
formData.append("paths[]", path);
});
const xhr = new XMLHttpRequest();
xhr.open('POST', 'upload.php');
xhr.send(formData);
});
````
And in `upload.php`:
````php
foreach ($_FILES['files']['name'] as $i => $name) {
if (strlen($_FILES['files']['name'][$i]) > 1) {
$fullpath = strip_tags($_POST['paths'][$i]);
$path = dirname($fullpath);
if (!is_dir('uploads/'.$path)){
mkdir('uploads/'.$path);
}
if (move_uploaded_file($_FILES['files']['tmp_name'][$i], 'uploads/'.$fullpath)) {
echo '
}
}
}
````
Note that PHP's [upload limits](http://php.net/manual/en/ini.core.php#ini.sect.file-uploads) might need to be raised depending on use case.
© [silverwind](https://github.com/silverwind), distributed under BSD licence