TextInput

單行文本輸入框組件。

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

子組件

無

接口

TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController})

參數：

屬性

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

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

EnterKeyType枚舉說明

InputType枚舉說明

TextInputStyle9+枚舉說明

PasswordIcon10+對象說明

事件

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

TextInputController8+

TextInput組件的控制器。

導入對象

controller: TextInputController = new TextInputController()

caretPosition8+

caretPosition(value: number): void

設置輸入光標的位置。

參數：

setTextSelection10+

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

設置文本選擇區域并高亮顯示。

參數：

stopEditing10+

stopEditing(): void

退出編輯態。

getTextContentRect10+

getTextContentRect(): [RectResult]

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

返回值：

說明：

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

RectResult10+

位置和大小。

getTextContentLineCount10+

getTextContentLineCount(): number

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

返回值：

示例

示例1

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

  build() {
    Column() {
      TextInput({ text: this.text, placeholder: 'input your word...', controller: this.controller })
        .placeholderColor(Color.Grey)
        .placeholderFont({ size: 14, weight: 400 })
        .caretColor(Color.Blue)
        .width(400)
        .height(40)
        .margin(20)
        .fontSize(14)
        .fontColor(Color.Black)
        .inputFilter('[a-z]', (e) = > {
          console.log(JSON.stringify(e))
        })
        .onChange((value: string) = > {
          this.text = value
        })
      Text(this.text)
      Button('Set caretPosition 1')
        .margin(15)
        .onClick(() = > {
          // 將光標移動至第一個字符后
          this.controller.caretPosition(1)
        })
      // 密碼輸入框
      TextInput({ placeholder: 'input your password...' })
        .width(400)
        .height(40)
        .margin(20)
        .type(InputType.Password)
        .maxLength(9)
        .showPasswordIcon(true)
      // 內聯風格輸入框
      TextInput({ text: 'inline style' })
        .width(400)
        .height(50)
        .margin(20)
        .borderRadius(0)
        .style(TextInputStyle.Inline)
    }.width('100%')
  }
}

示例2

@Entry
@Component
struct TextInputExample {
  @State PassWordSrc1: Resource = $r('app.media.onIcon')
  @State PassWordSrc2: Resource = $r('app.media.offIcon')
  @State TextError: string = ''
  @State Text: string = ''
  @State NameText: string = 'test'

  @Builder itemEnd() {
    Select([{ value: 'KB' },
      { value: 'MB' },
      { value: 'GB' },
      { value: 'TB', }])
      .height("48vp")
      .borderRadius(0)
      .selected(2)
      .align(Alignment.Center)
      .value('MB')
      .font({ size: 20, weight: 500 })
      .fontColor('#182431')
      .selectedOptionFont({ size: 20, weight: 400 })
      .optionFont({ size: 20, weight: 400 })
      .backgroundColor(Color.Transparent)
      .responseRegion({ height: "40vp", width: "80%", x: '10%', y: '6vp' })
      .onSelect((index: number) = > {
        console.info('Select:' + index)
      })
  }

  build() {
    Column({ space: 20 }) {
      // 自定義密碼顯示圖標
      TextInput({ placeholder: 'user define password icon' })
        .type(InputType.Password)
        .width(380)
        .height(60)
        .passwordIcon({ onIconSrc: this.PassWordSrc1, offIconSrc: this.PassWordSrc2 })
      // 下劃線模式
      TextInput({ placeholder: 'underline style' })
        .showUnderline(true)
        .width(380)
        .height(60)
        .showError('Error')
        .showUnit(this.itemEnd.bind(this))

      Text(`用戶名：${this.Text}`)
        .width('95%')
      TextInput({ placeholder: '請輸入用戶名', text: this.Text })
        .showUnderline(true)
        .width(380)
        .showError(this.TextError)
        .onChange((value: string) = > {
          this.Text = value
        })
        .onSubmit(() = > { // 用戶名不正確會清空輸入框和用戶名并提示錯誤文本
          if (this.Text == this.NameText) {
            this.TextError = ''
          } else {
            this.TextError = '用戶名輸入錯誤'
            this.Text = ''
          }
        })

    }.width('100%')
  }
}

示例3

// xxx.ets
@Entry
@Component
struct TextInputExample {
  controller: TextInputController = new TextInputController()
  @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() {
      TextInput({ controller: this.controller, text: this.inputValue })
        // 綁定自定義鍵盤
        .customKeyboard(this.CustomKeyboardBuilder()).margin(10).border({ width: 1 })
    }
  }
}

審核編輯 黃宇