operation_wx/miniprogram_npm/tdesign-miniprogram/indexes

---

title: Indexes 索引 description: 用于页面中信息快速检索，可以根据目录中的页码快速找到所需的内容。 spline: navigation

isComponent: true

IndexesAnchor 索引锚点组件于 0.32.0 版本上线，请留意版本。

引入

全局引入，在 miniprogram 根目录下的app.json中配置，局部引入，在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-indexes": "tdesign-miniprogram/indexes/indexes",
  "t-indexes-anchor": "tdesign-miniprogram/indexes-anchor/indexes-anchor"
}

代码演示

在开发者工具中预览效果

Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"

基础索引

{{ base }}

自定义索引

{{ custom }}

API

Indexes Props

名称 | 类型 | 默认值 | 说明 | 必传 -- | -- | -- | -- | -- index-list | Array | - | 0.32.0。索引字符列表。不传默认 A-Z。TS 类型：string [] \| number[] | N list | Array | [] | 已废弃。索引列表的列表数据。每个元素包含三个子元素，index(string)：索引值，例如1，2，3，…或A，B，C等；title(string): 索引标题，可不填将默认设为索引值；children(Array<{title: string}>): 子元素列表，title为子元素的展示文案。。TS 类型：ListItem[] interface ListItem { title: string; index: string; children: { title: string; [key: string]: any} [] }。详细类型定义 | N sticky | Boolean | true | 索引是否吸顶，默认为true。TS 类型：Boolean | N sticky-offset | Number | 0 | 1.0.0。锚点吸顶时与顶部的距离 | N

Indexes Events

名称 | 参数 | 描述 -- | -- | -- change | (index: string \| number) | 0.34.0。索引发生变更时触发事件 select | (index: string \| number) | 点击侧边栏时触发事件

IndexesAnchor Props

名称 | 类型 | 默认值 | 说明 | 必传 -- | -- | -- | -- | -- index | String / Number | - | 索引字符 | N

IndexesAnchor 外部样式类

类名 | 说明 -- | -- t-class | 根节点样式类 t-class-sidebar | 侧边栏样式类 t-class-sidebar-item | 侧边栏选项样式类

CSS 变量

组件提供了下列 CSS 变量，可用于自定义样式。 名称 | 默认值 | 描述 -- | -- | -- --td-indexes-sidebar-active-bg-color | @brand-color | - --td-indexes-sidebar-active-color | @font-white-1 | - --td-indexes-sidebar-color | @font-gray-1 | - --td-indexes-sidebar-font-size | 24rpx | - --td-indexes-sidebar-item-size | 40rpx | - --td-indexes-sidebar-line-height | 40rpx | - --td-indexes-sidebar-right | 16rpx | - --td-indexes-sidebar-tips-bg-color | @brand-color-light | - --td-indexes-sidebar-tips-color | @brand-color | - --td-indexes-sidebar-tips-font-size | 40rpx | - --td-indexes-sidebar-tips-right | 76rpx | - --td-indexes-sidebar-tips-size | 96rpx | - --td-indexes-anchor-active-bg-color | @bg-color-container | - --td-indexes-anchor-active-color | @brand-color | - --td-indexes-anchor-active-font-weight | 600 | - --td-indexes-anchor-bg-color | @bg-color-secondarycontainer | - --td-indexes-anchor-color | @font-gray-1 | - --td-indexes-anchor-font-size | 28rpx | - --td-indexes-anchor-line-height | 44rpx | -