settings_schema.json

settings_schema.json 文件控制主题编辑器中 主题设置 的配置定义项和内容。主题编辑器中所有的配置项的值都会保存在 settings_data.json 文件中。


位置

settings_schema.json 文件位于主题的 config 目录中:

└── theme
...
├── config
├── settings_data.json
└── settings_schema.json

结构

settings_schema.json 文件是一个表示设置类别的对象数组。每个对象需要具有以下属性:

属性描述必需的
name设置类别的名称
settings关联 settings 的数组

settings_schema.json 文件应该遵循以下基本格式:

[
{
"name": "Type",
"settings": [
...
]
},
...
]

settings_schema.json 文件是一个 JSON 文件,因此所有内容必须是有效的 JSON。此外,请确保按照你所期望的设置使用正确的语法。


用法

当你在处理 settings_schema.json 文件时,请熟悉以下内容:

配置类型

有两种配置类型:

类别描述
控件配置可以保存商家配置的值,并且可以由应用用户来配置
侧边栏配置不能保存商家配置的值,也不可由应用用户来配置。它们是描述控件,为控件配置提供分类、提示、让数据录入更加精准

访问配置

可以通过 settings 对象访问主题设置。要了解有关语法和注意事项的更多信息,请参考访问配置项的值

添加主题元数据

作为主题开发者,你可以在主题编辑器的主题操作菜单中包含额外的主题元数据。该菜单显示在主题编辑器顶部栏的左侧,并在主题商城上有所体现。

image.png image.png image.png

要添加此元数据,你可以在 settings_schema.json 文件中包含一个 theme_info 的对象。该对象必须包括以下属性:

属性描述必需的
name此属性的值必须是theme_info
theme_name主题名称
theme_version主题版本号
theme_author主题作者
theme_documentation_url主题文档URL
theme_support_url主题支持的URL
theme_cover_img主题在商城显示的封面图
theme_home_pc_preview_img主题在商城显示的PC端首页预览图
theme_home_mobile_preview_img主题在商城显示的H5端首页预览图
theme_pdp_pc_preview_img主题在商城显示的PC端商品详情页预览图
theme_pdp_mobile_preview_img主题在商城显示的H5端商品详情页预览图
refill_section_object是否开启sction对象填充
theme_type_version主题系列标识
警告
  • refill_section_object theme_type_versionOS 2.1 主题的标识,缺少会导致主题异常。
  • 目前 OS 2.1 主题有:Seed、Charm、Modern、North,主题商城中的主题也会有 OS 2.1 标志。

例如:

[
{
"name": "Seed",
"theme_name": "Seed",
"theme_version": "1.0.0",
"theme_author": "Shopline",
"theme_documentation_url": "",
"theme_support_url": "",
"theme_cover_img": "",
"theme_home_pc_preview_img": "",
"theme_home_mobile_preview_img": "",
"theme_pdp_pc_preview_img": "",
"theme_pdp_mobile_preview_img": "",
"refill_section_object": true,
"theme_type_version": "OS_2.1"
},
...
]
这篇文章对你有帮助吗?