filepond-rails, a Ruby on Rails gem to integrate with FilePond
What is filepond-rails?
filepond-rails is a Ruby on Rails gem for Rails version 7.0.x and above to allow easy plug and play functionality with FilePond and Rails.
The GitHub repository is located at https://github.com/Code-With-Rails/filepond-rails.
- Rails 7.0.x and above
- Use of importmap-rails (optional)
Add this line to your application's Gemfile:
And then run:
Add the following to your
*= require 'filepond'
head section of your layout:
Rails.application.routes.draw do mount Filepond::Rails::Engine, at: '/filepond' end
Note: You must mount the routes at
This gem compromises of two parts:
- An ingress controller for the FilePond
At the present moment, the above parts are designed (and assumed) to work together.
The gem assumes that you set up your models and Active Storage configuration in a standard Rails way. Assuming you have a form that looks like this:
<%= form_with model: @user, url: update_avatar_path, method: :post do |f| %> <%= f.label :avatar, 'Update your avatar' %> <%= f.file_field :avatar, class: 'filepond', direct_upload: true %> <%= f.button 'Update' %> <% end %>
You can instantiate the
file_field component like so:
FilePond(which corresponds to the original FilePond library)
FilePondRails(which is a convenience helper that integrates and sets up FilePond to work with our
The gem is available as open source under the terms of the MIT License.