Vue + better-scroll 实现移动端字母索引导航功能

让我为你详细讲解“Vue + better-scroll 实现移动端字母索引导航功能”的完整攻略。

简介

better-scroll 是一款移动端的滚动库，可以使包裹内容的容器进行滚动并提供丰富的滚动特效。同时，Vue 是一款非常流行的前端框架，能够方便地将应用程序的数据和用户界面组件化，以及提供方便的指令和组件功能。在本攻略中，将 Vue 和 better-scroll 结合起来，实现移动端字母索引导航功能。

步骤

步骤1：安装依赖

首先，需要安装 Vue 和 better-scroll。可以在 npm 中进行安装：

npm install vue better-scroll

步骤2：创建 Vue 实例

接下来，在 app.js 文件中创建 Vue 实例。此处需要注意的是，需要将 better-scroll 的内容包裹在一个容器中，以便实现滚动效果。

<template>
  <div class="index-nav-sidebar" ref="sidebar">
    <ul>
      <li v-for="c in letters" :key="c">{{ c }}</li>
    </ul>
  </div>
</template>

<script>
import BScroll from 'better-scroll';

export default {
  name: 'IndexNavSidebar',
  props: {
    letters: {
      type: Array,
      required: true,
    },
  },
  methods: {
    init() {
      this.scroll = new BScroll(this.$refs.sidebar, {
        click: true,
      });
    },
  },
  mounted() {
    this.init();
  },
  beforeDestroy() {
    this.scroll.destroy();
    this.scroll = null;
  },
};
</script>

步骤3：实现字母索引导航功能

此处使用了 better-scroll 的 click 配置项，当索引导航项被点击时，可以触发相应的操作。

<template>
  <div class="index-nav-sidebar" ref="sidebar">
    <ul>
      <li v-for="c in letters" :key="c" @click="handleClick(c)">{{ c }}</li>
    </ul>
  </div>
</template>

<script>
import BScroll from 'better-scroll';

export default {
  name: 'IndexNavSidebar',
  props: {
    letters: {
      type: Array,
      required: true,
    },
  },
  methods: {
    init() {
      this.scroll = new BScroll(this.$refs.sidebar, { click: true });
    },
    handleClick(index) {
      this.$emit('click', index);
    },
  },
  mounted() {
    this.init();
  },
  beforeDestroy() {
    this.scroll.destroy();
    this.scroll = null;
  },
};
</script>

步骤4：添加回调函数

实现字母索引导航功能的另一部分是添加回调函数。在父组件中添加相应的事件监听，以响应导航项的点击事件。

<template>
  <div class="index-nav">
    <IndexNavSidebar :letters="letters" @click="handleSidebarClick" />
  </div>
</template>

<script>
import IndexNavSidebar from '@/components/IndexNavSidebar.vue';

export default {
  name: 'IndexNav',
  components: {
    IndexNavSidebar,
  },
  props: {
    letters: {
      type: Array,
      required: true,
    },
  },
  methods: {
    handleSidebarClick(index) {
      // 处理索引导航项点击事件的代码
    },
  },
};
</script>

示例

考虑一个简单的使用案例，其中需要实现一个字母索引导航条，并且在点击相应的导航项时更新列表内容。

在 IndexNav 组件中，可以监听 IndexNavSidebar 子组件的点击事件，并且在回调函数中更新父组件的状态。

<template>
  <div class="index-nav">
    <IndexNavSidebar :letters="letters" @click="handleSidebarClick" />
    <ul>
      <li v-for="item in list" :key="item">{{ item }}</li>
    </ul>
  </div>
</template>

<script>
import IndexNavSidebar from '@/components/IndexNavSidebar.vue';

export default {
  name: 'IndexNav',
  components: {
    IndexNavSidebar,
  },
  props: {
    letters: {
      type: Array,
      required: true,
    },
  },
  data() {
    return {
      list: [
        'Apple',
        'Banana',
        'Citrus',
        'Durian',
        'Eggplant',
        'Fig',
        'Grape',
        'Honeydew',
        'Ironweed',
        'Jujube',
        'Kiwi',
        'Lemon',
        'Mango',
        'Nectarine',
        'Orange',
        'Peach',
        'Quince',
        'Raspberry',
        'Strawberry',
        'Tangerine',
        'Ugli Fruit',
        'Vine',
        'Watermelon',
        'Xigua',
        'Yam',
        'Zucchini',
      ],
    };
  },
  methods: {
    handleSidebarClick(index) {
      const elem = this.$el.querySelector(`li[data-letter='${index}']`);
      if (elem) {
        elem.scrollIntoView();
      }
    },
  },
};
</script>

在 IndexNavSidebar 组件中，需要注意监听 click 事件并触发 handleClick 方法。当 handleClick 方法被调用时，需要以当前导航项的内容作为参数触发 click 事件。

<template>
  <div class="index-nav-sidebar" ref="sidebar">
    <ul>
      <li v-for="c in letters" :key="c" @click="handleClick(c)" :data-letter="c">{{ c }}</li>
    </ul>
  </div>
</template>

<script>
import BScroll from 'better-scroll';

export default {
  name: 'IndexNavSidebar',
  props: {
    letters: {
      type: Array,
      required: true,
    },
  },
  methods: {
    init() {
      this.scroll = new BScroll(this.$refs.sidebar, { click: true });
    },
    handleClick(index) {
      this.$emit('click', index);
    },
  },
  mounted() {
    this.init();
  },
  beforeDestroy() {
    this.scroll.destroy();
    this.scroll = null;
  },
};
</script>

在这个示例中，当字母索引导航条组件中任何一个字母被点击时，父组件中的 handleSidebarClick 方法就会被调用。在这个方法中，首先根据点击的字母找到对应列表项的 DOM 元素，并通过 scrollIntoView 方法进行滚动。因此，在 IndexNav 组件中的列表中，每个列表项需要包含一个 data-letter 属性，以便在父组件中找到对应的 DOM 元素。

<template>
  <div class="index-nav">
    <IndexNavSidebar :letters="letters" @click="handleSidebarClick" />
    <ul>
      <li v-for="item in list" :key="item" :data-letter="item.substr(0, 1)">{{ item }}</li>
    </ul>
  </div>
</template>

上述代码展示了带有 data-letter 属性的 li 标签的配置。