1# TextInput 2 3单行文本输入框组件。 4 5> **说明：** 6> 7> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9 10## 子组件 11 12无 13 14 15## 接口 16 17TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController}) 18 19**参数：** 20 21| 参数名 | 参数类型 | 必填 | 参数描述 | 22| ----------------------- | ---------------------------------------- | ---- | --------------- | 23| placeholder | [ResourceStr](ts-types.md#resourcestr) | 否 | 设置无输入时的提示文本。 | 24| text | [ResourceStr](ts-types.md#resourcestr) | 否 | 设置输入框当前的文本内容。</br>当组件设置[stateStyles](ts-universal-attributes-polymorphic-style.md)等刷新属性时，建议通过onChange事件将状态变量与文本实时绑定，</br>避免组件刷新时TextInput中的文本内容异常。<br />从API version 10开始，该参数支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 | 25| controller<sup>8+</sup> | [TextInputController](#textinputcontroller8) | 否 | 设置TextInput控制器。 | 26 27 28## 属性 29 30除支持[通用属性](ts-universal-attributes-size.md)和[文本通用属性](ts-universal-attributes-text-style.md)的fontColor、fontSize、fontStyle、fontWeight、fontFamily外，还支持以下属性： 31 32| 名称 | 参数类型 | 描述 | 33| ------------------------ | ---------------------------------------- | ---------------------------------------- | 34| type | [InputType](#inputtype枚举说明) | 设置输入框类型。<br/>默认值：InputType.Normal | 35| placeholderColor | [ResourceColor](ts-types.md#resourcecolor) | 设置placeholder文本颜色。<br/>默认值跟随主题。 | 36| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式。 | 37| enterKeyType | [EnterKeyType](#enterkeytype枚举说明) | 设置输入法回车键类型，目前仅支持默认类型显示。<br/>默认值：EnterKeyType.Done | 38| caretColor | [ResourceColor](ts-types.md#resourcecolor) | 设置输入框光标颜色。<br/>默认值：'#007DFF'。 | 39| maxLength | number | 设置文本的最大输入字符数。 | 40| inputFilter<sup>8+</sup> | {<br/>value: [ResourceStr](ts-types.md#resourcestr),<br/>error?: (value: string) => void<br/>} | 正则表达式，匹配表达式的输入允许显示，不匹配的输入将被过滤。目前仅支持单个字符匹配，不支持字符串匹配。<br/>- value：设置正则表达式。<br/>- error：正则匹配失败时，返回被过滤的内容。 | 41| copyOption<sup>9+</sup> | [CopyOptions](ts-appendix-enums.md#copyoptions9) | 设置输入的文本是否可复制。<br/>默认值：CopyOptions.LocalDevice，支持设备内复制。<br/>设置CopyOptions.None时，当前TextInput中的文字无法被复制或剪切，仅支持粘贴。 | 42| showPasswordIcon<sup>9+</sup> | boolean | 密码输入模式时，输入框末尾的图标是否显示。<br/>默认值：true | 43| style<sup>9+</sup> | [TextInputStyle](#textinputstyle9枚举说明) \| [TextContentStyle](ts-appendix-enums.md#textcontentstyle10) | 设置输入框为默认风格或内联输入风格（内联输入风格只支持InputType.Normal类型）。<br/>默认值：TextInputStyle.Default | 44| textAlign<sup>9+</sup> | [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效果相同，控制内容在底部。 | 45| selectedBackgroundColor<sup>10+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 设置文本选中底板颜色。<br/>如果未设置透明度，默认为不透明（例如：“0x80000000”为50%透明度黑色）。 | 46| caretStyle<sup>10+</sup> | {<br/>width: [Length](ts-types.md#length)<br/>} | 设置光标风格，不支持百分比设置。 | 47| caretPosition<sup>10+</sup> | number | 设置光标位置。 | 48| showUnit<sup>10+</sup> | [CustomBuilder](ts-types.md#CustomBuilder8) | 设置控件作为文本框单位。<br/>默认无单位。 | 49| showError<sup>10+</sup> | string \| undefined | 设置错误状态下提示的错误文本或者不显示错误状态。<br/>默认不显示错误状态。<br/>**说明：** <br/>当参数类型为string并且输入内容不符合定义规范时，提示错误文本。当参数类型为undefined时，不显示错误状态。请参考[示例2](#示例2) | 50| showUnderline<sup>10+</sup> | boolean | 设置是否开启下划线。下划线默认颜色为'#33182431'，默认粗细为1px，文本框尺寸48vp（下划线只支持InputType.Normal类型）。<br/>默认值：false | 51| passwordIcon<sup>10+</sup> | [PasswordIcon](#passwordicon10对象说明) | 密码输入模式时，设置输入框末尾的图标。<br/>默认为系统提供的密码图标。 | 52| enableKeyboardOnFocus<sup>10+</sup> | boolean | TextInput获焦时，是否绑定输入法<br/>默认值：true。从API version 10开始，获焦默认绑定输入法。 | 53| selectionMenuHidden<sup>10+</sup> | boolean | 设置长按输入框或者右键输入框时，是否弹出文本选择菜单。<br />默认值：false | 54| barState<sup>10+</sup> | [BarState](ts-appendix-enums.md#BarState) | 设置内联输入风格编辑态时滚动条的显示模式。<br/>默认值：BarState.Auto | 55| maxLines<sup>10+</sup> | number | 设置内联输入风格编辑态时文本可显示的最大行数。<br/>默认值：3 | 56| customKeyboard<sup>10+</sup> | [CustomBuilder](ts-types.md#custombuilder8) | 设置自定义键盘。<br/>**说明：**<br/>当设置自定义键盘时，输入框激活后不会打开系统输入法，而是加载指定的自定义组件，针对系统键盘的enterKeyType属性设置将无效。<br/>自定义键盘的高度可以通过自定义组件根节点的height属性设置，宽度不可设置，使用系统默认值。<br/>自定义键盘采用覆盖原始界面的方式呈现，不会对应用原始界面产生压缩或者上提。<br/>自定义键盘无法获取焦点，但是会拦截手势事件。<br/>默认在输入控件失去焦点时，关闭自定义键盘，开发者也可以通过[TextInputController](#textinputcontroller8).[stopEditing](#stopediting10)方法控制键盘关闭。 | 57> **说明：** 58> [通用属性padding](ts-universal-attributes-size.md)的默认值为：<br>{<br> top: 8 vp,<br> right: 16 vp,<br> bottom: 8 vp,<br> left: 16 vp<br> } 59> 从API version 10开始，单行输入框可设置.width('auto')使组件宽度自适应文本宽度，自适应时组件宽度受constraintSize属性以及父容器传递的最大最小宽度限制，其余使用方式参考[尺寸设置](ts-universal-attributes-size.md#属性)。 60 61## EnterKeyType枚举说明 62 63| 名称 | 描述 | 64| ------------------- | --------- | 65| Go | 显示为前往样式。 | 66| Search | 显示为搜索样式。 | 67| Send | 显示为发送样式。 | 68| Next | 显示为下一个样式。 | 69| Done | 显示为确认样式。 | 70 71## InputType枚举说明 72 73| 名称 | 描述 | 74| ------------------ | ------------- | 75| Normal | 基本输入模式。<br/>支持输入数字、字母、下划线、空格、特殊字符。 | 76| Password | 密码输入模式。支持输入数字、字母、下划线、空格、特殊字符。密码显示小眼睛图标并且默认会将文字变成圆点。密码输入模式不支持下划线样式。 | 77| Email | 邮箱地址输入模式。支持数字，字母，下划线，以及@字符（只能存在一个@字符）。 | 78| Number | 纯数字输入模式。 | 79| PhoneNumber<sup>9+</sup> | 电话号码输入模式。<br/>支持输入数字、+ 、-、*、#，长度不限。 | 80 81## TextInputStyle<sup>9+</sup>枚举说明 82 83| 名称 | 描述 | 84| ------------------ | ------------- | 85| Default | 默认风格，光标宽1.5vp，光标高度与文本选中底板高度和字体大小相关。 | 86| Inline | 内联输入风格。文本选中底板高度与输入框高度相同。<br/>内联输入是在有明显的编辑态/非编辑态的区分场景下使用，例如：文件列表视图中的重命名。<br/>不支持showError属性。 | 87 88## PasswordIcon<sup>10+</sup>对象说明 89 90| 名称 | 类型 | 必填 | 描述 | 91| ---------- | -------------------------------------------------- | ---- | -------------------------------------------------- | 92| onIconSrc | string \|[Resource](ts-types.md#resource类型) | 否 | 密码输入模式时，能够切换密码隐藏的显示状态的图标。 | 93| offIconSrc | string \|[Resource](ts-types.md#resource类型) | 否 | 密码输入模式时，能够切换密码显示的隐藏状态的图标。 | 94 95## 事件 96 97除支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 98 99| 名称 | 功能描述 | 100| ------------------------------------------------------------ | ------------------------------------------------------------ | 101| onChange(callback: (value: string) => void) | 输入内容发生变化时，触发该回调。<br/>value：输入的文本内容。<br/>触发该事件的条件：<br/>1、键盘输入。<br/>2、粘贴、剪切。<br/>3、键盘快捷键Ctrl+v。 | 102| onSubmit(callback: (enterKey: EnterKeyType) => void) | 按下输入法回车键触发该回调，返回值为当前输入法回车键的类型。<br/>enterKeyType：输入法回车键类型。具体类型见[EnterKeyType枚举说明](#enterkeytype枚举说明)。 | 103| onEditChanged(callback: (isEditing: boolean) => void)<sup>(deprecated)</sup> | 输入状态变化时，触发该回调。从API 8开始，建议使用onEditChange。 | 104| onEditChange(callback: (isEditing: boolean) => void)<sup>8+</sup> | 输入状态变化时，触发该回调。有光标时为编辑态，无光标时为非编辑态。isEditing为true表示正在输入。 | 105| onCopy(callback:(value: string) => void)<sup>8+</sup> | 长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发该回调。<br/>value：复制的文本内容。 | 106| onCut(callback:(value: string) => void)<sup>8+</sup> | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发该回调。<br/>value：剪切的文本内容。 | 107| onPaste(callback:(value: string) => void)<sup>8+</sup> | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发该回调。<br/>value：粘贴的文本内容。 | 108| onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)<sup>10+</sup> | 文本选择的位置发生变化时，触发该回调。<br />selectionStart：文本选择区域起始位置，文本框中文字的起始位置为0。<br />selectionEnd：文本选择区域结束位置。 | 109| onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)<sup>10+</sup> | 文本内容滚动时，触发该回调。<br />totalOffsetX：文本在内容区的横坐标偏移。<br />totalOffsetY：文本在内容区的纵坐标偏移。 | 110 111## TextInputController<sup>8+</sup> 112 113TextInput组件的控制器。 114 115### 导入对象 116``` 117controller: TextInputController = new TextInputController() 118``` 119### caretPosition<sup>8+</sup> 120 121caretPosition(value: number): void 122 123设置输入光标的位置。 124 125**参数：** 126 127| 参数名 | 参数类型 | 必填 | 参数描述 | 128| ------ | -------- | ---- | -------------------------------------- | 129| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 | 130### setTextSelection<sup>10+</sup> 131 132setTextSelection(selectionStart: number, selectionEnd: number): void 133 134设置文本选择区域并高亮显示。 135 136**参数：** 137 138| 参数名 | 参数类型 | 必填 | 参数描述 | 139| -------------- | -------- | ---- | ---------------------- | 140| selectionStart | number | 是 | 文本选择区域起始位置，文本框中文字的起始位置为0。 | 141| selectionEnd | number | 是 | 文本选择区域结束位置。 | 142 143### stopEditing<sup>10+</sup> 144 145stopEditing(): void 146 147退出编辑态。 148 149### getTextContentRect<sup>10+</sup> 150 151getTextContentRect(): [RectResult](#rectresult) 152 153获取已编辑文本内容区域相对组件的位置和大小，返回值单位为像素。 154 155**返回值：** 156 157| 类型 | 说明 | 158| ------------------- | -------- | 159| [RectResult](#rectresult) | 已编辑文本内容的相对组件的位置和大小。 | 160 161> **说明：** 162> 163> - 初始不输入文本时，返回值中有相对组件的位置信息，大小为0。 164> - 返回值中的位置信息是第一个字符相对于可编辑组件的位置。 165 166### RectResult<sup>10+</sup> 167 168位置和大小。 169 170| 参数 | 类型 | 描述 | 171| ------- | ------ | ----------------------- | 172| x | number | 水平方向横坐标。| 173| y | number | 竖直方向纵坐标。| 174| width | number | 内容宽度大小。| 175| height | number | 内容高度大小。| 176 177 178### getTextContentLineCount<sup>10+</sup> 179 180getTextContentLineCount(): number 181 182获取已编辑文本内容的行数。 183 184**返回值：** 185 186| 类型 | 说明 | 187| ----- | -------- | 188| number| 已编辑文本内容行数。 | 189 190## 示例 191 192### 示例1 193 194```ts 195// xxx.ets 196@Entry 197@Component 198struct TextInputExample { 199 @State text: string = '' 200 controller: TextInputController = new TextInputController() 201 202 build() { 203 Column() { 204 TextInput({ text: this.text, placeholder: 'input your word...', controller: this.controller }) 205 .placeholderColor(Color.Grey) 206 .placeholderFont({ size: 14, weight: 400 }) 207 .caretColor(Color.Blue) 208 .width(400) 209 .height(40) 210 .margin(20) 211 .fontSize(14) 212 .fontColor(Color.Black) 213 .inputFilter('[a-z]', (e) => { 214 console.log(JSON.stringify(e)) 215 }) 216 .onChange((value: string) => { 217 this.text = value 218 }) 219 Text(this.text) 220 Button('Set caretPosition 1') 221 .margin(15) 222 .onClick(() => { 223 // 将光标移动至第一个字符后 224 this.controller.caretPosition(1) 225 }) 226 // 密码输入框 227 TextInput({ placeholder: 'input your password...' }) 228 .width(400) 229 .height(40) 230 .margin(20) 231 .type(InputType.Password) 232 .maxLength(9) 233 .showPasswordIcon(true) 234 // 内联风格输入框 235 TextInput({ text: 'inline style' }) 236 .width(400) 237 .height(50) 238 .margin(20) 239 .borderRadius(0) 240 .style(TextInputStyle.Inline) 241 }.width('100%') 242 } 243} 244``` 245 246 247 248### 示例2 249 250```ts 251@Entry 252@Component 253struct TextInputExample { 254 @State PassWordSrc1: Resource = $r('app.media.onIcon') 255 @State PassWordSrc2: Resource = $r('app.media.offIcon') 256 @State TextError: string = '' 257 @State Text: string = '' 258 @State NameText: string = 'test' 259 260 @Builder itemEnd() { 261 Select([{ value: 'KB' }, 262 { value: 'MB' }, 263 { value: 'GB' }, 264 { value: 'TB', }]) 265 .height("48vp") 266 .borderRadius(0) 267 .selected(2) 268 .align(Alignment.Center) 269 .value('MB') 270 .font({ size: 20, weight: 500 }) 271 .fontColor('#182431') 272 .selectedOptionFont({ size: 20, weight: 400 }) 273 .optionFont({ size: 20, weight: 400 }) 274 .backgroundColor(Color.Transparent) 275 .responseRegion({ height: "40vp", width: "80%", x: '10%', y: '6vp' }) 276 .onSelect((index: number) => { 277 console.info('Select:' + index) 278 }) 279 } 280 281 build() { 282 Column({ space: 20 }) { 283 // 自定义密码显示图标 284 TextInput({ placeholder: 'user define password icon' }) 285 .type(InputType.Password) 286 .width(380) 287 .height(60) 288 .passwordIcon({ onIconSrc: this.PassWordSrc1, offIconSrc: this.PassWordSrc2 }) 289 // 下划线模式 290 TextInput({ placeholder: 'underline style' }) 291 .showUnderline(true) 292 .width(380) 293 .height(60) 294 .showError('Error') 295 .showUnit(this.itemEnd.bind(this)) 296 297 Text(`用户名：${this.Text}`) 298 .width('95%') 299 TextInput({ placeholder: '请输入用户名', text: this.Text }) 300 .showUnderline(true) 301 .width(380) 302 .showError(this.TextError) 303 .onChange((value: string) => { 304 this.Text = value 305 }) 306 .onSubmit(() => { // 用户名不正确会清空输入框和用户名并提示错误文本 307 if (this.Text == this.NameText) { 308 this.TextError = '' 309 } else { 310 this.TextError = '用户名输入错误' 311 this.Text = '' 312 } 313 }) 314 315 }.width('100%') 316 } 317} 318``` 319 320 321 322### 示例3 323 324```ts 325// xxx.ets 326@Entry 327@Component 328struct TextInputExample { 329 controller: TextInputController = new TextInputController() 330 @State inputValue: string = "" 331 332 // 自定义键盘组件 333 @Builder CustomKeyboardBuilder() { 334 Column() { 335 Button('x').onClick(() => { 336 // 关闭自定义键盘 337 this.controller.stopEditing() 338 }) 339 Grid() { 340 ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9, '*', 0, '#'], (item:number|string) => { 341 GridItem() { 342 Button(item + "") 343 .width(110).onClick(() => { 344 this.inputValue += item 345 }) 346 } 347 }) 348 }.maxCount(3).columnsGap(10).rowsGap(10).padding(5) 349 }.backgroundColor(Color.Gray) 350 } 351 352 build() { 353 Column() { 354 TextInput({ controller: this.controller, text: this.inputValue }) 355 // 绑定自定义键盘 356 .customKeyboard(this.CustomKeyboardBuilder()).margin(10).border({ width: 1 }) 357 } 358 } 359} 360``` 361 362 363 364
