kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Feat: update the reference document of ui schema (#600) 

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG 2022-04-14 14:35:48 +08:00 committed by GitHub
parent 4b9e93d59f
commit d6a6f752b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/reference/ui-schema.md
View File

@ -50,6 +50,11 @@ The spec are as follows:
disabled: bool Disable this field.
style:
colSpan: int Defines the number of grids for the form, with 24 representing 100% width.
conditions: Control whether fields are enabled or disabled by certain conditions.
- jsonKey: string Specifies the path of the field, support the peer and subordinate fields.
op: == | != | in
value: any Specifies the expected value.
action: enable|disable
validate: The value validate rule, It must be defined as a whole.
defaultValue: any The default values.
required: bool
@ -76,25 +81,21 @@ The spec are as follows:
- [x] Select
- [x] Switch
- [x] Radio
- [ ] DatePicker
- [ ] Textarea
- [x] Password
#### Business form
- [x] Ignore: There are subordinate fields, and the current field is not displayed.
- [ ] ClusterSelect
- [ ] EnvSelect
- [x] SecretSelect
- [x] SecretKeySelect
- [ ] ComponentSelect
- [ ] ImageInput
- [ ] ClassStorageSelect
- [ ] PVCSelect
- [x] CPUNumber
- [x] MemoryNumber
- [x] DiskNumber
- [x] K8sObjectsCode
- [x] SecretSelect: Load the secret list to assist user selection
- [x] SecretKeySelect: Load the secret key list by secret name of the user selected to assist user selection
- [x] CPUNumber: CPU-style number input form.
- [x] MemoryNumber: Memory-style number input form.
- [x] DiskNumber: Disk-style number input form.
- [x] K8sObjectsCode: The yaml input form of kubernetes resource.
- [x] HelmRepoSelect: Load the helm repositories from integration configs to assist user selection.
- [x] HelmChartSelect: Load the helm charts to assist user selection.
- [x] HelmChartVersionSelect: Load the versions of selected helm chart to assist user selection.
- [x] HelmValues: Load the default values of selected helm chart and version to assist user config the custom values.
#### Combination form
@ -102,7 +103,6 @@ The spec are as follows:
- [x] Strings
- [x] Structs
- [x] Group: render as a titled container
- [ ] TabGroup
### Example

20
i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md
View File

@ -50,6 +50,11 @@ UI Schema 包含的字段如下：
disabled: bool 是否禁用该字段
style: 样式定义
colSpan: int 表单栅格大小，24 代表 100% 宽度
conditions: 表单显示行为的条件
- jsonKey: string 数据来源字段名称
op: == | != | in 判断方式
value: any 预期的值
action: enable|disable 表单满足条件时是启用还是禁用
validate: 数据校验规则，自定义后整体替换默认配置
defaultValue: any 默认值
required: bool 是否是必填参数
@ -76,25 +81,22 @@ UI Schema 包含的字段如下：
- [x] Select: 固定可选值表单
- [x] Switch: 开关选择器
- [x] Radio: 单选表单
- [ ] DatePicker: 时间选择框
- [ ] Textarea: 多行文本输入框
- [x] Password: 密码输入表单
#### 业务表单
- [x] Ignore: 当前字段存在下级字段，本级不显示。
- [ ] ClusterSelect: 集群选择器
- [ ] EnvSelect: 应用下环境选择器 （参数：appName）
- [x] SecretSelect: 目标集群密钥选择器 （参数：clusterName）
- [x] SecretKeySelect: Secret 资源中的 Key 选择，它必须与 SecretSelect 表单级联存在。 （参数：secretKeys）
- [ ] ComponentSelect: 应用下组件选择器 （参数：appName）
- [ ] ImageInput: 镜像输入框（针对镜像进行检测）
- [ ] ClassStorageSelect：目标集群存储类型选择器 （参数：clusterName）
- [ ] PVCSelect: 目标集群的存储卷选择 （参数：clusterName, namespace）
- [x] CPUNumber: cpu 数值输入框 支持小数点后 2 位，默认单位为 Core
- [x] MemoryNumber: 内存数值输入框 2^n 数值输入方式，默认单位为 MB
- [x] DiskNumber: 默认单位为 GB
- [x] K8sObjectsCode: kubernetes yaml 编辑框，支持上传 yaml，输出多个 k8s 资源对象。
- [x] HelmRepoSelect: 选择 Helm 仓库，数据来源于配置管理
- [x] HelmChartSelect: 从选择的仓库中加载 Chart 列表辅助用户选择
- [x] HelmChartVersionSelect: 从选择的 Chart 加载版本列表辅助用户选择
- [x] HelmValues: 从用户选择的 Chart 和 版本加载可配置的参数，供用户进行 Values 配置。
- [x] ImageInput: 镜像输入框，针对镜像进行有效性检测并响应其匹配的镜像仓库认证信息。
#### 组合表单
@ -105,8 +107,6 @@ UI Schema 包含的字段如下：
> AddByKV:env.name|env.value
> AddBySecret:env.name|env.valueFrom
- [x] Group: 组合（渲染为一个带标题的容器)
- [ ] TabGroup: 条件判断 Tab，只有一组生效。
### 配置案例

