filepond README

The project's README from github.com/pqina/filepond. As one markdown file: README.md.

FilePond

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.

License: MIT npm version npm minzipped size Discord

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

FilePond v5 Alpha version now available for testing

Documentation • Discord • Examples

FilePond

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

Core Features

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.

BrowserStack

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.

filepond (pqina/filepond)

Searching Database…

16.4K ·GitHub
Filepond
Что это такое?FilePond — это библиотека JavaScript для загрузки файлов. Она поддерживает перетаскивание и выбор файлов, асинхронную загрузку и автоматически оптимизирует изображения (меняет размер, обрезает, применяет фильтры, исправляет EXIF), чтобы загрузка проходила плавно и была удобна для всех пользователей.
Это самостоятельная библиотека или ей нужен фреймворк?В основе это библиотека на чистом JavaScript. Официальные адаптеры оборачивают её для проектов на React, Vue, Angular, Svelte и jQuery.
Как добавить её в проект?Установите её через npm и импортируйте в код или подключите напрямую через тег script с CDN.
Нужен ли конкретный бэкенд для приёма загруженных файлов?Конкретный бэкенд не обязателен. Однако сообщество поддерживает готовые серверные интеграции для PHP, Django, Laravel, SilverStripe и Ruby on Rails, которые обрабатывают конечную точку загрузки.
Насколько надёжна и хорошо ли протестирована FilePond на данный момент?По собственному признанию автора, покрытие тестами составляет всего около 65%. Если нужна поддержка IE11 или других старых браузеров, придётся самостоятельно добавить отдельный FilePond Polyfill и Babel polyfill.
Какую обработку изображений FilePond делает автоматически?Перед отправкой она на лету меняет размер изображений, обрезает их, применяет фильтры и исправляет ориентацию по EXIF, так что изображения приходят на сервер оптимизированными без дополнительного кода.
Можно ли редактировать изображения перед загрузкой, например обрезать или повернуть?FilePond сама сосредоточена на удобстве загрузки, но она интегрируется с Pintura — отдельным редактором изображений на JavaScript от того же автора — и добавляет инструменты обрезки, поворота, изменения размера и отражения.
Какие плагины могут расширить возможности FilePond?Есть официальные плагины для кодирования файлов, переименования, проверки размера и типа, метаданных, постеров, а также для предпросмотра изображений, их обрезки, изменения размера, фильтрации и трансформации. Кроме того, есть несколько плагинов от сообщества, например для предпросмотра PDF и загрузки zip-архивов.
Как файлы на самом деле отправляются на сервер?FilePond загружает файлы асинхронно через AJAX, поддерживает загрузку по частям для больших файлов, а также может кодировать файлы в base64 или отправлять их вместе с обычной отправкой формы.
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 13Release4.28.2Jun 09
Age
9y
Commits · 90 Days