鸿蒙5.0开发进阶:UI框架-ArkTS组件(TextArea)

鸿蒙Harmony应用开发—ArkTS声明式开发(通用属性:尺寸设置) ArkTS声明式开发(通用属性:尺寸设置) 阅读详情

往期鸿蒙全套实战文章必看:(文中附带全栈鸿蒙学习资料)


TextArea

多行文本输入框组件,当输入的文本内容超过组件宽度时会自动换行显示。

高度未设置时,组件无默认高度,自适应内容高度。宽度未设置时,默认撑满最大宽度。

说明

该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

无

接口

TextArea(value?: TextAreaOptions)

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextAreaOptions否TextArea组件参数。

TextAreaOptions对象说明

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
placeholderResourceStr否

设置无输入时的提示文本。输入内容后,提示文本不显示。

仅设置placeholder属性时,手柄依然跟随拖动,手柄松开后光标停留在文字开头位置。

textResourceStr否

设置输入框当前的文本内容。

建议通过onChange事件将状态变量与文本实时绑定,

避免组件刷新时TextArea中的文本内容异常。

从API version 10开始,该参数支持$$双向绑定变量。

controller8+TextAreaController否设置TextArea控制器。

属性

除支持通用属性,还支持以下属性:

说明

通用属性padding的默认值为:

{

top: '8vp',

right: '16vp',

bottom: '8vp',

left: '16vp'

}

从API version 11开始,多行输入框可设置.width('auto')使组件宽度自适应文本宽度,自适应时组件宽度受constraintSize属性以及父容器传递的最大最小宽度限制,其余使用方式参考尺寸设置。

placeholderColor

placeholderColor(value: ResourceColor)

设置placeholder文本颜色。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResourceColor是

placeholder文本颜色。

默认值:跟随主题。

placeholderFont

placeholderFont(value: Font)

设置placeholder文本样式,包括字体大小,字体粗细,字体族,字体风格。当前支持'HarmonyOS Sans'字体和注册自定义字体。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueFont是placeholder文本样式。

textAlign

textAlign(value: TextAlign)

设置文本在输入框中的水平对齐方式。

支持TextAlign.Start、TextAlign.Center和TextAlign.End。

可通过align属性控制文本段落在垂直方向上的位置,此组件中不可通过align属性控制文本段落在水平方向上的位置,即align属性中Alignment.TopStart、Alignment.Top、Alignment.TopEnd效果相同,控制内容在顶部,Alignment.Start、Alignment.Center、Alignment.End效果相同,控制内容垂直居中,Alignment.BottomStart、Alignment.Bottom、Alignment.BottomEnd效果相同,控制内容在底部。

当textAlign属性设置为TextAlign.JUSTIFY时,最后一行文本不参与两端对齐,为水平对齐首部效果。

从API version 11开始,textAlign可设置TextAlign.JUSTIFY

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextAlign是

文本在输入框中的水平对齐方式。

默认值:TextAlign.Start

caretColor

caretColor(value: ResourceColor)

设置输入框光标颜色。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResourceColor是

输入框光标颜色。

默认值:'#007DFF'

说明

从API version 12开始,此接口支持设置文本手柄颜色,光标和文本手柄颜色保持一致。

fontColor

fontColor(value: ResourceColor)

设置字体颜色。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResourceColor是字体颜色。

fontSize

fontSize(value: number | string | Resource)

设置字体大小。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResource | number | string是字体大小。fontSize为number类型时,使用fp单位。字体默认大小16fp。不支持设置百分比字符串。

fontStyle

fontStyle(value: FontStyle)

设置字体样式。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueFontStyle是

字体样式。

默认值:FontStyle.Normal

fontWeight

fontWeight(value: number | FontWeight | string)

设置文本的字体粗细,设置过大可能会在不同字体下有截断。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueFontWeight | number | string是

文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。string类型仅支持number类型取值的字符串形式,例如"400",以及"bold"、"bolder"、"lighter"、"regular"、"medium",分别对应FontWeight中相应的枚举值。

默认值:FontWeight.Normal

fontFamily

fontFamily(value: string | Resource)

设置字体列表。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResource | string是

字体列表。默认字体'HarmonyOS Sans'。

应用当前支持'HarmonyOS Sans'字体和注册自定义字体。

卡片当前仅支持'HarmonyOS Sans'字体。

inputFilter8+

inputFilter(value: ResourceStr, error?: (value: string) => void)

通过正则表达式设置输入过滤器。匹配表达式的输入允许显示,不匹配的输入将被过滤。仅支持单个字符匹配,不支持字符串匹配。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResourceStr是正则表达式。
error(value: string) => void否正则匹配失败时,返回被过滤的内容。

copyOption9+

copyOption(value: CopyOptions)

设置输入的文本是否可复制。设置CopyOptions.None时,当前TextArea中的文字无法被复制或剪切,仅支持粘贴。

设置CopyOptions.None时,不允许拖拽。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueCopyOptions是

输入的文本是否可复制。

默认值:CopyOptions.LocalDevice,支持设备内复制。

maxLength10+

maxLength(value: number)

设置文本的最大输入字符数。默认不设置最大输入字符数限制。到达文本最大字符限制,将无法继续输入字符,同时边框变为红色。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber是文本的最大输入字符数。

showCounter10+

showCounter(value: boolean, options?: InputCounterOptions)

设置当通过InputCounterOptions输入的字符数超过阈值时显示计数器。

参数value为true时,才能设置options,文本框开启计数下标功能,需要配合maxlength(设置最大字符限制)一起使用。字符计数器显示的效果是当前输入字符数/最大可输入字符数。

当输入字符数大于最大字符数乘百分比值时,显示字符计数器。如果用户设置计数器时不设置InputCounterOptions,那么当前输入字符数达到最大字符数时,边框和计数器下标将变为红色。用户同时设置参数value为true和InputCounterOptions,当thresholdPercentage数值在有效区间内,且输入字符数超过最大字符数时,边框和计数器下标将变为红色,框体抖动。highlightBorder设置为false,则不显示红色边框,计数器默认显示红色边框。内联模式下字符计数器不显示。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueboolean是是否显示计数器。
options11+InputCounterOptions否计数器的百分比。

style10+

style(value: TextContentStyle)

设置文本框多态样式,内联输入风格只支持TextAreaType.Normal类型。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextContentStyle是

文本框多态样式。

默认值:TextContentStyle.DEFAULT

enableKeyboardOnFocus10+

enableKeyboardOnFocus(value: boolean)

设置TextArea通过点击以外的方式获焦时,是否主动拉起软键盘。

从API version 10开始,获焦默认绑定输入法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueboolean是

通过点击以外的方式获焦时,是否主动拉起软键盘。

默认值:true

selectionMenuHidden10+

selectionMenuHidden(value: boolean)

设置是否不弹出系统文本选择菜单。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueboolean是

是否不弹出系统文本选择菜单。

设置为true时,单击输入框光标、长按输入框、双击输入框、三击输入框或者右键输入框,不弹出系统文本选择菜单。

设置为false时,弹出系统文本选择菜单。

默认值:false

barState10+

barState(value: BarState)

