TextArea

多行文本輸入框組件，當輸入的文本內容超過組件寬度時會自動換行顯示。

高度未設置時，組件無默認高度，自適應內容高度。寬度未設置時，默認撐滿最大寬度。

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
該組件從API Version 7開始支持。后續版本如有新增內容，則采用上角標單獨標記該內容的起始版本。

子組件

無

接口

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

參數：

屬性

除支持[通用屬性]和[文本通用屬性]的fontColor、fontSize、fontStyle、fontWeight、fontFamily外，還支持以下屬性：

說明：

[通用屬性padding]的默認值為：
{
top: 8 vp,
right: 16 vp,
bottom: 8 vp,
left: 16 vp
}
從API version 11開始，多行輸入框可設置.width('auto')使組件寬度自適應文本寬度，自適應時組件寬度受constraintSize屬性以及父容器傳遞的最大最小寬度限制，其余使用方式參考[尺寸設置]。

事件

除支持[通用事件]外，還支持以下事件：

TextAreaController8+

TextArea組件的控制器，目前可通過它設置TextArea組件的光標位置。

導入對象

controller: TextAreaController = new TextAreaController()

caretPosition8+

caretPosition(value: number): void

設置輸入光標的位置。

參數：

setTextSelection10+

setTextSelection(selectionStart: number, selectionEnd: number): void

組件在獲焦狀態下，調用該接口設置文本選擇區域并高亮顯示，且只有在selectionStart小于selectionEnd時，文字才會被選取、高亮顯示。

參數：

stopEditing10+

stopEditing(): void

退出編輯態。

getTextContentRect10+

getTextContentRect(): [RectResult]

獲取已編輯文本內容區域相對組件的位置和大小，返回值單位為像素。

返回值：

說明：

• 初始不輸入文本時，返回值中有相對組件的位置信息，大小為0。
• 返回值中的位置信息是第一個字符相對于可編輯組件的位置。
• 有輸入時返回信息中的寬度是組件編輯的固定寬度。

RectResult10+

位置和大小。

getTextContentLineCount10+

getTextContentLineCount(): number

獲取已編輯文本內容的行數。

返回值：

示例

示例1

// 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')
        .onChange((value: string) = > {
          this.text = value
        })
      Text(this.text)
      Button('Set caretPosition 1')
        .backgroundColor('#007DFF')
        .margin(15)
        .onClick(() = > {
          // 設置光標位置到第一個字符后
          this.controller.caretPosition(1)
        })
    }.width('100%').height('100%').backgroundColor('#F1F3F5')
  }
}

示例2

// xxx.ets
@Entry
@Component
struct TextAreaExample {
  @State text: string = 'test'
  @State counterVisible: boolean = false
  @State maxNumber: number = -1
  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')
        .maxLength(4)
        .showCounter(true)
        .backgroundColor('#FFFFFF')
        .onChange((value: string) = > {
          this.text = value
        })
    }.width('100%').height('100%').backgroundColor('#F1F3F5')
  }
}

示例3

// 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)
    }
  }
}

審核編輯 黃宇