Module: Phlex::Reactive::Streamable

Extended by:
ActiveSupport::Concern
Defined in:
lib/phlex/reactive/streamable.rb

Overview

Streamable gives a self-contained Phlex component the ability to render ITSELF as a Turbo Stream and to broadcast itself over a stream. Every streamable component must implement ‘#id` returning a stable DOM id —that id is the Turbo Stream target, so you never hand-pick targets.

Class methods (use in controllers):

render turbo_stream: Counter.replace(counter)
render turbo_stream: [Row.append(target: "items", model: @item),
                      Totals.update(@order)]

Broadcast methods (use in models/jobs/actions):

Counter.broadcast_replace_to(counter, model: counter)
Row.broadcast_append_to(@list, target: "items", model: @item)

Convention: the ‘id` you set on the root element in `view_template` must equal what `#id` returns, so replace/broadcast_replace target it.

NOTE: we intentionally do NOT include Turbo::Streams::ActionHelper — it pulls in ActionView::Helpers::TagHelper, which overrides Phlex’s internal ‘tag` method and breaks rendering. We use Turbo::Streams::TagBuilder directly instead.

Instance Method Summary collapse

Instance Method Details

#dom_id(record, prefix = nil) ⇒ Object

Render-context-free dom_id, safe to use inside ‘#id`. The streamable machinery calls `#id` BEFORE rendering, so Phlex’s render-time ‘dom_id` helper would raise HelpersCalledBeforeRenderError. This delegates to ActionView::RecordIdentifier, which works anywhere — so `def id = dom_id(@todo)` is safe.



177
178
179
 
# File 'lib/phlex/reactive/streamable.rb', line 177

def dom_id(record, prefix = nil)
  ::ActionView::RecordIdentifier.dom_id(record, prefix)
end

#id ⇒ Object

Required: the stable DOM id used as the Turbo Stream target. It MUST match the id set on the component’s root element in ‘view_template`.

Raises:

  • (NotImplementedError) 


168
169
170
 
# File 'lib/phlex/reactive/streamable.rb', line 168

def id
  raise NotImplementedError, "#{self.class} must implement #id for Turbo Stream targeting"
end

#to_stream_replace ⇒ Object

Render THIS already-built instance as a replace stream (used by the reactive action endpoint after an action mutated state).



183
184
185
 
# File 'lib/phlex/reactive/streamable.rb', line 183

def to_stream_replace
  self.class.turbo_stream_builder.replace(id, html: self.class.render_component(self))
end

#to_stream_update ⇒ Object 



187
188
189
 
# File 'lib/phlex/reactive/streamable.rb', line 187

def to_stream_update
  self.class.turbo_stream_builder.update(id, html: self.class.render_component(self))
end