Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blocknotes/activeadmin_jfu_upload
An ActiveAdmin plugin to use jQuery-File-Upload for file uploads in forms
https://github.com/blocknotes/activeadmin_jfu_upload
activeadmin activeadmin-plugin jquery rails5 ruby
Last synced: 8 days ago
JSON representation
An ActiveAdmin plugin to use jQuery-File-Upload for file uploads in forms
- Host: GitHub
- URL: https://github.com/blocknotes/activeadmin_jfu_upload
- Owner: blocknotes
- License: mit
- Created: 2018-02-24T08:38:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-18T18:03:56.000Z (over 2 years ago)
- Last Synced: 2024-10-29T14:15:21.847Z (17 days ago)
- Topics: activeadmin, activeadmin-plugin, jquery, rails5, ruby
- Language: Ruby
- Homepage:
- Size: 99.6 KB
- Stars: 12
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# ActiveAdmin jQuery File Upload
[](https://badge.fury.io/rb/activeadmin_jfu_upload) [](https://rubygems.org/gems/activeadmin_jfu_upload) [](https://github.com/blocknotes/activeadmin_jfu_upload/actions/workflows/linters.yml) [](https://github.com/blocknotes/activeadmin_jfu_upload/actions/workflows/specs.yml)
An ActiveAdmin 2.x plugin to use [jQuery-File-Upload](https://github.com/blueimp/jQuery-File-Upload) for file uploads in forms.
Features:
- AJAX uploads;
- chunked file uploads for large files;
- works with ActiveStorage.
The file is uploaded when selected, not when the form is submitted, that's why a record must exist for uploads.
## Install
- Update your Gemfile: `gem 'activeadmin_jfu_upload'` (and execute *bundle*)
- Add at the end of your ActiveAdmin styles (_app/assets/stylesheets/active_admin.scss_):
```css
@import 'activeadmin/jfu_upload_input';
```
- Add at the end of your ActiveAdmin javascripts (_app/assets/javascripts/active_admin.js_):
```js
//= require activeadmin/jfu_upload/jquery.fileupload
//= require activeadmin/jfu_upload_input
```
- Use the input with `as: :jfu_upload` in Active Admin model conf
Why 2 separated scripts? In this way you can include a different version of *jQuery-File-Upload* if you like.
## Options
**data-options**: permits to set *jQuery-File-Upload* options directly - see [options list](https://github.com/blueimp/jQuery-File-Upload/wiki/Options)
## Examples
```ruby
# ActiveAdmin article form conf:
# (optional) Upload action - an helper method is provided
member_action :jfu_upload, method: [:patch] do
render json: ActiveAdmin::JfuUpload::Engine::upload_file( request, params[:article][:cover], resource, :cover )
end
# Form setup
form do |f|
f.inputs 'Article' do
f.input :title
# Field setup - hint with file presence check using ActiveStorage
f.input :cover, as: :jfu_upload, hint: (object.avatar.attached? ? "Current: #{object.avatar.filename}" : nil) unless object.new_record?
f.input :published
end
f.actions
end
# Show setup (optional)
show do
attributes_table do
# ...
row :cover do |record|
image_tag url_for(record.cover) if record.cover.attached?
end
end
active_admin_comments
end
```
```ruby
# Chuncked upload (chunk size: 100 Kb) - checking presence with CarrierWave
f.input :cover, as: :jfu_upload, hint: f.object.cover? ? image_tag( f.object.cover.url ) : '', input_html: { data: { url: jfu_upload_admin_article_path( resource.id ), options: { maxChunkSize: 100000 } } } unless f.object.new_record?
```
More example in [spec dummy app](spec/dummy/app/admin).
## Notes
- The string field for the upload is used to store temp data, so it could be necessary to make it bigger
- If you want to customize the upload action take a look [here](lib/activeadmin/jfu_upload/engine.rb)
- Tested with CarrierWave uploader gem and with ActiveStorage
- To use this plugins with ActiveAdmin 1.x please use the version 0.1.8
## Do you like it? Star it!
If you use this component just star it. A developer is more motivated to improve a project when there is some interest. My other [Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source).
Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
## Contributors
- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer
## License
[MIT](LICENSE.txt)