配置文件​

当通过 SHOPLINE CLI 创建 UI 扩展时，shopline.ui.customizer.toml 文件会自动生成在根目录下。文件内容包含了扩展名称、扩展点位置、扩展能力的设置定义。

工作原理​

当通过 SHOPLINE CLI 启动扩展程序时，会对配置文件内容进行解析。在页面渲染扩展时，根据解析后的数据来匹配渲染位置。

将扩展发布到 SHOPLINE 时，配置文件内容会和你的扩展代码一并推送。

type = "checkout_ui_customizer"
name = "customizer-name"
extension_points = ['Checkout::Dynamic::Render']
[capabilities]
block_progress = true
# [settings]
# ....

配置属性​

商家配置项​

配置文件中的 [settings] 字段中定义了一组用户配置 [[settings.fields]]，最终会呈现在结账编辑器中给商家填写。

例如：下方代码中设置了 2 个配置项，第一个配置项的 name 名称是 标题（将被呈现给商家查看），其类型是 single_line_text_field，即单行文本输入框，更多数据类型请查看 支持的数据类型。当然，你也可以对输入的数据进行校验，请查看 数据校验选项。随后商家可以在结账编辑器中输入字符，且这个字符最终会传入扩展中，在扩展中可以通过 settings.{key} 读取该值。

[settings]
  [[settings.fields]]
  key = "title"
  type = "single_line_text_field"
  name = "标题"
  description = "标题描述"
  [[settings.fields]]
  key = "title2"
  type = "single_line_text_field"
  name = "标题2"
  description = "标题描述2"

[[settings.fields.validations]] 
 name = "max",  
 value = "25" 

支持的数据类型​

Title1
Title2
Title3 

数据校验选项​

流程阻断​

何时需要流程阻断​

如果扩展依赖于某些特定信息输入、元素交互，则需要阻断买家的结账流程，直到买家把所有必要的信息都补充。你可以通过 Interceptor 拦截器返回 { success: false } 的方式进行流程阻断。

例如：你希望买家点击某个勾选框，以确保他们已经知晓某些信息后，再进行结账流程；此时则需要将配置文件的 capabilities 配置项设置为 block_progress = true。

[capabilities]
block_progress = true

开启或关闭流程阻断​

开启 block_progress 后，阻断流程不会立即生效，还需要商家在结账编辑器 应用行为 中勾选 允许应用阻止结账 来开启或关闭流程阻断。