• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# TextInput
2
3单行文本输入框组件。
4
5>  **说明:**
6>
7>  该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9
10## 子组件
11
1213
14
15## 接口
16
17TextInput(value?: TextInputOptions)
18
19**参数:**
20| 参数名 |类型|必填|说明|
21|-----|-----|----|----|
22| value | [TextInputOptions](#textinputoptions对象说明) | 否  | TextInput组件参数。 |
23
24## TextInputOptions对象说明
25| 参数名                     | 参数类型                                     | 必填   | 参数描述                                     |
26| ----------------------- | ---------------------------------------- | ---- | ---------------------------------------- |
27| placeholder             | [ResourceStr](ts-types.md#resourcestr)   | 否    | 设置无输入时的提示文本。                             |
28| text                    | [ResourceStr](ts-types.md#resourcestr)   | 否    | 设置输入框当前的文本内容。</br>建议通过onChange事件将状态变量与文本实时绑定,</br>避免组件刷新时TextInput中的文本内容异常。<br />从API version 10开始,该参数支持[$$](../../../quick-start/arkts-two-way-sync.md)双向绑定变量。 |
29| controller<sup>8+</sup> | [TextInputController](#textinputcontroller8) | 否    | 设置TextInput控制器。                          |
30
31## 属性
32
33除支持[通用属性](ts-universal-attributes-size.md)和[文本通用属性](ts-universal-attributes-text-style.md)的fontColor、fontSize、fontStyle、fontWeight、fontFamily外,还支持以下属性:
34
35| 名称                                  | 参数类型                                                     | 描述                                                         |
36| ------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
37| type                                  | [InputType](#inputtype枚举说明)                              | 设置输入框类型。<br/>默认值:InputType.Normal                |
38| placeholderColor                      | [ResourceColor](ts-types.md#resourcecolor)                   | 设置placeholder文本颜色。<br/>默认值跟随主题。               |
39| placeholderFont                       | [Font](ts-types.md#font)                                     | 设置placeholder文本样式。                                    |
40| enterKeyType                          | [EnterKeyType](#enterkeytype枚举说明)                        | 设置输入法回车键类型。<br/>默认值:EnterKeyType.Done         |
41| caretColor                            | [ResourceColor](ts-types.md#resourcecolor)                   | 设置输入框光标颜色。<br/>默认值:'#007DFF'。                 |
42| maxLength                             | number                                                       | 设置文本的最大输入字符数。                                   |
43| inputFilter<sup>8+</sup>              | {<br/>value:&nbsp;[ResourceStr](ts-types.md#resourcestr),<br/>error?:&nbsp;(value:&nbsp;string)&nbsp;=&gt;&nbsp;void<br/>} | 正则表达式,匹配表达式的输入允许显示,不匹配的输入将被过滤。目前仅支持单个字符匹配,不支持字符串匹配。<br/>-&nbsp;value:设置正则表达式。<br/>-&nbsp;error:正则匹配失败时,返回被过滤的内容。<br/>从API version 11开始,设置inputFilter且输入的字符不为空字符,会导致设置输入框类型(即type接口)附带的文本过滤效果失效。 |
44| copyOption<sup>9+</sup>               | [CopyOptions](ts-appendix-enums.md#copyoptions9)             | 设置输入的文本是否可复制。<br/>默认值:CopyOptions.LocalDevice,支持设备内复制。<br/>设置CopyOptions.None时,当前TextInput中的文字无法被复制或剪切,仅支持粘贴。<br/>**说明:** <br/>copyOption对于拖拽,只限制是否选中,不涉及拖拽范围。 |
45| showPasswordIcon<sup>9+</sup>         | boolean                                                      | 密码输入模式时,输入框末尾的图标是否显示。<br/>默认值:true  |
46| style<sup>9+</sup>                    | [TextInputStyle](#textinputstyle9枚举说明) \| [TextContentStyle](ts-appendix-enums.md#textcontentstyle10) | 设置输入框为默认风格或内联输入风格(内联输入风格只支持InputType.Normal类型)。<br/>默认值:TextInputStyle.Default |
47| textAlign<sup>9+</sup>                | [TextAlign](ts-appendix-enums.md#textalign)                  | 设置文本在输入框中的水平对齐方式。<br/>默认值:TextAlign.Start<br/>**说明:**<br/>仅支持TextAlign.StartTextAlign.CenterTextAlign.End。<br/>可通过[align](ts-universal-attributes-location.md)属性控制文本段落在垂直方向上的位置,此组件中不可通过align属性控制文本段落在水平方向上的位置,即align属性中Alignment.TopStartAlignment.TopAlignment.TopEnd效果相同,控制内容在顶部,Alignment.StartAlignment.CenterAlignment.End效果相同,控制内容垂直居中,Alignment.BottomStartAlignment.BottomAlignment.BottomEnd效果相同,控制内容在底部。 |
48| selectedBackgroundColor<sup>10+</sup> | [ResourceColor](ts-types.md#resourcecolor)                   | 设置文本选中底板颜色。<br/>如果未设置不透明度,默认为20%不透明度。 |
49| caretStyle<sup>10+</sup>              | [CaretStyle](#caretstyle10对象说明)                          | 设置光标风格。                                               |
50| caretPosition<sup>10+</sup>           | number                                                       | 设置光标位置。                                               |
51| showUnit<sup>10+</sup>                | [CustomBuilder](ts-types.md#custombuilder8)                  | 设置控件作为文本框单位。<br/>默认无单位。<br/>需搭配showUnderline使用,当showUnderline为true时生效。 |
52| showError<sup>10+</sup>               | string&nbsp;\|&nbsp;undefined                                | 设置错误状态下提示的错误文本或者不显示错误状态。<br/>默认不显示错误状态。<br/>**说明:** <br/>当参数类型为string并且输入内容不符合定义规范时,提示错误文本。当参数类型为undefined时,不显示错误状态。请参考[示例2](#示例2) |
53| showUnderline<sup>10+</sup>           | boolean                                                      | 设置是否开启下划线。下划线默认颜色为'#33182431',默认粗细为1px,文本框尺寸48vp(下划线只支持InputType.Normal类型)。<br/>默认值:false |
54| passwordIcon<sup>10+</sup>            | [PasswordIcon](#passwordicon10对象说明)                      | 密码输入模式时,设置输入框末尾的图标。<br/>默认为系统提供的密码图标。 |
55| enableKeyboardOnFocus<sup>10+</sup>   | boolean                                                      | TextInput通过点击以外的方式获焦时,是否绑定输入法。<br/>默认值:true。从API version 10开始,获焦默认绑定输入法。 |
56| selectionMenuHidden<sup>10+</sup>     | boolean                                                      | 设置长按、双击输入框或者右键输入框时,是否弹出文本选择菜单。<br />默认值:false |
57| barState<sup>10+</sup>                | [BarState](ts-appendix-enums.md#barstate)                    | 设置内联输入风格编辑态时滚动条的显示模式。<br/>默认值:BarState.Auto |
58| maxLines<sup>10+</sup>                | number                                                       | 设置内联输入风格编辑态时文本可显示的最大行数。<br/>默认值:3 <br/>**说明:**<br/>取值范围:(0, +∞)。 |
59| customKeyboard<sup>10+</sup>          | [CustomBuilder](ts-types.md#custombuilder8)                  | 设置自定义键盘。<br/>**说明:**<br/>当设置自定义键盘时,输入框激活后不会打开系统输入法,而是加载指定的自定义组件,针对系统键盘的enterKeyType属性设置将无效。<br/>自定义键盘的高度可以通过自定义组件根节点的height属性设置,宽度不可设置,使用系统默认值。<br/>自定义键盘采用覆盖原始界面的方式呈现,不会对应用原始界面产生压缩或者上提。<br/>自定义键盘无法获取焦点,但是会拦截手势事件。<br/>默认在输入控件失去焦点时,关闭自定义键盘,开发者也可以通过[TextInputController](#textinputcontroller8).[stopEditing](#stopediting10)方法控制键盘关闭。<br/>如果设备支持拍摄输入,设置自定义键盘后,该输入框会不支持拍摄输入。 |
60| enableAutoFill<sup>11+<sup>           | boolean                                                      | 设置是否启用自动填充。true表示启用,false表示不启用。默认值为true。 |
61| passwordRules<sup>11+<sup>            | string                                                       | 定义生成密码的规则。在触发自动填充时,所设置的密码规则会透传给密码保险箱,用于新密码的生成。 |
62| cancelButton<sup>11+</sup>            | {<br/>style? : [CancelButtonStyle](ts-basic-components-search.md#cancelbuttonstyle10枚举说明)<br/>icon?: [IconOptions](ts-basic-components-search.md#iconoptions10对象说明) <br/>} | 设置右侧清除按钮样式。<br />默认值:<br />{<br />style: CancelButtonStyle.INPUT<br />}<br />不支持内联模式。 |
63| selectAll<sup>11+</sup>               | boolean                                                      | 初始状态,是否全选文本。<br />默认值:false<br />不支持内联模式。 |
64| showCounter<sup>11+</sup>             | value: boolean, options?: [InputCounterOptions](#inputcounteroptions11对象说明) | 参数value为true时,才能设置options,文本框开启计数下标功能,需要配合maxLength(设置最大字符限制)一起使用。字符计数器显示的效果是当前输入字符数/最大可输入字符数。当输入字符数大于最大字符数乘百分比值时,显示字符计数器。如果用户设置计数器时不设置InputCounterOptions,那么当前输入字符数达到最大字符数时,边框和计数器下标将变为红色。用户同时设置参数value为true和InputCounterOptions,当thresholdPercentage数值在有效区间内,且输入字符超过最大字符数时,边框和计数器下标将变为红色,框体抖动。highlightBorder设置为false,则不显示红色边框,计数器默认显示红色边框。TextInput组件显示边框需要设置为下划线模式,内联模式和密码模式下字符计数器不显示。 |
65>  **说明:**
66>  [通用属性padding](ts-universal-attributes-size.md#padding)的默认值为:<br>{<br>&nbsp;top: 8 vp,<br>&nbsp;right: 16 vp,<br>&nbsp;bottom: 8 vp,<br>&nbsp;left: 16 vp<br> }
67>   从API version 10开始,单行输入框可设置.width('auto')使组件宽度自适应文本宽度,自适应时组件宽度受constraintSize属性以及父容器传递的最大最小宽度限制,其余使用方式参考[尺寸设置](ts-universal-attributes-size.md#属性)。
68
69
70## SubmitEvent<sup>11+</sup>
71
72定义用户提交事件。
73
74| 名称                | 类型            | 必填   | 描述                           |
75| ----------------- | ------------- | ---- | ---------------------------- |
76| keepEditableState | () => void | 否    | 用户自定义输入框编辑状态。<br/> 调用时保持编辑态。 |
77| text              | string        | 否    | 输入框文本内容。                     |
78
79## CaretStyle<sup>10+</sup>对象说明
80| 参数名 | 类型  | 必填 | 说明  |
81| ------ | -------- | ---- | ------------------------------------------- |
82| width  | [Length](ts-types.md#length) | 否  | 光标尺寸,不支持百分比设置。 |
83
84## EnterKeyType枚举说明
85
86| 名称                     | 描述        |
87| ---------------------- | --------- |
88| Go                     | 显示为开始样式。  |
89| Search                 | 显示为搜索样式。  |
90| Send                   | 显示为发送样式。  |
91| Next                   | 显示为下一个样式。 |
92| Done                   | 显示为完成样式。  |
93| PREVIOUS<sup>11+</sup> | 显示为上一个样式。 |
94| NEW_LINE<sup>11+</sup> | 显示为换行样式。  |
95
96## InputType枚举说明
97
98| 名称                                 | 描述                                       |
99| ---------------------------------- | ---------------------------------------- |
100| Normal                             | 基本输入模式,无特殊限制。                            |
101| Password                           | 密码输入模式。支持输入数字、字母、下划线、空格、特殊字符。密码显示小眼睛图标并且默认会将文字变成圆点。密码输入模式不支持下划线样式。在已启用密码保险箱的情况下,支持用户名、密码的自动保存和自动填充。 |
102| Email                              | 邮箱地址输入模式。支持数字,字母,下划线,小数点,以及@字符(只能存在一个@字符)。 |
103| Number                             | 纯数字输入模式。                                 |
104| PhoneNumber<sup>9+</sup>           | 电话号码输入模式。<br/>支持输入数字、+ 、-、*、#,长度不限。      |
105| USER_NAME<sup>11+<sup>             | 用户名输入模式。在已启用密码保险箱的情况下,支持用户名、密码的自动保存和自动填充。                |
106| NEW_PASSWORD<sup>11+<sup>          | 新密码输入模式。在已启用密码保险箱的情况下,支持自动生成新密码。                                 |
107| NUMBER_PASSWORD<sup>11+</sup>      | 纯数字密码输入模式。密码显示小眼睛图标并且默认会将文字变成圆点。密码输入模式不支持下划线样式。 |
108| NUMBER_DECIMAL<sup>11+</sup>       | 带小数点的数字输入模式。支持数字,小数点(只能存在一个小数点)。         |
109
110## TextInputStyle<sup>9+</sup>枚举说明
111
112| 名称      | 描述                                       |
113| ------- | ---------------------------------------- |
114| Default | 默认风格,光标宽1.5vp,光标高度与文本选中底板高度和字体大小相关。      |
115| Inline  | 内联输入风格。文本选中底板高度与输入框高度相同。<br/>内联输入是在有明显的编辑态/非编辑态的区分场景下使用,例如:文件列表视图中的重命名。<br/>不支持showError属性。 |
116
117## PasswordIcon<sup>10+</sup>对象说明
118
119| 名称         | 类型                                       | 必填   | 描述                        |
120| ---------- | ---------------------------------------- | ---- | ------------------------- |
121| onIconSrc  | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型) | 否    | 密码输入模式时,能够切换密码隐藏的显示状态的图标。 |
122| offIconSrc | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型) | 否    | 密码输入模式时,能够切换密码显示的隐藏状态的图标。 |
123
124## 事件
125
126除支持[通用事件](ts-universal-events-click.md)外,还支持以下事件:
127
128| 名称                                       | 功能描述                                     |
129| ---------------------------------------- | ---------------------------------------- |
130| onChange(callback:&nbsp;(value:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 输入内容发生变化时,触发该回调。<br/>value:输入的文本内容。<br/>触发该事件的条件:<br/>1、键盘输入。<br/>2、粘贴、剪切。<br/>3、键盘快捷键Ctrl+v。 |
131| onSubmit(callback:&nbsp;(enterKey:&nbsp;EnterKeyType,&nbsp;event<sup>11+</sup>:&nbsp;[SubmitEvent](#submitevent11))&nbsp;=&gt;&nbsp;void) | 按下输入法回车键触发该回调。<br/>enterKey:输入法回车键类型。类型为EnterKeyType.NEW_LINE且输入框为内联输入模式时不触发onSubmit。具体类型见[EnterKeyType枚举说明](#enterkeytype枚举说明)。<br/>event:提交事件,具体类型见[SubmitEvent事件说明](#submitevent11)。 |
132| onEditChanged(callback:&nbsp;(isEditing:&nbsp;boolean)&nbsp;=&gt;&nbsp;void)<sup>(deprecated)</sup> | 输入状态变化时,触发该回调。从API 8开始,建议使用onEditChange。 |
133| onEditChange(callback:&nbsp;(isEditing:&nbsp;boolean)&nbsp;=&gt;&nbsp;void)<sup>8+</sup> | 输入状态变化时,触发该回调。有光标时为编辑态,无光标时为非编辑态。isEditing为true表示正在输入。 |
134| onCopy(callback:(value:&nbsp;string)&nbsp;=&gt;&nbsp;void)<sup>8+</sup> | 长按输入框内部区域弹出剪贴板后,点击剪切板复制按钮,触发该回调。<br/>value:复制的文本内容。 |
135| onCut(callback:(value:&nbsp;string)&nbsp;=&gt;&nbsp;void)<sup>8+</sup> | 长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮,触发该回调。<br/>value:剪切的文本内容。 |
136| onPaste(callback:(value:&nbsp;string, event<sup>11+</sup>:&nbsp;[PasteEvent](ts-basic-components-richeditor.md#pasteevent11))&nbsp;=&gt;&nbsp;void) | 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发该回调。<br/>value:粘贴的文本内容。<br/>event:用户自定义的粘贴事件。 |
137| onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)<sup>10+</sup> | 文本选择的位置发生变化时,触发该回调。<br />selectionStart:文本选择区域起始位置,文本框中文字的起始位置为0。<br />selectionEnd:文本选择区域结束位置。 |
138| onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)<sup>10+</sup> | 文本内容滚动时,触发该回调。<br />totalOffsetX:文本在内容区的横坐标偏移,单位px。<br />totalOffsetY:文本在内容区的纵坐标偏移,单位px。 |
139
140## TextInputController<sup>8+</sup>
141
142TextInput组件的控制器。
143
144### 导入对象
145```
146controller: TextInputController = new TextInputController()
147```
148### caretPosition<sup>8+</sup>
149
150caretPosition(value:&nbsp;number): void
151
152设置输入光标的位置。
153
154**参数:**
155
156| 参数名   | 参数类型   | 必填   | 参数描述                |
157| ----- | ------ | ---- | ------------------- |
158| value | number | 是    | 从字符串开始到光标所在位置的字符长度。 |
159### setTextSelection<sup>10+</sup>
160
161setTextSelection(selectionStart:&nbsp;number, selectionEnd:&nbsp;number): void
162
163设置文本选择区域并高亮显示。
164
165**参数:**
166
167| 参数名            | 参数类型   | 必填   | 参数描述                      |
168| -------------- | ------ | ---- | ------------------------- |
169| selectionStart | number | 是    | 文本选择区域起始位置,文本框中文字的起始位置为0。 |
170| selectionEnd   | number | 是    | 文本选择区域结束位置。               |
171>  **说明:**
172>
173>  如果selectionStart或selectionEnd被赋值为undefined时,当作0处理。
174### stopEditing<sup>10+</sup>
175
176stopEditing(): void
177
178退出编辑态。
179
180### getTextContentRect<sup>10+</sup>
181
182getTextContentRect(): [RectResult](#rectresult10)
183
184获取已编辑文本内容区域相对组件的位置和大小,返回值单位为像素。
185
186**返回值:**
187
188| 类型                          | 说明                  |
189| --------------------------- | ------------------- |
190| [RectResult](#rectresult10) | 已编辑文本内容的相对组件的位置和大小。 |
191
192> **说明:**
193>
194> - 初始不输入文本时,返回值中有相对组件的位置信息,大小为0。
195> - 返回值中的位置信息是第一个字符相对于可编辑组件的位置。
196
197### RectResult<sup>10+</sup>
198
199位置和大小,单位均为像素。
200
201| 参数     | 类型     | 描述       |
202| ------ | ------ | -------- |
203| x      | number | 水平方向横坐标。 |
204| y      | number | 竖直方向纵坐标。 |
205| width  | number | 内容宽度大小。  |
206| height | number | 内容高度大小。  |
207
208
209### getTextContentLineCount<sup>10+</sup>
210
211getTextContentLineCount(): number
212
213获取已编辑文本内容的行数。
214
215**返回值:**
216
217| 类型     | 说明         |
218| ------ | ---------- |
219| number | 已编辑文本内容行数。 |
220### getCaretOffset<sup>11+</sup>
221
222getCaretOffset(): CaretOffset
223
224返回当前光标所在位置信息。
225
226**返回值:**
227
228| 类型                                | 说明          |
229| --------------------------------- | ----------- |
230| [CaretOffset](#caretoffset11对象说明) | 光标相对输入框的位置。 |
231
232> **说明:**
233>
234> - 在当前帧更新光标位置同时调用该接口,该接口不生效。
235
236## CaretOffset<sup>11+</sup>对象说明
237| 参数名   | 类型     | 描述             |
238| ----- | ------ | -------------- |
239| index | number | 光标所在位置的索引值。    |
240| x     | number | 光标相对输入框的x坐标位值,单位px。 |
241| y     | number | 光标相对输入框的y坐标位值,单位px。 |
242
243## InputCounterOptions<sup>11+</sup>对象说明
244
245| 参数名              | 类型    | 描述                                                         |
246| ------------------- | ------- | ------------------------------------------------------------ |
247| thresholdPercentage | number  | thresholdPercentage是可输入字符数占最大字符限制的百分比值。字符计数器显示的样式为当前输入字符数/最大字符数。当输入字符数大于最大字符数乘百分比值时,显示字符计数器。thresholdPercentage值的有效值区间为[1,100],如果设置的number超出有效值区间内,不显示字符计数器。thresholdPercentage设置为undefined,显示字符计数器,但此参数不生效。 |
248| highlightBorder     | boolean | 如果用户设置计数器时不设置InputCounterOptions,那么当前输入字符数达到最大字符数时,边框和计数器下标将变为红色。如果用户设置显示字符计数器同时thresholdPercentage参数数值在有效区间内,那么当输入字符数超过最大字符数时,边框和计数器下标将变成红色。如果此参数为true,则显示红色边框。计数器默认显示红色边框。 |
249
250## 示例
251
252### 示例1
253
254```ts
255// xxx.ets
256@Entry
257@Component
258struct TextInputExample {
259  @State text: string = ''
260  @State positionInfo: CaretOffset = { index: 0, x: 0, y: 0 }
261  controller: TextInputController = new TextInputController()
262
263  build() {
264    Column() {
265      TextInput({ text: this.text, placeholder: 'input your word...', controller: this.controller })
266        .placeholderColor(Color.Grey)
267        .placeholderFont({ size: 14, weight: 400 })
268        .caretColor(Color.Blue)
269        .width('95%')
270        .height(40)
271        .margin(20)
272        .fontSize(14)
273        .fontColor(Color.Black)
274        .inputFilter('[a-z]', (e) => {
275          console.log(JSON.stringify(e))
276        })
277        .onChange((value: string) => {
278          this.text = value
279        })
280      Text(this.text)
281      Button('Set caretPosition 1')
282        .margin(15)
283        .onClick(() => {
284          // 将光标移动至第一个字符后
285          this.controller.caretPosition(1)
286        })
287      Button('Get CaretOffset')
288        .margin(15)
289        .onClick(() => {
290          this.positionInfo = this.controller.getCaretOffset()
291        })
292      // 密码输入框
293      TextInput({ placeholder: 'input your password...' })
294        .width('95%')
295        .height(40)
296        .margin(20)
297        .type(InputType.Password)
298        .maxLength(9)
299        .showPasswordIcon(true)
300      // 内联风格输入框
301      TextInput({ text: 'inline style' })
302        .width('95%')
303        .height(50)
304        .margin(20)
305        .borderRadius(0)
306        .style(TextInputStyle.Inline)
307    }.width('100%')
308  }
309}
310```
311
312![TextInput](figures/TextInput.png)
313
314### 示例2
315
316```ts
317@Entry
318@Component
319struct TextInputExample {
320  @State PassWordSrc1: Resource = $r('app.media.onIcon')
321  @State PassWordSrc2: Resource = $r('app.media.offIcon')
322  @State TextError: string = ''
323  @State Text: string = ''
324  @State NameText: string = 'test'
325
326  @Builder itemEnd() {
327    Select([{ value: 'KB' },
328      { value: 'MB' },
329      { value: 'GB' },
330      { value: 'TB', }])
331      .height("48vp")
332      .borderRadius(0)
333      .selected(2)
334      .align(Alignment.Center)
335      .value('MB')
336      .font({ size: 20, weight: 500 })
337      .fontColor('#182431')
338      .selectedOptionFont({ size: 20, weight: 400 })
339      .optionFont({ size: 20, weight: 400 })
340      .backgroundColor(Color.Transparent)
341      .responseRegion({ height: "40vp", width: "80%", x: '10%', y: '6vp' })
342      .onSelect((index: number) => {
343        console.info('Select:' + index)
344      })
345  }
346
347  build() {
348    Column({ space: 20 }) {
349      // 自定义密码显示图标
350      TextInput({ placeholder: 'user define password icon' })
351        .type(InputType.Password)
352        .width(380)
353        .height(60)
354        .passwordIcon({ onIconSrc: this.PassWordSrc1, offIconSrc: this.PassWordSrc2 })
355      // 下划线模式
356      TextInput({ placeholder: 'underline style' })
357        .showUnderline(true)
358        .width(380)
359        .height(60)
360        .showError('Error')
361        .showUnit(this.itemEnd)
362
363      Text(`用户名:${this.Text}`)
364        .width('95%')
365      TextInput({ placeholder: '请输入用户名', text: this.Text })
366        .showUnderline(true)
367        .width(380)
368        .showError(this.TextError)
369        .onChange((value: string) => {
370          this.Text = value
371        })
372        .onSubmit(() => { // 用户名不正确会清空输入框和用户名并提示错误文本
373          if (this.Text == this.NameText) {
374            this.TextError = ''
375          } else {
376            this.TextError = '用户名输入错误'
377            this.Text = ''
378          }
379        })
380
381    }.width('100%')
382  }
383}
384```
385
386![TextInputError](figures/TextInputError.png)
387
388### 示例3
389
390```ts
391// xxx.ets
392@Entry
393@Component
394struct TextInputExample {
395  controller: TextInputController = new TextInputController()
396  @State inputValue: string = ""
397
398  // 自定义键盘组件
399  @Builder CustomKeyboardBuilder() {
400    Column() {
401      Button('x').onClick(() => {
402        // 关闭自定义键盘
403        this.controller.stopEditing()
404      })
405      Grid() {
406        ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9, '*', 0, '#'], (item:number|string) => {
407          GridItem() {
408            Button(item + "")
409              .width(110).onClick(() => {
410              this.inputValue += item
411            })
412          }
413        })
414      }.maxCount(3).columnsGap(10).rowsGap(10).padding(5)
415    }.backgroundColor(Color.Gray)
416  }
417
418  build() {
419    Column() {
420      TextInput({ controller: this.controller, text: this.inputValue })
421        // 绑定自定义键盘
422        .customKeyboard(this.CustomKeyboardBuilder()).margin(10).border({ width: 1 })
423    }
424  }
425}
426```
427
428![customKeyboard](figures/textInputCustomKeyboard.png)
429
430
431### 示例4
432
433```ts
434// xxx.ets
435@Entry
436@Component
437struct ClearNodeExample {
438  @State text: string = ''
439  controller: TextInputController = new TextInputController()
440
441  build() {
442    Column() {
443      TextInput({ placeholder: 'input ...', controller: this.controller })
444        .width(380)
445        .height(60)
446        .cancelButton({
447          style: CancelButtonStyle.CONSTANT,
448          icon: {
449            size: 45,
450            src: $r('app.media.icon'),
451            color: Color.Blue
452          }
453        })
454        .onChange((value: string) => {
455          this.text = value
456        })
457    }
458  }
459}
460```
461
462![cancelButton](figures/TextInputCancelButton.png)
463
464### 示例5
465
466```ts
467// xxx.ets
468@Entry
469@Component
470struct TextInputExample {
471  @State text: string = ''
472  controller: TextInputController = new TextInputController()
473
474  build() {
475    Column() {
476      TextInput({ text: this.text, controller: this.controller })
477        .placeholderFont({ size: 16, weight: 400 })
478        .width(336)
479        .height(56)
480        .maxLength(6)
481        .showUnderline(true)
482		.showCounter(true, { thresholdPercentage: 50, highlightBorder: true })
483		//计数器显示效果为用户当前输入字符数/最大字符限制数。最大字符限制数通过maxLength()接口设置。
484        //如果用户当前输入字符数达到最大字符限制乘50%(thresholdPercentage)。字符计数器显示。
485        //用户设置highlightBorder为false时,配置取消红色边框。不设置此参数时,默认为true。
486        .onChange((value: string) => {
487          this.text = value
488        })
489    }.width('100%').height('100%').backgroundColor('#F1F3F5')
490  }
491}
492```
493
494![TextInputCounter](figures/TextInputShowCounter.jpg)
495