mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Some basic documentation for the has_rich_text macro
This commit is contained in:
parent
83d781ed01
commit
228044c5c2
1 changed files with 18 additions and 0 deletions
|
@ -3,6 +3,24 @@ module ActionText
|
|||
extend ActiveSupport::Concern
|
||||
|
||||
class_methods do
|
||||
# Provides access to a dependent RichText model that holds the body and attachments for a single named rich text attribute.
|
||||
# This dependent attribute is lazily instantiated and will be auto-saved when it's been changed. Example:
|
||||
#
|
||||
# class Message < ActiveRecord::Base
|
||||
# has_rich_text :content
|
||||
# end
|
||||
#
|
||||
# message = Message.create!(content: "<h1>Funny times!</h1>")
|
||||
# message.content.to_s # => "<h1>Funny times!</h1>"
|
||||
# message.content.body.to_plain_text # => "Funny times!"
|
||||
#
|
||||
# The dependent RichText model will also automatically process attachments links as sent via the Trix-powered editor.
|
||||
# These attachments are associated with the RichText model using Active Storage.
|
||||
#
|
||||
# If you wish to preload the dependent RichText model, you can use the named scope:
|
||||
#
|
||||
# Message.all.with_rich_text_content # Avoids N+1 queries when you just want the body, not the attachments.
|
||||
# Message.all.with_rich_text_content_and_emebds # Avoids N+1 queries when you just want the body and attachments.
|
||||
def has_rich_text(name)
|
||||
class_eval <<-CODE, __FILE__, __LINE__ + 1
|
||||
def #{name}
|
||||
|
|
Loading…
Reference in a new issue