From fb691cad4a3f1db7baa17afe68ad96c4432603d8 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Tue, 13 Jun 2023 10:54:12 +0800 Subject: [PATCH] docs: refine repeater props (#232) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 完善开发者文档中关于 Repeater 表单项的参数。 /kind documentation ```release-note None ``` --- docs/developer-guide/form-schema.md | 13 +++++++++--- .../developer-guide/form-schema.md | 21 ++++++++++++++++--- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/developer-guide/form-schema.md b/docs/developer-guide/form-schema.md index 4d2eeac..c5972cd 100644 --- a/docs/developer-guide/form-schema.md +++ b/docs/developer-guide/form-schema.md @@ -67,12 +67,17 @@ spec: 除了 FormKit 官方提供的常用输入组件之外,Halo 还额外提供了一些输入组件,这些输入组件可以在 Form Schema 中使用。 -### Repeater +### repeater #### 描述 一组重复的输入组件,可以用于定义一组数据,最终得到的数据为一个对象的数组,可以方便地让使用者对其进行增加、移除、排序等操作。 +#### 参数 + +- `min`:数组最小要求数量,默认为 `0` +- `max`:数组最大容量,默认为 `Infinity`,即无限制。 + #### 示例 ```yaml @@ -80,6 +85,8 @@ spec: name: socials label: 社交账号 value: [] + max: 5 + min: 1 children: - $formkit: text name: name @@ -112,7 +119,7 @@ UI 效果: -### Attachment +### attachment #### 描述 @@ -135,7 +142,7 @@ UI 效果: value: "" ``` -### Code +### code #### 描述 diff --git a/versioned_docs/version-2.6/developer-guide/form-schema.md b/versioned_docs/version-2.6/developer-guide/form-schema.md index 24e7adc..c5972cd 100644 --- a/versioned_docs/version-2.6/developer-guide/form-schema.md +++ b/versioned_docs/version-2.6/developer-guide/form-schema.md @@ -67,12 +67,17 @@ spec: 除了 FormKit 官方提供的常用输入组件之外,Halo 还额外提供了一些输入组件,这些输入组件可以在 Form Schema 中使用。 -### Repeater +### repeater #### 描述 一组重复的输入组件,可以用于定义一组数据,最终得到的数据为一个对象的数组,可以方便地让使用者对其进行增加、移除、排序等操作。 +#### 参数 + +- `min`:数组最小要求数量,默认为 `0` +- `max`:数组最大容量,默认为 `Infinity`,即无限制。 + #### 示例 ```yaml @@ -80,6 +85,8 @@ spec: name: socials label: 社交账号 value: [] + max: 5 + min: 1 children: - $formkit: text name: name @@ -112,22 +119,30 @@ UI 效果: -### Attachment +### attachment #### 描述 附件类型的输入框,支持直接调用附件库弹框选择附件。 +#### 参数 + +- `accepts`:文件类型,数据类型为 `string[]`。 + #### 示例 ```yaml - $formkit: attachment name: logo label: Logo + accepts: + - "image/png" + - "video/mp4" + - "audio/*" value: "" ``` -### Code +### code #### 描述