设置输入框编辑态时滚动条的显示模式。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueBarState是

输入框编辑态时滚动条的显示模式。

默认值:BarState.Auto

maxLines10+

maxLines(value: number)

配置textOverflow一起使用时,maxlines为可显示行数,超出截断;未配置textOverflow时,内联模式获焦状态下内容超出maxlines时,文本可滚动显示,内联模式非获焦状态下不生效maxlines,非内联模式按行截断。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber是

内联输入风格编辑态时文本可显示的最大行数。

默认值:3,非内联模式下,默认值为+∞,不限制最大行数。

取值范围:(0, +∞)

customKeyboard10+

customKeyboard(value: CustomBuilder, options?: KeyboardOptions)

设置自定义键盘。

当设置自定义键盘时,输入框激活后不会打开系统输入法,而是加载指定的自定义组件。

自定义键盘的高度可以通过自定义组件根节点的height属性设置,宽度不可设置,使用系统默认值。

自定义键盘采用覆盖原始界面的方式呈现,当没有开启避让模式或者输入框不需要避让的场景不会对应用原始界面产生压缩或者上提。

自定义键盘无法获取焦点,但是会拦截手势事件。

默认在输入控件失去焦点时,关闭自定义键盘,开发者也可以通过TextAreaController.stopEditing方法控制键盘关闭。

如果设备支持拍摄输入,设置自定义键盘后,该输入框会不支持拍摄输入。

当设置自定义键盘时,可以通过绑定onKeyPrelme事件规避物理键盘的输入。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueCustomBuilder是

自定义键盘。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

options12+KeyboardOptions否设置自定义键盘是否支持避让功能。

type11+

type(value: TextAreaType)

设置输入框类型。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextAreaType是

输入框类型。

默认值:TextAreaType.Normal

enterKeyType11+

enterKeyType(value: EnterKeyType)

设置输入法回车键类型。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueEnterKeyType是

输入法回车键类型。

默认值:EnterKeyType.NEW_LINE

enableAutoFill12+

enableAutoFill(value: boolean)

设置是否启用自动填充。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueboolean是

是否启用自动填充。

true表示启用,false表示不启用。

默认值:true

contentType12+

contentType(contentType: ContentType)

设置自动填充类型。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
contentTypeContentType是自动填充类型。

lineHeight12+

lineHeight(value: number | string | Resource)

设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,number类型时单位为fp。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber | string | Resource是文本的文本行高。

decoration12+

decoration(value: TextDecorationOptions)

设置文本装饰线类型样式及其颜色。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextDecorationOptions是

文本装饰线对象。

默认值:{

type: TextDecorationType.None,

color: Color.Black,

style: TextDecorationStyle.SOLID

}

letterSpacing12+

letterSpacing(value: number | string | Resource)

设置文本字符间距。设置该值为百分比时,按默认值显示。设置该值为0时,按默认值显示。

当取值为负值时,文字会发生压缩,负值过小时会将组件内容区大小压缩为0,导致无内容显示。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber | string | Resource是文本字符间距。

fontFeature12+

fontFeature(value: string)

设置文字特性效果,比如数字等宽的特性。

格式为:normal | <feature-tag-value>

<feature-tag-value>的格式为:<string> [ <integer> | on | off ]

<feature-tag-value>的个数可以有多个,中间用','隔开。

例如,使用等宽数字的输入格式为:"ss01" on。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuestring是文字特性效果。

Font Feature当前支持的属性见 fontFeature属性列表。

设置 Font Feature 属性,Font Feature 是 OpenType 字体的高级排版能力,如支持连字、数字等宽等特性,一般用在自定义字体中,其能力需要字体本身支持。

wordBreak12+

wordBreak(value: WordBreak)

设置文本断行规则。该属性对placeholder文本无效。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueWordBreak是

文本断行规则。

默认值:WordBreak.BREAK_WORD

说明

组件不支持clip属性设置,设置该属性任意枚举值对组件文本截断无影响。

selectedBackgroundColor12+

selectedBackgroundColor(value: ResourceColor)

设置文本选中底板颜色。如果未设置不透明度,默认为20%不透明度。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueResourceColor是

文本选中底板颜色。

默认为20%不透明度。

caretStyle12+

caretStyle(value: CaretStyle)

设置光标风格。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueCaretStyle是光标的风格。

textIndent12+

textIndent(value: Dimension)

设置首行文本缩进。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueDimension是

首行文本缩进。

默认值:0

textOverflow12+

textOverflow(value: TextOverflow)

设置文本超长时的显示方式。

内联模式,主动配置textoverflow才会生效按maxline截断效果,不配置时,默认不截断。

文本截断是按字截断。例如,英文以单词为最小单位进行截断,若需要以字母为单位进行截断,wordBreak属性可设置为WordBreak.BREAK_ALL。

当overflow设置为TextOverflow.None、TextOverflow.Clip、TextOverflow.Ellipsis时,需配合maxLines使用,单独设置不生效。设置TextOverflow.None与TextOverflow.Clip效果一样。

卡片能力: 该接口支持在ArkTS卡片中使用。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextOverflow是

文本超长时的显示方式。

默认值:TextOverflow.Clip

说明

TextArea组件不支持设置TextOverflow.MARQUEE模式,当设置为TextOverflow.MARQUEE模式时 显示为TextOverflow.Clip

minFontSize12+

minFontSize(value: number | string | Resource)

设置文本最小显示字号。

需配合maxFontSize以及maxLines或布局大小限制使用,单独设置不生效。

自适应字号生效时,fontSize设置不生效。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber | string | Resource是文本最小显示字号。

maxFontSize12+

maxFontSize(value: number | string | Resource)

设置文本最大显示字号。

需配合minFontSize以及maxLines或布局大小限制使用,单独设置不生效。

自适应字号生效时,fontSize设置不生效。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber | string | Resource是文本最大显示字号。

heightAdaptivePolicy12+

heightAdaptivePolicy(value: TextHeightAdaptivePolicy)

设置文本自适应高度的方式。

当设置为TextHeightAdaptivePolicy.MAX_LINES_FIRST时,优先使用maxLines属性来调整文本高度。如果使用maxLines属性的布局大小超过了布局约束,则尝试在minFontSize和maxFontSize的范围内缩小字体以显示更多文本。

组件设置为内联输入风格,编辑态与非编辑态存在字体大小不一致情况。

当设置为TextHeightAdaptivePolicy.MIN_FONT_SIZE_FIRST时,优先使用minFontSize属性来调整文本高度。如果使用minFontSize属性可以将文本布局在一行中,则尝试在minFontSize和maxFontSize的范围内增大字体并使用最大可能的字体大小。

当设置为TextHeightAdaptivePolicy.LAYOUT_CONSTRAINT_FIRST时,优先使用布局约束来调整文本高度。如果布局大小超过布局约束,则尝试在minFontSize和maxFontSize的范围内缩小字体以满足布局约束。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueTextHeightAdaptivePolicy是

文本自适应高度的方式。

默认值:TextHeightAdaptivePolicy.MAX_LINES_FIRST

lineSpacing12+

lineSpacing(value: LengthMetrics)

