鸿蒙5.0版开辟：ArkTS根本组件（TextPicker）

往期鸿蒙全套实战文章必看：

• 鸿蒙开辟核心知识点，看这篇文章就够了
  
• 最新版！鸿蒙HarmonyOS Next应用开辟实战学习路线
  
• 鸿蒙HarmonyOS NEXT开辟技术最全学习路线指南
  
• 鸿蒙应用开辟实战项目，看这一篇文章就够了（部门项目附源码）
  

---

TextPicker

滑动选择文本内容的组件。
   说明：
  该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
  子组件

无
接口

TextPicker(options?: TextPickerOptions)
根据range指定的选择范围创建文本选择器。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明optionsTextPickerOptions否配置文本选择器的参数。 TextPickerOptions对象说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
名称类型必填描述rangestring[] | string[] []10+ | Resource |
TextPickerRangeContent[]10+ | TextCascadePickerRangeContent[]10+是选择器的数据选择列表。不可设置为空数组，若设置为空数组，则不显示；若动态变化为空数组，则保持当前正常值显示。
说明：单列数据选择器利用string[]，Resource，TextPickerRangeContent[]类型。
多列数据选择器利用string[][]类型。
多列联动数据选择器利用TextCascadePickerRangeContent[]类型。
Resource类型只支持strarray.json。
range的类型及列数不可以动态修改。selectednumber | number[]10+否设置默认选中项在数组中的索引值。
默认值：0
说明：单列数据选择器利用number类型。
多列、多列联动数据选择器利用number[]类型。
从API version 10开始，该参数支持$$双向绑定变量。valuestring | string[]10+否设置默认选中项的值，优先级低于selected。
默认值：第一个元素值
说明：只有显示文本列表时该值有用。显示图片或图片加文本的列表时，该值无效。
单列数据选择器利用string类型。
多列、多列联动数据选择器利用string[]类型。
从API version 10开始，该参数支持$$双向绑定变量。 TextPickerRangeContent10+类型说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
参数名参数类型必填参数描述iconstring | Resource是图片资源。textstring | Resource否文本信息。 TextCascadePickerRangeContent10+类型说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
参数名参数类型必填参数描述textstring | Resource是文本信息。childrenTextCascadePickerRangeContent[]否联动数据。 DividerOptions12+类型说明

参数名参数类型必填参数描述strokeWidthDimension否分割线的线宽（默认单位vp），也可指定单位为px，不支持"百分比"类型。startMarginDimension否分割线与TextPicker侧边起始端的距离（默认单位vp），也可指定单位为px，不支持“百分比”类型。endMarginDimension否分割线与TextPicker侧边结束端的距离（默认单位vp），也可指定单位为px，不支持“百分比”类型。colorResourceColor否分割线的颜色。 属性

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

defaultPickerItemHeight(value: number | string)
设置Picker各选择项的高度。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valuenumber | string是Picker各选择项的高度。 disappearTextStyle10+

disappearTextStyle(value: PickerTextStyle)
设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valuePickerTextStyle是所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。
默认值：
{
color: ‘#ff182431’,
font: {
size: ‘14fp’,
weight: FontWeight.Regular
}
} textStyle10+

textStyle(value: PickerTextStyle)
设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valuePickerTextStyle是所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。
默认值：
{
color: ‘#ff182431’,
font: {
size: ‘16fp’,
weight: FontWeight.Regular
}
} selectedTextStyle10+

selectedTextStyle(value: PickerTextStyle)
设置选中项的文本颜色、字号、字体粗细。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valuePickerTextStyle是选中项的文本颜色、字号、字体粗细。
默认值：
{
color: ‘#ff007dff’,
font: {
size: ‘20vp’,
weight: FontWeight.Medium
}
} selectedIndex10+

selectedIndex(value: number | number[])
设置默认选中项在数组中的索引值，优先级高于options中的选中值。单列数据选择器利用number类型。多列、多列联动数据选择器利用number[]类型。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valuenumber | number[]是默认选中项在数组中的索引值。 canLoop10+

canLoop(value: boolean)
设置是否可循环滚动。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valueboolean是是否可循环滚动。
true：可循环，false：不可循环。
默认值：true divider12+

divider(value: DividerOptions | null)
设置分割线样式，不设置该属性则按“默认值”展示分割线。
startMargin + endMargin 超过组件宽度后startMargin和endMargin会被置0。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valueDividerOptions | null是1.设置DividerOptions，则按设置的样式显示分割线。
默认值：
{
strokeWidth: ‘2px’,
startMargin: 0,
endMargin: 0,
color: ‘#33000000’
}
2.设置为null不显示分割线。 gradientHeight12+

gradientHeight(value: Dimension)
设置渐隐效果高度，不设置该属性则显示默认渐隐效果。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valueDimension是内容区上下边沿的渐隐高度（支持百分比，100%为TextPicker高度的一半即最大值），设置为0时不显示渐隐效果，负数等非法值显示默认渐隐效果。默认值为36vp。 变乱

除支持通用变乱外，还支持以下变乱：
onAccept(deprecated)

onAccept(callback: (value: string, index: number) => void)
点击弹窗中的“确定”按钮时触发该回调。该变乱仅在文本滑动选择器弹窗中生效。
从API version 10开始废弃。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valueboolean是当前选中项的文本。indexnumber是当前选中项的索引值。 onCancel(deprecated)

onCancel(callback: () => void)
点击弹窗中的“取消”按钮时触发该回调。该变乱仅在文本滑动选择器弹窗中生效。
从API version 10开始废弃。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onChange

