Module: Turbo::Streams::ActionHelper

Included in:
Broadcasts, TagBuilder
Defined in:
app/helpers/turbo/streams/action_helper.rb

Instance Method Summary collapse

Instance Method Details

#turbo_stream_action_tag(action, target: nil, targets: nil, template: nil) ⇒ Object

Creates a ‘turbo-stream` tag according to the passed parameters. Examples:

turbo_stream_action_tag "remove", target: "message_1"
# => <turbo-stream action="remove" target="message_1"></turbo-stream>

turbo_stream_action_tag "replace", target: "message_1", template: %(<div id="message_1">Hello!</div>)
# => <turbo-stream action="replace" target="message_1"><template><div id="message_1">Hello!</div></template></turbo-stream>

turbo_stream_action_tag "replace", targets: "message_1", template: %(<div id="message_1">Hello!</div>)
# => <turbo-stream action="replace" targets="message_1"><template><div id="message_1">Hello!</div></template></turbo-stream>



12
13
14
15
16
17
18
19
20
21
22
 
# File 'app/helpers/turbo/streams/action_helper.rb', line 12

def turbo_stream_action_tag(action, target: nil, targets: nil, template: nil)
  template = action.to_sym == :remove ? "" : "<template>#{template}</template>"

  if target = convert_to_turbo_stream_dom_id(target)
    %(<turbo-stream action="#{action}" target="#{target}">#{template}</turbo-stream>).html_safe
  elsif targets = convert_to_turbo_stream_dom_id(targets, include_selector: true)
    %(<turbo-stream action="#{action}" targets="#{targets}">#{template}</turbo-stream>).html_safe
  else
    raise ArgumentError, "target or targets must be supplied"
  end
end