设置文本的行间距,设置值不大于0时,取默认值0。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valueLengthMetrics是文本的行间距。默认值:0

lineBreakStrategy12+

lineBreakStrategy(strategy: LineBreakStrategy)

设置折行规则。该属性在wordBreak不等于breakAll的时候生效,不支持连词符。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
strategyLineBreakStrategy是

文本的折行规则。

默认值:LineBreakStrategy.GREEDY

editMenuOptions12+

editMenuOptions(editMenu: EditMenuOptions)

设置自定义菜单扩展项,允许用户设置扩展项的文本内容、图标、回调方法。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
editMenuEditMenuOptions是扩展菜单选项。

enablePreviewText12+

enablePreviewText(enable: boolean)

设置是否开启输入预上屏。

预上屏内容定义为文字暂存态,目前不支持文字拦截功能,因此不触发onWillInsert、onDidInsert、onWillDelete、onDidDelete回调。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
enableboolean是

是否开启输入预上屏。

默认值:true

说明

该接口在CAPI场景使用时下,默认关闭。可以在工程的module.json5中配置metadata字段控制是否启用预上屏,配置如下:

 
 
  1. "metadata": [
  2. {
  3. "name": "can_preview_text",
  4. "value": "true",
  5. }
  6. ]

事件

除支持通用事件外,还支持以下事件:

onChange

onChange(callback: EditableTextOnChangeCallback)

输入内容发生变化时,触发该回调。

在本回调中,若执行了光标操作,需要开发者在预上屏场景下依据previewText参数调整光标逻辑,以适应预上屏场景。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
callbackEditableTextOnChangeCallback是当前输入文本内容变化时的回调。

onEditChange10+

onEditChange(callback: (isEditing: boolean) => void)

输入状态变化时,触发该回调。有光标时为编辑态,无光标时为非编辑态。isEditing为true表示正在输入。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
isEditingboolean是为true表示正在输入。

onCopy8+

onCopy(callback: (value: string) => void)

进行复制操作时,触发该回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuestring是复制的文本内容。

onCut8+

onCut(callback: (value: string) => void)

进行剪切操作时,触发该回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuestring是剪切的文本内容。

onPaste

onPaste(callback: (value: string, event: PasteEvent) => void)

进行粘贴操作时,触发该回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuestring是粘贴的文本内容。
event11+PasteEvent是用户自定义的粘贴事件。

onTextSelectionChange10+

onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)

文本选择的位置发生变化或编辑状态下光标位置发生变化时,触发该回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
selectionStartnumber是所选文本的起始位置,文字的起始位置为0。
selectionEndnumber是所选文本的结束位置。

onContentScroll10+

onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)

文本内容滚动时,触发该回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
totalOffsetXnumber是文本在内容区的横坐标偏移,单位px。
totalOffsetYnumber是文本在内容区的纵坐标偏移,单位px。

onSubmit11+

onSubmit(callback: (enterKey: EnterKeyType) => void)

按下输入法回车键触发该回调。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
enterKeyEnterKeyType是输入法回车键类型,类型为EnterKeyType.NEW_LINE时不触发onSubmit。

onWillInsert12+

onWillInsert(callback: Callback<InsertValue, boolean>)

在将要输入时,触发该回调。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
callbackCallback<InsertValue, boolean>是

在将要输入时调用的回调。

在返回true时,表示正常插入,返回false时,表示不插入。

在预上屏操作时,该回调不触发。

仅支持系统输入法输入的场景。

onDidInsert12+

onDidInsert(callback: Callback<InsertValue>)

在输入完成时,触发该回调。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
callbackCallback<InsertValue>是

在输入完成时调用的回调。

仅支持系统输入法输入的场景。

onWillDelete12+

onWillDelete(callback: Callback<DeleteValue, boolean>)

在将要删除时,触发该回调。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
callbackCallback<DeleteValue, boolean>是

在将要删除时调用的回调。

在返回true时,表示正常删除,返回false时,表示不删除。

在预上屏删除操作时,该回调不触发。

仅支持系统输入法输入的场景。

onDidDelete12+

onDidDelete(callback: Callback<DeleteValue>)

在删除完成时,触发该回调。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
callbackCallback<DeleteValue>是

在删除完成时调用的回调。

仅支持系统输入法输入的场景。

TextAreaController8+

TextArea组件的控制器继承自TextContentControllerBase。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

导入对象

controller: TextAreaController = new TextAreaController()

constructor8+

constructor()

TextAreaController的构造函数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

caretPosition8+

caretPosition(value: number): void

设置输入光标的位置。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
valuenumber是从字符串开始到光标所在位置的字符长度。

setTextSelection10+

setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void

组件在获焦状态下,调用该接口设置文本选择区域并高亮显示,且只有在selectionStart小于selectionEnd时,文字才会被选取、高亮显示。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名类型必填说明
selectionStartnumber是

文本选择区域起始位置,文本框中文字的起始位置为0。

当selectionStart小于0时、按照0处理;当selectionStart大于文字最大长度时、按照文字最大长度处理。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

selectionEndnumber是

文本选择区域结束位置。

当selectionEnd小于0时、按照0处理;当selectionEnd大于文字最大长度时、按照文字最大长度处理。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

options12+SelectionOptions否

选中文字时的配置。

默认值:MenuPolicy.DEFAULT

元服务API: 从API version 12开始,该接口支持在元服务中使用。

说明

如果selectionMenuHidden被赋值为true或设备为2in1时,即使options被赋值为MenuPolicy.SHOW,调用setTextSelection也不弹出菜单。

如果选中的文本含有emoji表情时,表情的起始位置包含在设置的文本选中区域内就会被选中。

stopEditing10+

stopEditing(): void

退出编辑态。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

TextAreaType11+枚举说明

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称值描述
NORMAL0

基本输入模式。

支持输入数字、字母、下划线、空格、特殊字符。

NUMBER2纯数字输入模式。
PHONE_NUMBER3

电话号码输入模式。

支持输入数字、空格、+ 、-、*、#、(、),长度不限。

EMAIL5

邮箱地址输入模式。

支持数字,字母,下划线、小数点、!、#、$、%、&、'、*、+、-、/、=、?、^、`、{、|、}、~,以及@字符(只能存在一个@字符)。

NUMBER_DECIMAL12+12

带小数点的数字输入模式。

支持数字,小数点(只能存在一个小数点)。

URL12+13带URL的输入模式。

ContentType12+枚举说明

