Search 搜索

引入

通过以下方式来全局注册组件，更多注册方式请参考。

基础用法

用于控制搜索框中的文字，background 可以自定义搜索框外部背景色。

  1. <van-search v-model="value" placeholder="请输入搜索关键词" />
  1. import { ref } from 'vue';
  3. export default {
  4.     const value = ref('');
  5.     return { value };
  6.   },
  7. };

事件监听

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

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

搜索框内容对齐

  1. <van-search
  2.   v-model="value"
  3.   placeholder="请输入搜索关键词"
  4.   input-align="center"
  5. />

通过 属性禁用搜索框。

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

自定义背景色

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

  1. <van-search
  2.   v-model="value"
  3.   shape="round"
  4.   background="#4fc08d"
  5. />

自定义按钮

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

  1. import { ref } from 'vue';
  2. import { showToast } from 'vant';
  4. export default {
  5.   setup() {
  6.     const value = ref('');
  7.     const onSearch = (val) => showToast(val);
  8.     const onClickButton = () => showToast(value.value);
  9.     return {
  10.       value,
  11.       onSearch,
  12.       onClickButton,
  13.     };
  14.   },
  15. };

Props

Events

通过 ref 可以获取到 Search 实例并调用实例方法，详见。

类型定义

  1. import type { SearchProps, SearchShape, SearchInstance } from 'vant';

SearchInstance 是组件实例的类型，用法如下：

  1. import { ref } from 'vue';
  2. import type { SearchInstance } from 'vant';
  4. const searchRef = ref<SearchInstance>();

Slots

样式变量

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

在桌面端点击清除按钮无效？

清除按钮监听是的移动端 Touch 事件，参见。