diff --git a/docs/developer-guide/form-schema.md b/docs/developer-guide/form-schema.md index 7a2114a5..709f1e52 100644 --- a/docs/developer-guide/form-schema.md +++ b/docs/developer-guide/form-schema.md @@ -761,3 +761,33 @@ UI 效果: ``` ::: + +### switch + +开关组件,提供两个值之间的选择;当您想使用户切换功能开或关时,这是一个很好的选项 + +参数 + +- `onValue`:开关打开时的值,默认为 `true` +- `offValue`:开关关闭时的值,默认为 `false` +- `disabled`:是否禁用开关,默认为 `false` + +#### 示例 + +```yaml +- $formkit: switch + name: enabled + label: 是否启用 + value: false +``` + +如果需要开关的值为其他值,可以设置 `onValue` 和 `offValue` 参数。 + +```yaml +- $formkit: switch + name: enabled + label: 是否启用 + value: "active" + onValue: "active" + offValue: "inactive" +``` diff --git a/docs/developer-guide/plugin/api-changelog.md b/docs/developer-guide/plugin/api-changelog.md index f6e3e7ec..3d68cef4 100644 --- a/docs/developer-guide/plugin/api-changelog.md +++ b/docs/developer-guide/plugin/api-changelog.md @@ -28,6 +28,12 @@ spec: 尝试构建并解决编译错误即可。 +## 2.22.2 + +### 表单定义 > 新增 `switch` 组件 + +在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch) + ## 2.22.0 ### `@halo-dev/console-shared` 改名 diff --git a/docs/developer-guide/theme/api-changelog.md b/docs/developer-guide/theme/api-changelog.md index 95c40d7d..d80cb44a 100644 --- a/docs/developer-guide/theme/api-changelog.md +++ b/docs/developer-guide/theme/api-changelog.md @@ -3,6 +3,12 @@ title: API 变更日志 description: 记录每一个版本的主题 API 变更记录,方便开发者适配 --- +## 2.22.2 + +### 表单定义 > 新增 `switch` 表单类型 + +在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch) + ## 2.22.0 ### 表单定义 > 新增 Iconify 图标选择器 diff --git a/versioned_docs/version-2.22/developer-guide/form-schema.md b/versioned_docs/version-2.22/developer-guide/form-schema.md index 7a2114a5..709f1e52 100644 --- a/versioned_docs/version-2.22/developer-guide/form-schema.md +++ b/versioned_docs/version-2.22/developer-guide/form-schema.md @@ -761,3 +761,33 @@ UI 效果: ``` ::: + +### switch + +开关组件,提供两个值之间的选择;当您想使用户切换功能开或关时,这是一个很好的选项 + +参数 + +- `onValue`:开关打开时的值,默认为 `true` +- `offValue`:开关关闭时的值,默认为 `false` +- `disabled`:是否禁用开关,默认为 `false` + +#### 示例 + +```yaml +- $formkit: switch + name: enabled + label: 是否启用 + value: false +``` + +如果需要开关的值为其他值,可以设置 `onValue` 和 `offValue` 参数。 + +```yaml +- $formkit: switch + name: enabled + label: 是否启用 + value: "active" + onValue: "active" + offValue: "inactive" +``` diff --git a/versioned_docs/version-2.22/developer-guide/plugin/api-changelog.md b/versioned_docs/version-2.22/developer-guide/plugin/api-changelog.md index f6e3e7ec..3d68cef4 100644 --- a/versioned_docs/version-2.22/developer-guide/plugin/api-changelog.md +++ b/versioned_docs/version-2.22/developer-guide/plugin/api-changelog.md @@ -28,6 +28,12 @@ spec: 尝试构建并解决编译错误即可。 +## 2.22.2 + +### 表单定义 > 新增 `switch` 组件 + +在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch) + ## 2.22.0 ### `@halo-dev/console-shared` 改名 diff --git a/versioned_docs/version-2.22/developer-guide/theme/api-changelog.md b/versioned_docs/version-2.22/developer-guide/theme/api-changelog.md index 95c40d7d..d80cb44a 100644 --- a/versioned_docs/version-2.22/developer-guide/theme/api-changelog.md +++ b/versioned_docs/version-2.22/developer-guide/theme/api-changelog.md @@ -3,6 +3,12 @@ title: API 变更日志 description: 记录每一个版本的主题 API 变更记录,方便开发者适配 --- +## 2.22.2 + +### 表单定义 > 新增 `switch` 表单类型 + +在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch) + ## 2.22.0 ### 表单定义 > 新增 Iconify 图标选择器