{"id":14955569,"url":"https://github.com/blocknotes/activeadmin_froala_editor","last_synced_at":"2025-10-08T18:02:07.122Z","repository":{"id":40211930,"uuid":"106963650","full_name":"blocknotes/activeadmin_froala_editor","owner":"blocknotes","description":"Froala WYSIWYG editor for ActiveAdmin","archived":false,"fork":false,"pushed_at":"2025-03-22T14:11:04.000Z","size":3022,"stargazers_count":43,"open_issues_count":1,"forks_count":22,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T01:06:22.425Z","etag":null,"topics":["activeadmin","activeadmin-plugin","rails","rails5","ruby","ruby-on-rails"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blocknotes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["blocknotes"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2017-10-14T21:18:24.000Z","updated_at":"2025-03-22T14:11:06.000Z","dependencies_parsed_at":"2024-06-21T07:10:58.071Z","dependency_job_id":"b0eb7cd4-2e71-4983-bfd8-a5b3929bc62a","html_url":"https://github.com/blocknotes/activeadmin_froala_editor","commit_stats":{"total_commits":63,"total_committers":5,"mean_commits":12.6,"dds":0.4920634920634921,"last_synced_commit":"60909941b81290e1d6e1807d20ad1c440f168dd5"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blocknotes%2Factiveadmin_froala_editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blocknotes%2Factiveadmin_froala_editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blocknotes%2Factiveadmin_froala_editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blocknotes%2Factiveadmin_froala_editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blocknotes","download_url":"https://codeload.github.com/blocknotes/activeadmin_froala_editor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137887,"owners_count":21053775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["activeadmin","activeadmin-plugin","rails","rails5","ruby","ruby-on-rails"],"created_at":"2024-09-24T13:11:23.113Z","updated_at":"2025-10-08T18:02:07.116Z","avatar_url":"https://github.com/blocknotes.png","language":"CSS","readme":"# ActiveAdmin Froala Editor\n[![gem version](https://badge.fury.io/rb/activeadmin_froala_editor.svg)](https://badge.fury.io/rb/activeadmin_froala_editor)\n[![gem downloads](https://badgen.net/rubygems/dt/activeadmin_froala_editor)](https://rubygems.org/gems/activeadmin_froala_editor)\n[![linters](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/linters.yml)\n[![Specs Rails 7.0](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails70.yml/badge.svg)](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails70.yml)\n[![Specs Rails 8.0](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails80.yml/badge.svg)](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails80.yml)\n\nAn Active Admin plugin to use [Froala WYSIWYG editor](https://github.com/froala/wysiwyg-editor) (jQuery required, font-awesome required \u0026 included). For Froala license / pricing see Froala website.\n\nFeatures:\n- permits to include an easy to use rich editor in Active Admin;\n- customizable options via data attributes in the form input;\n- plugins included, like images upload.\n\n![screenshot](extra/screenshot.png)\n\nPlease :star: if you like it.\n\n## Install\n\n*NOTE*: if you are using Ruby \u003c 3.0, please use Activeadmin Froala Editor 1.0.0\n\nAfter installing Active Admin, add to your Gemfile: `gem 'activeadmin_froala_editor'` (and execute *bundle*)\n\nIf you installed Active Admin **without Webpacker** support:\n\n- Add a SASS/SCSS gem to your Gemfile (ex. `gem 'sassc'`)\n- Add at the end of your Active Admin styles (_app/assets/stylesheets/active_admin.scss_):\n```css\n@import 'font-awesome/font-awesome';\n@import 'activeadmin/froala_editor_input';\n```\n- Add at the end of your Active Admin javascripts (_app/assets/javascripts/active_admin.js_):\n```js\n//= require activeadmin/froala_editor/froala_editor.pkgd.min\n//= require activeadmin/froala_editor_input\n```\n- Use the input with `as: :froala_editor` in Active Admin model conf\n\nOtherwise **with Webpacker**:\n\n- Execute in your project root:\n\n```sh\nyarn add blocknotes/activeadmin_froala_editor\n```\n\n- Add to your *app/javascript/packs/active_admin.js*:\n\n```js\nrequire('activeadmin_froala_editor')\n```\n\n## Notes\n\n- To use this plugins with Active Admin 1.x please use the version [0.1.3](https://github.com/blocknotes/activeadmin_froala_editor/releases/tag/v0.1.3)\n- **data-options**: permits to set *froala editor* options directly from the form field (examples below) - see [options list](https://www.froala.com/wysiwyg-editor/docs/options)\n\n## Examples\n\n### Basic usage\n\n```ruby\n# Active Admin article form conf:\n  form do |f|\n    f.inputs 'Article' do\n      f.input :title\n      f.input :description, as: :froala_editor\n      f.input :published\n    end\n    f.actions\n  end\n```\n\n### Toolbar buttons configuration\n\n```ruby\n# Form field\nf.input :description, as: :froala_editor, input_html: { data: { options: { toolbarButtons: ['undo', 'redo', '|', 'bold', 'italic'] } } }\n```\n\n### Froala upload plugin\n\n```ruby\n# Upload method (to be included in the admin entity configuration)\nmember_action :upload, method: [:post] do\n  success = resource.images.attach(params[:file_upload])\n  result = success ? { link: url_for(resource.images.last) } : {}\n  render json: result\nend\n```\n\n```ruby\n# Form field\nf.input :description, as: :froala_editor, input_html: { data: { options: { imageUploadParam: 'file_upload', imageUploadURL: upload_admin_post_path(resource.id), toolbarButtons: %w[bold italic underline | insertImage insertVideo insertFile] } } }\n```\n\nFor the relevant files of an upload example see [here](examples/upload_plugin_using_activestorage/).\nConsider that this is just a basic example: images are uploaded as soon as they are attached to the\n editor (regardless of the form submit), it shows the editor only for an existing record (because of\nthe *upload_admin_post_path*) and it doesn't provide a way to remove images (just deleting them from\nthe editor will not destroy them, you'll need to implement a purge logic for that).\n\n## Changelog\n\nThe changelog is available [here](CHANGELOG.md).\n\n## Development\n\nProject created by [Mattia Roccoberton](http://blocknot.es), thanks also to the good guys that opened issues and pull requests from time to time.\n\nFor development information please check [this document](extra/development.md).\n\n## Do you like it? Star it!\n\nIf 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=✓\u0026tab=repositories\u0026q=activeadmin\u0026type=source).\n\nOr consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).\n\n## License\n\nThe gem is available as open-source under the terms of the [MIT](LICENSE.txt).\n\nFor Froala editor License: see [Froala website](https://froala.com/wysiwyg-editor/).\n","funding_links":["https://github.com/sponsors/blocknotes"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblocknotes%2Factiveadmin_froala_editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblocknotes%2Factiveadmin_froala_editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblocknotes%2Factiveadmin_froala_editor/lists"}