Vue-Mention 项目教程

1. 项目介绍

Vue-Mention 是一个基于 Vue.js 的小型组件库，旨在简化在文本输入框中添加提及功能的过程。它允许用户通过输入特定的触发字符（默认为 @）来搜索和选择用户名，然后将所选用户名插入到文本中，同时自动创建一个链接指向该用户的详细资料页面。这款插件不仅易用，而且性能高效，能够很好地适应各种项目需求。

2. 项目快速启动

安装

首先，你需要安装 Vue-Mention 和 floating-vue：

pnpm i vue-mention@next
pnpm i floating-vue

然后，添加 floating-vue 的默认样式：

import 'floating-vue/dist/style.css'

快速开始

以下是一个简单的示例，展示如何在 Vue 项目中使用 Vue-Mention：

<template>
  <Mentionable :keys="['@', '#']" :items="items" offset="6" insert-space @open="onOpen">
    <textarea v-model="text" />
    <template #no-result>
      <div class="dim"> No result </div>
    </template>
    <template #item-@="[item]">
      <div class="user"> [[ item.value ]] <span class="dim"> ([[ item.firstName ]]) </span> </div>
    </template>
    <template #item-#="[item]">
      <div class="issue"> <span class="number"> #[[ item.value ]] </span> <span class="dim"> [[ item.label ]] </span> </div>
    </template>
  </Mentionable>
</template>

<script>
import { Mentionable } from 'vue-mention'

const users = [
  { value: 'akryum', firstName: 'Guillaume' },
  { value: 'posva', firstName: 'Eduardo' },
  { value: 'atinux', firstName: 'Sébastien' }
]

const issues = [
  { value: 123, label: 'Error with foo bar', searchText: 'foo bar' },
  { value: 42, label: 'Cannot read line', searchText: 'foo bar line' },
  { value: 77, label: 'I have a feature suggestion', searchText: 'feature' }
]

export default {
  components: { Mentionable },
  data() {
    return {
      text: '',
      items: []
    }
  },
  methods: {
    onOpen(key) {
      this.items = key === '@' ? users : issues
    }
  }
}
</script>

3. 应用案例和最佳实践

应用案例

Vue-Mention 适用于任何需要提及功能的场景，如社交网络、论坛、博客评论等。无论你是要创建一个新的社交应用，还是希望为现有的在线社区添加互动元素，Vue-Mention 都能为你提供助力。

最佳实践

1. 自定义触发字符：你可以根据需求自定义触发字符，例如使用 # 来提及话题。
2. 自定义模板：通过自定义模板，你可以轻松调整提及的样式以匹配你的应用设计。
3. 事件驱动：利用 onSelect 和 onChange 等事件，在提及操作发生时执行额外逻辑。

4. 典型生态项目

Vue-Mention 是 Vue.js 生态系统中的一个重要组件，与其他 Vue.js 项目和库兼容良好。以下是一些典型的生态项目：

• Vue.js：Vue-Mention 是基于 Vue.js 构建的，因此与 Vue.js 框架完美兼容。
• Floating-Vue：Vue-Mention 依赖于 Floating-Vue 来实现弹出提示功能。
• Element UI：如果你使用 Element UI 作为 UI 框架，Vue-Mention 可以与之无缝集成。

通过这些生态项目的结合，你可以构建出功能强大且用户体验良好的 Web 应用。