• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 文本滑动选择器弹窗
2
3根据指定的选择范围创建文本选择器,展示在弹窗上。
4
5>  **说明:**
6>
7> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> 本模块功能依赖UI的执行上下文,不可在UI上下文不明确的地方使用,参见[UIContext](../apis/js-apis-arkui-UIContext.md#uicontext)说明。
10>
11> 从API version 10开始,可以通过使用[UIContext](../apis/js-apis-arkui-UIContext.md#uicontext)中的[showTextPickerDialog](../apis/js-apis-arkui-UIContext.md#showtextpickerdialog)来明确UI的执行上下文。
12
13## TextPickerDialog.show
14
15show(options?: TextPickerDialogOptions)
16
17定义文本滑动选择器弹窗并弹出。
18
19**TextPickerDialogOptions参数:**
20
21| 参数名 | 参数类型 | 必填 |  参数描述 |
22| -------- | -------- | -------- |  -------- |
23| range | string[]&nbsp;\|&nbsp;[Resource](ts-types.md#resource)\|[TextPickerRangeContent](ts-basic-components-textpicker.md#textpickerrangecontent10类型说明)[]<sup>10+</sup> | 是 | 设置文本选择器的选择范围。不可设置为空数组,若设置为空数组,则不弹出弹窗。<br/>**说明:** <br/>Resource类型只支持[strarray.json](../../quick-start/resource-categories-and-access.md#资源组目录)。 |
24| selected | number | 否 |  设置选中项的索引值。<br>默认值:0 |
25| value       | string           | 否    | 设置选中项的文本内容。当设置了selected参数时,该参数不生效。如果设置的value值不在range范围内,则默认取range第一个元素。<br>**说明**:只有显示文本列表时该值有效。显示图片或图片加文本的列表时,该值无效。 |
26| defaultPickerItemHeight | number \| string | 否 | 设置选择器中选项的高度。 |
27| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。<br/>默认值:<br/>{<br/>color: '#ff182431',<br/>font: {<br/>size: '14fp', <br/>weight: FontWeight.Regular<br/>}<br/>} |
28| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。<br/>默认值:<br/>{<br/>color: '#ff182431',<br/>font: {<br/>size: '16fp', <br/>weight: FontWeight.Regular<br/>}<br/>} |
29| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置选中项的文本颜色、字号、字体粗细。<br/>默认值:<br/>{<br/>color: '#ff007dff',<br/>font: {<br/>size: '20vp', <br/>weight: FontWeight.Medium<br/>}<br/>} |
30| canLoop<sup>10+</sup> | boolean | 否 | 设置是否可循环滚动,true:可循环,false:不可循环,默认值:true。 |
31| alignment<sup>10+</sup>  | [DialogAlignment](ts-methods-alert-dialog-box.md#dialogalignment枚举说明) | 否   | 弹窗在竖直方向上的对齐方式。<br>默认值:DialogAlignment.Default |
32| offset<sup>10+</sup>     | [Offset](ts-types.md#offset) | 否     | 弹窗相对alignment所在位置的偏移量。<br/>默认值:{&nbsp;dx:&nbsp;0&nbsp;,&nbsp;dy:&nbsp;0&nbsp;} |
33| maskRect<sup>10+</sup>| [Rectangle](ts-methods-alert-dialog-box.md#rectangle10类型说明) | 否     | 弹窗遮蔽层区域,在遮蔽层区域内的事件不透传,在遮蔽层区域外的事件透传。<br/>默认值:{ x: 0, y: 0, width: '100%', height: '100%' } |
34| onAccept | (value: [TextPickerResult](#textpickerresult对象说明)) => void | 否 |  点击弹窗中的“确定”按钮时触发该回调。 |
35| onCancel | () => void | 否 | 点击弹窗中的“取消”按钮时触发该回调。 |
36| onChange | (value: [TextPickerResult](#textpickerresult对象说明)) => void | 否 |  滑动弹窗中的选择器使当前选中项改变时触发该回调。 |
37
38## TextPickerResult对象说明
39
40| 名称 | 类型 | 描述 |
41| -------- | -------- | -------- |
42| value | string \| string []<sup>10+</sup> | 选中项的文本内容。<br/>**说明**:当显示文本或图片加文本列表时,value值为选中项中的文本值。(文本选择器显示多列时,value为数组类型。)<br/>当显示图片列表时,value值为空。 |
43| index | number \| number []<sup>10+</sup> | 选中项在选择范围数组中的索引值。(文本选择器显示多列时,index为数组类型。) |
44
45## 示例
46
47```ts
48// xxx.ets
49@Entry
50@Component
51struct TextPickerDialogExample {
52  private select: number | number[] = 2
53  private fruits: string[] = ['apple1', 'orange2', 'peach3', 'grape4', 'banana5']
54
55  build() {
56    Row() {
57      Column() {
58        Button("TextPickerDialog")
59          .margin(20)
60          .onClick(() => {
61            TextPickerDialog.show({
62              range: this.fruits,
63              selected: this.select,
64              disappearTextStyle: {color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}},
65              textStyle: {color: Color.Black, font: {size: 20, weight: FontWeight.Normal}},
66              selectedTextStyle: {color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}},
67              onAccept: (value: TextPickerResult) => {
68                // 设置select为按下确定按钮时候的选中项index,这样当弹窗再次弹出时显示选中的是上一次确定的选项
69                this.select = value.index
70                console.info("TextPickerDialog:onAccept()" + JSON.stringify(value))
71              },
72              onCancel: () => {
73                console.info("TextPickerDialog:onCancel()")
74              },
75              onChange: (value: TextPickerResult) => {
76                console.info("TextPickerDialog:onChange()" + JSON.stringify(value))
77              }
78            })
79          })
80      }.width('100%')
81    }.height('100%')
82  }
83}
84```
85
86![TextPickerDialog](figures/TextPickerDialog.gif)
87