module ActionText

Action Text¶ ↑

Action Text brings rich text content and editing to Rails. It includes the Trix editor that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that’s associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.

You can read more about Action Text in the Action Text Overview guide.

Development¶ ↑

The JavaScript for Action Text is distributed both as a npm module under @rails/actiontext and via the asset pipeline as actiontext.js (and we mirror Trix as trix.js). To ensure that the latter remains in sync, you must run yarn build and checkin the artifacts whenever the JavaScript source or the Trix dependency is bumped. CSS changes must be brought over manually to app/assets/stylesheets/trix.css

License¶ ↑

Action Text is released under the MIT License.

Public Class Methods

gem_version() click to toggle source

Returns the currently loaded version of Action Text as a Gem::Version.

# File lib/action_text/gem_version.rb, line 7
def self.gem_version
  Gem::Version.new VERSION::STRING
end

html_document_class() click to toggle source

# File lib/action_text.rb, line 47
def html_document_class
  return @html_document_class if defined?(@html_document_class)
  @html_document_class =
    defined?(Nokogiri::HTML5) ? Nokogiri::HTML5::Document : Nokogiri::HTML4::Document
end

html_document_fragment_class() click to toggle source

# File lib/action_text.rb, line 53
def html_document_fragment_class
  return @html_document_fragment_class if defined?(@html_document_fragment_class)
  @html_document_fragment_class =
    defined?(Nokogiri::HTML5) ? Nokogiri::HTML5::DocumentFragment : Nokogiri::HTML4::DocumentFragment
end

version() click to toggle source

Returns the currently loaded version of Action Text as a Gem::Version.

# File lib/action_text/version.rb, line 9
def self.version
  gem_version
end