Field 输入框

介绍

用户可以在文本框内输入或编辑文字。

基础用法

可以通过 v-model 双向绑定输入框的值，通过 placeholder 设置占位提示文字。

 <z-field v-model="value" label="文本" placeholder="请输入文本" />

import { ref } from 'vue'
const value = ref('')

自定义类型

根据 type 属性定义不同类型的输入框，默认值为 text。

  <!-- 输入任意文本 -->
  <z-field v-model="text" label="文本" />
  <!-- 输入手机号，调起手机号键盘 -->
  <z-field v-model="tel" type="tel" label="手机号" />
  <!-- 允许输入正整数，调起纯数字键盘 -->
  <z-field v-model="digit" type="digit" label="整数" />
  <!-- 允许输入数字，调起带符号的纯数字键盘 -->
  <z-field v-model="number" type="number" label="数字" />
  <!-- 输入密码 -->
  <z-field v-model="password" type="password" label="密码" />

禁用输入框

通过 readonly 将输入框设置为只读状态，通过 disabled 将输入框设置为禁用状态。

  <z-field label="文本" model-value="输入框只读" readonly />
  <z-field label="文本" model-value="输入框已禁用" disabled />

显示图标

通过 left-icon 和 right-icon 配置输入框两侧的图标，通过设置 clearable 在输入过程中展示清除图标。

<z-cell-group inset>
  <z-field
    v-model="value1"
    label="文本"
    left-icon="detail"
    right-icon="info-circle"
    placeholder="显示图标"
  />
  <z-field
    v-model="value2"
    clearable
    label="文本"
    left-icon="safetycertificate"
    placeholder="显示清除图标"
  />
</z-cell-group>

必填星号

设置 required 属性来展示必填星号。

  <z-field
    v-model="username"
    required
    label="用户名"
    placeholder="请输入用户名"
  />
  <z-field
    v-model="phone"
    required
    label="手机号"
    placeholder="请输入手机号"
  />

请注意 required 属性只用于控制样式展示，在进行表单校验时，需要使用 rule.required 选项来控制校验逻辑。

自动展示星号

你可以在 Form 组件上设置 required="auto"，此时 Form 里的所有 Field 会自动根据 rule.required 来判断是否需要展示星号。

<z-form required="auto">
  <z-field
    v-model="username"
    :rules="[{ required: true }]"
    label="用户名"
    placeholder="请输入用户名"
  />
  <z-field
    v-model="phone"
    :rules="[{ required: false }]"
    label="手机号"
    placeholder="请输入手机号"
  />
</z-form>

错误提示

设置 required 属性表示这是一个必填项，可以配合 error 或 error-message 属性显示对应的错误提示。

  <z-field
    v-model="username"
    error
    label="用户名"
    placeholder="请输入用户名"
  />
  <z-field
    v-model="phone"
    label="手机号"
    placeholder="请输入手机号"
    error-message="手机号格式错误"
  />

插入按钮

通过 button 插槽可以在输入框尾部插入按钮。

  <z-field
    v-model="sms"
    center
    clearable
    label="短信验证码"
    placeholder="请输入短信验证码"
  >
    <template #button>
      <z-button size="small" type="primary">发送验证码</z-button>
    </template>
  </z-field>

格式化输入内容

通过 formatter 属性可以对输入的内容进行格式化，通过 format-trigger 属性可以指定执行格式化的时机，默认在输入时进行格式化。

  <z-field
    v-model="value1"
    label="文本"
    :formatter="formatter"
    placeholder="在输入时执行格式化"
  />
  <z-field
    v-model="value2"
    label="文本"
    :formatter="formatter"
    format-trigger="onBlur"
    placeholder="在失焦时执行格式化"
  />

// 过滤输入的数字
const formatter = (value) => value.replace(/\d/g, '');

高度自适应

对于 textarea，可以通过 autosize 属性设置高度自适应。

  <z-field
    v-model="message"
    rows="1"
    autosize
    label="留言"
    type="textarea"
    placeholder="请输入留言"
  />

显示字数统计

设置 maxlength 和 show-word-limit 属性后会在底部显示字数统计。

  <z-field
    v-model="message"
    rows="2"
    autosize
    label="留言"
    type="textarea"
    maxlength="50"
    placeholder="请输入留言"
    show-word-limit
  />

输入框内容对齐

通过 input-align 属性可以设置输入框内容的对齐方式，可选值为 center、right。

  <z-field
    v-model="value"
    label="文本"
    placeholder="输入框内容右对齐"
    input-align="right"
  />

输入框文本位置

通过 label-align 属性可以设置输入框文本的位置，可选值为 center、right、top。

  <z-field
    v-model="value"
    label="文本"
    placeholder="顶部对齐"
    label-align="top"
  />
  <z-field
    v-model="value2"
    label="文本"
    placeholder="左对齐"
    label-align="left"
  />
  <z-field
    v-model="value3"
    label="文本"
    placeholder="居中对齐"
    label-align="center"
  />
  <z-field
    v-model="value4"
    label="文本"
    placeholder="右对齐"
    label-align="right"
  />

Props

Events

方法

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

Slots

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。