filepond on GitHub (pqina/filepond)

filepond README

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.

npm

FilePond adapters are available for React, Vue, Angular, Svelte, and jQuery

FilePond v5 Alpha version now available for testing

Documentation • Discord • Examples

Buy me a Coffee • Use FilePond with Pintura • Dev updates

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.

Learn more about FilePond

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.

Learn more about Pintura

Live Demos

Plugins

Adapters

Backend

Quick Start

Install using npm:

npm install filepond

Then import in your project:

import * as FilePond from 'filepond';

// Create a multi file upload component
const pond = FilePond.create({
    multiple: true,
    name: 'filepond',
});

// Add it to the DOM
document.body.appendChild(pond.element);

Or get it from a CDN:

<!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>

        <!-- Turn all file input elements into ponds -->
        <script>
            FilePond.parse(document.body);
        </script>
    </body>
</html>

Getting started with FilePond

Internationalization

The locale folder contains different language files, PR's are welcome, you can use locale files like this:

import pt_BR from 'filepond/locale/pt-br.js';

FilePond.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

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

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.

16.4K ·GitHub

Filepond

What is this?

FilePond is a JavaScript file upload library that handles drag-and-drop, file selection, and async uploads while automatically optimizing images (resize, crop, filter, EXIF fix) for a smooth, accessible upload experience.

Is it a standalone library or does it need a framework?

It's a vanilla JavaScript library at its core, with official adapters that wrap it for React, Vue, Angular, Svelte, and jQuery projects.

How do I add it to a project?

Install it with npm and import it into your code, or pull it in directly from a CDN script tag.

Do I need a specific backend to receive the uploads?

No particular backend is required, but the community maintains ready-made server integrations for PHP, Django, Laravel, SilverStripe, and Ruby on Rails to handle the upload endpoint.

How solid and well-tested is FilePond right now?

Test coverage is only around 65% by the maintainer's own admission, and if you need to support IE11 or other old browsers you must add the separate FilePond Polyfill and Babel polyfill yourself.

What image handling does FilePond do automatically?

It auto-resizes, crops, filters images, and fixes EXIF orientation on the fly before upload, so images arrive optimized without extra code.

Can I edit images before uploading, like crop or rotate?

FilePond itself focuses on upload UX, but it integrates with Pintura, the author's separate JavaScript image editor, to add crop, rotate, resize, and flip tools.

What plugins can extend FilePond's behavior?

There are official plugins for file encode, rename, size/type validation, metadata, poster images, and image preview, crop, resize, filter, and transform, plus several community plugins for things like PDF preview and zip uploads.

How are files actually sent to the server?

FilePond uploads asynchronously over AJAX, supports chunked uploads for large files, and can also encode files as base64 or send them along with a normal form post.

What are similar projects?

interact.js, jQuery-File-Upload, bootstrap-table, dnd-kit, react-dropzone, sweetalert2, lenis, dragula

Which topics is it in?

vanilla-js, file-upload, cross-browser, drag-and-drop, responsive, npm-package, accessibility, i18n, image-processing, vue, testing, plugin

Creator: pqina
Size: 8.8 MB
Stars: 16.4K
Updated: CommitJul 13 Release4.28.2Jun 09
Age: 9y
Commits · 90 Days