组件
所有图像和交互元素均在items中定义。
简易表单仅包含按钮,因此默认情况下,所有组件类型均为按钮。自定义表单组件需要明确指定其类型,例如type: dropdown(下拉菜单)。
你可以通过layout列表来自由排列组件的顺序,组件的编号越小,显示位置会越靠上。
组件类型
提示
若为简易式表单,其所有组件本质上都是按钮,因此不必在简易式表单中指定组件的类型。
下表列出的是自定义式表单的组件类型。
| 类型 | 描述 |
|---|---|
| 按钮 | 用于简易表单的按钮。 |
| 标签 | 用于自定义表单的文本。 |
| 下拉菜单 | 含自定义选项的下拉菜单。 |
| 输入框 | 用于自定义文本输入。 |
| 开关 | 布尔值切换开关(开/关)。 |
| 滑条 | 设定范围的数值滑条。 |
| 分段滑条 | 带选项的滑条(如:低、中、高)。 |
表单行为与显示机制
layout控制组件的垂直排序。- 同一编号下列出的组件会根据条件决定其是否显示,按照从上到下的顺序检查,只显示第一个符合条件的组件。
- 简易式表单仅执行点击按钮的命令。
- 自定义式表单在点击提交按钮时会执行所有组件的命令,否则不执行命令。
自定义式表单会将输入的值保存到临时会话数据中。示例:
- 如果你的组件是
input0,使用%commandpanels_session_input0%来获取值。
组件配置
每个组件类型都有独立的配置结构。
按钮
可执行命令操作的按钮。如果未定义icon-type,则默认为PATH。icon-texture定义纹理的路径,支持URL链接。
type: 'button'
name: '点我'
icon-type: PATH / URL
icon-texture: 'texture/url/path' # 纹理的资源路径
文本
显示文本内容。
type: 'label'
name: '自定义式表单中的自定义文本。'
下拉菜单
带有自定义选项的下拉菜单。
type: 'dropdown'
name: '请做出你的选择'
options:
- '生存'
- '创造'
- '旁观'
输入框
文本输入框。
type: 'input'
name: '输入框上方的文本'
placeholder: '输入框内部的灰色文本'
default: '默认输入的文本'
复选框
二元选择输入组件,default定义面板打开后要默认显示的状态。
type: 'toggle'
name: '开关,选还是不选'
default: 'false' # 默认显示状态,填true或false
滑条
特定范围内的数值选择滑条。min为最小值,max为最大值,step为滑条移动时数值增减的最小单位,default为打开面板时默认显示的值。
type: 'slider'
name: '滑条上方的名称'
min: 1
max: 10
step: 1
default: 1
分段滑条
带有特定选项的滑条。
type: 'step-slider'
name: '分段滑条上方的名称'
default: 超大杯
steps:
- 中杯
- 大杯
- 超大杯