rails--rails/README.md

Action Text

🤸‍♂️💰📝

Installing

Assumes a Rails 5.2+ application with Active Storage and Webpacker installed.

1. Install the gem:

   # Gemfile
   gem "activetext", github: "basecamp/activetext", require: "action_text"
   gem "mini_magick" # for Active Storage variants
   

2. Install the npm package:

   // package.json
   "dependencies": {
     "activetext": "basecamp/activetext"
   }
   

   $ yarn install
   

   // app/javascript/packs/application.js
   import "activetext"
   

3. Declare text columns as Action Text attributes:

   # app/models/message.rb
   class Message < ActiveRecord::Base
     has_rich_text :content
   end
   

4. Replace form text_areas with rich_text_fields:

   <%# app/views/messages/_form.html.erb %>
   <%= form_with(model: message) do |form| %>
     …
     <div class="field">
       <%= form.label :content %>
       <%= form.rich_text_field :content %>
     </div>
     …
   <% end %>