AlphabetIndexer

可以与容器组件联动用于按逻辑结构快速定位容器显示区域的组件。

说明：

该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

子组件

无

接口

AlphabetIndexer(value: {arrayValue: Array<string>, selected: number})

参数：

参数名	参数类型	必填	参数描述
arrayValue	Array<string>	是	字母索引字符串数组，不可设置为空。
selected	number	是	初始选中项索引值，若超出索引值范围，则取默认值0。

属性

除支持通用属性外，还支持以下属性：

名称	参数类型	描述
color	ResourceColor	设置文字颜色。 默认值：0x99000000。
selectedColor	ResourceColor	设置选中项文字颜色。 默认值：0xFF254FF7。
popupColor	ResourceColor	设置提示弹窗文字颜色。 默认值：0xFF254FF7。
selectedBackgroundColor	ResourceColor	设置选中项背景颜色。 默认值：0x1F0A59F7。
popupBackground	ResourceColor	设置提示弹窗背景色。 默认值：0xFFF1F3F5。
usingPopup	boolean	设置是否使用提示弹窗。 默认值：false。
selectedFont	Font	设置选中项文字样式。 默认值： { fontSize:10, fontStyle:FontStyle.Normal, fontWeight:FontWeight.Normal, fontFamily:HarmonyOS Sans }
popupFont	Font	设置提示弹窗字体样式。 默认值： { fontSize:10, fontStyle:FontStyle.Normal, fontWeight:FontWeight.Normal, fontFamily:HarmonyOS Sans }
font	Font	设置字母索引条默认字体样式。 默认值： { fontSize:10, fontStyle:FontStyle.Normal, fontWeight:FontWeight.Normal, fontFamily:HarmonyOS Sans }
itemSize	string | number	设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。不支持设置为百分比。 默认值：24.0。
alignStyle	IndexerAlign	设置字母索引条弹框的对齐样式，支持弹窗显示在索引条右侧和左侧。 默认值:IndexerAlign.Right。
selected	number	设置选中项索引值。 默认值：0。
popupPosition	Position	设置弹出窗口相对于索引器条上边框中点的位置。 默认值：{x:96.0, y:48.0}。

IndexerAlign枚举说明

名称	描述
Left	弹框显示在索引条右侧。
Right	弹框显示在索引条左侧。

事件

仅支持以下事件：

名称	功能描述
onSelected(callback: (index: number) => void)(deprecated)	索引条选中回调,返回值为当前选中索引。
onSelect(callback: (index: number) => void)8+	索引条选中回调,返回值为当前选中索引。
onRequestPopupData(callback: (index: number) => Array<string>)8+	选中字母索引后，请求索引提示弹窗显示内容回调。 返回值：索引对应的字符串数组，此字符串数组在弹窗中竖排显示，字符串列表最多显示5个，超出部分可以滑动显示。
onPopupSelect(callback: (index: number) => void)8+	字母索引提示弹窗字符串列表选中回调。

示例

// xxx.ets
@Entry
@Component
struct AlphabetIndexerSample {
  private value: string[] = ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z']

  build() {
    AlphabetIndexer({ arrayValue: this.value, selected: 0 })
      .selectedColor(0xffffff) // 选中颜色
      .popupColor(0xFFFAF0) // 弹出框颜色
      .selectedBackgroundColor(0xCCCCCC) // 选中背景颜色
      .popupBackground(0xD2B48C) // 弹出框背景颜色
      .usingPopup(true) // 是否显示弹出框
      .selectedFont({ size: 16, weight: FontWeight.Bolder }) // 选中的样式
      .popupFont({ size: 30, weight: FontWeight.Bolder }) // 弹出框的演示
      .itemSize(28) // 每一项的大小正方形
      .alignStyle(IndexerAlign.Left) // 左对齐
      .onSelect((index: number) => {
        console.info(this.value[index] + '被选中了') // 选中的事件
      })
      .margin({ left: 50 })
  }
}