Form 表单

介绍

用于数据录入、校验，支持输入框、单选框、复选框、文件上传等类型，需要与 Field 输入框 组件搭配使用。

基础用法

在表单中，每个 Field 组件 代表一个表单项，使用 Field 的 rules 属性定义校验规则。

<z-form ref="formBasic" @submit="onSubmitBasic">
  <z-field
    v-model="username"
    name="用户名"
    label="用户名"
    placeholder="用户名"
    :rules="[{ required: true, message: '请填写用户名' }]"
  />
  <z-field
    v-model="password"
    type="password"
    name="密码"
    label="密码"
    placeholder="密码"
    :rules="[{ required: true, message: '请填写密码' }]"
  />
</z-form>
<view class="button">
  <z-button block type="primary" @click="submitFormBasic">
    提交
  </z-button>
</view>

import { ref } from 'vue';
const username = ref('')
const password = ref('')
const onSubmitBasic = (values: any) => {
  console.log('submit', values)
}

<style lang="scss" scoped>
.demo-form {
  .button {
    margin-top: 20rpx;
  }
}
</style>

校验规则

通过 rules 定义表单校验规则，所有可用字段见下方表格。

<z-form @failed="onFailed">
  <z-cell-group inset>
    <!-- 通过 pattern 进行正则校验 -->
    <z-field
      v-model="value1"
      name="pattern"
      placeholder="正则校验"
      :rules="[{ pattern, message: '请输入正确内容' }]"
    />
    <!-- 通过 validator 进行函数校验 -->
    <z-field
      v-model="value2"
      name="validator"
      placeholder="函数校验"
      :rules="[{ validator, message: '请输入正确内容' }]"
    />
    <!-- 通过 validator 返回错误提示 -->
    <z-field
      v-model="value3"
      name="validatorMessage"
      placeholder="校验函数返回错误提示"
      :rules="[{ validator: validatorMessage }]"
    />
    <!-- 通过 validator 进行异步函数校验 -->
    <z-field
      v-model="value4"
      name="asyncValidator"
      placeholder="异步函数校验"
      :rules="[{ validator: asyncValidator, message: '请输入正确内容' }]"
    />
  </z-cell-group>
  <div style="margin: 16px;">
    <z-button round block type="primary" native-type="submit">
      提交
    </z-button>
  </div>
</z-form>

import { ref } from 'vue';
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const value1 = ref('')
const value2 = ref('')
const value3 = ref('abc')
const value4 = ref('')
const pattern = /\d{6}/
const validator = (val: any) => /1\d{10}/.test(val)
const validatorMessage = (val: any) => `${val} 不合法，请重新输入`
const asyncValidator = (val: any) =>
  new Promise((resolve) => {
    toast.showLoadingToast('验证中...')

    setTimeout(() => {
      toast.closeToast()
      resolve(val === '1234')
    }, 1000)
  })
const onFailed = (errorInfo: any) => {
  console.log('failed', errorInfo)
}

表单项类型 - 开关

在表单中使用 Switch 组件。

<z-field name="switch" label="开关">
  <template #input>
    <z-switch v-model="switchChecked" />
  </template>
</z-field>

表单项类型 - 复选框

在表单中使用 Checkbox 组件。

<z-field name="checkbox" label="复选框">
  <template #input>
    <z-checkbox v-model="checked" shape="square" />
  </template>
</z-field>
<z-field name="checkboxGroup" label="复选框组">
  <template #input>
    <z-checkbox-group v-model="groupChecked" direction="horizontal">
      <z-checkbox name="1" shape="square">复选框 1</z-checkbox>
      <z-checkbox name="2" shape="square">复选框 2</z-checkbox>
    </z-checkbox-group>
  </template>
</z-field>

表单项类型 - 单选框

在表单中使用 Radio 组件。

<z-field name="radio" label="单选框">
  <template #input>
    <z-radio-group v-model="checked" direction="horizontal">
      <z-radio name="1">单选框 1</z-radio>
      <z-radio name="2">单选框 2</z-radio>
    </z-radio-group>
  </template>
</z-field>

表单项类型 - 步进器

在表单中使用 Stepper 组件。

<z-field name="stepper" label="步进器">
  <template #input>
    <z-stepper v-model="value" />
  </template>
</z-field>

表单项类型 - 评分

在表单中使用 Rate 组件。

<z-field name="rate" label="评分">
  <template #input>
    <z-rate v-model="value" />
  </template>
</z-field>

表单项类型 - 滑块

在表单中使用 Slider 组件。

<z-field name="slider" label="滑块">
  <template #input>
    <z-slider v-model="value" />
  </template>
</z-field>

表单项类型 - 文件上传

在表单中使用 Uploader 组件。

<z-field name="uploader" label="文件上传">
  <template #input>
    <z-uploader v-model="value" />
  </template>
</z-field>

表单项类型 - 选择器

在表单中使用 Picker 组件。

<z-field
  v-model="result"
  is-link
  readonly
  name="picker"
  label="选择器"
  placeholder="点击选择城市"
  @click="showPicker = true"
/>
<z-popup v-model:show="showPicker" position="bottom">
  <z-picker
    :columns="columns"
    @confirm="onConfirm"
    @cancel="showPicker = false"
  />
</z-popup>

表单项类型 - 日期选择器

在表单中使用 DatePicker 组件。

<z-field
  v-model="result"
  is-link
  readonly
  name="datePicker"
  label="时间选择"
  placeholder="点击选择时间"
  @click="showPicker = true"
/>
<z-popup v-model:show="showPicker" position="bottom">
  <z-date-picker @confirm="onConfirm" @cancel="showPicker = false" />
</z-popup>

表单项类型 - 省市区选择器

在表单中使用 Area 组件。

<z-field
  v-model="result"
  is-link
  readonly
  name="area"
  label="地区选择"
  placeholder="点击选择省市区"
  @click="showArea = true"
/>
<z-popup v-model:show="showArea" position="bottom">
  <z-area
    :area-list="areaList"
    @confirm="onConfirm"
    @cancel="showArea = false"
  />
</z-popup>

表单项类型 - 日历

在表单中使用 Calendar 组件。

<z-field
  v-model="result"
  is-link
  readonly
  name="calendar"
  label="日历"
  placeholder="点击选择日期"
  @click="showCalendar = true"
/>
<z-calendar v-model:show="showCalendar" @confirm="onConfirm" />

Props

表单项的 API 参见：Field 组件

Rule 数据结构

使用 Field 的 rules 属性可以定义校验规则，可选属性如下:

validate-trigger 可选值

通过 validate-trigger 属性可以自定义表单校验的触发时机。

Events

方法

通过 ref 可以获取到 Form 实例并调用实例方法。

Slots