FormList 表单

{ "input": "", "inputNumber": null, "radioGroup": "1", "switch": 0, "autocomplete": "", "select": "1", "cascader": [ "1", "2", "3" ], "datePicker": [ "2022-02-11 12:00:00", "2022-03-16 12:00:00" ], "slot": "", "extendSlot": "", "slotA": "", "upload": "" }

vue

<script setup lang="ts">
import type { FormListOptions } from 'qin-lantern'
import { QlFormList } from 'qin-lantern'

// 模拟接口延时
import { delayed } from './utils'

const timedelay = delayed()

const loading = ref(false)
onMounted(async () => {
  loading.value = true
  await timedelay().finally(() => {
    loading.value = false
  })
})

const formData = reactive({
  input: '',
  inputNumber: null,
  radioGroup: '1',
  switch: 0,
  autocomplete: '',
  select: '1',
  cascader: ['1', '2', '3'],
  datePicker: ['2022-02-11 12:00:00', '2022-03-16 12:00:00'],
  slot: '',
  extendSlot: '',
  slotA: '',
  upload: '',
})

const options = reactive<FormListOptions>([
  {
    label: 'form表单封装',
    type: 'txt', // 'show'|'txt'|'input'|'inputNumber'|'radioGroup'|'switch'|'autocomplete'|'select'|'cascader'|'datePicker'|'upload'|'slot'
  },
  {
    label: '输入框',
    key: 'input',
    type: 'input',
    // hidden: true, // 是否隐藏
    bind: { // 绑定属性
      type: 'textarea',
    },
    on: { // 绑定事件
      change(data: string | number) {
        console.log(`input change data:${data}`)
      },
    },
    rule: [{ // 验证规则
      required: true,
      message: 'Please input Activity input',
      trigger: 'blur',
    }],
  },
  {
    label: '数字输入框',
    key: 'inputNumber',
    type: 'inputNumber',
    bind: {
      min: 0,
      precision: 2,
    },
    rule: [{
      required: true,
      message: 'Please input Activity inputNumber',
      trigger: 'blur',
    }],
  },
  {
    label: '单选框',
    key: 'radioGroup',
    type: 'radioGroup',
    options: [ // 可以使用el-radio 的所有属性
      {
        value: '1',
        label: 'Option1',
      },
      {
        value: '2',
        label: 'Option2',
        disabled: true,
      },
    ],
    on: {
      change(data: string | number | boolean) {
        console.log(`radioGroup change data:${data}`)
      },
    },
    rule: [{
      required: true,
      message: 'Please input Activity radioGroup',
      trigger: 'change',
    }],
  },
  {
    label: '多选框',
    key: 'checkboxGroup',
    type: 'checkboxGroup',
    options: [ // 可以使用el-checkbox 的所有属性
      {
        value: '1',
        label: 'Option1',
      },
      {
        value: '2',
        label: 'Option2',
        size: 'small',
      },
    ],
  },
  {
    label: 'Switch开关',
    key: 'switch',
    type: 'switch',
    bind: {
      activeText: '是',
      inactiveText: '否',
      activeValue: 1,
      inactiveValue: 0,
    },
  },
  {
    label: '远程搜索',
    key: 'autocomplete',
    type: 'autocomplete',
    bind: {
      // 参考文档fetch-suggestions
      fetchSuggestions: async (_queryString: string, callback: any) => {
        const data = await timedelay([
          { value: 'vue', link: 'https://github.com/vuejs/vue' },
          { value: 'element', link: 'https://github.com/ElemeFE/element' },
          { value: 'cooking', link: 'https://github.com/ElemeFE/cooking' },
        ])
        callback(data)
      },
    },
    rule: [{
      required: true,
      message: 'Please input Activity autocomplete',
      trigger: 'change',
    }],
  },
  // 隐藏交互，type: 'show'之后的数据模式隐藏
  {
    label: '隐藏显示配置项', // 默认显示 更多信息
    type: 'show',
  },
  {
    label: '下拉选择器',
    key: 'select',
    type: 'select',
    bind: {
      filterable: true,
    },
    options: [{ // 可以使用el-option的所有属性
      value: '1',
      label: 'Option1',
    }, {
      value: '2',
      label: 'Option2',
      disabled: true,
    }],
    rule: [{
      required: true,
      message: 'Please input Activity select',
      trigger: 'change',
    }],
  },
  {
    label: '级联选择器',
    key: 'cascader',
    type: 'cascader',
    bind: {
      options: [
        {
          value: '1',
          label: 'Guide',
          children: [{
            value: '2',
            label: 'Disciplines',
            children: [
              {
                value: '3',
                label: 'Consistency',
              },
              {
                value: '4',
                label: 'Feedback',
              },
              {
                value: '5',
                label: 'Efficiency',
              },
              {
                value: '6',
                label: 'Controllability',
              },
            ],
          }],
        },
      ],
    },
    rule: [{
      required: true,
      message: 'Please input Activity cascader',
      trigger: 'change',
    }],
  },
  {
    label: '日期选择器',
    key: 'datePicker',
    type: 'datePicker',
    bind: {
      type: 'datetimerange', // date:单选时间 daterange:范围时间  datetime:单选时间(时分秒) datetimerange:范围时间(时分秒)
      valueFormat: 'YYYY-MM-DD HH:mm:ss', // 绑定值的格式
    },
    rule: [{
      required: true,
      message: 'Please input Activity datePicker',
      trigger: 'change',
    }],
  },
  { // type: 'slot' 插入el-form-item之内
    label: 'slot',
    key: 'slot',
    type: 'slot',
    rule: [{
      required: true,
      message: 'Please input slot',
      trigger: 'blur',
    }],
  },
  { // type: 'extendSlot' 插入el-form之内和el-form-item平级
    key: 'extendSlot',
    type: 'extendSlot',
    col: { sm: 12, lg: 24 },
    hidden: false,
  },

  {
    label: 'slotA',
    key: 'slotA',
    type: 'slot',
    col: { sm: 12, lg: 24 }, // col可以为数字或对象
    rule: [{
      required: true,
      message: 'Please input slotA',
      trigger: 'blur',
    }],
  },
  {
    label: '图片上传',
    key: 'upload',
    type: 'upload',
    col: 24, // 固定某一栏占位
    bind: {
      limit: 1,
    },
    rule: [{
      required: true,
      trigger: 'change',
      validator(_rule: any, value: any, callback: any) {
        if (!value) {
          callback(new Error('请上传图片'))
        }
        else {
          callback()
        }
      },
    }],
  },
])

