TextArea

提供多行文本输入组件。

说明：

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

权限列表

无

子组件

无

接口

TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextAreaController})

参数：

参数名	参数类型	必填	默认值	参数描述
placeholder	ResourceStr	否	-	无输入时的提示文本。
text	ResourceStr	否	-	设置输入框当前的文本内容。
controller⁸⁺	TextAreaController	否	-	设置TextArea控制器。

属性

除支持通用属性外，还支持以下属性：

名称	参数类型	默认值	描述
placeholderColor	ResourceColor	-	设置placeholder文本颜色。
placeholderFont	{ size?: number, weight?:number \| FontWeight， family?: string, style?: FontStyle }	-	设置placeholder文本样式： - size: 设置文本尺寸，Length为number类型时，使用fp单位。 - weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。 - family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial, sans-serif'。 - style: 设置文本的字体样式。
textAlign	TextAlign	Start	设置文本水平对齐方式。
caretColor	ResourceColor	-	设置输入框光标颜色。
inputFilter⁸⁺	{ value: ResourceStr⁸⁺, error?: (value: string) => void }	-	通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\d)(?=.[a-z])(?=.*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。 - value：设置正则表达式。 - error：正则匹配失败时，返回被忽略的内容。

事件

名称	功能描述
onChange(callback: (value: string) => void)	输入发生变化时，触发回调。
onCopy⁸⁺(callback:(value: string) => void)	长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发回调。 value：复制的文本内容。
onCut⁸⁺(callback:(value: string) => void)	长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发回调。 value：剪切的文本内容。
onPaste⁸⁺(callback:(value: string) => void)	长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发回调。 value：粘贴的文本内容。

TextAreaController⁸⁺

TextArea组件的控制器，通过它操作TextArea组件。

导入对象

controller: TextAreaController = new TextAreaController()

caretPosition⁸⁺

caretPosition(value: number): void

设置输入光标的位置。

参数：

参数名	参数类型	必填	默认值	参数描述
value	number	是	-	从字符串开始到光标所在位置的字符长度。

示例

多行文本输入

// xxx.ets
@Entry
@Component
struct TextAreaExample1 {
  controller: TextAreaController = new TextAreaController()
  @State text: string = ''
  build() {
    Column() {
      TextArea({ placeholder: 'input your word', controller: this.controller})
        .placeholderColor("rgb(0,0,225)")
        .placeholderFont({ size: 30, weight: 100, family: 'cursive', style: FontStyle.Italic })
        .textAlign(TextAlign.Center)
        .caretColor(Color.Blue)
        .height(50)
        .fontSize(30)
        .fontWeight(FontWeight.Bold)
        .fontFamily("sans-serif")
        .fontStyle(FontStyle.Normal)
        .fontColor(Color.Red)
        .inputFilter('^[\u4E00-\u9FA5A-Za-z0-9_]+$',(value: string) => {
          console.info("hyb"+value)
        })
        .onChange((value: string) => {
          this.text = value
          this.controller.caretPosition(-1)
        })
      Text(this.text).width('90%')
    }
  }
}

zh-cn_image_0000001251087311

设置光标

// xxx.ets
@Entry
@Component
struct TextAreaExample2 {
    controller: TextAreaController = new TextAreaController()
    build() {
        Column() {
            TextArea({ placeholder: 'input your word',controller:this.controller })
            Button('caretPosition')
                .onClick(() => {
                    this.controller.caretPosition(4)
                })
          }
    }
}

zh-cn_image_0000001252653499