antom.createElement()

antom.createElement() 是一个工厂方法。在成功调用 loadAntom() 加载 SDK 并获取 antom 实例后,您可以通过此方法传入指定的 elementType 来动态创建相应的支付或绑卡元素实例。

方法签名

调用此方法时,请使用以下标准方法签名格式:

copy
antom.createElement(elementType, options)

参数

此方法接收两个参数,分别用于指定要创建的元素类型及其配置。

参数

类型

是否必需

描述

elementType

String

Element 类型,有效值为:

  • CVV用于创建 CVVElement 实例以收集买家输入的 CVV(Card Verification Value)安全码。
  • vaulting用于创建 VaultingElement 实例以收集买家的信用卡/借记卡信息,完成绑卡流程。

options

Object

配置对象,用于设置组件的外观主题和多语言环境。

options

参数类型是否必需描述
appearance

Object

用于自定义外观配置,更多信息请参阅自定义外观样式其包含以下参数:

  • theme:主题颜色。
  • variables:通过 CSS 设计 Token(如 color-primary)覆盖底层 CSS 自定义属性,实现主题定制。
localeString

多语言配置。

注意

  • 若同时在 loadAntom() 方法中设置了 locale 参数,则以antom.createElement() 参数中的 locale 值为优先
  • 如果不传或传入的语言值不在以下列出的范围内,系统将默认使用英语。

有效值为:

  • en_US:默认值。英语
  • pt_BR:葡萄牙语(巴西)
  • pt_PT:葡萄牙语
  • es_ES:西班牙语
  • ko_KR:韩语
  • zh_CN:简体中文
  • zh_HK:繁体中文
  • ms_MY:马来西亚语
  • in_ID:印度尼西亚语
  • th_TH:泰语
  • vi_VN:越南语
  • tl_PH:菲律宾语
  • it_IT:意大利语
  • de_DE:德语
  • fr_FR:法语
  • nl_NL:荷兰语
  • ja_JP:日语
  • ro:罗马尼亚语
  • pl_PL:波兰语
  • ar_SA:阿拉伯语
  • tr_TR:土耳其语
  • hi_IN:印度语

返回值

此方法返回一个 element 实例对象,提供挂载、卸载、销毁及配置更新等方法,用于灵活管理页面中的组件生命周期。

方法名描述

element.on()

为 Element 实例注册事件监听器。

element.mount()

用于将元素挂载到指定的页面节点,可传入一个具体的 HTMLElement

element.unmount()卸载当前 Element(可再次挂载)。
element.destroy()销毁当前 Element(不可再次挂载)。
element.updateConfig()更新配置。

错误码

调用 element.on() 方法监听 antom.createElement() 方法相关的错误码。具体错误码列表请参见错误码