Module: Cybertrain::Turbo

Defined in:
cybertrain/turbo.rb

Overview

Turbo Stream elements (turbo-rails’ turbo_stream.replace and the rest), built in Ruby: what Stream.broadcast_replace_to and friends send, and what an action can answer with for a text/vnd.turbo-stream.html request.

Cybertrain::Turbo.replace(article, Cybertrain::Html.safe(“<p>x</p>”)) # =>

A target is a DOM id String, or a record, whose DOM id is its snake-cased model name and id (article_12). The HTML is escaped unless it is a SafeString.

Class Method Summary collapse

Class Method Details

.after(target, html) ⇒ SafeString

Returns:



40
# File 'cybertrain/turbo.rb', line 40

def self.after(target, html) = Turbo.action("after", target, html)

.append(target, html) ⇒ SafeString

Returns:



28
# File 'cybertrain/turbo.rb', line 28

def self.append(target, html) = Turbo.action("append", target, html)

.before(target, html) ⇒ SafeString

Returns:



36
# File 'cybertrain/turbo.rb', line 36

def self.before(target, html) = Turbo.action("before", target, html)

.prepend(target, html) ⇒ SafeString

Returns:



32
# File 'cybertrain/turbo.rb', line 32

def self.prepend(target, html) = Turbo.action("prepend", target, html)

.refresh ⇒ SafeString

<turbo-stream action="refresh">: the page reloads itself.

Returns:



56
57
58
# File 'cybertrain/turbo.rb', line 56

def self.refresh
  SafeString.of("<turbo-stream action=\"refresh\"></turbo-stream>")
end

.remove(target) ⇒ SafeString

<turbo-stream action="remove" target="...">, no template.

Returns:



45
46
47
48
49
50
51
# File 'cybertrain/turbo.rb', line 45

def self.remove(target)
  id = Html.escape(Turbo.target_text(target))
  out = +"<turbo-stream action=\"remove\" target=\""
  out << id
  out << "\"></turbo-stream>"
  SafeString.of(out)
end

.replace(target, html) ⇒ SafeString

Returns:



20
# File 'cybertrain/turbo.rb', line 20

def self.replace(target, html) = Turbo.action("replace", target, html)

.update(target, html) ⇒ SafeString

Returns:



24
# File 'cybertrain/turbo.rb', line 24

def self.update(target, html) = Turbo.action("update", target, html)