自动填充类型。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称值描述
USER_NAME0【用户名】在已启用密码保险箱的情况下,支持用户名的自动保存和自动填充。
PASSWORD1【密码】在已启用密码保险箱的情况下,支持密码的自动保存和自动填充。
NEW_PASSWORD2【新密码】在已启用密码保险箱的情况下,支持自动生成新密码。
FULL_STREET_ADDRESS3【详细地址】在已启用情景化自动填充的情况下,支持详细地址的自动保存和自动填充。
HOUSE_NUMBER4【门牌号】在已启用情景化自动填充的情况下,支持门牌号的自动保存和自动填充。
DISTRICT_ADDRESS5【区/县】在已启用情景化自动填充的情况下,支持区/县的自动保存和自动填充。
CITY_ADDRESS6【市】在已启用情景化自动填充的情况下,支持市的自动保存和自动填充。
PROVINCE_ADDRESS7【省】在已启用情景化自动填充的情况下,支持省的自动保存和自动填充。
COUNTRY_ADDRESS8【国家】在已启用情景化自动填充的情况下,支持国家的自动保存和自动填充。
PERSON_FULL_NAME9【姓名】在已启用情景化自动填充的情况下,支持姓名的自动保存和自动填充。
PERSON_LAST_NAME10【姓氏】在已启用情景化自动填充的情况下,支持姓氏的自动保存和自动填充。
PERSON_FIRST_NAME11【名字】在已启用情景化自动填充的情况下,支持名字的自动保存和自动填充。
PHONE_NUMBER12【手机号码】在已启用情景化自动填充的情况下,支持手机号码的自动保存和自动填充。
PHONE_COUNTRY_CODE13【国家代码】在已启用情景化自动填充的情况下,支持国家代码的自动保存和自动填充。
FULL_PHONE_NUMBER14【包含国家代码的手机号码】在已启用情景化自动填充的情况下,支持包含国家代码的手机号码的自动保存和自动填充。
EMAIL_ADDRESS15【邮箱地址】在已启用情景化自动填充的情况下,支持邮箱地址的自动保存和自动填充。
BANK_CARD_NUMBER16【银行卡号】在已启用情景化自动填充的情况下,支持银行卡号的自动保存和自动填充。
ID_CARD_NUMBER17【身份证号】在已启用情景化自动填充的情况下,支持身份证号的自动保存和自动填充。
NICKNAME23【昵称】在已启用情景化自动填充的情况下,支持昵称的自动保存和自动填充。
DETAIL_INFO_WITHOUT_STREET24【无街道地址】在已启用情景化自动填充的情况下,支持无街道地址的自动保存和自动填充。
FORMAT_ADDRESS25【标准地址】在已启用情景化自动填充的情况下,支持标准地址的自动保存和自动填充。

示例

示例1(设置与获取光标位置)

该示例通过controller实现了光标位置的设置与获取。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text: string = ''
  @State positionInfo: CaretOffset = { index: 0, x: 0, y: 0 }
  controller: TextAreaController = new TextAreaController()

  build() {
    Column() {
      TextArea({
        text: this.text,
        placeholder: 'The text area can hold an unlimited amount of text. input your word...',
        controller: this.controller
      })
        .placeholderFont({ size: 16, weight: 400 })
        .width(336)
        .height(56)
        .margin(20)
        .fontSize(16)
        .fontColor('#182431')
        .backgroundColor('#FFFFFF')
        .onChange((value: string) => {
          this.text = value
        })
      Text(this.text)
      Button('Set caretPosition 1')
        .backgroundColor('#007DFF')
        .margin(15)
        .onClick(() => {
          // 设置光标位置到第一个字符后
          this.controller.caretPosition(1)
        })
      Button('Get CaretOffset')
        .backgroundColor('#007DFF')
        .margin(15)
        .onClick(() => {
          this.positionInfo = this.controller.getCaretOffset()
        })
    }.width('100%').height('100%').backgroundColor('#F1F3F5')
  }
}

示例2(设置计数器)

该示例通过maxLength、showCounter属性实现了计数器的功能。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text: string = ''
  controller: TextAreaController = new TextAreaController()

  build() {
    Column() {
      TextArea({
        text: this.text,
        placeholder: 'The text area can hold an unlimited amount of text. input your word...',
        controller: this.controller
      })
        .placeholderFont({ size: 16, weight: 400 })
        .width(336)
        .height(56)
        .margin(20)
        .fontSize(16)
        .fontColor('#182431')
        .backgroundColor('#FFFFFF')
        .maxLength(4)
        .showCounter(true, { thresholdPercentage: 50, highlightBorder: true })
          //计数器显示效果为用户当前输入字符数/最大字符限制数。最大字符限制数通过maxLength()接口设置。
          //如果用户当前输入字符数达到最大字符限制乘50%(thresholdPercentage)。字符计数器显示。
          //用户设置highlightBorder为false时,配置取消红色边框。不设置此参数时,默认为true。
        .onChange((value: string) => {
          this.text = value
        })
    }.width('100%').height('100%').backgroundColor('#F1F3F5')
  }
}

示例3(设置自定义键盘)

该示例通过customKeyboard属性实现了自定义键盘的功能。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  controller: TextAreaController = new TextAreaController()
  @State inputValue: string = ""

  // 自定义键盘组件
  @Builder CustomKeyboardBuilder() {
    Column() {
      Button('x').onClick(() => {
        // 关闭自定义键盘
        this.controller.stopEditing()
      })
      Grid() {
        ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9, '*', 0, '#'], (item: number | string) => {
          GridItem() {
            Button(item + "")
              .width(110).onClick(() => {
              this.inputValue += item
            })
          }
        })
      }.maxCount(3).columnsGap(10).rowsGap(10).padding(5)
    }.backgroundColor(Color.Gray)
  }

  build() {
    Column() {
      TextArea({ controller: this.controller, text: this.inputValue})
        // 绑定自定义键盘
        .customKeyboard(this.CustomKeyboardBuilder()).margin(10).border({ width: 1 })
        .height(200)
    }
  }
}

示例4(设置输入法回车键类型)

该示例通过enterKeyType属性实现了动态切换输入法回车键的效果。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text: string = ''
  @State enterTypes: Array<EnterKeyType> =
    [EnterKeyType.Go, EnterKeyType.Search, EnterKeyType.Send, EnterKeyType.Done, EnterKeyType.Next,
      EnterKeyType.PREVIOUS, EnterKeyType.NEW_LINE]
  @State index: number = 0

  build() {
    Column({ space: 20 }) {
      TextArea({ placeholder: '请输入用户名', text: this.text })
        .width(380)
        .enterKeyType(this.enterTypes[this.index])
        .onChange((value: string) => {
          this.text = value
        })
        .onSubmit((enterKey: EnterKeyType) => {
          console.log("trigger area onsubmit" + enterKey);
        })
      Button('改变EnterKeyType').onClick(() => {
        this.index = (this.index + 1) % this.enterTypes.length;
      })

    }.width('100%')
  }
}

示例5(设置文本断行规则)

