on()

2026-03-06 01:30

Note: Translation in progress.

通过该方法可监听组件事件。

注意：该方法不适用于 Express Element.

语法

调用此方法时，请使用以下标准语法格式：

JavaScript

TypeScript

copy
on(event, callback)

此方法接收一个配置对象作为参数，用于指定要监听的事件及对应的处理逻辑。具体参数说明如下：

参数类型 是否必需 描述

参数	类型	是否必需	描述
event	String	是	事件类型，用于指定要监听的事件。支持以下事件： `paymentMethodChanged`：支付方式变更事件。 `valuesChanged`：支付表单数据变更事件。注意：仅在 Payment Element 场景下可用；其他业务场景下调用将触发控制台错误：`Event "${event}" is not allowed.`
callback	Function	是	事件回调函数，用于接收事件触发时的参数。不同事件类型对应的回调参数结构如下： `paymentMethodChanged` 事件：回调函数接收一个参数 payload，其中包含支付方式变更相关数据。 `valuesChanged` 事件：回调函数接收一个参数 payload，其中包含最新的支付表单数据。

event

String

是

事件类型，用于指定要监听的事件。支持以下事件：

注意：仅在 Payment Element 场景下可用；其他业务场景下调用将触发控制台错误：`Event "${event}" is not allowed.`

callback

Function

是

事件回调函数，用于接收事件触发时的参数。不同事件类型对应的回调参数结构如下：

当买家切换支付方式时触发，payload 为一个包含支付方式变更数据的对象：

参数	类型	是否必需	描述
type	String	是	支付方式类型。具体值请参考支付方式枚举值或 APO 支付方式文档。

当买家编辑支付表单数据时触发，payload 为包含表单输入结果的对象。

注意：当前仅适用于 billingAddress 场景。

此方法无返回值。调用后会在内部完成事件监听的注册操作，后续由回调函数响应事件触发，无需等待或处理返回结果。