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.
Namespace
Module
- ActionText::Attachable
- ActionText::Attachables
- ActionText::Attachments
- ActionText::Attribute
- ActionText::ContentHelper
- ActionText::Encryption
- ActionText::HtmlConversion
- ActionText::PlainTextConversion
- ActionText::Serialization
- ActionText::SystemTestHelper
- ActionText::TagHelper
- ActionText::VERSION
Class
- ActionText::Attachment
- ActionText::AttachmentGallery
- ActionText::Content
- ActionText::EncryptedRichText
- ActionText::Engine
- ActionText::FixtureSet
- ActionText::Fragment
- ActionText::RichText
- ActionText::TrixAttachment
Methods
Class Public methods
gem_version()
Returns the currently loaded version of Action Text as a Gem::Version.
π Source code
# File actiontext/lib/action_text/gem_version.rb, line 5
def self.gem_version
Gem::Version.new VERSION::STRING
endhtml_document_class()
π Source code
# File actiontext/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
endhtml_document_fragment_class()
π Source code
# File actiontext/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
endversion()
Returns the currently loaded version of Action Text as a Gem::Version.
π Source code
# File actiontext/lib/action_text/version.rb, line 7
def self.version
gem_version
end