General hooks

onSubmitButtonEnable()

在默认启用提交按钮之前调用。

Returns:

bool|null 返回 TRUE 以跳过默认行为,该行为会重新启用提交按钮。

MauticFormCallback['formname'] = {
    onSubmitButtonEnable: function () {
         // do some custom stuff
    },
};
onSubmitButtonDisable()

在默认禁用提交按钮之后调用,该操作发生在表单提交后。

Returns:

bool|null 返回 TRUE 以跳过默认行为,该行为会禁用提交按钮。

MauticFormCallback['formname'] = {
    onSubmitButtonDisable: function () {
         // do some custom stuff
    },
};
onShowNextPage()

在显示表单中的下一页之前调用,这对于在使页面可见之前调整 DOM 非常有用。

Arguments:
  • pageNumber (number()) – 要显示的页码。

Returns:

void

MauticFormCallback['formname'] = {
    onShowNextPage: function (pageNumber) {
         // do some custom stuff
    },
};
onShowPreviousPage()

在显示表单中的上一页之前调用,这对于在使页面可见之前调整 DOM 非常有用。

Arguments:
  • pageNumber (number()) – 要显示的页码。

Returns:

void

MauticFormCallback['formname'] = {
    onShowPreviousPage: function (pageNumber) {
         // do some custom stuff
    },
};
onMessageSet()

在将文本注入到与消息类型对应的元素之前调用,该操作发生在表单验证之前,用于清除先前提交中的现有文本,以及在表单验证成功或出现验证错误后。

Arguments:
  • messageObject (object()) –

    • messageObject.message 要注入的文本。

    • messageObject.type 这可能是 errormessage

Returns:

bool|NULL|void 返回 TRUE 以阻止默认行为,即向相应的元素注入消息(例如,如果钩子已将消息注入到其他位置)。返回 NULL|void 以继续使用默认行为。

MauticFormCallback['replaceWithFormName'] = {
    onMessageSet: function (messageObject) {
        if ('error' == messageObject.type) {
            // do something custom
        }
    },
};