Module: TurboStreamActionsHelper

Defined in:
app/helpers/turbo_stream_actions_helper.rb

Overview

View helper: turbo stream actions.

Instance Method Summary collapse

Instance Method Details

#analytics_event(event_name, properties = {}) ⇒ Object

Fire an analytics event
Usage: <%= turbo_stream.analytics_event("add_to_cart", { sku: "ABC123", price: 29.99 }) %>



136
137
138
139
140
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 136

def analytics_event(event_name, properties = {})
  turbo_stream_action_tag :analytics_event,
    'event-name': event_name,
    properties: properties.to_json
end

#bs_modal_hide ⇒ Object 



52
53
54
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 52

def bs_modal_hide
  turbo_stream_action_tag :bs_modal_hide
end

#bs_modal_show(modal_id) ⇒ Object

Show a Bootstrap modal by ID
Usage: <%= turbo_stream.bs_modal_show("myModalId") %>



48
49
50
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 48

def bs_modal_show(modal_id)
  turbo_stream_action_tag :bs_modal_show, 'modal-id': modal_id
end

#bs_offcanvas_hide(offcanvas_id) ⇒ Object

Hide a Bootstrap offcanvas by ID
Usage: <%= turbo_stream.bs_offcanvas_hide("offcanvas-id") %>



58
59
60
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 58

def bs_offcanvas_hide(offcanvas_id)
  turbo_stream_action_tag :bs_offcanvas_hide, target: offcanvas_id
end

#clear_elements_id_prefix_except(id_prefix, except_id) ⇒ Object 



102
103
104
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 102

def clear_elements_id_prefix_except(id_prefix, except_id)
  turbo_stream_action_tag :clear_elements_id_prefix_except, 'id-prefix': id_prefix, 'except-id': except_id
end

#clear_elements_matching(*selectors) ⇒ Object 



98
99
100
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 98

def clear_elements_matching(*selectors)
  turbo_stream_action_tag :clear_elements_matching, selectors: selectors.flatten.compact.to_json
end

#clear_modal ⇒ Object 



116
117
118
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 116

def clear_modal
  turbo_stream_action_tag :clear_modal
end

#hide_element(element_id) ⇒ Object

Hide an element by ID (adds display:none)
Usage: <%= turbo_stream.hide_element("elementId") %>



70
71
72
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 70

def hide_element(element_id)
  turbo_stream_action_tag :hide_element, 'element-id': element_id
end

#init_bootstrap(target_id, component: nil) ⇒ Object

Initialize Bootstrap components after a Turbo Stream update
Usage: <%= turbo_stream.init_bootstrap("messages_list", component: "Tooltip") %>
Supported: Tooltip, Popover, Collapse, Dropdown (or nil for all)



84
85
86
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 84

def init_bootstrap(target_id, component: nil)
  turbo_stream_action_tag :init_bootstrap, target: target_id, component: component
end

#open_url(url) ⇒ Object

Open a URL in a new browser tab (for PDFs, downloads, etc.)
Usage: turbo_stream.open_url(upload_url(@pdf))



12
13
14
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 12

def open_url(url)
  turbo_stream_action_tag :open_url, url: url
end

#redirect(url) ⇒ Object

Full-page redirect via Turbo Drive (breaks out of Turbo Frame context)
Usage: turbo_stream.redirect("/my-account")



6
7
8
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 6

def redirect(url)
  turbo_stream_action_tag :redirect, url: url
end

#remove_hidden_inputs(name_contains:, value:) ⇒ Object

Remove hidden inputs whose value matches value and whose name attribute
contains name_contains. Used after destroying a nested-form record so the
leftover hidden inputs (rendered for the destroyed row) do not get
re-submitted with the parent form on its next save.
Usage:
<%= turbo_stream.remove_hidden_inputs(name_contains: 'contact_points_attributes',
value: @contact_point.id) %>

Raises:

  • (ArgumentError) 


167
168
169
170
171
172
173
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 167

def remove_hidden_inputs(name_contains:, value:)
  raise ArgumentError, 'remove_hidden_inputs: value must not be blank' if value.blank?

  turbo_stream_action_tag :remove_hidden_inputs,
    'name-contains': name_contains,
    value: value.to_s
end

#replace_css_class(selector, pattern, replacement, traverse: 0) ⇒ Object

Replace CSS classes matching a regex pattern with a replacement class
Usage: <%= turbo_stream.replace_css_class(".my-selector", "status-\w+", "status-7") %>
Pass traverse: N to walk up N parent levels before replacing.



77
78
79
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 77