onChange(callback: (value: string | string[], index: number | number[]) => void)
滑动选中TextPicker文本内容后，触发该回调。当显示文本或图片加文本列表时，value值为选中项中的文本值，当显示图片列表时，value值为空。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
参数名类型必填说明valuestring | string[]10+是当前选中项的文本。多列的环境，value为数组类型。indexnumber | number[]10+是当前选中项的索引值。多列的环境，index为数组类型。 示例

1. // xxx.ets
2. class bottom {
3.   bottom:number = 50
4. }
5. let bott:bottom = new bottom()
6. @Entry
7. @Component
8. struct TextPickerExample {
9.   private select: number = 1
10.   private apfruits: string[] = ['apple1', 'apple2', 'apple3', 'apple4']
11.   private orfruits: string[] = ['orange1', 'orange2', 'orange3', 'orange4']
12.   private pefruits: string[] = ['peach1', 'peach2', 'peach3', 'peach4']
13.   private multi: string[][] = [this.apfruits, this.orfruits, this.pefruits]
14.   private cascade: TextCascadePickerRangeContent[] = [
15.     {
16.       text: '辽宁省',
17.       children: [{ text: '沈阳市', children: [{ text: '沈河区' }, { text: '和平区' }, { text: '浑南区' }] },
18.         { text: '大连市', children: [{ text: '中山区' }, { text: '金州区' }, { text: '长海县' }] }]
19.     },
20.     {
21.       text: '吉林省',
22.       children: [{ text: '长春市', children: [{ text: '南关区' }, { text: '宽城区' }, { text: '朝阳区' }] },
23.         { text: '四平市', children: [{ text: '铁西区' }, { text: '铁东区' }, { text: '梨树县' }] }]
24.     },
25.     {
26.       text: '黑龙江省',
27.       children: [{ text: '哈尔滨市', children: [{ text: '道里区' }, { text: '道外区' }, { text: '南岗区' }] },
28.         { text: '牡丹江市', children: [{ text: '东安区' }, { text: '西安区' }, { text: '爱民区' }] }]
29.     }
30.   ]
32.   build() {
33.     Column() {
35.       TextPicker({ range: this.apfruits, selected: this.select })
36.         .onChange((value: string | string[], index: number | number[]) => {
37.           console.info('Picker item changed, value: ' + value + ', index: ' + index)
38.         }).margin(bott)
40.       TextPicker({ range: this.multi })
41.         .onChange((value: string | string[], index: number | number[]) => {
42.           console.info('TextPicker 多列:onChange ' + JSON.stringify(value) + ', ' + 'index: ' + JSON.stringify(index))
43.         }).margin(bott)
45.       TextPicker({ range: this.cascade })
46.         .onChange((value: string | string[], index: number | number[]) => {
47.           console.info('TextPicker 多列联动:onChange ' + JSON.stringify(value) + ', ' + 'index: ' + JSON.stringify(index))
48.         })
49.     }
50.   }
51. }

复制代码

1. // xxx.ets
2. @Entry
3. @Component
4. struct TextPickerExample {
5.   private select: number = 1
6.   private fruits: string[] = ['apple1', 'orange2', 'peach3', 'grape4']
8.   build() {
9.     Column() {
10.       TextPicker({ range: this.fruits, selected: this.select })
11.         .onChange((value: string | string[], index: number | number[]) => {
12.           console.info('Picker item changed, value: ' + value + ', index: ' + index)
13.         })
14.         .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
15.         .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
16.         .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
17.     }.width('100%').height('100%')
18.   }
19. }

复制代码

1. // xxx.ets
2. @Entry
3. @Component
4. struct TextPickerExample {
5.   private select: number = 1
6.   private fruits: string[] = ['apple1', 'orange2', 'peach3', 'grape4']
8.   build() {
9.     Column() {
10.       TextPicker({ range: this.fruits, selected: this.select })
11.         .onChange((value: string | string[], index: number | number[]) => {
12.           console.info('Picker item changed, value: ' + value + ', index: ' + index)
13.         })
14.         .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
15.         .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
16.         .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
17.         .divider(null)
18.     }.width('100%').height('100%')
19.   }
20. }

复制代码

1. // xxx.ets
2. @Entry
3. @Component
4. struct TextPickerExample {
5.   private select: number = 1
6.   private fruits: string[] = ['apple1', 'orange2', 'peach3', 'grape4']
8.   build() {
9.     Column() {
10.       TextPicker({ range: this.fruits, selected: this.select })
11.         .onChange((value: string | string[], index: number | number[]) => {
12.           console.info('Picker item changed, value: ' + value + ', index: ' + index)
13.         })
14.         .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
15.         .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
16.         .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
17.         .divider({ strokeWidth: 10, color: Color.Red, startMargin: 10, endMargin: 20 } as DividerOptions)
18.     }.width('100%').height('100%')
19.   }
20. }

复制代码

1. // xxx.ets 该示例实现了通过gradientHeight()自定义TextPicker的渐隐效果高度
2. @Entry
3. @Component
4. struct TextPickerExample {
5.   private select: number = 1
6.   private fruits: string[] = ['apple1', 'orange2', 'peach3', 'grape4']
8.   build() {
9.     Column() {
10.       TextPicker({ range: this.fruits, selected: this.select })
11.         .onChange((value: string | string[], index: number | number[]) => {
12.           console.info('Picker item changed, value: ' + value + ', index: ' + index)
13.         })
14.         .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
15.         .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
16.         .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
17.         .gradientHeight(100)
18.     }.width('100%').height('100%')
19.   }
20. }

复制代码

看完三件事❤️

• 假如你觉得这篇内容对你还蛮有资助，我想邀请你帮我三个小忙：
  
• 点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。
  
• 关注作者，不定期分享原创知识。
  
• 同时可以等待后续文章ing