该示例通过wordBreak属性实现了TextArea不同断行规则下的效果。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  build() {
    Column() {
      Text("属性WordBreakType为NORMAL的样式:").fontSize(16).fontColor(0xFF0000)
      TextArea({
        text: 'This is set wordBreak to WordBreak text Taumatawhakatangihangakoauauotamateaturipukakapikimaungahoronukupokaiwhenuakitanatahu.'
      })
        .fontSize(16)
        .border({ width: 1 })
        .wordBreak(WordBreak.NORMAL)
      Text("英文文本,属性WordBreakType为BREAK_ALL的样式:").fontSize(16).fontColor(0xFF0000)
      TextArea({
        text: 'This is set wordBreak to WordBreak text Taumatawhakatangihangakoauauotamateaturipukakapikimaungahoronukupokaiwhenuakitanatahu.'
      })
        .fontSize(16)
        .border({ width: 1 })
        .wordBreak(WordBreak.BREAK_ALL)
      Text("中文文本,属性WordBreakType为BREAK_ALL的样式:").fontSize(16).fontColor(0xFF0000)
      TextArea({
        text: '多行文本输入框组件,当输入的文本内容超过组件宽度时会自动换行显示。\n高度未设置时,组件无默认高度,自适应内容高度。宽度未设置时,默认撑满最大宽度。'
      })
        .fontSize(16)
        .border({ width: 1 })
        .wordBreak(WordBreak.BREAK_ALL)
      Text("属性WordBreakType为BREAK_WORD的样式:").fontSize(16).fontColor(0xFF0000)
      TextArea({
        text: 'This is set wordBreak to WordBreak text Taumatawhakatangihangakoauauotamateaturipukakapikimaungahoronukupokaiwhenuakitanatahu.'
      })
        .fontSize(16)
        .border({ width: 1 })
        .wordBreak(WordBreak.BREAK_WORD)
    }
  }
}

示例6(设置文本样式)

该示例通过lineHeight、letterSpacing、decoration属性展示了不同样式的文本效果。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  build() {
    Row() {
      Column() {
        Text('lineHeight').fontSize(9).fontColor(0xCCCCCC)
        TextArea({text: 'lineHeight unset'})
          .border({ width: 1 }).padding(10).margin(5)
        TextArea({text: 'lineHeight 15'})
          .border({ width: 1 }).padding(10).margin(5).lineHeight(15)
        TextArea({text: 'lineHeight 30'})
          .border({ width: 1 }).padding(10).margin(5).lineHeight(30)

        Text('letterSpacing').fontSize(9).fontColor(0xCCCCCC)
        TextArea({text: 'letterSpacing 0'})
          .border({ width: 1 }).padding(5).margin(5).letterSpacing(0)
        TextArea({text: 'letterSpacing 3'})
          .border({ width: 1 }).padding(5).margin(5).letterSpacing(3)
        TextArea({text: 'letterSpacing -1'})
          .border({ width: 1 }).padding(5).margin(5).letterSpacing(-1)

        Text('decoration').fontSize(9).fontColor(0xCCCCCC)
        TextArea({text: 'LineThrough, Red\nsecond line'})
          .border({ width: 1 }).padding(5).margin(5)
          .decoration({type: TextDecorationType.LineThrough, color: Color.Red})
        TextArea({text: 'Overline, Red, DOTTED\nsecond line'})
          .border({ width: 1 }).padding(5).margin(5)
          .decoration({type: TextDecorationType.Overline, color: Color.Red, style: TextDecorationStyle.DOTTED})
        TextArea({text: 'Underline, Red, WAVY\nsecond line'})
          .border({ width: 1 }).padding(5).margin(5)
          .decoration({type: TextDecorationType.Underline, color: Color.Red, style: TextDecorationStyle.WAVY})
      }.height('90%')
    }
    .width('90%')
    .margin(10)
  }
}

示例7(设置文字特性效果)

该示例通过fontFeature属性实现了文本在不同文字特性下的展示效果。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text1: string = 'This is ss01 on : 0123456789'
  @State text2: string = 'This is ss01 off: 0123456789'

  build() {
    Column(){
      TextArea({text: this.text1})
        .fontSize(20)
        .margin({top:200})
        .fontFeature("\"ss01\" on")
      TextArea({text : this.text2})
        .margin({top:10})
        .fontSize(20)
        .fontFeature("\"ss01\" off")
    }
    .width("90%")
    .margin("5%")
  }
}

示例8(自定义键盘避让)

该示例通过自定义键盘实现了键盘避让的功能。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  controller: TextAreaController = new TextAreaController()
  @State inputValue: string = ""
  @State height1:string|number = '80%'
  @State height2:number = 100
  @State supportAvoidance:boolean = true;

  // 自定义键盘组件
  @Builder CustomKeyboardBuilder() {
    Column() {
      Row(){
        Button('x').onClick(() => {
          // 关闭自定义键盘
          this.controller.stopEditing()
        }).margin(10)
      }
      Grid() {
        ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9, '*', 0, '#'], (item: number | string) => {
          GridItem() {
            Button(item + "")
              .width(110).onClick(() => {
              this.inputValue += item
            })
          }
        })
      }.maxCount(3).columnsGap(10).rowsGap(10).padding(5)
    }.backgroundColor(Color.Gray)
  }

  build() {
    Column() {
      Row(){
        Button("20%")
          .fontSize(24)
          .onClick(()=>{
            this.height1 = "20%"
          })
        Button("80%")
          .fontSize(24)
          .margin({left:20})
          .onClick(()=>{
            this.height1 = "80%"
          })
      }
      .justifyContent(FlexAlign.Center)
      .alignItems(VerticalAlign.Bottom)
      .height(this.height1)
      .width("100%")
      .padding({bottom:50})
      TextArea({ controller: this.controller, text: this.inputValue})
        .height(100)
        // 绑定自定义键盘
        .customKeyboard(this.CustomKeyboardBuilder(),{ supportAvoidance: this.supportAvoidance }).margin(10).border({ width: 1 })
        // .height(200)
    }
  }
}

示例9(设置文本自适应)

该示例通过minFontSize、maxFontSize、heightAdaptivePolicy属性展示了文本自适应字号的效果。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  build() {
    Row() {
      Column() {
        Text('heightAdaptivePolicy').fontSize(9).fontColor(0xCCCCCC)
        TextArea({text: 'This is the text with the height adaptive policy set'})
          .width('80%').height(90).borderWidth(1).margin(1)
          .minFontSize(4)
          .maxFontSize(40)
          .maxLines(3)
          .heightAdaptivePolicy(TextHeightAdaptivePolicy.MAX_LINES_FIRST)
        TextArea({text: 'This is the text with the height adaptive policy set'})
          .width('80%').height(90).borderWidth(1).margin(1)
          .minFontSize(4)
          .maxFontSize(40)
          .maxLines(3)
          .heightAdaptivePolicy(TextHeightAdaptivePolicy.MIN_FONT_SIZE_FIRST)
        TextArea({text: 'This is the text with the height adaptive policy set'})
          .width('80%').height(90).borderWidth(1).margin(1)
          .minFontSize(4)
          .maxFontSize(40)
          .maxLines(3)
          .heightAdaptivePolicy(TextHeightAdaptivePolicy.LAYOUT_CONSTRAINT_FIRST)
      }.height('90%')
    }
    .width('90%')
    .margin(10)
  }
}

示例10(设置文本行间距)

该示例通过lineSpacing属性展示了文本在不同行间距下的展示效果。

// xxx.ets
import { LengthMetrics } from '@kit.ArkUI'

