TextInput
單行文本輸入框組件。
說(shuō)明:
開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
該組件從API Version 7開始支持。后續(xù)版本如有新增內(nèi)容,則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。
子組件
無(wú)
接口
TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController})
參數(shù)名 | 參數(shù)類型 | 必填 | 參數(shù)描述 |
---|---|---|---|
placeholder | [ResourceStr] | 否 | 設(shè)置無(wú)輸入時(shí)的提示文本。 |
text | [ResourceStr] | 否 | 設(shè)置輸入框當(dāng)前的文本內(nèi)容。當(dāng)組件設(shè)置[stateStyles]等刷新屬性時(shí),建議通過onChange事件將狀態(tài)變量與文本實(shí)時(shí)綁定,避免組件刷新時(shí)TextInput中的文本內(nèi)容異常。 從API version 10開始,該參數(shù)支持[$$]雙向綁定變量。 |
controller8+ | [TextInputController] | 否 | 設(shè)置TextInput控制器。 |
屬性
除支持[通用屬性]和[文本通用屬性]的fontColor、fontSize、fontStyle、fontWeight、fontFamily外,還支持以下屬性:
名稱 | 參數(shù)類型 | 描述 |
---|---|---|
type | [InputType] | 設(shè)置輸入框類型。 默認(rèn)值:InputType.Normal |
placeholderColor | [ResourceColor] | 設(shè)置placeholder文本顏色。 默認(rèn)值跟隨主題。 |
placeholderFont | [Font] | 設(shè)置placeholder文本樣式。 |
enterKeyType | [EnterKeyType] | 設(shè)置輸入法回車鍵類型,目前僅支持默認(rèn)類型顯示。 默認(rèn)值:EnterKeyType.Done |
caretColor | [ResourceColor] | 設(shè)置輸入框光標(biāo)顏色。 默認(rèn)值:'#007DFF'。 |
maxLength | number | 設(shè)置文本的最大輸入字符數(shù)。 |
inputFilter8+ | { value: [ResourceStr], error?: (value: string) => void } | 正則表達(dá)式,匹配表達(dá)式的輸入允許顯示,不匹配的輸入將被過濾。目前僅支持單個(gè)字符匹配,不支持字符串匹配。 - value:設(shè)置正則表達(dá)式。 - error:正則匹配失敗時(shí),返回被過濾的內(nèi)容。 |
copyOption9+ | [CopyOptions] | 設(shè)置輸入的文本是否可復(fù)制。 默認(rèn)值:CopyOptions.LocalDevice,支持設(shè)備內(nèi)復(fù)制。 設(shè)置CopyOptions.None時(shí),當(dāng)前TextInput中的文字無(wú)法被復(fù)制或剪切,僅支持粘貼。 |
showPasswordIcon9+ | boolean | 密碼輸入模式時(shí),輸入框末尾的圖標(biāo)是否顯示。 默認(rèn)值:true |
style9+ | [TextInputStyle] | [TextContentStyle] |
textAlign9+ | [TextAlign] | 設(shè)置文本在輸入框中的水平對(duì)齊方式。 默認(rèn)值:TextAlign.Start**說(shuō)明:**僅支持TextAlign.Start、TextAlign.Center和TextAlign.End。 可通過[align]屬性控制文本段落在垂直方向上的位置,此組件中不可通過align屬性控制文本段落在水平方向上的位置,即align屬性中Alignment.TopStart、Alignment.Top、Alignment.TopEnd效果相同,控制內(nèi)容在頂部,Alignment.Start、Alignment.Center、Alignment.End效果相同,控制內(nèi)容垂直居中,Alignment.BottomStart、Alignment.Bottom、Alignment.BottomEnd效果相同,控制內(nèi)容在底部。 |
selectedBackgroundColor10+ | [ResourceColor] | 設(shè)置文本選中底板顏色。 如果未設(shè)置透明度,默認(rèn)為不透明(例如:“0x80000000”為50%透明度黑色)。 |
caretStyle10+ | { width: [Length]} | 設(shè)置光標(biāo)風(fēng)格,不支持百分比設(shè)置。 |
caretPosition10+ | number | 設(shè)置光標(biāo)位置。 |
showUnit10+ | [CustomBuilder] | 設(shè)置控件作為文本框單位。 默認(rèn)無(wú)單位。 |
showError10+ | string | undefined |
showUnderline10+ | boolean | 設(shè)置是否開啟下劃線。下劃線默認(rèn)顏色為'#33182431',默認(rèn)粗細(xì)為1px,文本框尺寸48vp(下劃線只支持InputType.Normal類型)。 默認(rèn)值:false |
passwordIcon10+ | [PasswordIcon] | 密碼輸入模式時(shí),設(shè)置輸入框末尾的圖標(biāo)。 默認(rèn)為系統(tǒng)提供的密碼圖標(biāo)。 |
enableKeyboardOnFocus10+ | boolean | TextInput獲焦時(shí),是否綁定輸入法 默認(rèn)值:true。從API version 10開始,獲焦默認(rèn)綁定輸入法。 |
selectionMenuHidden10+ | boolean | 設(shè)置長(zhǎng)按輸入框或者右鍵輸入框時(shí),是否彈出文本選擇菜單。 默認(rèn)值:false |
maxLines10+ | number | 設(shè)置內(nèi)聯(lián)輸入風(fēng)格編輯態(tài)時(shí)文本可顯示的最大行數(shù)。 默認(rèn)值:3**說(shuō)明:**取值范圍:(0, +∞)。 |
customKeyboard10+ | [CustomBuilder] | 設(shè)置自定義鍵盤。**說(shuō)明:**當(dāng)設(shè)置自定義鍵盤時(shí),輸入框激活后不會(huì)打開系統(tǒng)輸入法,而是加載指定的自定義組件,針對(duì)系統(tǒng)鍵盤的enterKeyType屬性設(shè)置將無(wú)效。 自定義鍵盤的高度可以通過自定義組件根節(jié)點(diǎn)的height屬性設(shè)置,寬度不可設(shè)置,使用系統(tǒng)默認(rèn)值。 自定義鍵盤采用覆蓋原始界面的方式呈現(xiàn),不會(huì)對(duì)應(yīng)用原始界面產(chǎn)生壓縮或者上提。 自定義鍵盤無(wú)法獲取焦點(diǎn),但是會(huì)攔截手勢(shì)事件。 默認(rèn)在輸入控件失去焦點(diǎn)時(shí),關(guān)閉自定義鍵盤,開發(fā)者也可以通過[TextInputController].[stopEditing]方法控制鍵盤關(guān)閉。 |
說(shuō)明:
[通用屬性padding]的默認(rèn)值為:
{
top: 8 vp,
right: 16 vp,
bottom: 8 vp,
left: 16 vp
}
從API version 10開始,單行輸入框可設(shè)置.width('auto')使組件寬度自適應(yīng)文本寬度,自適應(yīng)時(shí)組件寬度受constraintSize屬性以及父容器傳遞的最大最小寬度限制,其余使用方式參考[尺寸設(shè)置]。
EnterKeyType枚舉說(shuō)明
名稱 | 描述 |
---|---|
Go | 顯示為前往樣式。 |
Search | 顯示為搜索樣式。 |
Send | 顯示為發(fā)送樣式。 |
Next | 顯示為下一個(gè)樣式。 |
Done | 顯示為確認(rèn)樣式。 |
InputType枚舉說(shuō)明
名稱 | 描述 |
---|---|
Normal | 基本輸入模式。 支持輸入數(shù)字、字母、下劃線、空格、特殊字符。 |
Password | 密碼輸入模式。支持輸入數(shù)字、字母、下劃線、空格、特殊字符。密碼顯示小眼睛圖標(biāo)并且默認(rèn)會(huì)將文字變成圓點(diǎn)。密碼輸入模式不支持下劃線樣式。 |
郵箱地址輸入模式。支持?jǐn)?shù)字,字母,下劃線,以及@字符(只能存在一個(gè)@字符)。 | |
Number | 純數(shù)字輸入模式。 |
PhoneNumber9+ | 電話號(hào)碼輸入模式。 支持輸入數(shù)字、+ 、-、*、#,長(zhǎng)度不限。 |
TextInputStyle9+枚舉說(shuō)明
名稱 | 描述 |
---|---|
Default | 默認(rèn)風(fēng)格,光標(biāo)寬1.5vp,光標(biāo)高度與文本選中底板高度和字體大小相關(guān)。 |
Inline | 內(nèi)聯(lián)輸入風(fēng)格。文本選中底板高度與輸入框高度相同。 內(nèi)聯(lián)輸入是在有明顯的編輯態(tài)/非編輯態(tài)的區(qū)分場(chǎng)景下使用,例如:文件列表視圖中的重命名。 不支持showError屬性。 |
PasswordIcon10+對(duì)象說(shuō)明
名稱 | 類型 | 必填 | 描述 |
---|---|---|---|
onIconSrc | string | [Resource] | 否 |
offIconSrc | string | [Resource] | 否 |
事件
除支持[通用事件]外,還支持以下事件:
名稱 | 功能描述 |
---|---|
onChange(callback: (value: string) => void) | 輸入內(nèi)容發(fā)生變化時(shí),觸發(fā)該回調(diào)。 value:輸入的文本內(nèi)容。 觸發(fā)該事件的條件: 1、鍵盤輸入。 2、粘貼、剪切。 3、鍵盤快捷鍵Ctrl+v。 |
onSubmit(callback: (enterKey: EnterKeyType) => void) | 按下輸入法回車鍵觸發(fā)該回調(diào),返回值為當(dāng)前輸入法回車鍵的類型。 enterKeyType:輸入法回車鍵類型。具體類型見[EnterKeyType枚舉說(shuō)明]。 |
onEditChange(callback: (isEditing: boolean) => void)8+ | 輸入狀態(tài)變化時(shí),觸發(fā)該回調(diào)。有光標(biāo)時(shí)為編輯態(tài),無(wú)光標(biāo)時(shí)為非編輯態(tài)。isEditing為true表示正在輸入。 |
onCopy(callback:(value: string) => void)8+ | 長(zhǎng)按輸入框內(nèi)部區(qū)域彈出剪貼板后,點(diǎn)擊剪切板復(fù)制按鈕,觸發(fā)該回調(diào)。 value:復(fù)制的文本內(nèi)容。 |
onCut(callback:(value: string) => void)8+ | 長(zhǎng)按輸入框內(nèi)部區(qū)域彈出剪貼板后,點(diǎn)擊剪切板剪切按鈕,觸發(fā)該回調(diào)。 value:剪切的文本內(nèi)容。 |
onPaste(callback:(value: string) => void)8+ | 長(zhǎng)按輸入框內(nèi)部區(qū)域彈出剪貼板后,點(diǎn)擊剪切板粘貼按鈕,觸發(fā)該回調(diào)。 value:粘貼的文本內(nèi)容。 |
onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)10+ | 文本選擇的位置發(fā)生變化時(shí),觸發(fā)該回調(diào)。 selectionStart:文本選擇區(qū)域起始位置,文本框中文字的起始位置為0。 selectionEnd:文本選擇區(qū)域結(jié)束位置。 |
onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)10+ | 文本內(nèi)容滾動(dòng)時(shí),觸發(fā)該回調(diào)。 totalOffsetX:文本在內(nèi)容區(qū)的橫坐標(biāo)偏移。 totalOffsetY:文本在內(nèi)容區(qū)的縱坐標(biāo)偏移。 |
TextInputController8+
TextInput組件的控制器。
導(dǎo)入對(duì)象
controller: TextInputController = new TextInputController()
caretPosition8+
caretPosition(value: number): void
設(shè)置輸入光標(biāo)的位置。
參數(shù):
參數(shù)名 | 參數(shù)類型 | 必填 | 參數(shù)描述 |
---|---|---|---|
value | number | 是 | 從字符串開始到光標(biāo)所在位置的字符長(zhǎng)度。 |
setTextSelection10+
setTextSelection(selectionStart: number, selectionEnd: number): void
設(shè)置文本選擇區(qū)域并高亮顯示。
參數(shù):
參數(shù)名 | 參數(shù)類型 | 必填 | 參數(shù)描述 |
---|---|---|---|
selectionStart | number | 是 | 文本選擇區(qū)域起始位置,文本框中文字的起始位置為0。 |
selectionEnd | number | 是 | 文本選擇區(qū)域結(jié)束位置。 |
stopEditing10+
stopEditing(): void
退出編輯態(tài)。
getTextContentRect10+
getTextContentRect(): [RectResult]
獲取已編輯文本內(nèi)容區(qū)域相對(duì)組件的位置和大小,返回值單位為像素。
返回值:
類型 | 說(shuō)明 |
---|---|
[RectResult] | 已編輯文本內(nèi)容的相對(duì)組件的位置和大小。 |
說(shuō)明:
- 初始不輸入文本時(shí),返回值中有相對(duì)組件的位置信息,大小為0。
- 返回值中的位置信息是第一個(gè)字符相對(duì)于可編輯組件的位置。
RectResult10+
位置和大小。
參數(shù) | 類型 | 描述 |
---|---|---|
x | number | 水平方向橫坐標(biāo)。 |
y | number | 豎直方向縱坐標(biāo)。 |
width | number | 內(nèi)容寬度大小。 |
height | number | 內(nèi)容高度大小。 |
getTextContentLineCount10+
getTextContentLineCount(): number
獲取已編輯文本內(nèi)容的行數(shù)。
返回值:
類型 | 說(shuō)明 |
---|---|
number | 已編輯文本內(nèi)容行數(shù)。HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿 |
示例
示例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(() = > {
// 將光標(biāo)移動(dòng)至第一個(gè)字符后
this.controller.caretPosition(1)
})
// 密碼輸入框
TextInput({ placeholder: 'input your password...' })
.width(400)
.height(40)
.margin(20)
.type(InputType.Password)
.maxLength(9)
.showPasswordIcon(true)
// 內(nèi)聯(lián)風(fēng)格輸入框
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 }) {
// 自定義密碼顯示圖標(biāo)
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: '請(qǐng)輸入用戶名', text: this.Text })
.showUnderline(true)
.width(380)
.showError(this.TextError)
.onChange((value: string) = > {
this.Text = value
})
.onSubmit(() = > { // 用戶名不正確會(huì)清空輸入框和用戶名并提示錯(cuò)誤文本
if (this.Text == this.NameText) {
this.TextError = ''
} else {
this.TextError = '用戶名輸入錯(cuò)誤'
this.Text = ''
}
})
}.width('100%')
}
}
示例3
// xxx.ets
@Entry
@Component
struct TextInputExample {
controller: TextInputController = new TextInputController()
@State inputValue: string = ""
// 自定義鍵盤組件
@Builder CustomKeyboardBuilder() {
Column() {
Button('x').onClick(() = > {
// 關(guān)閉自定義鍵盤
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 })
}
}
}
審核編輯 黃宇
-
組件
+關(guān)注
關(guān)注
1文章
503瀏覽量
17784 -
鴻蒙
+關(guān)注
關(guān)注
57文章
2302瀏覽量
42689
發(fā)布評(píng)論請(qǐng)先 登錄
相關(guān)推薦
評(píng)論