20
i18n/zh/docusaurus-plugin-content-docs/version-v1.3/reference/ui-schema.md
View File

@ -50,6 +50,11 @@ UI Schema 包含的字段如下：
disabled: bool 是否禁用该字段
style: 样式定义
colSpan: int 表单栅格大小，24 代表 100% 宽度
conditions: 表单显示行为的条件
- jsonKey: string 数据来源字段名称
op: == | != | in 判断方式
value: any 预期的值
action: enable|disable 表单满足条件时是启用还是禁用
validate: 数据校验规则，自定义后整体替换默认配置
defaultValue: any 默认值
required: bool 是否是必填参数
@ -76,25 +81,22 @@ UI Schema 包含的字段如下：
- [x] Select: 固定可选值表单
- [x] Switch: 开关选择器
- [x] Radio: 单选表单
- [ ] DatePicker: 时间选择框
- [ ] Textarea: 多行文本输入框
- [x] Password: 密码输入表单
#### 业务表单
- [x] Ignore: 当前字段存在下级字段，本级不显示。
- [ ] ClusterSelect: 集群选择器
- [ ] EnvSelect: 应用下环境选择器 （参数：appName）
- [x] SecretSelect: 目标集群密钥选择器 （参数：clusterName）
- [x] SecretKeySelect: Secret 资源中的 Key 选择，它必须与 SecretSelect 表单级联存在。 （参数：secretKeys）
- [ ] ComponentSelect: 应用下组件选择器 （参数：appName）
- [ ] ImageInput: 镜像输入框（针对镜像进行检测）
- [ ] ClassStorageSelect：目标集群存储类型选择器 （参数：clusterName）
- [ ] PVCSelect: 目标集群的存储卷选择 （参数：clusterName, namespace）
- [x] CPUNumber: cpu 数值输入框 支持小数点后 2 位，默认单位为 Core
- [x] MemoryNumber: 内存数值输入框 2^n 数值输入方式，默认单位为 MB
- [x] DiskNumber: 默认单位为 GB
- [x] K8sObjectsCode: kubernetes yaml 编辑框，支持上传 yaml，输出多个 k8s 资源对象。
- [x] HelmRepoSelect: 选择 Helm 仓库，数据来源于配置管理
- [x] HelmChartSelect: 从选择的仓库中加载 Chart 列表辅助用户选择
- [x] HelmChartVersionSelect: 从选择的 Chart 加载版本列表辅助用户选择
- [x] HelmValues: 从用户选择的 Chart 和 版本加载可配置的参数，供用户进行 Values 配置。
- [x] ImageInput: 镜像输入框，针对镜像进行有效性检测并响应其匹配的镜像仓库认证信息。
#### 组合表单
@ -105,8 +107,6 @@ UI Schema 包含的字段如下：
> AddByKV:env.name|env.value
> AddBySecret:env.name|env.valueFrom
- [x] Group: 组合（渲染为一个带标题的容器)
- [ ] TabGroup: 条件判断 Tab，只有一组生效。
### 配置案例

30
versioned_docs/version-v1.3/reference/ui-schema.md
View File

@ -50,6 +50,11 @@ The spec are as follows:
disabled: bool Disable this field.
style:
colSpan: int Defines the number of grids for the form, with 24 representing 100% width.
conditions: Control whether fields are enabled or disabled by certain conditions.
- jsonKey: string Specifies the path of the field, support the peer and subordinate fields.
op: == | != | in
value: any Specifies the expected value.
action: enable|disable
validate: The value validate rule, It must be defined as a whole.
defaultValue: any The default values.
required: bool
@ -76,25 +81,21 @@ The spec are as follows:
- [x] Select
- [x] Switch
- [x] Radio
- [ ] DatePicker
- [ ] Textarea
- [x] Password
#### Business form
- [x] Ignore: There are subordinate fields, and the current field is not displayed.
- [ ] ClusterSelect
- [ ] EnvSelect
- [x] SecretSelect
- [x] SecretKeySelect
- [ ] ComponentSelect
- [ ] ImageInput
- [ ] ClassStorageSelect
- [ ] PVCSelect
- [x] CPUNumber
- [x] MemoryNumber
- [x] DiskNumber
- [x] K8sObjectsCode
- [x] SecretSelect: Load the secret list to assist user selection
- [x] SecretKeySelect: Load the secret key list by secret name of the user selected to assist user selection
- [x] CPUNumber: CPU-style number input form.
- [x] MemoryNumber: Memory-style number input form.
- [x] DiskNumber: Disk-style number input form.
- [x] K8sObjectsCode: The yaml input form of kubernetes resource.
- [x] HelmRepoSelect: Load the helm repositories from integration configs to assist user selection.
- [x] HelmChartSelect: Load the helm charts to assist user selection.
- [x] HelmChartVersionSelect: Load the versions of selected helm chart to assist user selection.
- [x] HelmValues: Load the default values of selected helm chart and version to assist user config the custom values.
#### Combination form
@ -102,7 +103,6 @@ The spec are as follows:
- [x] Strings
- [x] Structs
- [x] Group: render as a titled container
- [ ] TabGroup
### Example