const form = ref<InstanceType<typeof QlFormList>>()
async function validate() {
  await form.value?.validate()
}
function resetFields() {
  form.value?.resetFields()
}

const flag = ref(false)
function showHidden() {
  flag.value = !flag.value
  /**
   * 多个属性隐藏时, 可传递数组  isHide(['upload'], flag)
   */
  form.value?.isHide(['upload'], flag.value)
}
</script>

<template>
  <ql-card>
    <template #search>
      <!-- col在指定的断点及以上生效
        col默认值 {
          xs: 24,
          sm: 12,
          md: 8,
          lg: 6,
          xl: 4
        }
      -->
      <QlFormList
        ref="form"
        v-model="formData"
        v-loading="loading"
        :options="options"
        :col="{ xs: 24, sm: 12 }"
      >
        <!-- 插入el-form-item之内  插槽名与key保持一致  即#name  key="name" -->
        <template #slot>
          <el-input
            v-model="formData.slot"
            clearable
            placeholder="请输入slot"
          />
        </template>
        <!-- extendSlot插槽和 el-form-item 平级 可以自定义复杂逻辑 -->
        <template #extendSlot>
          <el-form-item
            label="extendSlot"
            prop="extendSlot"
            :rules="[{
              required: true,
              message: 'Please input extendSlot',
              trigger: 'blur',
            }]"
          >
            <el-input
              v-model="formData.extendSlot"
              clearable
              placeholder="请输入extendSlot"
            />
          </el-form-item>
        </template>

        <template #slotA>
          <el-input
            v-model="formData.slotA"
            clearable
            placeholder="请输入slotA"
          />
        </template>

        <!-- 额外插槽可自定义规则 -->
        <el-form-item>
          <el-button @click="validate">
            校验
          </el-button>
          <el-button @click="resetFields">
            重置
          </el-button>
          <!-- 会重置数据 -->
          <el-button @click="showHidden">
            {{ flag ? '显示' : '隐藏' }}upload
          </el-button>
        </el-form-item>
      </QlFormList>
    </template>
    {{ formData }}
  </ql-card>
</template>

<style scoped lang='scss'></style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367

API

Attributes

属性名	说明	类型	默认
v-model	表单数据对象	`Record<string, any>`	-
options	表单配置项	`FormListOptions`	[]
col	布局分栏	`object`	`{xs: 24, sm: 12, md: 8, lg: 6, xl: 4}`

Exposes

名称	说明	类型
validate	对整个表单的内容进行验证。接收一个回调函数，或返回 Promise	`(callback?: FormValidateCallback) => Promise<void>`
validateField	验证具体的某个字段。	`(props?: Arrayable<FormItemProp>` \|`undefined, callback?: FormValidateCallback`\| `undefined) => FormValidationResult`
resetFields	重置该表单项，将其值重置为初始值，并移除校验结果	`(props?: Arrayable<FormItemProp>`\|`undefined) => void`
scrollToField	滚动到指定的字段	`(prop: FormItemProp) => void`
clearValidate	清理某个字段的表单验证信息	`(props?: Arrayable<FormItemProp>` \| `undefined) => void`
isHide	隐藏显示配置项	`(data: string, flag: boolean) => Promise<void>`

Other Attributes

FormList 表单 ​

API ​

Attributes ​

Exposes ​

FormList 表单

API

Attributes

Exposes