@ophiuchus/index-bar v1.0.1

IndexBar 索引栏

引入

// 方式1（推荐）
import Vue from 'vue';
import IndexBar from '@ophiuchus/index-bar';

Vue.use(IndexBar);

// 方式2
import Vue from 'vue';
import { IndexBar, IndexAnchor } from '@ophiuchus/index-bar';

Vue.component(IndexBar.name, IndexBar);
Vue.component(IndexAnchor.name, IndexAnchor);

代码演示

基础用法

点击索引栏时，会自动跳转到对应的 IndexAnchor 锚点位置。

<sf-index-bar>
  <sf-index-anchor index="A" />
  <sf-cell title="文本" />
  <sf-cell title="文本" />
  <sf-cell title="文本" />

  <sf-index-anchor index="B" />
  <sf-cell title="文本" />
  <sf-cell title="文本" />
  <sf-cell title="文本" />

  ...
</sf-index-bar>

自定义索引列表

可以通过 index-list 属性自定义展示的索引字符列表。

<sf-index-bar :index-list="indexList">
  <sf-index-anchor index="1">标题1</sf-index-anchor>
  <sf-cell title="文本" />
  <sf-cell title="文本" />
  <sf-cell title="文本" />

  <sf-index-anchor index="2">标题2</sf-index-anchor>
  <sf-cell title="文本" />
  <sf-cell title="文本" />
  <sf-cell title="文本" />

  ...
</sf-index-bar>

export default {
  data() {
    return {
      indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
    };
  },
};

API

IndexBar Props

IndexAnchor Props

IndexBar Events

IndexAnchor Slots

IndexBar 方法

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

样式变量

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