Comparing version 1.0.7 to 1.0.8
{ | ||
"name": "filepond", | ||
"version": "1.0.7", | ||
"version": "1.0.8", | ||
"description": "FilePond, Where files go to stretch their bits.", | ||
@@ -5,0 +5,0 @@ "homepage": "https://pqina.nl/filepond", |
102
README.md
# <img src="https://github.com/pqina/filepond-github-assets/blob/master/logo.svg" height="44" alt="FilePond"/> | ||
**A JavaScript file upload plugin that's easy to setup and a joy to use.** | ||
A (21 KB gzipped) JavaScript library that can **upload anything** you throw at it, **optimizes images** for faster uploads, and offers a great, **accessible**, silky **smooth user experience**. | ||
Beautiful animations, fast uploads with client-side image optimization, and a great, accessible, user experience. | ||
[Learn more about FilePond](https://pqina.nl/filepond) | ||
<img src="https://github.com/pqina/filepond-github-assets/blob/master/filepond-animation-01.gif" width="370" height="400" alt=""/> | ||
### Core Features | ||
- Accepts **directories**, **files**, blobs, local URLs, **remote URLs** and Data URIs. | ||
- **Drop files**, browse on filesystem, **copy and paste files**, or add files using the API. | ||
- **Async uploading** with AJAX or encode files as base64 data and send along form post. | ||
- **Accessible**, tested with AT software like VoiceOver and JAWS, **navigable by Keyboard**. | ||
- **Image optimization**, automatic image resizing, **cropping**, and **correcting of EXIF orientation** on the client saves bandwidth. | ||
- **Responsive**, automatically scales to available space, is function on both **mobile and desktop**. | ||
### Plugins | ||
- [File encode](https://github.com/pqina/filepond-plugin-file-encode) | ||
- [File size validation](https://github.com/pqina/filepond-plugin-file-validate-size) | ||
- [File type validation](https://github.com/pqina/filepond-plugin-file-validate-type) | ||
- [Image preview](https://github.com/pqina/filepond-plugin-image-preview) | ||
- [Image crop](https://github.com/pqina/filepond-plugin-image-crop) | ||
- [Image resize](https://github.com/pqina/filepond-plugin-image-resize) | ||
- [Image transform](https://github.com/pqina/filepond-plugin-image-transform) | ||
- [Image EXIF orientation](https://github.com/pqina/filepond-plugin-image-exif-orientation) | ||
### Boilerplates | ||
- [PHP](https://github.com/pqina/filepond-boilerplate-php) | ||
[Learn more about FilePond](https://pqina.nl/filepond) | ||
## Quick Start | ||
Install from NPM [![npm version](https://badge.fury.io/js/filepond.svg)](https://badge.fury.io/js/filepond) | ||
Install from NPM | ||
[![npm version](https://badge.fury.io/js/filepond.svg)](https://badge.fury.io/js/filepond) | ||
```bash | ||
@@ -23,44 +49,56 @@ npm install filepond | ||
```js | ||
import { FilePond } from 'filepond'; | ||
``` | ||
import * as FilePond from 'filepond'; | ||
Or get from a CDN | ||
// Create a multi file upload component | ||
const pond = FilePond.create({ | ||
multiple:true, | ||
name:'filepond' | ||
}); | ||
```html | ||
<!-- add to document <head> --> | ||
<link href="https://unpkg.com/filepond/dist/filepond.css" rel="stylesheet"> | ||
<!-- add before </body> --> | ||
<script src="https://unpkg.com/filepond/dist/filepond.js"></script> | ||
// Add it to the DOM | ||
document.body.appendChild(pond.element); | ||
``` | ||
Now you can turn an `<input type="file">` into a FilePond. | ||
Or get it from a CDN | ||
```html | ||
<input type="file" class="filepond'> | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<title>FilePond from CDN</title> | ||
<!-- Filepond stylesheet --> | ||
<link href="https://unpkg.com/filepond/dist/filepond.css" rel="stylesheet"> | ||
</head> | ||
<body> | ||
<!-- We'll transform this input into a pond --> | ||
<input type="file" class="filepond"> | ||
<!-- Load FilePond library --> | ||
<script src="https://unpkg.com/filepond/dist/filepond.js"></script> | ||
<script> | ||
FilePond.parse(document.body); | ||
</script> | ||
<!-- Turn all file input elements into ponds --> | ||
<script> | ||
FilePond.parse(document.body); | ||
</script> | ||
</body> | ||
</html> | ||
``` | ||
Read more in the [FilePond documentation](https://pqina.nl/filepond/docs/patterns/getting-started/) | ||
[Getting started with FilePond](https://pqina.nl/filepond/docs/patterns/getting-started/) | ||
## License terms | ||
## License | ||
The free version of FilePond is licensed under [GPLv3](https://opensource.org/licenses/GPL-3.0). | ||
### Commercial license | ||
### What does this mean? | ||
If you want to use FilePond on commercial sites, themes, projects, and applications, the Commercial license is what you need. With the commercial license, your source code is kept proprietary. View the license options on the [pricing page](https://pqina.nl/filepond/pricing.html#commercial-license). | ||
* You **may** use this lib for any private projects which you do not plan to share or sell | ||
* You **may** use this lib for public projects as long as those projects are licensed under GPLv3 as well. | ||
* You **may not** remove the license and PQINA attribution from source files | ||
### Open source license | ||
For more information read the [repository license details](https://github.com/pqina/filepond/blob/master/LICENSE). | ||
If you're working on an open source project under a license compatible with [GPLv3](https://opensource.org/licenses/GPL-3.0), you may use FilePond under the terms of the GPLv3. | ||
If the GPLv3 license does not match your use case, the [commercial license](https://pqina.nl/filepond/pricing.html#commercial-license) might be more suitable. | ||
### Commercial use | ||
Interested in using FilePond for a project without being restricted by the GPLv3 requirements, view the license options on the [pricing page](https://pqina.nl/filepond/pricing.html#commercial-license). | ||
For more information you can [read the full license here](https://pqina.nl/filepond/license). |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
595513
10
13243
104