@Entry
@Component
struct TextAreaExample {
  build() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
        Text('TextArea lineSpacing.').fontSize(9).fontColor(0xCCCCCC)
        TextArea({ placeholder: 'This is the TextArea with no lineSpacing set.' })
          .fontSize(12)
        TextArea({ placeholder: 'This is the TextArea with lineSpacing set to 20_px.' })
          .fontSize(12)
          .lineSpacing(LengthMetrics.px(20))
        TextArea({ placeholder: 'This is the TextArea with lineSpacing set to 20_vp.' })
          .fontSize(12)
          .lineSpacing(LengthMetrics.vp(20))
        TextArea({ placeholder: 'This is the TextArea with lineSpacing set to 20_fp.' })
          .fontSize(12)
          .lineSpacing(LengthMetrics.fp(20))
        TextArea({ placeholder: 'This is the TextArea with lineSpacing set to 20_lpx.' })
          .fontSize(12)
          .lineSpacing(LengthMetrics.lpx(20))
        TextArea({ placeholder: 'This is the TextArea with lineSpacing set to 100%.' })
          .fontSize(12)
          .lineSpacing(LengthMetrics.percent(1))
      }.height(600).width(350).padding({ left: 35, right: 35, top: 35 })
  }
}

示例11(设置自动填充)

该示例通过contentType、enableAutoFill属性实现了文本自动填充的功能。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text: string = ''

  build() {
    Column() {
      // 邮箱地址自动填充类型
      TextArea({ placeholder: 'input your email...' })
        .width('95%')
        .height(40)
        .margin(20)
        .contentType(ContentType.EMAIL_ADDRESS)
        .enableAutoFill(true)
        .maxLength(20)
      // 街道地址自动填充类型
      TextArea({ placeholder: 'input your street address...' })
        .width('95%')
        .height(40)
        .margin(20)
        .contentType(ContentType.FULL_STREET_ADDRESS)
        .enableAutoFill(true)
        .maxLength(20)
    }.width('100%').height('100%').backgroundColor('#F1F3F5')
  }
}

示例12(设置折行规则)

该示例通过lineBreakStrategy属性实现了TextArea不同折行规则下的效果。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State message1: string =
    "They can be classified as built-in components–those directly provided by the ArkUI framework and custom components – those defined by developers" +
      "The built-in components include buttons radio buttonsprogress indicators and text You can set the rendering effectof thesecomponents in method chaining mode," +
      "page components are divided into independent UI units to implementindependent creation development and reuse of different units on pages making pages more engineering-oriented."
  @State lineBreakStrategyIndex: number = 0
  @State lineBreakStrategy: LineBreakStrategy[] =
    [LineBreakStrategy.GREEDY, LineBreakStrategy.HIGH_QUALITY, LineBreakStrategy.BALANCED]
  @State lineBreakStrategyStr: string[] = ['GREEDY', 'HIGH_QUALITY', 'BALANCED']

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start }) {
      Text('lineBreakStrategy').fontSize(9).fontColor(0xCCCCCC)
      TextArea({ text: this.message1 })
        .fontSize(12)
        .border({ width: 1 })
        .padding(10)
        .width('100%')
        .lineBreakStrategy(this.lineBreakStrategy[this.lineBreakStrategyIndex])
      Row() {
        Button('当前lineBreakStrategy模式:' + this.lineBreakStrategyStr[this.lineBreakStrategyIndex]).onClick(() => {
          this.lineBreakStrategyIndex++
          if (this.lineBreakStrategyIndex > (this.lineBreakStrategyStr.length - 1)) {
            this.lineBreakStrategyIndex = 0
          }
        })
      }.padding({ top: 10 })
    }.height(700).width(370).padding({ left: 35, right: 35, top: 35 })
  }
}

示例13(支持插入和删除回调)

该示例通过onWillInsert、onDidInsert、onWillDelete、onDidDelete接口实现了插入和删除的功能。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
@State insertValue: string = ""
@State deleteValue: string = ""
@State insertOffset: number = 0
@State deleteOffset: number = 0
@State deleteDirection: number = 0

build() {
Row() {
Column() {
TextArea({ text: "TextArea支持插入回调文本" })
.width(300)
.height(60)
.onWillInsert((info: InsertValue) => {
this.insertValue = info.insertValue
return true;
})
.onDidInsert((info: InsertValue) => {
this.insertOffset = info.insertOffset
})

Text("insertValue:" + this.insertValue + " insertOffset:" + this.insertOffset).height(30)

TextArea({ text: "TextArea支持删除回调文本b" })
.width(300)
.height(60)
.onWillDelete((info: DeleteValue) => {
this.deleteValue = info.deleteValue
info.direction
return true;
})
.onDidDelete((info: DeleteValue) => {
this.deleteOffset = info.deleteOffset
this.deleteDirection = info.direction
})

Text("deleteValue:" + this.deleteValue + " deleteOffset:" + this.deleteOffset).height(30)
Text("deleteDirection:" + (this.deleteDirection == 0 ? "BACKWARD" : "FORWARD")).height(30)

}.width('100%')
}
.height('100%')
}
}

示例14(文本扩展自定义菜单)

该示例通过editMenuOptions接口实现了文本设置自定义菜单扩展项的文本内容、图标以及回调的功能。

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text: string = 'TextArea editMenuOptions'
  onCreateMenu = (menuItems: Array<TextMenuItem>) => {
    let item1: TextMenuItem = {
      content: 'custom1',
      icon: $r('app.media.startIcon'),
      id: TextMenuItemId.of('custom1'),
    }
    let item2: TextMenuItem = {
      content: 'custom2',
      id: TextMenuItemId.of('custom2'),
      icon: $r('app.media.startIcon'),
    }
    menuItems.push(item1)
    menuItems.unshift(item2)
    return menuItems
  }
  onMenuItemClick = (menuItem: TextMenuItem, textRange: TextRange) => {
    if (menuItem.id.equals(TextMenuItemId.of("custom2"))) {
      console.log("拦截 id: custom2 start:" + textRange.start + "; end:" + textRange.end)
      return true
    }
    if (menuItem.id.equals(TextMenuItemId.COPY)) {
      console.log("拦截 COPY start:" + textRange.start + "; end:" + textRange.end)
      return true
    }
    if (menuItem.id.equals(TextMenuItemId.SELECT_ALL)) {
      console.log("不拦截 SELECT_ALL start:" + textRange.start + "; end:" + textRange.end)
      return false
    }
    return false
  }
  @State editMenuOptions: EditMenuOptions = {
    onCreateMenu: this.onCreateMenu, onMenuItemClick: this.onMenuItemClick
  }

  build() {
    Column() {
      TextArea({ text: this.text })
        .width('95%')
        .height(56)
        .editMenuOptions(this.editMenuOptions)
        .margin({ top: 100 })
    }
    .width("90%")
    .margin("5%")
  }
}

鸿蒙5.0版开发:ArkTS基础组件(TextArea) 多行文本输入框组件,当输入的文本内容超过组件宽度时会自动换行显示。 阅读详情

相关推荐

鸿蒙Harmony应用开发—ArkTS声明式开发(基础手势:TextArea)

ArkTS声明式开发(基础手势:TextArea)

m0_64420071的博客 2426

鸿蒙HarmonyOS学习笔记一

