🌊 A flexible and fun JavaScript file upload library
Installations
npm install filepondDeveloper
Developer Guide
Module System
CommonJS, UMD
Min. Node Version
Typescript Support
Yes
Node Version
10.15.3
NPM Version
6.4.1
Statistics
15,233 Stars
772 Commits
828 Forks
158 Watching
7 Branches
76 Contributors
Updated on 28 Nov 2024
Bundle Size
117.23 kB
Minified
33.67 kB
Minified + Gzipped
Languages
JavaScript (95.83%)
CSS (4.03%)
HTML (0.14%)
Total Downloads
Cumulative downloads
Total Downloads
19,641,667
Last day
20.3%
36,025
Compared to previous day
Last week
2.3%
167,157
Compared to previous week
Last month
27.4%
655,873
Compared to previous month
Last year
33.9%
5,788,198
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
21
A JavaScript library that can upload anything you throw at it, optimizes images for faster uploads, and offers a great, accessible, silky smooth user experience.
FilePond adapters are available for React, Vue, Angular, Svelte, and jQuery
Buy me a Coffee / Use FilePond with Pintura / Dev updates on Twitter
Core Features
- Accepts directories, files, blobs, local URLs, remote URLs and Data URIs.
- Drop files, select on filesystem, copy and paste files, or add files using the API.
- Async uploads with AJAX, supports chunk uploads, can 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, filtering, and fixes EXIF orientation.
- Responsive, automatically scales to available space, is functional on both mobile and desktop devices.
Also need Image Editing?
Pintura the modern JavaScript Image Editor is what you're looking for. Pintura supports setting crop aspect ratios, resizing, rotating, cropping, and flipping images. Above all, it integrates beautifully with FilePond.
Live Demos
Plugins
- File encode
- File rename
- File size validation
- File type validation
- File metadata
- File poster
- Image editor
- Image size validation
- Image preview
- Image crop
- Image filter
- Image resize
- Image transform
- Image EXIF orientation
- Image overlay (nielsboogaard/filepond-plugin-image-overlay)
- Media preview (nielsboogaard/filepond-plugin-media-preview)
- Media preview + PDF preview (ErnestBrandi/filepond-plugin-media-preview)
- Get file (nielsboogaard/filepond-plugin-get-file)
- Zip Directory Uploads (tzsk/filepond-plugin-zipper)
- PDF Preview (Adri-Glez/filepond-plugin-pdf-preview)
- PDF Convert (alexandreDavid/filepond-plugin-pdf-convert)
- Copy Path (jnkn6/filepond-plugin-copy-path)
Adapters
- React
- Vue
- Svelte
- jQuery
- Angular
- Angular 1 (johnnyasantoss/angularjs-filepond)
- Blazor (soenneker/soenneker.blazor.filepond)
- Ember (alexdiliberto/ember-filepond)
Backend
- PHP
- Django (ImperialCollegeLondon/django-drf-filepond)
- Laravel (Sopamo/laravel-filepond)
- Laravel (Albert221/laravel-filepond)
- SilverStripe (lekoala/silverstripe-filepond)
- Ruby on Rails (Code-With-Rails/filepond-rails)
Quick Start
Install using npm:
1npm install filepond
Then import in your project:
1import * as FilePond from 'filepond'; 2 3// Create a multi file upload component 4const pond = FilePond.create({ 5 multiple: true, 6 name: 'filepond', 7}); 8 9// Add it to the DOM 10document.body.appendChild(pond.element);
Or get it from a CDN:
1<!DOCTYPE html> 2<html> 3 <head> 4 <title>FilePond from CDN</title> 5 6 <!-- Filepond stylesheet --> 7 <link href="https://unpkg.com/filepond/dist/filepond.css" rel="stylesheet" /> 8 </head> 9 <body> 10 <!-- We'll transform this input into a pond --> 11 <input type="file" class="filepond" /> 12 13 <!-- Load FilePond library --> 14 <script src="https://unpkg.com/filepond/dist/filepond.js"></script> 15 16 <!-- Turn all file input elements into ponds --> 17 <script> 18 FilePond.parse(document.body); 19 </script> 20 </body> 21</html>
Internationalization
The locale folder contains different language files, PR's are welcome, you can use locale files like this:
1import pt_BR from 'filepond/locale/pt-br.js';
2
3FilePond.setOptions(pt_BR);Contributing
At the moment test coverage is not great, it's around 65%. To accept pull requests the tests need to be better, any help to improve them is very much appreciated.
Tests are based on Jest and can be run with npm run test
To build the library run npm run build
Publications
- Using FilePond with NodeJS
- Applying Watermarks to Images with FilePond
- Generating Image Thumbnails in the Browser using JavaScript and FilePond
- How to upload files with Vue and FilePond
- Smooth file uploading with React and FilePond
- 5 interesting technical challenges I faced while building FilePond
- Image uploads with Laravel and FilePond
- Integrating FilePond with Ember
- FilePond launch day post-mortem
- FilePond on ProductHunt
Browser Compatibility
FilePond is compatible with a wide range of desktop and mobile browsers, the oldest explicitly supported browser is IE11, for best cross browser support add FilePond Polyfill and Babel polyfill to your project.
FilePond uses BrowserStack for compatibility testing.
License
Please don't remove or change the disclaimers in the source files
MIT License
Copyright (c) 2020 PQINA | Rik Schennink
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
No vulnerabilities found.
Reason
22 commit(s) and 22 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 5/16 approved changesets -- score normalized to 3
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 19 are checked with a SAST tool
Reason
56 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
- Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
3.4
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More