1# AlphabetIndexer 2 3可以与容器组件联动用于按逻辑结构快速定位容器显示区域的组件。 4 5> **说明：** 6> 7> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9 10## 子组件 11 12无 13 14 15## 接口 16 17AlphabetIndexer(value: {arrayValue: Array<string>, selected: number}) 18 19**参数：** 20 21| 参数名 | 参数类型 | 必填 | 参数描述 | 22| -------- | -------- | -------- | -------- | 23| arrayValue | Array<string> | 是 | 字母索引字符串数组，不可设置为空。 | 24| selected | number | 是 | 初始选中项索引值，若超出索引值范围，则取默认值0。 | 25 26## 属性 27 28除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： 29 30| 名称 | 参数类型 | 描述 | 31| ----------------------- | --------------- | ----------------------------------------------------------- | 32| color | [ResourceColor](ts-types.md#resourcecolor) | 设置文字颜色。<br/>默认值：0x99000000。 | 33| selectedColor | [ResourceColor](ts-types.md#resourcecolor) | 设置选中项文字颜色。<br/>默认值：0xFF254FF7。 | 34| popupColor | [ResourceColor](ts-types.md#resourcecolor) | 设置提示弹窗文字颜色。<br/>默认值：0xFF254FF7。 | 35| selectedBackgroundColor | [ResourceColor](ts-types.md#resourcecolor) | 设置选中项背景颜色。<br/>默认值：0x1F0A59F7。 | 36| popupBackground | [ResourceColor](ts-types.md#resourcecolor) | 设置提示弹窗背景色。<br/>默认值：0xFFF1F3F5。 | 37| usingPopup | boolean | 设置是否使用提示弹窗。<br/>默认值：false。 | 38| selectedFont | [Font](ts-types.md#font) | 设置选中项文字样式。<br/>默认值：<br/>{<br/>size:10,<br/> style:FontStyle.Normal,<br/> weight:FontWeight.Normal,<br/> family:'HarmonyOS Sans'<br/>} | 39| popupFont | [Font](ts-types.md#font) | 设置提示弹窗字体样式。<br/>默认值：<br/>{<br/>size:10,<br/> style:FontStyle.Normal,<br/> weight:FontWeight.Normal,<br/> family:'HarmonyOS Sans'<br/>} | 40| font | [Font](ts-types.md#font) | 设置字母索引条默认字体样式。<br/>默认值：<br/>{<br/>size:10,<br/> style:FontStyle.Normal,<br/> weight:FontWeight.Normal,<br/> family:'HarmonyOS Sans'<br/>} | 41| itemSize | string \| number | 设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。不支持设置为百分比。<br/>默认值：24.0<br/>单位：vp | 42| alignStyle | IndexerAlign | 设置字母索引条弹框的对齐样式，支持弹窗显示在索引条右侧和左侧。<br/>默认值:IndexerAlign.Right。 | 43| selected | number | 设置选中项索引值。<br/>默认值：0。 | 44| popupPosition | [Position](ts-types.md#position8) | 设置弹出窗口相对于索引器条上边框中点的位置。<br/>默认值：{x:96.0, y:48.0}。 | 45 46## IndexerAlign枚举说明 47 48| 名称 | 描述 | 49| -------- | -------- | 50| Left | 弹框显示在索引条右侧。 | 51| Right | 弹框显示在索引条左侧。 | 52 53## 事件 54 55除支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 56 57| 名称 | 功能描述 | 58| -------- | -------- | 59| onSelected(callback: (index: number) => void)<sup>(deprecated)</sup> | 索引条选中回调,返回值为当前选中索引。 从API Version 8开始废弃，建议使用onSelect代替。 | 60| onSelect(callback: (index: number) => void)<sup>8+</sup> | 索引条选中回调,返回值为当前选中索引。 | 61| onRequestPopupData(callback: (index: number) => Array<string>)<sup>8+</sup> | 选中字母索引后，请求索引提示弹窗显示内容回调。<br/>返回值：索引对应的字符串数组，此字符串数组在弹窗中竖排显示，字符串列表最多显示5个，超出部分可以滑动显示。 | 62| onPopupSelect(callback: (index: number) => void)<sup>8+</sup> | 字母索引提示弹窗字符串列表选中回调。 | 63 64 65## 示例 66 67```ts 68// xxx.ets 69@Entry 70@Component 71struct AlphabetIndexerSample { 72 private arrayA: string[] = ['安'] 73 private arrayB: string[] = ['卜', '白', '包', '毕', '丙'] 74 private arrayC: string[] = ['曹', '成', '陈', '催'] 75 private arrayL: string[] = ['刘', '李', '楼', '梁', '雷', '吕', '柳', '卢'] 76 private value: string[] = ['#', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 77 'H', 'I', 'J', 'K', 'L', 'M', 'N', 78 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 79 'V', 'W', 'X', 'Y', 'Z'] 80 81 build() { 82 Stack({ alignContent: Alignment.Start }) { 83 Row() { 84 List({ space: 20, initialIndex: 0 }) { 85 ForEach(this.arrayA, (item) => { 86 ListItem() { 87 Text(item) 88 .width('80%') 89 .height('5%') 90 .fontSize(30) 91 .textAlign(TextAlign.Center) 92 }.editable(true) 93 }, item => item) 94 95 ForEach(this.arrayB, (item) => { 96 ListItem() { 97 Text(item) 98 .width('80%') 99 .height('5%') 100 .fontSize(30) 101 .textAlign(TextAlign.Center) 102 }.editable(true) 103 }, item => item) 104 105 ForEach(this.arrayC, (item) => { 106 ListItem() { 107 Text(item) 108 .width('80%') 109 .height('5%') 110 .fontSize(30) 111 .textAlign(TextAlign.Center) 112 }.editable(true) 113 }, item => item) 114 115 ForEach(this.arrayL, (item) => { 116 ListItem() { 117 Text(item) 118 .width('80%') 119 .height('5%') 120 .fontSize(30) 121 .textAlign(TextAlign.Center) 122 }.editable(true) 123 }, item => item) 124 } 125 .width('50%') 126 .height('100%') 127 128 AlphabetIndexer({ arrayValue: this.value, selected: 0 }) 129 .selectedColor(0xFFFFFF) // 选中项文本颜色 130 .popupColor(0xFFFAF0) // 弹出框文本颜色 131 .selectedBackgroundColor(0xCCCCCC) // 选中项背景颜色 132 .popupBackground(0xD2B48C) // 弹出框背景颜色 133 .usingPopup(true) // 是否显示弹出框 134 .selectedFont({ size: 16, weight: FontWeight.Bolder }) // 选中项字体样式 135 .popupFont({ size: 30, weight: FontWeight.Bolder }) // 弹出框内容的字体样式 136 .itemSize(28) // 每一项的尺寸大小 137 .alignStyle(IndexerAlign.Left) // 弹出框在索引条右侧弹出 138 .onSelect((index: number) => { 139 console.info(this.value[index] + ' Selected!') 140 }) 141 .onRequestPopupData((index: number) => { 142 if (this.value[index] == 'A') { 143 return this.arrayA // 当选中A时，弹出框里面的提示文本列表显示A对应的列表arrayA，选中B、C、L时也同样 144 } else if (this.value[index] == 'B') { 145 return this.arrayB 146 } else if (this.value[index] == 'C') { 147 return this.arrayC 148 } else if (this.value[index] == 'L') { 149 return this.arrayL 150 } else { 151 return [] // 选中其余子母项时，提示文本列表为空 152 } 153 }) 154 .onPopupSelect((index: number) => { 155 console.info('onPopupSelected:' + index) 156 }) 157 } 158 .width('100%') 159 .height('100%') 160 } 161 } 162} 163``` 164 165