首先还是得谈谈鸿蒙的HarmonyOS,自鸿蒙出了HarmonyOS之后,其它厂商品牌也都纷纷开始各自的系统研究,带来的问题也很明显,就是适配了。有好有坏吧,相应的岗位自然是增加了,Android开发者也多了一个出路,但也相应的会有弊端:小公司来说,基本招多一个鸿蒙开发来说,是相对不可能的,让Android开发者去适配跨平台又或者学习ArkTS进行开发,这种的概率自然是高点。所以,学习下ArkTS也没什么坏处,当作一个傍身技能,面试也许会成为加分项呢。

s5924854的博客 1437

HarmonyOS应用开发:TextArea(基础组件)

多行文本输入框组件,当输入的文本内容超过组件宽度时会自动换行显示。

situnanQAQ的博客 1512

HarmonyOS 7 实战:ArkTS + Canvas 2D 打造情绪可视化 AI 应用

本文介绍了一个基于HarmonyOS 7开发的"情绪树"AI应用,通过ArkTS和Canvas 2D技术将用户情绪可视化为动态生长的树木。文章重点阐述了三个核心内容: 产品设计理念:通过"情绪树"的具身化隐喻(Embodied Metaphor),将多维情绪数据转化为可视化树木,比传统折线图更直观生动。 技术架构:采用端云协同的三层模型,App调用本地FastAPI服务而非直接持有大模型API Key,实现了AI失败降级和渲染与数据解耦的设计。 关键技术实现:包括ArkTS的声明式UI开发范式、多级状态管理

一键难忘的博客 2万+

rk3568 OpenHarmony4.0如何使用中文输入法

问题:rk3568开发板 OpenHarmony4.0release系统自带输入法kikaInput软件只有英文输入,不含中文输入,不方便。本文基于rk3568开发板 OpenHarmony4.0release移植了laval社区发布的开发者手机中的搜狗输入法(测试版),实现了中文输入,为OpenHarmony4.0release的其他开发板中文输入提供参考。

Devlin_的博客 2919

鸿蒙5.0版开发:UI框架JS组件-基础组件(textarea)

多行文本输入的文本框。

m0_69424697的博客 718

从零打造鸿蒙原生 Python IDE:ArkTS + N-API + PTY + CPython 全链路解析

鸿蒙原生Python IDE技术解析 项目概述 鸿蟒工坊(HongMian Workshop)是一款运行在HarmonyOS PC上的Python集成开发环境,填补了鸿蒙PC生态的开发工具空白。项目将Thonny IDE的核心功能移植到鸿蒙平台,提供代码编辑、Shell交互和完整CPython解释器支持。 技术架构 UI层:基于ArkTS/ArkUI实现编辑器界面 桥接层:使用C++/N-API实现JS与C++的通信 运行时层:嵌入CPython 3.12解释器 系统层:利用HarmonyOS内核

一键难忘的博客 3万+

鸿蒙5.0进阶开发:UI开发-文本输入 (TextInput/TextArea)

TextInput、TextArea是输入框组件,通常用于响应用户的输入操作...........

AyomQAQ的博客 1411

0 基础入门React Native鸿蒙跨平台开发:HarmonyOS ArkTS API 24,监听Keyboard模块原生键盘事件以做出相应回应