def replace_css_class(selector, pattern, replacement, traverse: 0)
  turbo_stream_action_tag :replace_css_class, selector: selector, pattern: pattern, replacement: replacement, traverse: traverse
end

#replace_history_state(path) ⇒ Object

Rewrite the browser URL via history.replaceState without navigating —
e.g. to restore a "return path" after a Turbo Stream update. Replaces the
need for an inline in the .turbo_stream.erb view. The JS handler
preserves history.state so Turbo's Back restoration keeps working.
Usage: turbo_stream.replace_history_state(@return_path)



156
157
158
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 156

def replace_history_state(path)
  turbo_stream_action_tag :replace_history_state, path: path
end

#reset_activity_card_collapse(container_dom_id) ⇒ Object 



112
113
114
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 112

def reset_activity_card_collapse(container_dom_id)
  turbo_stream_action_tag :reset_activity_card_collapse, 'container-id': container_dom_id
end

#set_input_value_by_selector(selector, value) ⇒ Object 



94
95
96
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 94

def set_input_value_by_selector(selector, value)
  turbo_stream_action_tag :set_input_value_by_selector, selector: selector, value: value.to_s
end

#set_tab_param(tab_id) ⇒ Object

Update the ?tab=<id> query param in the browser URL via replaceState
without triggering a navigation. Used by the warehouse stream actions
when the originating tab disappears (count went to 0) so the URL keeps
reflecting the tab actually being shown.
Usage: turbo_stream.set_tab_param("picking")



147
148
149
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 147

def set_tab_param(tab_id)
  turbo_stream_action_tag :set_tab_param, tab: tab_id
end

#set_value(target_id, value) ⇒ Object

Set an input/textarea value by target ID
Avoids inline tags and .html_safe for passing data to form fields.
Usage: turbo_stream.set_value("room_name", @room_name)



130
131
132
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 130

def set_value(target_id, value)
  turbo_stream_action_tag :set_value, target: target_id, value: value.to_s
end

#show_element(element_id) ⇒ Object

Show an element by ID (removes display:none)
Usage: <%= turbo_stream.show_element("elementId") %>



64
65
66
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 64

def show_element(element_id)
  turbo_stream_action_tag :show_element, 'element-id': element_id
end

#sync_calendar_event ⇒ Object

Sync a CRM calendar event (legacy: uses data-attribute template on #event_calendar)
Used by crm/events/create.turbo_stream.erb



108
109
110
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 108

def sync_calendar_event
  turbo_stream_action_tag :sync_calendar_event
end

#toast(content = nil, &block) ⇒ Object

Show a toast notification
Usage: <%= turbo_stream.toast do %>...<% end %>



122
123
124
125
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 122

def toast(content = nil, &block)
  template = content || (block ? @view_context.capture(&block) : nil)
  turbo_stream_action_tag :toast, template: template
end

#track_download(url, filename: nil, worker: nil, disposition: nil) ⇒ Object

Surface a downloadable file in the global Jobs offcanvas as a "Ready"
entry AND auto-trigger an immediate browser action. The offcanvas
entry is the always-visible fallback when the auto-trigger is
suppressed by the browser's pop-up blocker (common after multi-redirect
server flows like print_pick_slip → upload_url → redirect).

Disposition (default: :attachment) controls the auto-trigger:

  • :attachment → forces save-as via . Browser ignores the
    target attribute when download is set, so no tab opens.
  • :inline → opens in a new tab via . The
    server's Content-Disposition header decides whether the browser
    renders inline (PDFs in the in-browser viewer) or saves anyway.

Filename and worker label are optional; filename defaults to the
basename of the URL path on the client side; worker defaults to
"Download".

Usage:
turbo_stream.track_download(upload_url(@pdf))
turbo_stream.track_download(upload_url(@pdf), filename: 'invoice.pdf')
turbo_stream.track_download(upload_url(@pdf), worker: 'Print Pick Slip')
turbo_stream.track_download(upload_url(@pdf), disposition: :inline)



38
39
40
41
42
43
44
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 38

def track_download(url, filename: nil, worker: nil, disposition: nil)
  turbo_stream_action_tag :track_download,
    url: url,
    filename: filename,
    worker: worker,
    disposition: disposition.to_s.presence
end

#unblock_ui ⇒ Object

Clear jquery-blockUI overlay after Turbo Stream updates
Usage: <%= turbo_stream.unblock_ui %>



90
91
92
 
# File 'app/helpers/turbo_stream_actions_helper.rb', line 90

def unblock_ui
  turbo_stream_action_tag :unblock_ui
end