File tree Expand file tree Collapse file tree
versioned_docs/version-2.22/developer-guide Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -792,6 +792,51 @@ UI 效果:
792792 offValue: "inactive"
793793` ` `
794794
795+ # ## toggle
796+
797+ 切换组件,用于对一组图片、颜色或文字等选择切换,支持单选与多选。它的功能与 `select` 组件类似,但相较于 `select` 组件,`toggle` 组件可以更直观的展示选项。
798+
799+ 参数:
800+
801+ - ` renderType` :当前组件的渲染类型,可选参数为 `image`、`color`、`text`,默认为 `text`。
802+ - `options`:一组同类型的数据源,数据类型为 `{ label? : string; value: string; render?: string }[]`,其中 `label` 为选项的文本,`value` 为选项的值。`render` 为选项的渲染展示内容,与 `renderType` 参数配合使用。
803+ - 当 `renderType` 为 `image` 时,`render` 参数为图片的 URL。
804+ - 当 `renderType` 为 `color` 时,`render` 参数为颜色的十六进制代码。例如 `#000000`。
805+ - 当 `renderType` 为 `text` 时,`render` 参数为文字内容。
806+ - ` multiple` :可选,是否支持多选,默认为 `false`。
807+ - ` size` :可选,渲染内容的尺寸,`number` 类型,单位为 `px`。
808+ - ` gap` :可选,渲染内容之间的间距,`number` 类型,单位为 `px`。
809+ - `value` : 可选初始值,数据类型为 `string | number | boolean | (string | number | boolean)[]`。
810+
811+ # ### 示例
812+
813+ ` ` ` yaml
814+ - $formkit: toggle
815+ label: 选择图片
816+ name: toggle
817+ render-type: image
818+ size: 100
819+ gap: 10
820+ help: 选择图片作为背景
821+ options:
822+ - label: 图文1
823+ value: 1
824+ render: https://placehold.co/600x400
825+ - label: 图文2
826+ value: 2
827+ render: https://placehold.co/600x400
828+ - label: 图文3
829+ value: 3
830+ render: https://placehold.co/600x400
831+
832+ ` ` `
833+
834+ # ### UI 效果
835+
836+ <p>
837+ <img src="/img/formkit/formkit-toggle.png" width="50%" class="medium-zoom-image" />
838+ </p>
839+
795840# ## secret
796841
797842密钥输入组件,用于选择一个密钥资源。
Original file line number Diff line number Diff line change @@ -3,6 +3,12 @@ title: API 变更日志
33description : 记录每一个版本的插件 API 变更记录,方便开发者适配
44---
55
6+ ## 2.22.8
7+
8+ ### 表单定义 > 新增 ` toggle ` 组件
9+
10+ 在 2.22.8 中,我们为 FormKit 表单新增了 ` toggle ` 组件,这是一个可以对一组图片、颜色或文字等进行选择切换的组件,详细文档可查阅:[ 表单定义#toggle] ( ../../developer-guide/form-schema.md#toggle )
11+
612## 2.22.5
713
814### SpringDoc 依赖更新可能导致插件无法启动
Original file line number Diff line number Diff line change @@ -3,6 +3,12 @@ title: API 变更日志
33description : 记录每一个版本的主题 API 变更记录,方便开发者适配
44---
55
6+ ## 2.22.8
7+
8+ ### 表单定义 > 新增 ` toggle ` 表单类型
9+
10+ 在 2.22.8 中,我们为 FormKit 表单新增了 ` toggle ` 组件,这是一个可以对一组图片、颜色或文字等进行选择切换的组件,详细文档可查阅:[ 表单定义#toggle] ( ../../developer-guide/form-schema.md#toggle )
11+
612## 2.22.2
713
814### 表单定义 > 新增 ` switch ` 表单类型
Original file line number Diff line number Diff line change @@ -792,6 +792,51 @@ UI 效果:
792792 offValue: "inactive"
793793` ` `
794794
795+ # ## toggle
796+
797+ 切换组件,用于对一组图片、颜色或文字等选择切换,支持单选与多选。它的功能与 `select` 组件类似,但相较于 `select` 组件,`toggle` 组件可以更直观的展示选项。
798+
799+ 参数:
800+
801+ - ` renderType` :当前组件的渲染类型,可选参数为 `image`、`color`、`text`,默认为 `text`。
802+ - `options`:一组同类型的数据源,数据类型为 `{ label? : string; value: string; render?: string }[]`,其中 `label` 为选项的文本,`value` 为选项的值。`render` 为选项的渲染展示内容,与 `renderType` 参数配合使用。
803+ - 当 `renderType` 为 `image` 时,`render` 参数为图片的 URL。
804+ - 当 `renderType` 为 `color` 时,`render` 参数为颜色的十六进制代码。例如 `#000000`。
805+ - 当 `renderType` 为 `text` 时,`render` 参数为文字内容。
806+ - ` multiple` :可选,是否支持多选,默认为 `false`。
807+ - ` size` :可选,渲染内容的尺寸,`number` 类型,单位为 `px`。
808+ - ` gap` :可选,渲染内容之间的间距,`number` 类型,单位为 `px`。
809+ - `value` : 可选初始值,数据类型为 `string | number | boolean | (string | number | boolean)[]`。
810+
811+ # ### 示例
812+
813+ ` ` ` yaml
814+ - $formkit: toggle
815+ label: 选择图片
816+ name: toggle
817+ render-type: image
818+ size: 100
819+ gap: 10
820+ help: 选择图片作为背景
821+ options:
822+ - label: 图文1
823+ value: 1
824+ render: https://placehold.co/600x400
825+ - label: 图文2
826+ value: 2
827+ render: https://placehold.co/600x400
828+ - label: 图文3
829+ value: 3
830+ render: https://placehold.co/600x400
831+
832+ ` ` `
833+
834+ # ### UI 效果
835+
836+ <p>
837+ <img src="/img/formkit/formkit-toggle.png" width="50%" class="medium-zoom-image" />
838+ </p>
839+
795840# ## secret
796841
797842密钥输入组件,用于选择一个密钥资源。
Original file line number Diff line number Diff line change @@ -3,6 +3,12 @@ title: API 变更日志
33description : 记录每一个版本的插件 API 变更记录,方便开发者适配
44---
55
6+ ## 2.22.8
7+
8+ ### 表单定义 > 新增 ` toggle ` 组件
9+
10+ 在 2.22.8 中,我们为 FormKit 表单新增了 ` toggle ` 组件,这是一个可以对一组图片、颜色或文字等进行选择切换的组件,详细文档可查阅:[ 表单定义#toggle] ( ../../developer-guide/form-schema.md#toggle )
11+
612## 2.22.5
713
814### SpringDoc 依赖更新可能导致插件无法启动
Original file line number Diff line number Diff line change @@ -3,6 +3,12 @@ title: API 变更日志
33description : 记录每一个版本的主题 API 变更记录,方便开发者适配
44---
55
6+ ## 2.22.8
7+
8+ ### 表单定义 > 新增 ` toggle ` 表单类型
9+
10+ 在 2.22.8 中,我们为 FormKit 表单新增了 ` toggle ` 组件,这是一个可以对一组图片、颜色或文字等进行选择切换的组件,详细文档可查阅:[ 表单定义#toggle] ( ../../developer-guide/form-schema.md#toggle )
11+
612## 2.22.2
713
814### 表单定义 > 新增 ` switch ` 表单类型
You can’t perform that action at this time.
0 commit comments