JSRUN 用代码说话

Search 搜索

编辑教程

Search 搜索

引入

import Vue from 'vue';
import { Search } from 'vant';

Vue.use(Search);

代码演示

基础用法

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

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

事件监听

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

<form action="/">
  <van-search
    v-model="value"
    show-action
    placeholder="请输入搜索关键词"
    @search="onSearch"
    @cancel="onCancel"
  />
</form>


import { Toast } from 'vant';

export default {
  data() {
    return {
      value: ''
    };
  },
  methods: {
    onSearch(val) {
      Toast(val);
    },
    onCancel() {
      Toast('取消');
    }
  }
}

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

搜索框内容对齐

通过 input-align 属性设置搜索框内容的对齐方式,可选值为center、right

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

禁用搜索框

通过disabled属性禁用搜索框

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

自定义背景色

通过background属性可以设置搜索框外部的背景色,通过shape属性设置搜索框的形状,可选值为round

<van-search
  v-model="value"
  shape="round"
  background="#4fc08d"
  placeholder="请输入搜索关键词"
/>

自定义按钮

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

<van-search
  v-model="value"
  show-action
  placeholder="请输入搜索关键词"
  @search="onSearch"
>
  <div slot="action" @click="onSearch">搜索</div>
</van-search>

API

Props

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

实例

JSRUN闪电教程系统是国内最先开创的教程维护系统, 所有工程师都可以参与共同维护的闪电教程,让知识的积累变得统一完整、自成体系。 大家可以一起参与进共编,让零散的知识点帮助更多的人。
X
支付宝
9.99
无法付款,请点击这里
金额: 0
备注:
转账时请填写正确的金额和备注信息,到账由人工处理,可能需要较长时间
如有疑问请联系QQ:565830900
正在生成二维码, 此过程可能需要15秒钟