StimulusReflex fusklapp · Cheat Sheets

Kärnkoncept

StimulusReflex möjliggör reaktiva användargränssnitt i realtid i Rails med hjälp av WebSockets (ActionCable) och CableReady.

Grundläggande Reflex

<!-- 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

Morph-lägen

Page Morph (Standard)

Renderar om hela sidan via controlleråtgärden och sammanfogar skillnaderna i 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

Kör serverlogik utan att uppdatera klientens DOM.

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

Livscykelmetoder

Callbacks på serversidan

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

Generiska callbacks på klientsidan

beforeReflex(element, reflex, noop, reflexId): Innan WebSocket-förfrågan skickas
reflexSuccess(element, reflex, noop, reflexId): Efter reflex-körning och DOM-uppdatering
reflexError(element, reflex, error, reflexId): När servern kastar ett ohanterat fel
reflexHalted(element, reflex, noop, reflexId): När reflex avbryts med throw :abort
afterReflex(element, reflex, noop, reflexId): Körs vid både framgång och misslyckande
finalizeReflex(element, reflex, noop, reflexId): Slutlig rensningshook

DOM-händelser

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

Praktiska mönster

Formulärhantering

Reflexer som triggas på formulärelement serialiserar automatiskt indata till params.

Promise-kedjning

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

Permanenta element

Märk element med data-reflex-permanent så att helsidesmorphs lämnar dem orörda.

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

Referenser

StimulusReflex dokumentation