Pass controller instance to registerActionOption callback (#691)

Add ability for registerActionOption callbacks to receive the controller instance Resolves #668
hotwired · Jul 12, 2023 · da8be68 · da8be68
1 parent c989795
commit da8be68
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 7 deletions.
diff --git a/docs/reference/actions.md b/docs/reference/actions.md
@@ -215,12 +215,13 @@ route the event to the controller action, return `true`.
 
 The callback accepts a single object argument with the following keys:
 
-| Name    | Description                                                                                           |
-| ------- | ----------------------------------------------------------------------------------------------------- |
-| name    | String: The option's name (`"open"` in the example above)                                             |
-| value   | Boolean: The value of the option (`:open` would yield `true`, `:!open` would yield `false`)           |
-| event   | [Event][]: The event instance, including with the `params` action parameters on the submitter element |
-| element | [Element]: The element where the action descriptor is declared                                        |
+| Name       | Description                                                                                           |
+| ---------- | ----------------------------------------------------------------------------------------------------- |
+| name       | String: The option's name (`"open"` in the example above)                                             |
+| value      | Boolean: The value of the option (`:open` would yield `true`, `:!open` would yield `false`)           |
+| event      | [Event][]: The event instance, including with the `params` action parameters on the submitter element |
+| element    | [Element]: The element where the action descriptor is declared                                        |
+| controller | The `Controller` instance which would receive the method call                                         |
 
 [toggle]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLDetailsElement/toggle_event
 [Event]: https://developer.mozilla.org/en-US/docs/web/api/event

diff --git a/src/core/action_descriptor.ts b/src/core/action_descriptor.ts
@@ -1,10 +1,13 @@
+import type { Controller } from "./controller"
+
 export type ActionDescriptorFilters = Record<string, ActionDescriptorFilter>
 export type ActionDescriptorFilter = (options: ActionDescriptorFilterOptions) => boolean
 type ActionDescriptorFilterOptions = {
   name: string
   value: boolean
   event: Event
   element: Element
+  controller: Controller<Element>
 }
 
 export const defaultActionDescriptorFilters: ActionDescriptorFilters = {

diff --git a/src/core/binding.ts b/src/core/binding.ts
@@ -50,14 +50,15 @@ export class Binding {
   private applyEventModifiers(event: Event): boolean {
     const { element } = this.action
     const { actionDescriptorFilters } = this.context.application
+    const { controller } = this.context
 
     let passes = true
 
     for (const [name, value] of Object.entries(this.eventOptions)) {
       if (name in actionDescriptorFilters) {
         const filter = actionDescriptorFilters[name]
 
-        passes = passes && filter({ name, value, event, element })
+        passes = passes && filter({ name, value, event, element, controller })
       } else {
         continue
       }

diff --git a/src/tests/modules/core/event_options_tests.ts b/src/tests/modules/core/event_options_tests.ts
@@ -1,3 +1,4 @@
+import type { Controller } from "src/core"
 import { LogControllerTestCase } from "../../cases/log_controller_test_case"
 
 export default class EventOptionsTests extends LogControllerTestCase {
@@ -177,6 +178,47 @@ export default class EventOptionsTests extends LogControllerTestCase {
     this.assertNoActions()
   }
 
+  async "test custom action option callback params contain the controller instance"() {
+    let lastActionOptions: { controller?: Controller<Element> } = {}
+
+    const mockCallback = (options: Object) => {
+      lastActionOptions = options
+    }
+
+    this.application.registerActionOption("all", (options: Object) => {
+      mockCallback(options)
+      return true
+    })
+
+    await this.setAction(this.buttonElement, "click->c#log:all")
+
+    await this.triggerEvent(this.buttonElement, "click")
+
+    this.assertActions({ name: "log", identifier: "c", eventType: "click", currentTarget: this.buttonElement })
+
+    this.assert.deepEqual(["name", "value", "event", "element", "controller"], Object.keys(lastActionOptions))
+
+    this.assert.equal(
+      lastActionOptions.controller,
+      this.application.getControllerForElementAndIdentifier(this.element, "c")
+    )
+
+    this.controllerConstructor.actionLog = [] // clear actions
+
+    await this.setAction(this.buttonElement, "click->d#log:all")
+
+    await this.triggerEvent(this.buttonElement, "click")
+
+    this.assertActions({ name: "log", identifier: "d", eventType: "click", currentTarget: this.buttonElement })
+
+    this.assert.deepEqual(["name", "value", "event", "element", "controller"], Object.keys(lastActionOptions))
+
+    this.assert.equal(
+      lastActionOptions.controller,
+      this.application.getControllerForElementAndIdentifier(this.element, "d")
+    )
+  }
+
   async "test custom option"() {
     this.application.registerActionOption("open", ({ value, event: { type, target } }) => {
       switch (type) {