Search 搜索

引入

  1. import Vue from 'vue';
  2. import { Search } from 'vant';
  3. Vue.use(Search);

代码演示

基础用法

v-model 用于控制搜索框中的文字,background 可以自定义搜索框外部背景色

  1. <van-search placeholder="请输入搜索关键词" v-model="value" />

事件监听

Search 组件提供了searchcancel事件,search事件在点击键盘上的搜索/回车按钮后触发,cancel事件在点击搜索框右侧取消按钮时触发

  1. <form action="/">
  2. <van-search
  3. v-model="value"
  4. placeholder="请输入搜索关键词"
  5. show-action
  6. @search="onSearch"
  7. @cancel="onCancel"
  8. />
  9. </form>

Tips: 在 van-search 外层增加 form 标签,且 action 不为空,即可在 iOS 输入法中显示搜索按钮

自定义按钮

使用action插槽可以自定义右侧按钮的内容。使用插槽后,cancel 事件将不再触发

  1. <van-search
  2. v-model="value"
  3. placeholder="请输入搜索关键词"
  4. show-action
  5. shape="round"
  6. @search="onSearch"
  7. >
  8. <div slot="action" @click="onSearch">搜索</div>
  9. </van-search>

API

Props

参数说明类型默认值
label搜索框左侧文本string-
shape搜索框形状,可选值为 roundstringsquare
background搜索框背景色string#f2f2f2
maxlength输入的最大字符数string | number-
placeholder占位提示文字string-
clearable是否启用清除控件booleantrue
autofocus是否自动聚焦,iOS 系统不支持该属性booleanfalse
show-action是否在搜索框右侧显示取消按钮booleanfalse
action-text v2.2.2取消按钮文字boolean取消
disabled是否禁用输入框booleanfalse
readonly是否将输入框设为只读booleanfalse
error是否将输入内容标红booleanfalse
input-align输入框内容对齐方式,可选值为 center rightstringleft
left-icon输入框左侧图标名称或图片链接,可选值见 Icon 组件stringsearch
right-icon输入框右侧图标名称或图片链接,可选值见 Icon 组件string-

Events

事件名说明回调参数
search确定搜索时触发value: 输入框当前值
input输入框内容变化时触发value: 输入框当前值
focus输入框获得焦点时触发event: Event
blur输入框失去焦点时触发event: Event
clear点击清除按钮后触发event: Event
cancel点击取消按钮时触发-

Slots

名称说明
label自定义搜索框左侧文本
action自定义搜索框右侧按钮,设置show-action属性后展示
left-icon自定义输入框左侧图标
right-icon自定义输入框右侧图标

Search 搜索 - 图1