Python 的方法解析顺序是基于 C3,这是为 Dylan 编程语言(http://opendylan.org)构建的。在早期版本的 Python 中,所有类并没有一个共同的祖先 object。这里 L[MyClass]是 MyClass 类的线性化,而 merge 是合并多个线性化结果的具体。在 Python 2 中,如果使用的是旧式类(不继承自 object),仍然存在这样的算法。例如,在(Base1,Python 所有的 2.x 版本中都保留了旧式类,目的是为了向后兼容,所以在这些版本中,如。

2301_77888392的博客 811

STM32F103串口接收中断:USART_IT_IDLE和USART_IT_RXNE区别

2:如果是大于1个byte的数据,在不用DMA的情况下,同时使能USART_IT_RXNE,USART_IT_IDLE中断,每收到一个字节在中断中把数据存到缓存中,待收到USART_IT_IDLE中断时,收完整帧数据,然后再解析处理数据。比如:如上图在初始化时,同时开启了两个中断,如果传送8个字节的数据,就会产生8个USART_IT_RXNE,和1个USART_IT_IDLE中断。(如果接收到数据,在1个byte的时间内,没有收到新数据,就认为是数据传送完成,产生空闲USART_IT_IDLE中断)

weixin_66299220的博客 2403

Ubuntu18.04 SoftRoCE安装教程

目标:创建两台Ubuntu18.04虚拟机,安装SoftRoCE环境,一台作为Server,一台作为Client,模拟RDMA通信环境,熟悉RDMA的通信方式。

GGGYL111的博客 1551

鸿蒙 HarmonyOS 待办清单应用开发实战 —— 基于 ArkTS + SQLite 的完整教程

本文介绍了如何基于鸿蒙HarmonyOS的ArkTS语言和SQLite数据库开发一个功能完整的待办清单应用。主要内容包括: 项目概述: 实现待办事项的增删改查、状态切换、优先级管理、截止日期设置等核心功能 采用ArkTS + Stage模型 + SQLite技术栈 数据持久化设计: 选择SQLite作为存储方案,设计合理的表结构 定义了TodoItem和InsertTodoItem接口规范数据类型 封装TodoDatabase类管理数据库操作 关键技术点: 使用@ohos.data.relationalSt

s1316339343的博客 460

Unity游戏接入穿山甲广告SDK全攻略:从零到上线的避坑指南

本文为Unity开发者提供了接入穿山甲广告SDK的完整实战指南。详细解析了从账号注册、应用创建到Unity插件集成、安卓与iOS平台打包配置的全流程,并重点分享了广告加载失败、展示异常等常见问题的排查与解决方案,帮助开发者高效实现游戏广告变现。

weixin_29015899的博客 538

鸿蒙原生开发手记:徒步迹 - 表单组件与输入校验

本文介绍了鸿蒙原生应用开发中表单组件与输入校验的实现方法。通过封装通用FormInput组件,整合了标签、输入框和错误提示功能,支持文本、数字等输入类型。组件采用ArkUI声明式语法,利用@Prop和@State装饰器管理状态,实现了数据双向绑定。该方案简化了表单开发流程,确保了应用内输入校验的一致性和可靠性。文章还总结了HarmonyOS开发的核心要点,包括ArkUI状态管理、跨组件通信和性能优化技巧,并提供了相关学习资源链接。

weixin_54000324的博客 211

Crush 终端 LLM 工具安装与使用指南:把 AI 编程助手装进你的命令行

喜欢命令行的开发者需要离线/轻量级 AI 助手的场景希望自定义模型与工具链的高级用户通过LSP + MCP + 多模型支持,Crush 不仅能写代码,还能理解项目、调用工具、连接服务,真正成为你的“终端编程搭档”。

weixin_44058951的博客 1616

2017全国大学生电子设计大赛B题 | 板球控制系统(四)机械设计相关

转载请注明出处。   转眼2019了诶,可能有些同学又该问了,哇向阳哥,你这个鸽子放的好,转眼大半年了一年都没更新,我也知道啊,说好的源码呢,挖的机械的坑呢?咕咕咕咕我也不想啊,我这不是懒吗!过年有空了,又到了收红包泡妹子玩游戏.......呸,学习准备比赛码代码的时候了,终于有点空闲,于是乎今晚先把机械的大坑填了。     咱话先说在最前面。机械这玩意,靠经验,也考想象力,更要命的还是出了...

王向阳的博客 3万+

HarmonyOS 6效果实现:TextInput是ArkTS中用于接收单行文本输入的组件,它的placeholder参数用于设置占位提示文字,引导用户输入正确的内容

在鸿蒙操作系统的应用开发生态中,ArkTS作为首选的开发语言,承载着连接声明式UI范式与原生系统能力的重要使命。ArkTS并非一门全新的语言,而是在TypeScript的基础上进行了深度扩展,引入了装饰器(Decorator)、状态管理、自定义组件等一系列声明式开发特性,使得开发者能够以更加直观、高效的方式构建用户界面。与传统的命令式UI开发不同,声明式开发强调"描述UI应该是什么样子",而非"一步步告诉计算机如何构建UI",这种范式的转变极大地提升了开发效率和代码可维护性。鸿蒙应用的核心开发单元是组件(C

2401_86049470的博客 438

INS/伪距组合导航(1)

星间单差GNSS/INS伪距紧组合

u014430081的博客 877

HarmonyOS ArkTS便利贴应用深度解析:ArkTS CRUD 全流程与编辑/新增双模式实战

本文介绍了如何使用ArkTS开发一个完整的备忘录应用,实现CRUD功能。通过定义Note接口规范数据结构,应用包含标题、内容和时间戳字段,支持多行文本输入。核心功能包括:添加/更新笔记(带自动时间戳)、编辑回填表单、删除笔记。代码展示了状态管理、数组操作和表单交互的实现方式,特别对比了interface与class的选择建议,为ArkTS数据驱动开发提供了典型范例。 关键点: 使用interface定义纯数据结构 通过editingIndex状态区分新增/编辑模式 实现表单数据与状态的双向绑定 列表渲染与数

2403_87838053的博客 247

swl安装无法与服务器建立链接,如何解决?

🏆本文收录于《全栈Bug调优(实战版)》专栏,主要记录项目实战过程中所遇到的Bug或因后果及提供真实有效的解决方案,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!! 备注:部分问题/疑难杂症搜集于互联网。

**My Coding Family** 2079

5大步骤!轻松玩转Dorisoy.Rigger:基于.NET Core 6、MAUI和Blazor的多数据库开发框架生成器

各位小伙伴,你们是否厌倦了每次项目启动都要从头配置数据库连接、编写重复的代码?今天,我们就来聊聊如何使用Dorisoy.Rigger这个强大的开发框架生成器,让你的.NET Core 6、MAUI和Blazor项目开发变得简单又高效!准备好迎接开发的新乐趣了吗?让我们一起开始吧!接下来,我们需要定义数据模型。假设我们有一个简单的用户表,包含ID、用户名和密码字段。在项目中创建一个新的类文件,命名为User.csset;set;set;这段代码定义了一个用户模型,其中包含了用户的ID、用户名和密码。

java专栏 1743

HarmonyOS 6 ArkUI - TextArea是多行文本输入组件,适合输入较长的文本内容,有placeholder、text和onChange等属性和事件

在分布式操作系统鸿蒙(HarmonyOS)的生态体系中,ArkTS作为核心的应用开发语言,承载着连接声明式UI范式与原生系统能力的重要使命。ArkTS在TypeScript的基础之上,融合了声明式UI、状态管理、自定义组件等现代化前端开发理念,同时又深度绑定了鸿蒙系统的分布式能力、方舟编译器的运行时优化以及ArkUI框架的渲染管线。对于开发者而言,理解ArkTS不仅仅是掌握一门语言,更是理解一整套声明式UI的构建哲学、状态驱动的渲染机制以及组件化的工程实践。声明式UI是ArkTS最核心的设计理念之一。与传统

2401_86049470的博客 437

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

基于 HarmonyOS ArkTS API 24 Reusable 组件复用装饰器页面跳转组件缓存复用性能优化攻略

鸿蒙操作系统(HarmonyOS)是华为面向全场景智慧生活打造的分布式操作系统,其应用开发框架ArkUI采用ArkTS作为核心开发语言。ArkTS在TypeScript的基础上进行了深度扩展,不仅保留了静态类型系统的编译期安全检查能力,还针对声明式UI开发范式引入了装饰器系统、组件化结构和状态驱动机制。在ArkTS中,interface用于定义数据结构契约,struct配合装饰器用于定义UI组件,function用于封装纯逻辑函数,这三者共同构成了应用的基础代码骨架。ArkTS的强类型约束要求所有变量声明、

wilbur1688的博客 388

假人有限元模型

假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

React Native鸿蒙跨平台医疗健康类的血压记录,HarmonyOS ArkTS API 24,包括收缩压、舒张压、心率、日期、时间、备注和状态

在处理这些问题时,你可能会遇到的最后一个问题是外部服务提供商施加的速率限制。以使用 Google Maps API 为例,在撰写本书时,免费和未经身份验证的请求的官方费率限制为每秒 10 个请求和每天 2,500 个请求。当使用多线程时,很容易耗尽这样的限制。更严重的问题是,因为我们没有覆盖任何故障的场景,而处理多线程 Python 代码中的异常比平常更复杂。当客户端超过 Google 的速率时,api.geocode()函数将抛出异常,这是个好消息。

2301_77888392的博客 944

efm32 入门.pdf

本PDF共计22页,介绍的是操作驱动API,下载与否自己斟酌。

TextArea 多行文本输入实战:用声明式 UI 串起数据、操作和结果

在移动应用里,文本输入是最常见的交互之一。单行输入用 就够了,可一旦遇到"发言稿、商品描述、反馈意见、聊天长消息"这类需要换行、需要多段的内容,就必须交给 。它和 同属输入控件家族,但核心差异在于支持多行与自动换行,并且在高度、滚动、内容裁剪上的行为都围绕"一块可生长的文本区域"来设计。理解 ,不能只停留在"放一个框让用户打字"。它背后牵连着受控与非受控、字符计数、软键盘行为、聚焦状态、表单校验、布局伸缩一整套工程问题。一个评论框看似简单,真要做扎实,得把输入的长度约束、超长提示、失焦校验、回车提交、暗

autumn2005的博客 338

HarmonyOS应用开发实战:萌宠日记 - 从看 HarmonyOS 应用开发最佳实践

本文总结了HarmonyOS应用"萌宠日记"的完整开发历程,系统梳理了100篇技术文章的核心内容。从架构设计、UI组件化、数据管理到性能优化,全面呈现了应用开发的最佳实践。 关键要点包括: 三层导航架构设计(Tabs+Navigation+NavPathStack) 组件化UI设计规范(卡片/标题/标签组件) 数据分层存储方案(Preferences/RDB/文件系统) 性能优化策略(懒加载/缓存/生命周期管理) 可扩展性设计(分类/语言/设备适配) 文章还提供了开发工具链推荐、系列内容回顾以及AI功能等未

b13053810049的博客 235
上一篇: 鸿蒙5.0开发进阶:UI框架-ArkTS组件(Text)
下一篇: 鸿蒙5.0开发进阶:UI框架-ArkTS组件(TextInput)
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值