跳到主要内容

settings_schema.json

settings_schema.json 文件控制主题编辑器中主题设置区域的组织结构和内容。在主题编辑器中选择的所有设置都保存在 settings_data.json 中。

位置

settings_schema.json 文件位于 theme 的 config 目录下:

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

Schema

settings_schema.json 文件是一个对象数组,每个对象代表一个设置分类。每个对象需要包含以下属性:

属性描述是否必填
name设置分类的名称。
settings该分类下关联的设置数组。

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

[
{
"name": {
"en-US": "Colors",
"zh-CN": "颜色"
},
"settings": [
...
]
},
...
]

settings_schema.json 文件是 JSON 文件,所有内容必须是有效的 JSON。此外,请确保遵循所需设置类型的正确语法。

使用说明

使用 settings_schema.json 文件时,请熟悉以下内容:

设置类型

设置分为两类:

类别描述
输入设置可以保存值的设置,可由应用用户配置。
Sidebar 设置不保存值的设置,不可由应用用户配置。这些是信息展示元素,可为输入设置提供说明和补充信息。

访问设置

主题设置可以通过 settings 对象访问。了解语法和注意事项,请参考访问设置