1# TextArea 2 3多行文本输入框组件，当输入的文本内容超过组件宽度时会自动换行显示。 4 5高度未设置时，组件无默认高度，自适应内容高度。宽度未设置时，默认撑满最大宽度。 6 7> **说明：** 8> 9> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 10 11 12## 子组件 13 14无 15 16 17## 接口 18 19TextArea(value?: TextAreaOptions) 20 21**参数：** 22| 参数名 |类型|必填|说明| 23|-----|-----|----|----| 24| value | [TextAreaOptions](#textareaoptions对象说明) | 否 | TextArea组件参数。 | 25 26## TextAreaOptions对象说明 27| 参数名 | 参数类型 | 必填 | 参数描述 | 28| ----------------------- | ---------------------------------------- | ---- | -------------- | 29| placeholder | [ResourceStr](ts-types.md#resourcestr) | 否 | 设置无输入时的提示文本。输入内容后，提示文本不显示。<br/>仅设置placeholder属性时，手柄依然跟随拖动，手柄松开后光标停留在文字开头位置。 | 30| text | [ResourceStr](ts-types.md#resourcestr) | 否 | 设置输入框当前的文本内容。</br>建议通过onChange事件将状态变量与文本实时绑定，</br>避免组件刷新时TextArea中的文本内容异常。<br />从API version 10开始，该参数支持[$$](../../../quick-start/arkts-two-way-sync.md)双向绑定变量。 | 31| controller<sup>8+</sup> | [TextAreaController](#textareacontroller8) | 否 | 设置TextArea控制器。 | 32 33 34## 属性 35 36除支持[通用属性](ts-universal-attributes-size.md)和[文本通用属性](ts-universal-attributes-text-style.md)的fontColor、fontSize、fontStyle、fontWeight、fontFamily外，还支持以下属性： 37 38| 名称 | 参数类型 | 描述 | 39| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | 40| placeholderColor | [ResourceColor](ts-types.md#resourcecolor) | 设置placeholder文本颜色。<br/>默认值跟随主题。 | 41| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式，包括字体大小，字体粗细，字体族，字体风格。目前仅支持默认字体族。 | 42| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | 设置文本在输入框中的水平对齐方式。<br/>默认值：TextAlign.Start<br/>**说明：**<br/>支持TextAlign.Start、TextAlign.Center和TextAlign.End。<br/>可通过[align](ts-universal-attributes-location.md)属性控制文本段落在垂直方向上的位置，此组件中不可通过align属性控制文本段落在水平方向上的位置，即align属性中Alignment.TopStart、Alignment.Top、Alignment.TopEnd效果相同，控制内容在顶部，Alignment.Start、Alignment.Center、Alignment.End效果相同，控制内容垂直居中，Alignment.BottomStart、Alignment.Bottom、Alignment.BottomEnd效果相同，控制内容在底部。<br/>当`textAlign`属性设置为TextAlign.JUSTIFY时，最后一行文本不参与两端对齐，为水平对齐首部效果。 <br>从API version 11开始，textAlign可设置TextAlign.JUSTIFY| 43| caretColor | [ResourceColor](ts-types.md#resourcecolor) | 设置输入框光标颜色。<br/>默认值：'#007DFF'。 | 44| inputFilter<sup>8+</sup> | {<br/>value: [ResourceStr](ts-types.md#resourcestr),<br/>error?: (value: string) => void<br/>} | 通过正则表达式设置输入过滤器。匹配表达式的输入允许显示，不匹配的输入将被过滤。仅支持单个字符匹配，不支持字符串匹配。<br/>- value：设置正则表达式。<br/>- error：正则匹配失败时，返回被过滤的内容。 | 45| copyOption<sup>9+</sup> | [CopyOptions](ts-appendix-enums.md#copyoptions9) | 设置输入的文本是否可复制。<br/>默认值：CopyOptions.LocalDevice，支持设备内复制。 <br/>设置CopyOptions.None时，当前TextArea中的文字无法被复制或剪切，仅支持粘贴。<br/>**说明：** <br/>copyOption对于拖拽，只限制是否选中，不涉及拖拽范围。 | 46| maxLength<sup>10+</sup> | number | 设置文本的最大输入字符数。<br/>默认不设置最大输入字符数限制。<br/>到达文本最大字符限制，将无法继续输入字符，同时边框变为红色。 | 47| showCounter<sup>10+</sup> | value: boolean, options<sup>11+</sup>?: [InputCounterOptions](ts-basic-components-textinput.md#inputcounteroptions11对象说明) | 参数value为true时，才能设置options，文本框开启计数下标功能，需要配合maxlength（设置最大字符限制）一起使用。字符计数器显示的效果是当前输入字符数/最大可输入字符数。当输入字符数大于最大字符数乘百分比值时，显示字符计数器。如果用户设置计数器时不设置InputCounterOptions，那么当前输入字符数达到最大字符数时，边框和计数器下标将变为红色。用户同时设置参数value为true和InputCounterOptions，当thresholdPercentage数值在有效区间内，且输入字符数超过最大字符数时，边框和计数器下标将变为红色，框体抖动。highlightBorder设置为false，则不显示红色边框，计数器默认显示红色边框。内联模式下字符计数器不显示。 | 48| style<sup>10+</sup> | [TextContentStyle](ts-appendix-enums.md#textcontentstyle10) | 设置文本框多态样式。<br/>默认值：TextContentStyle.DEFAULT | 49| enableKeyboardOnFocus<sup>10+</sup> | boolean | TextArea通过点击以外的方式获焦时，是否绑定输入法。<br/>默认值：true。从API version 10开始，获焦默认绑定输入法。 | 50| selectionMenuHidden<sup>10+</sup> | boolean | 设置长按、双击输入框或者右键输入框时，是否不弹出文本选择菜单。<br />默认值：false | 51| barState<sup>10+</sup> | [BarState](ts-appendix-enums.md#barstate) | 设置输入框编辑态时滚动条的显示模式。<br/>默认值：BarState.Auto | 52| maxLines<sup>10+</sup> | number | 设置内联输入风格编辑态时文本可显示的最大行数。<br/>默认值：3 <br/>**说明：**<br/>取值范围：(0, +∞)。| 53| customKeyboard<sup>10+</sup> | [CustomBuilder](ts-types.md#custombuilder8) | 设置自定义键盘。<br/>**说明：**<br/>当设置自定义键盘时，输入框激活后不会打开系统输入法，而是加载指定的自定义组件。<br/>自定义键盘的高度可以通过自定义组件根节点的height属性设置，宽度不可设置，使用系统默认值。<br/>自定义键盘采用覆盖原始界面的方式呈现，不会对应用原始界面产生压缩或者上提。<br/>自定义键盘无法获取焦点，但是会拦截手势事件。<br/>默认在输入控件失去焦点时，关闭自定义键盘，开发者也可以通过[TextAreaController](#textareacontroller8).[stopEditing](#stopediting10)方法控制键盘关闭。<br/>如果设备支持拍摄输入，设置自定义键盘后，该输入框会不支持拍摄输入。 | 54| type<sup>11+</sup> | [TextAreaType](#textareatype11枚举说明) | 设置输入框类型。<br/>默认值：TextAreaType.Normal | 55| enterKeyType<sup>11+</sup> | [EnterKeyType](ts-basic-components-textinput.md#enterkeytype枚举说明) | 设置输入法回车键类型。<br/>默认值：EnterKeyType.NEW_LINE | 56> **说明：** 57> 58> [通用属性padding](ts-universal-attributes-size.md#padding)的默认值为：<br>{<br> top: 8 vp,<br> right: 16 vp,<br> bottom: 8 vp,<br> left: 16 vp<br> } <br>从API version 11开始，多行输入框可设置.width('auto')使组件宽度自适应文本宽度，自适应时组件宽度受constraintSize属性以及父容器传递的最大最小宽度限制，其余使用方式参考[尺寸设置](ts-universal-attributes-size.md#属性)。 59 60## 事件 61 62除支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 63 64| 名称 | 功能描述 | 65| ------------------------------------------------------------ | ------------------------------------------------------------ | 66| onChange(callback: (value: string) => void) | 输入内容发生变化时，触发该回调。<br/>- value：当前输入的文本内容。 | 67| onEditChange(callback: (isEditing: boolean) => void)<sup>10+</sup> | 输入状态变化时，触发该回调。有光标时为编辑态，无光标时为非编辑态。isEditing为true表示正在输入。 | 68| onCopy<sup>8+</sup>(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发该回调。<br/>- value：复制的文本内容。 | 69| onCut<sup>8+</sup>(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发该回调。<br/>- value：剪切的文本内容。 | 70| onPaste(callback:(value: string, event<sup>11+</sup>: [PasteEvent](ts-basic-components-richeditor.md#pasteevent11)) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发该回调。<br/>- value：粘贴的文本内容。<br/>- event：用户自定义的粘贴事件。| 71| onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)<sup>10+</sup> | 文本选择的位置发生变化时，触发该回调。<br />selectionStart：文本选择区域起始位置，文本框中文字的起始位置为0。<br />selectionEnd：文本选择区域结束位置。 | 72| onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)<sup>10+</sup> | 文本内容滚动时，触发该回调。<br />totalOffsetX：文本在内容区的横坐标偏移，单位px。<br />totalOffsetY：文本在内容区的纵坐标偏移，单位px。 | 73| onSubmit(callback: (enterKey: EnterKeyType) => void)<sup>11+</sup> | 按下输入法回车键触发该回调。<br/>enterKey：输入法回车键类型，类型为EnterKeyType.NEW_LINE时不触发onSubmit。具体类型见[EnterKeyType枚举说明](ts-basic-components-textinput.md#enterkeytype枚举说明)。| 74 75## TextAreaController<sup>8+</sup> 76 77TextArea组件的控制器，目前可通过它设置TextArea组件的光标位置。 78 79### 导入对象 80 81``` 82controller: TextAreaController = new TextAreaController() 83``` 84 85### caretPosition<sup>8+</sup> 86 87caretPosition(value: number): void 88 89设置输入光标的位置。 90 91**参数：** 92 93| 参数名 | 参数类型 | 必填 | 参数描述 | 94| ------ | -------- | ---- | -------------------------------------- | 95| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 | 96 97### setTextSelection<sup>10+</sup> 98 99setTextSelection(selectionStart: number, selectionEnd: number): void 100 101组件在获焦状态下，调用该接口设置文本选择区域并高亮显示，且只有在selectionStart小于selectionEnd时，文字才会被选取、高亮显示。 102 103**参数：** 104 105| 参数名 | 参数类型 | 必填 | 参数描述 | 106| -------------- | -------- | ---- | ------------------------------------------------------------ | 107| selectionStart | number | 是 | 文本选择区域起始位置，文本框中文字的起始位置为0。<br/>当selectionStart小于0时、按照0处理；当selectionStart大于文字最大长度时、按照文字最大长度处理。<br/> | 108| selectionEnd | number | 是 | 文本选择区域结束位置。<br/>当selectionEnd小于0时、按照0处理；当selectionEnd大于文字最大长度时、按照文字最大长度处理。<br/> | 109 110### stopEditing<sup>10+</sup> 111 112stopEditing(): void 113 114退出编辑态。 115 116### getTextContentRect<sup>10+</sup> 117 118getTextContentRect(): [RectResult](#rectresult10) 119 120获取已编辑文本内容区域相对组件的位置和大小，返回值单位为像素。 121 122**返回值：** 123 124| 类型 | 说明 | 125| ------------------- | -------- | 126| [RectResult](#rectresult10) | 已编辑文本内容的相对组件的位置和大小。 | 127 128> **说明：** 129> 130> - 初始不输入文本时，返回值中有相对组件的位置信息，大小为0。 131> - 返回值中的位置信息是第一个字符相对于可编辑组件的位置。 132> - 有输入时返回信息中的宽度是组件编辑的固定宽度。 133 134### RectResult<sup>10+</sup> 135 136位置和大小，单位均为像素。 137 138| 参数 | 类型 | 描述 | 139| ------- | ------ | ----------------------- | 140| x | number | 水平方向横坐标。| 141| y | number | 竖直方向纵坐标。| 142| width | number | 内容宽度大小。| 143| height | number | 内容高度大小。| 144 145 146### getTextContentLineCount<sup>10+</sup> 147 148getTextContentLineCount(): number 149 150获取已编辑文本内容的行数。 151 152**返回值：** 153 154| 类型 | 说明 | 155| ----- | -------- | 156| number| 已编辑文本内容行数。 | 157 158### getCaretOffset<sup>11+</sup> 159 160getCaretOffset(): CaretOffset 161 162返回当前光标所在位置信息。 163 164**返回值：** 165 166| 类型 | 说明 | 167| ----------------------- | ---------------- | 168| [CaretOffset](ts-basic-components-textinput.md#caretoffset11对象说明) | 光标相对输入框的位置。 | 169 170> **说明：** 171> 172> - 在当前帧更新光标位置同时调用该接口，该接口不生效。 173 174## TextAreaType<sup>11+</sup>枚举说明 175 176| 名称 | 描述 | 177| ------------------ | ------------- | 178| NORMAL | 基本输入模式。<br/>支持输入数字、字母、下划线、空格、特殊字符。 | 179| EMAIL | 邮箱地址输入模式。支持数字，字母，下划线，以及@字符（只能存在一个@字符）。 | 180| NUMBER | 纯数字输入模式。 | 181| PHONE_NUMBER | 电话号码输入模式。<br/>支持输入数字、+ 、-、*、#，长度不限。 | 182 183## 示例 184 185### 示例1 186 187```ts 188// xxx.ets 189@Entry 190@Component 191struct TextAreaExample { 192 @State text: string = '' 193 @State positionInfo: CaretOffset = { index: 0, x: 0, y: 0 } 194 controller: TextAreaController = new TextAreaController() 195 196 build() { 197 Column() { 198 TextArea({ 199 text: this.text, 200 placeholder: 'The text area can hold an unlimited amount of text. input your word...', 201 controller: this.controller 202 }) 203 .placeholderFont({ size: 16, weight: 400 }) 204 .width(336) 205 .height(56) 206 .margin(20) 207 .fontSize(16) 208 .fontColor('#182431') 209 .backgroundColor('#FFFFFF') 210 .onChange((value: string) => { 211 this.text = value 212 }) 213 Text(this.text) 214 Button('Set caretPosition 1') 215 .backgroundColor('#007DFF') 216 .margin(15) 217 .onClick(() => { 218 // 设置光标位置到第一个字符后 219 this.controller.caretPosition(1) 220 }) 221 Button('Get CaretOffset') 222 .backgroundColor('#007DFF') 223 .margin(15) 224 .onClick(() => { 225 this.positionInfo = this.controller.getCaretOffset() 226 }) 227 }.width('100%').height('100%').backgroundColor('#F1F3F5') 228 } 229} 230``` 231 232 233 234### 示例2 235 236```ts 237// xxx.ets 238@Entry 239@Component 240struct TextAreaExample { 241 @State text: string = 'test' 242 @State counterVisible: boolean = false 243 @State maxNumber: number = -1 244 controller: TextAreaController = new TextAreaController() 245 246 build() { 247 Column() { 248 TextArea({ 249 text: this.text, 250 placeholder: 'The text area can hold an unlimited amount of text. input your word...', 251 controller: this.controller 252 }) 253 .placeholderFont({ size: 16, weight: 400 }) 254 .width(336) 255 .height(56) 256 .margin(20) 257 .fontSize(16) 258 .fontColor('#182431') 259 .maxLength(4) 260 .showCounter(true) 261 .backgroundColor('#FFFFFF') 262 .onChange((value: string) => { 263 this.text = value 264 }) 265 }.width('100%').height('100%').backgroundColor('#F1F3F5') 266 } 267} 268``` 269 270 271 272 273### 示例3 274 275```ts 276// xxx.ets 277@Entry 278@Component 279struct TextAreaExample { 280 controller: TextAreaController = new TextAreaController() 281 @State inputValue: string = "" 282 283 // 自定义键盘组件 284 @Builder CustomKeyboardBuilder() { 285 Column() { 286 Button('x').onClick(() => { 287 // 关闭自定义键盘 288 this.controller.stopEditing() 289 }) 290 Grid() { 291 ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9, '*', 0, '#'], (item: number | string) => { 292 GridItem() { 293 Button(item + "") 294 .width(110).onClick(() => { 295 this.inputValue += item 296 }) 297 } 298 }) 299 }.maxCount(3).columnsGap(10).rowsGap(10).padding(5) 300 }.backgroundColor(Color.Gray) 301 } 302 303 build() { 304 Column() { 305 TextArea({ controller: this.controller, text: this.inputValue}) 306 // 绑定自定义键盘 307 .customKeyboard(this.CustomKeyboardBuilder()).margin(10).border({ width: 1 }) 308 .height(200) 309 } 310 } 311} 312``` 313 314 315 316### 示例4 317 318```ts 319// xxx.ets 320@Entry 321@Component 322struct TextAreaExample { 323 @State text: string = '' 324 controller: TextAreaController = new TextAreaController() 325 326 build() { 327 Column() { 328 TextArea({ text: this.text, controller: this.controller }) 329 .placeholderFont({ size: 16, weight: 400 }) 330 .width(336) 331 .height(56) 332 .maxLength(6) 333 .showCounter(true, { thresholdPercentage: 50, highlightBorder: true }) 334 //计数器显示效果为用户当前输入字符数/最大字符限制数。最大字符限制数通过maxLength()接口设置。 335 //如果用户当前输入字符数达到最大字符限制乘50%（thresholdPercentage）。字符计数器显示。 336 //用户设置highlightBorder为false时，配置取消红色边框。不设置此参数时，默认为true。 337 .onChange((value: string) => { 338 this.text = value 339 }) 340 }.width('100%').height('100%').backgroundColor('#F1F3F5') 341 } 342} 343``` 344 345 346 347 348### 示例5 349```ts 350// xxx.ets 351@Entry 352@Component 353struct TextInputExample { 354 @State Text: string = '' 355 @State enterTypes: Array<EnterKeyType> = [EnterKeyType.Go, EnterKeyType.Search, EnterKeyType.Send, EnterKeyType.Done, EnterKeyType.Next, EnterKeyType.PREVIOUS, EnterKeyType.NEW_LINE] 356 @State index: number = 0 357 build() { 358 Column({ space: 20 }) { 359 TextArea({ placeholder: '请输入用户名', text: this.Text }) 360 .width(380) 361 .enterKeyType(this.enterTypes[this.index]) 362 .onChange((value: string) => { 363 this.Text = value 364 }) 365 .onSubmit((enterKey: EnterKeyType) => { 366 console.log("trigger area onsubmit" + enterKey); 367 }) 368 Button('改变EnterKeyType').onClick(() => { 369 this.index = (this.index + 1) % this.enterTypes.length; 370 }) 371 372 }.width('100%') 373 } 374} 375``` 376 377
