class ActionText::RichText

Action Text `RichText`

Запись RichText содержит контент, созданный редактором Trix и сериализованный в атрибуте body. Она также содержит все ссылки на встроенные файлы, которые хранятся с помощью Active Storage. Затем эта запись связывается с моделью Active Record, в которой приложение желает иметь форматированный текст, с помощью метода класса has_rich_text.

class Message < ActiveRecord::Base
  has_rich_text :content
end

message = Message.create!(content: "<h1>Funny times!</h1>")
message.content #=> #<ActionText::RichText....
message.content.to_s # => "<h1>Funny times!</h1>"
message.content.to_plain_text # => "Funny times!"

message = Message.create!(content: "<div onclick='action()'>safe<script>unsafe</script></div>")
message.content #=> #<ActionText::RichText....
message.content.to_s # => "<div>safeunsafe</div>"
message.content.to_plain_text # => "safeunsafe"

Открытые методы экземпляра

embeds () Показать исходный код

# File actiontext/app/models/action_text/rich_text.rb, line 55
has_many_attached :embeds

Возвращает записи ActiveStorage::Attachment для встроенных файлов.

Записи ActiveStorage::Blob вложений извлекаются из body в обратном вызове before_validation.

record () Показать исходный код

# File actiontext/app/models/action_text/rich_text.rb, line 46
belongs_to :record, polymorphic: true, touch: true

Возвращает связанную запись.

to_plain_text () Показать исходный код

# File actiontext/app/models/action_text/rich_text.rb, line 72
def to_plain_text
  body&.to_plain_text.to_s
end

Возвращает текстовую версию разметки из атрибута body без тегов, но с закодированными HTML-сущностями.

message = Message.create!(content: "<h1>Funny times!</h1>")
message.content.to_plain_text # => "Funny times!"

ПРИМЕЧАНИЕ: возвращаемая строка не является безопасной для HTML и не должна отображаться в браузерах.

message = Message.create!(content: "&lt;script&gt;alert()&lt;/script&gt;")
message.content.to_plain_text # => "<script>alert()</script>"

to_s () Показать исходный код

# File actiontext/app/models/action_text/rich_text.rb, line 39
serialize :body, coder: ActionText::Content

Безопасно преобразует RichText в HTML-строку String.

message = Message.create!(content: "<h1>Funny times!</h1>")
message.content.to_s # => "<h1>Funny times!</h1>"

message = Message.create!(content: "<div onclick='action()'>safe<script>unsafe</script></div>")
message.content.to_s # => "<div>safeunsafe</div>"

to_trix_html () Показать исходный код

# File actiontext/app/models/action_text/rich_text.rb, line 88
def to_trix_html
  body&.to_trix_html
end

Возвращает атрибут body в формате, позволяющем редактировать его в редакторе Trix. Предварительные просмотры вложений отображаются внутри текста.

content = "<h1>Funny Times!</h1><figure data-trix-attachment='{\"sgid\":\"..."\}'></figure>"
message = Message.create!(content: content)
message.content.to_trix_html # =>
# <div class="trix-content">
#   <h1>Funny times!</h1>
#   <figure data-trix-attachment='{\"sgid\":\"..."\}'>
#      <img src="http://example.org/rails/active_storage/.../funny.jpg">
#   </figure>
# </div>

class ActionText::RichText

Action Text RichText

Action Text `RichText`