Guia de referência do StimulusReflex

Conceitos Fundamentais

O StimulusReflex permite interfaces de usuário reativas em tempo real em aplicações Rails usando WebSockets (ActionCable) e CableReady.

Reflex Básico

<!-- view.html.erb -->
<button data-reflex="click->Counter#increment">Increment</button>

# app/reflexes/counter_reflex.rb
class CounterReflex < ApplicationReflex
  def increment
    @count = element.dataset[:count].to_i + 1
  end
end

Modos de Morph

Page Morph (Padrão)

Renderiza novamente toda a página via controller e aplica as diferenças no DOM.

Selector Morph

# app/reflexes/example_reflex.rb
class ExampleReflex < ApplicationReflex
  def update_metric
    morph "#metric-display", render(partial: "metrics/metric", locals: { value: 42 })
  end
end

Nothing Morph

Executa lógica no servidor sem atualizar o DOM do cliente.

class ExampleReflex < ApplicationReflex
  def background_task
    LongRunningJob.perform_later
    morph :nothing
  end
end

Métodos de Ciclo de Vida

Callbacks no Servidor

class ExampleReflex < ApplicationReflex
  before_reflex :authenticate
  around_reflex :measure_time
  after_reflex :log_activity
end

Callbacks Genéricos no Cliente

beforeReflex(element, reflex, noop, reflexId): Antes de enviar a requisição WebSocket
reflexSuccess(element, reflex, noop, reflexId): Após execução do reflex e atualização do DOM
reflexError(element, reflex, error, reflexId): Quando o servidor lança um erro não tratado
reflexHalted(element, reflex, noop, reflexId): Quando o reflex é abortado com throw :abort
afterReflex(element, reflex, noop, reflexId): Executado tanto no sucesso quanto na falha
finalizeReflex(element, reflex, noop, reflexId): Hook final de limpeza

Eventos DOM

stimulus-reflex:before
stimulus-reflex:success
stimulus-reflex:error
stimulus-reflex:halted
stimulus-reflex:after
stimulus-reflex:connected
stimulus-reflex:disconnected
stimulus-reflex:ready

Padrões Práticos

Manipulação de Formulários

Reflexes disparados dentro de formulários serializam automaticamente os campos para params.

Encadeamento de Promises

this.stimulate('Comments#create')
  .then(() => this.showSuccess())
  .catch((err) => this.handleError(err))

Elementos Permanentes

Marque elementos com data-reflex-permanent para que morphs de página inteira não os alterem.

<div data-reflex-permanent>
  <video id="player" src="video.mp4" controls></video>
</div>

Referências

Documentação do StimulusReflex