mirror of https://github.com/halo-dev/halo
217 lines
5.1 KiB
Markdown
217 lines
5.1 KiB
Markdown
# 自定义 FormKit 输入组件
|
||
|
||
## 原由
|
||
|
||
目前在 Console 端的所有表单都使用了 FormKit，但 FormKit 内置的 Input 组件并不满足所有的需求，因此需要自定义一些 Input 组件。此外，为了插件和主题能够更加方便的使用系统内的一些数据，所以同样需要自定义一些带数据的选择组件。
|
||
|
||
## 使用方式
|
||
|
||
目前已提供以下类型：
|
||
|
||
- `code`: 代码编辑器
|
||
- 参数
|
||
1. language: 目前支持 `yaml`, `html`, `css`, `javascript`, `json`
|
||
2. height: 编辑器高度，如：`100px`
|
||
- `attachment`: 附件选择
|
||
- 参数
|
||
1. accepts：允许上传的文件类型，如：`image/*`
|
||
- `repeater`: 定义一个对象集合，可以让使用者可视化的操作集合。
|
||
- 参数
|
||
1. min: 最小数量，默认为 `0`
|
||
2. max: 最大数量，默认为 `Infinity`，即无限制。
|
||
3. addLabel: 添加按钮的文本，默认为 `添加`
|
||
4. addButton: 是否显示添加按钮，默认为 `true`
|
||
5. upControl: 是否显示上移按钮，默认为 `true`
|
||
6. downControl: 是否显示下移按钮，默认为 `true`
|
||
7. insertControl: 是否显示插入按钮，默认为 `true`
|
||
8. removeControl: 是否显示删除按钮，默认为 `true`
|
||
- `list`: 动态列表，定义一个数组列表。
|
||
- 参数
|
||
1. itemType: 列表项的数据类型，用于初始化数据类型，可选参数 `string`, `number`, `boolean`, `object`，默认为 `string`
|
||
1. min: 最小数量，默认为 `0`
|
||
2. max: 最大数量，默认为 `Infinity`，即无限制。
|
||
3. addLabel: 添加按钮的文本，默认为 `添加`
|
||
4. addButton: 是否显示添加按钮，默认为 `true`
|
||
5. upControl: 是否显示上移按钮，默认为 `true`
|
||
6. downControl: 是否显示下移按钮，默认为 `true`
|
||
7. insertControl: 是否显示插入按钮，默认为 `true`
|
||
8. removeControl: 是否显示删除按钮，默认为 `true`
|
||
- `menuCheckbox`：选择一组菜单
|
||
- `menuRadio`：选择一个菜单
|
||
- `menuItemSelect`：选择菜单项
|
||
- `postSelect`：选择文章
|
||
- `singlePageSelect`：选择自定义页面
|
||
- `categorySelect`：选择分类
|
||
- 参数
|
||
1. multiple: 是否多选，默认为 `false`
|
||
- `categoryCheckbox`：选择多个分类
|
||
- `tagSelect`：选择标签
|
||
- 参数
|
||
1. multiple: 是否多选，默认为 `false`
|
||
- `tagCheckbox`：选择多个标签
|
||
- `verificationForm`: 远程验证一组数据是否符合某个规则
|
||
- 参数
|
||
1. action: 对目标数据进行验证的接口地址
|
||
2. label: 验证按钮文本
|
||
3. buttonAttrs: 验证按钮的额外属性
|
||
|
||
在 Vue 单组件中使用：
|
||
|
||
```vue
|
||
<script lang="ts" setup>
|
||
const postName = ref("");
|
||
</script>
|
||
|
||
<template>
|
||
<FormKit
|
||
v-model="postName"
|
||
placeholder="请选择文章"
|
||
label="文章"
|
||
type="postSelect"
|
||
validation="required"
|
||
/>
|
||
</template>
|
||
```
|
||
|
||
在 FormKit Schema 中使用（插件 / 主题设置表单定义）：
|
||
|
||
```yaml
|
||
- $formkit: menuRadio
|
||
name: menus
|
||
label: 底部菜单组
|
||
```
|
||
|
||
### list
|
||
|
||
list 是一个数组类型的输入组件，可以让使用者可视化的操作数组。它支持动态添加、删除、上移、下移、插入数组项等操作。
|
||
|
||
在 Vue SFC 中以组件形式使用：
|
||
|
||
```vue
|
||
<script lang="ts" setup>
|
||
const users = ref([]);
|
||
</script>
|
||
|
||
<template>
|
||
<FormKit
|
||
:min="1"
|
||
:max="3"
|
||
type="list"
|
||
label="Users"
|
||
add-label="Add User"
|
||
item-type="string"
|
||
>
|
||
<template #default="{ index }">
|
||
<FormKit
|
||
type="text"
|
||
:index="index"
|
||
validation="required"
|
||
/>
|
||
</template>
|
||
</FormKit>
|
||
</template>
|
||
```
|
||
|
||
在 FormKit Schema 中使用：
|
||
|
||
```yaml
|
||
- $formkit: list
|
||
name: users
|
||
label: Users
|
||
addLabel: Add User
|
||
min: 1
|
||
max: 3
|
||
itemType: string
|
||
children:
|
||
- $formkit: text
|
||
index: "$index"
|
||
validation: required
|
||
```
|
||
|
||
> [!NOTE]
|
||
> `list` 组件有且只有一个子节点，并且必须为子节点传递 `index` 属性。若想提供多个字段，则建议使用 `group` 组件包裹。
|
||
|
||
|
||
最终得到的数据类似于：
|
||
|
||
```json
|
||
{
|
||
"users": [
|
||
"Jack",
|
||
"John"
|
||
]
|
||
}
|
||
```
|
||
|
||
|
||
### Repeater
|
||
|
||
Repeater 是一个集合类型的输入组件，可以让使用者可视化的操作集合。
|
||
|
||
在 Vue SFC 中以组件形式使用：
|
||
|
||
```vue
|
||
<script lang="ts" setup>
|
||
const users = ref([]);
|
||
</script>
|
||
|
||
<template>
|
||
<FormKit
|
||
v-model="users"
|
||
:min="1"
|
||
:max="3"
|
||
addLabel="Add User"
|
||
type="repeater"
|
||
label="Users"
|
||
>
|
||
<FormKit
|
||
type="text"
|
||
label="Full Name"
|
||
name="full_name"
|
||
validation="required"
|
||
/>
|
||
<FormKit
|
||
type="email"
|
||
label="Email"
|
||
name="email"
|
||
validation="required|email"
|
||
/>
|
||
</FormKit>
|
||
</template>
|
||
```
|
||
|
||
在 FormKit Schema 中使用：
|
||
|
||
```yaml
|
||
- $formkit: repeater
|
||
name: users
|
||
label: Users
|
||
addLabel: Add User
|
||
min: 1
|
||
max: 3
|
||
items:
|
||
- $formkit: text
|
||
name: full_name
|
||
label: Full Name
|
||
validation: required
|
||
- $formkit: email
|
||
name: email
|
||
label: Email
|
||
validation: required|email
|
||
```
|
||
|
||
最终得到的数据类似于：
|
||
|
||
```json
|
||
[
|
||
{
|
||
"full_name": "Jack",
|
||
"email": "jack@example.com"
|
||
},
|
||
{
|
||
"full_name": "John",
|
||
"email": "john@example.com"
|
||
}
|
||
]
|
||
```
|