ライフサイクルコールバック

ライフサイクルコールバックと呼ばれる特別なメソッドを使用すると、コントローラや特定のターゲットがドキュメントに接続したり切断したりするたびに応答できるようになります。

import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  connect() {
    // …
  }
}
原文 Special methods called _lifecycle callbacks_ allow you to respond whenever a controller or certain targets connects to and disconnects from the document. 
import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  connect() {
    // …
  }
}

メソッド一覧

コントローラには、以下のライフサイクルコールバックメソッドを定義することができます：

Method Stimulusによって呼び出されるタイミング…
initialize() コントローラが最初にインスタンス化されたとき(一度だけ)
[name]TargetConnected(target: Element) ターゲットがDOMに接続されるたび
connect() コントローラーがDOMに接続されるたび
[name]TargetDisconnected(target: Element) ターゲットがDOMから切り離されるたび
disconnect() コントローラーがDOMから切り離されるたび
原文

You may define any of the following methods in your controller:

Method Invoked by Stimulus…
initialize() Once, when the controller is first instantiated
[name]TargetConnected(target: Element) Anytime a target is connected to the DOM
connect() Anytime the controller is connected to the DOM
[name]TargetDisconnected(target: Element) Anytime a target is disconnected from the DOM
disconnect() Anytime the controller is disconnected from the DOM

Connection

コントローラがドキュメントに接続されるのは、以下の条件の両方が真の場合です：

コントローラが接続されると、Stimulusはconnect()メソッドを呼び出します。

原文 A controller is _connected_ to the document when both of the following conditions are true:
  • its element is present in the document (i.e., a descendant of document.documentElement, the <html> element)
  • its identifier is present in the element’s data-controller attribute

When a controller becomes connected, Stimulus calls its connect() method.

ターゲット

ターゲットがドキュメントに接続されるのは、以下の両方の条件が真である場合です：

ターゲットが接続されると、Stimulusはコントローラの[name]TargetConnected()メソッドを呼び出し、ターゲット要素をパラメータとして渡します。 name]TargetConnected()ライフサイクルコールバックは、コントローラのconnect()コールバックより 前に 起動します。

原文 A target is _connected_ to the document when both of the following conditions are true:
  • its element is present in the document as a descendant of its corresponding controller’s element
  • its identifier is present in the element’s data-{identifier}-target attribute

When a target becomes connected, Stimulus calls its controller’s [name]TargetConnected() method, passing the target element as a parameter. The [name]TargetConnected() lifecycle callbacks will fire before the controller’s connect() callback.

Disconnection

接続されたコントローラは、以下のケースのように、前述の条件のいずれかが偽になると切断されます：

コントローラが切断されると、Stimulus はdisconnect()メソッドを呼び出します。

原文 A connected controller will later become _disconnected_ when either of the preceding conditions becomes false, such as under any of the following scenarios:
  • the element is explicitly removed from the document with Node#removeChild() or ChildNode#remove()
  • one of the element’s parent elements is removed from the document
  • one of the element’s parent elements has its contents replaced by Element#innerHTML=
  • the element’s data-controller attribute is removed or modified
  • the document installs a new <body> element, such as during a Turbo page change

When a controller becomes disconnected, Stimulus calls its disconnect() method.

ターゲット

接続されたターゲットは、以下のケースのように、前述の条件のいずれかが偽になると切断されます：

ターゲットが切断されると、Stimulusはコントローラの[name]TargetDisconnected()メソッドを呼び出し、ターゲット要素をパラメータとして渡します。 name]TargetDisconnected()ライフサイクルのコールバックは、コントローラのdisconnect()コールバックより 前に 起動します。

原文

A connected target will later become disconnected when either of the preceding conditions becomes false, such as under any of the following scenarios:

  • the element is explicitly removed from the document with Node#removeChild() or ChildNode#remove()
  • one of the element’s parent elements is removed from the document
  • one of the element’s parent elements has its contents replaced by Element#innerHTML=
  • the element’s data-{identifier}-target attribute is removed or modified
  • the document installs a new <body> element, such as during a Turbo page change

When a target becomes disconnected, Stimulus calls its controller’s [name]TargetDisconnected() method, passing the target element as a parameter. The [name]TargetDisconnected() lifecycle callbacks will fire before the controller’s disconnect() callback.

Reconnection

切断されたコントローラは、後で再び接続される可能性があります。

これが発生した場合 (ドキュメントからコントローラーの要素を削除してから再アタッチした後など) 、Stimulusは要素の以前のコントローラーインスタンスを再利用し、そのconnect()メソッドを再び呼び出します。

同様に、切断されたターゲットも後で再び接続される可能性があります。 Stimulusはコントローラの[name]TargetConnected()メソッドも同様に再び呼び出します。

原文

A disconnected controller may become connected again at a later time.

When this happens, such as after removing the controller’s element from the document and then re-attaching it, Stimulus will reuse the element’s previous controller instance, calling its connect() method multiple times.

Similarly, a disconnected target may be connected again at a later time. Stimulus will invoke its controller’s [name]TargetConnected() method multiple times.

順序とタイミング

StimulusはDOM MutationObserver APIを使用して非同期にページの変更を監視します。

つまりこれは、Stimulusがドキュメントに変更が加えられた際、各変更の次のマイクロタスクでコントローラのライフサイクルメソッドを非同期に呼び出すことを意味します。

ライフサイクルメソッドは発生順に実行されるため、コントローラのconnect()メソッドが2回呼び出されるような時は、常にdisconnect()が間に1度呼び出されることになります。 同様に、特定のターゲットに対するコントローラーの[name]TargetConnected()が2回呼ばれる時は、同じターゲットに対する[name]TargetDisconnected()が間に1度呼ばれることになります。

原文

Stimulus watches the page for changes asynchronously using the DOM MutationObserver API.

This means that Stimulus calls your controller’s lifecycle methods asynchronously after changes are made to the document, in the next microtask following each change.

Lifecycle methods still run in the order they occur, so two calls to a controller’s connect() method will always be separated by one call to disconnect(). Similarly, two calls to a controller’s [name]TargetConnected() for a given target will always be separated by one call to [name]TargetDisconnected() for that same target.