Skip to content

Commit 70d398f

Browse files
committed
docs: add switch formkit component
1 parent 0aad18f commit 70d398f

File tree

6 files changed

+84
-0
lines changed

6 files changed

+84
-0
lines changed

docs/developer-guide/form-schema.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,3 +761,33 @@ UI 效果:
761761
```
762762

763763
:::
764+
765+
### switch
766+
767+
开关组件,提供两个值之间的选择;当您想使用户切换功能开或关时,这是一个很好的选项
768+
769+
参数
770+
771+
- `onValue`:开关打开时的值,默认为 `true`
772+
- `offValue`:开关关闭时的值,默认为 `false`
773+
- `disabled`:是否禁用开关,默认为 `false`
774+
775+
#### 示例
776+
777+
```yaml
778+
- $formkit: switch
779+
name: enabled
780+
label: 是否启用
781+
value: false
782+
```
783+
784+
如果需要开关的值为其他值,可以设置 `onValue` 和 `offValue` 参数。
785+
786+
```yaml
787+
- $formkit: switch
788+
name: enabled
789+
label: 是否启用
790+
value: "active"
791+
onValue: "active"
792+
offValue: "inactive"
793+
```

docs/developer-guide/plugin/api-changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ spec:
2828
2929
尝试构建并解决编译错误即可。
3030
31+
## 2.22.2
32+
33+
### 表单定义 > 新增 `switch` 组件
34+
35+
在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch)
36+
3137
## 2.22.0
3238

3339
### `@halo-dev/console-shared` 改名

docs/developer-guide/theme/api-changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ title: API 变更日志
33
description: 记录每一个版本的主题 API 变更记录,方便开发者适配
44
---
55

6+
## 2.22.2
7+
8+
### 表单定义 > 新增 `switch` 表单类型
9+
10+
在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch)
11+
612
## 2.22.0
713

814
### 表单定义 > 新增 Iconify 图标选择器

versioned_docs/version-2.22/developer-guide/form-schema.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,3 +761,33 @@ UI 效果:
761761
```
762762

763763
:::
764+
765+
### switch
766+
767+
开关组件,提供两个值之间的选择;当您想使用户切换功能开或关时,这是一个很好的选项
768+
769+
参数
770+
771+
- `onValue`:开关打开时的值,默认为 `true`
772+
- `offValue`:开关关闭时的值,默认为 `false`
773+
- `disabled`:是否禁用开关,默认为 `false`
774+
775+
#### 示例
776+
777+
```yaml
778+
- $formkit: switch
779+
name: enabled
780+
label: 是否启用
781+
value: false
782+
```
783+
784+
如果需要开关的值为其他值,可以设置 `onValue` 和 `offValue` 参数。
785+
786+
```yaml
787+
- $formkit: switch
788+
name: enabled
789+
label: 是否启用
790+
value: "active"
791+
onValue: "active"
792+
offValue: "inactive"
793+
```

versioned_docs/version-2.22/developer-guide/plugin/api-changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ spec:
2828
2929
尝试构建并解决编译错误即可。
3030
31+
## 2.22.2
32+
33+
### 表单定义 > 新增 `switch` 组件
34+
35+
在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch)
36+
3137
## 2.22.0
3238

3339
### `@halo-dev/console-shared` 改名

versioned_docs/version-2.22/developer-guide/theme/api-changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ title: API 变更日志
33
description: 记录每一个版本的主题 API 变更记录,方便开发者适配
44
---
55

6+
## 2.22.2
7+
8+
### 表单定义 > 新增 `switch` 表单类型
9+
10+
在 2.22.2 中,我们为 FormKit 表单新增了 `switch` 组件,用于定义一个功能的开关,详细文档可查阅:[表单定义#switch](../../developer-guide/form-schema.md#switch)
11+
612
## 2.22.0
713

814
### 表单定义 > 新增 Iconify 图标选择器

0 commit comments

Comments
 (0)