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

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 |

[toggle]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLDetailsElement/toggle_event

[Event]: https://developer.mozilla.org/en-US/docs/web/api/event

}

handleEvent(event: Event) {

if (this.willBeInvokedByEvent(event) && this.applyEventModifiers(event)) {

this.invokeWithEvent(event)

const actionEvent = this.prepareActionEvent(event)

if (this.willBeInvokedByEvent(event) && this.applyEventModifiers(actionEvent)) {

this.invokeWithEvent(actionEvent)

}

}

return passes

}

private invokeWithEvent(event: Event) {

private prepareActionEvent(event: Event): ActionEvent {

return Object.assign(event, { params: this.action.params })

}

private invokeWithEvent(event: ActionEvent) {

const { target, currentTarget } = event

try {

const { params } = this.action

const actionEvent: ActionEvent = Object.assign(event, { params })

this.method.call(this.controller, actionEvent)

this.method.call(this.controller, event)

this.context.logDebugActivity(this.methodName, { event, target, currentTarget, action: this.methodName })

} catch (error: any) {

const { identifier, controller, element, index } = this

this.assertActions({ name: "log", eventType: "toggle" })

}

async "test custom action option callback event contains params"() {

let lastActionEventParams: Object = {}

// clone the params to ensure we check the value as the callback receives it

// not the event after all actions have resolved

const mockCallback = ({ event: { params = {} } = {} }) => {

lastActionEventParams = { ...params }

}

this.application.registerActionOption("all", (options: Object) => {

mockCallback(options)

return true

})

this.buttonElement.setAttribute("data-c-custom-number-param", "41")

this.buttonElement.setAttribute("data-c-custom-string-param", "validation")

this.buttonElement.setAttribute("data-c-custom-boolean-param", "true")

this.buttonElement.setAttribute("data-d-should-ignore-param", "_IGNORED_")

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 })

const expectedEventParams = {

customBoolean: true,

customNumber: 41,

customString: "validation",

}

this.assert.deepEqual(this.controllerConstructor.actionLog[0].params, expectedEventParams)

this.assert.deepEqual(lastActionEventParams, expectedEventParams)

}

setAction(element: Element, value: string) {

element.setAttribute("data-action", value)

return this.nextFrame