ts-basic-components-textpicker.md 3.4 KB
Newer Older
Z
zengyawen 已提交
1 2
# TextPicker

L
luoying_ace_admin 已提交
3
滑动选择文本内容的组件。
T
explain  
tianyu 已提交
4

H
geshi  
HelloCrease 已提交
5
>  **说明:**
G
gmy 已提交
6 7
>
>  该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
Z
zengyawen 已提交
8 9 10 11 12 13 14 15 16


## 子组件




## 接口

C
update  
chensi10 已提交
17
TextPicker(options?: {range: string[]|Resource|TextPickerRangeContent[], selected?: number, value?: string})
Z
zengyawen 已提交
18 19 20

根据range指定的选择范围创建文本选择器。

G
gmy 已提交
21
**参数:**
Z
zengyawen 已提交
22

G
gmy 已提交
23 24
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
25
| range | string[]&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型)\|[TextPickerRangeContent](#textpickerrangecontent10类型说明)[]<sup>10+</sup> | 是 | 选择器的数据选择列表。不可设置为空数组,若设置为空数组,则不显示;若动态变化为空数组,则保持当前正常值显示。 |
L
luoying_ace_admin 已提交
26
| selected | number | 否 | 设置默认选中项在数组中的索引值。<br/>默认值:0 |
C
update  
chensi10 已提交
27 28 29 30 31 32 33 34
| value | string | 否 | 设置默认选中项的值,优先级低于selected。<br/>默认值:第一个元素值<br/>**说明**:只有显示文本列表时该值有效。显示图片或图片加文本的列表时,该值无效。 |

## TextPickerRangeContent<sup>10+</sup>类型说明

| 参数名 | 参数类型                                                 | 必填 | 参数描述   |
| ------ | -------------------------------------------------------- | ---- | ---------- |
| icon   | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 是   | 图片资源。 |
| text   | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 否   | 文本信息。 |
Z
zengyawen 已提交
35 36 37

## 属性

G
gmy 已提交
38 39
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
L
luoying_ace_admin 已提交
40
| defaultPickerItemHeight | number \| string | 设置Picker各选择项的高度。 |
C
update  
chensi10 已提交
41 42 43
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置选中项的文本颜色、字号、字体粗细。 |
Z
zengyawen 已提交
44 45 46

## 事件

G
gmy 已提交
47 48
除支持[通用事件](ts-universal-events-click.md)外,还支持以下事件:

T
explain  
tianyu 已提交
49
| 名称 | 描述 |
50
| -------- | -------- |
C
update  
chensi10 已提交
51
| onChange(callback:&nbsp;(value:&nbsp;string,&nbsp;index:&nbsp;number)&nbsp;=&gt;&nbsp;void) | 滑动选中TextPicker文本内容后,触发该回调。<br/>-&nbsp;value:&nbsp;当前选中项的文本。<br/>**说明**:当显示文本或图片加文本列表时,value值为选中项中的文本值,当显示图片列表时,value值为空。<br/>-&nbsp;index:&nbsp;当前选中项的索引值。 |
Z
zengyawen 已提交
52 53 54 55


## 示例

H
geshi  
HelloCrease 已提交
56 57
```ts
// xxx.ets
Z
zengyawen 已提交
58 59 60 61 62 63 64 65
@Entry
@Component
struct TextPickerExample {
  private select: number = 1
  private fruits: string[] = ['apple1', 'orange2', 'peach3', 'grape4']

  build() {
    Column() {
L
luoying_ace_admin 已提交
66
      TextPicker({ range: this.fruits, selected: this.select })
Z
zengyawen 已提交
67 68 69 70 71 72 73 74 75
        .onChange((value: string, index: number) => {
          console.info('Picker item changed, value: ' + value + ', index: ' + index)
        })
    }
  }
}
```

![zh-cn_image_0000001219662657](figures/zh-cn_image_0000001219662657.png)