如何在Vue3中实现一个带有自动补全功能的搜索框

本文链接：https://blog.csdn.net/yuanlong12178/article/details/139804955

前端开发中的自动补全搜索框不仅能够提升用户体验，还能显著提高用户输入效率。在现代Web开发中，Vue.js作为一个非常流行的前端框架，提供了实现这些功能的优秀工具和方法。本文将向您展示如何在Vue3中实现一个带有自动补全功能的搜索框。

1. 初始化Vue3项目

首先，我们需要初始化一个Vue3项目。在这里我们使用Vue CLI来快速创建一个项目。

npm install -g @vue/cli
vue create auto-complete-search

选择默认的配置，等待安装完成后，我们进入项目目录：

cd auto-complete-search
npm run serve

我们现在已经有了基本的Vue3项目结构。

2. 创建组件库

在src文件夹下创建一个名为components的文件夹，并在其下创建一个名为AutoCompleteSearch.vue的文件。这就是我们将要实现自动补全搜索框的组件。

3. 设计组件结构

组件的核心大致包括以下几部分：

输入框
下拉提示框
数据处理

我们首先在AutoCompleteSearch.vue中添加基本的模板结构：

<template>
  <div class="auto-complete-search">
    <input 
      type="text" 
      v-model="query" 
      @input="onInput"
      @keydown.down="onArrowDown"
      @keydown.up="onArrowUp"
      @keydown.enter="onEnter"
    />
    <ul v-if="showSuggestions">
      <li 
        v-for="(suggestion, index) in filteredSuggestions" 
        :key="index"
        @click="selectSuggestion(suggestion)"
        :class="{ highlighted: index === highlightedIndex }"
      >
        {{ suggestion }}
      </li>
    </ul>
  </div>
</template>

这个模板包含一个输入框和一个下拉菜单用于提示用户输入的建议。

4. 添加数据和方法

接下来，在

<script>
export default {
  name: 'AutoCompleteSearch',
  data() {
    return {
      query: '',
      suggestions: ['Apple', 'Banana', 'Cherry', 'Date', 'Grape', 'Orange', 'Strawberry'],
      filteredSuggestions: [],
      showSuggestions: false,
      highlightedIndex: -1,
    }
  },
  methods: {
    onInput() {
      if (this.query.length > 0) {
        this.filteredSuggestions = this.suggestions.filter(
          suggestion => suggestion.toLowerCase().includes(this.query.toLowerCase())
        );
        this.showSuggestions = this.filteredSuggestions.length > 0;
      } else {
        this.showSuggestions = false;
      }
    },
    selectSuggestion(suggestion) {
      this.query = suggestion;
      this.showSuggestions = false;
    },
    onArrowDown() {
      if (this.highlightedIndex < this.filteredSuggestions.length - 1) {
        this.highlightedIndex++;
      }
    },
    onArrowUp() {
      if (this.highlightedIndex > 0) {
        this.highlightedIndex--;
      }
    },
    onEnter() {
      if (this.highlightedIndex >= 0) {
        this.selectSuggestion(this.filteredSuggestions[this.highlightedIndex]);
      }
    },
  }
}
</script>

在data()中，我们初始化了输入内容query、用于建议的数组suggestions、经过过滤的建议filteredSuggestions、是否显示建议showSuggestions和高亮显示的建议索引highlightedIndex。

在methods中，onInput负责处理输入事件，每当用户输入时，会根据输入的内容过滤建议。selectSuggestion 方法在用户选中一条建议时更新输入框。onArrowDown, onArrowUp, 和 onEnter 用来处理键盘导航。

5. 样式调整

接下来，我们添加一些基本的样式来让组件更友好：

<style scoped>
.auto-complete-search {
  position: relative;
  width: 300px;
  margin: 20px auto;
}
.auto-complete-search input {
  width: 100%;
  padding: 8px;
  box-sizing: border-box;
}
.auto-complete-search ul {
  list-style-type: none;
  padding: 0;
  margin: 0;
  position: absolute;
  width: 100%;
  max-height: 200px;
  overflow-y: auto;
  border: 1px solid #ccc;
  border-top: none;
  box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);
  background-color: #fff;
  z-index: 1000;
}
.auto-complete-search li {
  padding: 8px;
  cursor: pointer;
}
.auto-complete-search li.highlighted {
  background-color: #007BFF;
  color: #fff;
}
</style>

6. 使用组件

现在我们已经完成了自动补全搜索框组件的设计和实现，在App.vue中我们可以使用它：

<template>
  <div id="app">
    <AutoCompleteSearch />
  </div>
</template>

<script>
import AutoCompleteSearch from './components/AutoCompleteSearch.vue';

export default {
  name: 'App',
  components: {
    AutoCompleteSearch
  }
}
</script>

<style>
#app {
  font-family: Avenir, Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
}
</style>