Overview
Defines enumerations related to TextInput, which supports multiple input type configurations (including text, numbers, passwords, emails, and phone numbers), style customization of the clear button, auto-filling content type settings, and input box style selection. It is applicable to scenarios requiring user interaction input, such as login and registration, form filling, and search input, helping you quickly implement single-line text input that meets service requirements.
File to include: <arkui/node_attributes/text_input.h>
Library: libace_ndk.z.so
System capability: SystemCapability.ArkUI.ArkUI.Full
Since: 12
Related module: ArkUI_NativeModule
Sample: native_type_sample
[h2]Enums
| Name | typedef Keyword | Description |
|---|---|---|
| ArkUI_TextInputType | ArkUI_TextInputType | Enumerates the input types of single-line text. |
| ArkUI_CancelButtonStyle | ArkUI_CancelButtonStyle | Enumerates the styles of the Cancel button. |
| ArkUI_TextInputContentType | ArkUI_TextInputContentType | Enumerates autofill types. |
| ArkUI_TextInputStyle | ArkUI_TextInputStyle | Enumerates text input styles. |
[h2]ArkUI_TextInputType
enum ArkUI_TextInputType
Description
Enumerates the input types of single-line text.
Since: 12
| Value | Description |
|---|---|
| ARKUI_TEXTINPUT_TYPE_NORMAL = 0 | Normal input type with no special restrictions. |
| ARKUI_TEXTINPUT_TYPE_NUMBER = 2 | Numeric input type. |
| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER = 3 | Phone number input type. It supports input of digits, spaces, +, -, *, #, (, ), with no length limit. |
| ARKUI_TEXTINPUT_TYPE_EMAIL = 5 | Email address input type. It supports digits, letters, underscores, decimal points, !, #, $, %, &, ', *, +, -, /, =, ?, ^, `, {, |, }, ~, and @ (only one @ character allowed). The email address format must follow the basic specification: the part before the @ character is the username, and the part after the @ character is the domain name. |
| ARKUI_TEXTINPUT_TYPE_PASSWORD = 7 | Password input type. By default, the input text is briefly displayed and then changed to dots. Since API version 12, on PCs/2-in-1 devices, the input text is directly displayed as dots. On TV devices, the eye icon is hidden by default at the end of the input box. On other devices, the eye icon is shown by default at the end of the input box. |
| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD = 8 | Numeric password input type. By default, the input text is briefly displayed and then changed to dots. Since API version 12, on PCs/2-in-1 devices, the input text is directly displayed as dots. On TV devices, the eye icon is hidden by default at the end of the input box. On other devices, the eye icon is shown by default at the end of the input box. |
| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD = 9 | Lock screen password input type. It supports input of digits, letters, underscores, spaces, and special characters. The eye icon is shown at the end of the input box and the input text changes to dots by default. Since API version 12, on wearables, the input text is directly displayed as dots. The password input type does not support the underline style. |
| ARKUI_TEXTINPUT_TYPE_USER_NAME = 10 | Username input type with no special restrictions. When Password Vault is enabled, usernames can be auto-saved and auto-filled. |
| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD = 11 | New password input type. By default, the input text is briefly displayed and then changed to dots. Since API version 12, on PCs/2-in-1 devices, the input text is directly displayed as dots. On TV devices, the eye icon is hidden by default at the end of the input box. On other devices, the eye icon is shown by default at the end of the input box. |
| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL = 12 | Number input type with a decimal point. It supports digits and a decimal point (only one decimal point allowed), and does not support negative numbers (including negative integers and negative decimals). |
| ARKUI_TEXTINPUT_TYPE_ONE_TIME_CODE = 14 | Verification code input type with no special restrictions. In this type, the system input method is shown by default when the component gains focus. Since: 20 |
[h2]ArkUI_CancelButtonStyle
enum ArkUI_CancelButtonStyle
Description
Enumerates the styles of the Cancel button.
Since: 12
| Value | Description |
|---|---|
| ARKUI_CANCELBUTTON_STYLE_CONSTANT = 0 | The Cancel button is always displayed. It is suitable for scenarios where the Cancel button needs to be always displayed, such as search boxes and other input boxes that require frequent content clearing. |
| ARKUI_CANCELBUTTON_STYLE_INVISIBLE = 1 | The Cancel button is always hidden. It is suitable for scenarios where the Cancel button is not needed. |
| ARKUI_CANCELBUTTON_STYLE_INPUT = 2 | The Cancel button is displayed when there is text input and hidden when there is no text input. It is suitable for scenarios where the Cancel button is displayed on demand. This is the recommended default behavior. |
[h2]ArkUI_TextInputContentType
enum ArkUI_TextInputContentType
Description
Enumerates autofill types.
Autofilling is a feature where the system automatically fills in input box content based on saved information in scenarios such as user login, registration, and form filling. It can only be used after Password Vault or contextual autofilling is enabled in system settings.
Since: 12
| Value | Description |
|---|---|
| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME = 0 | Username. Password Vault, when enabled, can automatically save and fill in usernames. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD = 1 | Password. Password Vault, when enabled, can automatically save and fill in passwords. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD = 2 | New password. Password Vault, when enabled, can automatically generate a new password. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_STREET_ADDRESS = 3 | Full street address. The scenario-based autofill feature, when enabled, can automatically save and fill in full street addresses. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER = 4 | House number. The scenario-based autofill feature, when enabled, can automatically save and fill in house numbers. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_DISTRICT_ADDRESS = 5 | District and county. The scenario-based autofill feature, when enabled, can automatically save and fill in districts and counties. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS = 6 | City. The scenario-based autofill feature, when enabled, can automatically save and fill in cities. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS = 7 | Province. The scenario-based autofill feature, when enabled, can automatically save and fill in provinces. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS = 8 | Country. The scenario-based autofill feature, when enabled, can automatically save and fill in countries. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME = 9 | Full name. The scenario-based autofill feature, when enabled, can automatically save and fill in full names. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME = 10 | Last name. The scenario-based autofill feature, when enabled, can automatically save and fill in last names. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME = 11 | First name. The scenario-based autofill feature, when enabled, can automatically save and fill in first names. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER = 12 | Phone number. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE = 13 | Country code. The scenario-based autofill feature, when enabled, can automatically save and fill in country codes. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_PHONE_NUMBER = 14 | Phone number with country code. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers with country codes. |
| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS = 15 | Email address. The scenario-based autofill feature, when enabled, can automatically save and fill in email addresses. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_BANK_CARD_NUMBER = 16 | Bank card number. The scenario-based autofill feature, when enabled, can automatically save and fill in bank card numbers. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_ID_CARD_NUMBER = 17 | ID card number. The scenario-based autofill feature, when enabled, can automatically save and fill in ID card numbers. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME = 18 | Nickname. The scenario-based autofill feature, when enabled, can automatically save and fill in nicknames. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_DETAIL_INFO_WITHOUT_STREET = 19 | Address information without street address. The scenario-based autofill feature, when enabled, can automatically save and fill in address information without street addresses. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS = 20 | Standard address. The scenario-based autofill feature, when enabled, can automatically save and fill in standard addresses. |
| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSPORT_NUMBER = 21 | Passport number. The scenario-based autofill feature, when enabled, can automatically save and fill in passport numbers. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_VALIDITY = 22 | Passport validity period. The scenario-based autofill feature, when enabled, can automatically save and fill in passport validity periods. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_ISSUE_AT = 23 | Passport place of issue. The scenario-based autofill feature, when enabled, can automatically save and fill in the place of issue for passports. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_ORGANIZATION = 24 | Invoice title. The scenario-based autofill feature, when enabled, can automatically save and fill in invoice titles. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_TAX_ID = 25 | Tax ID. The scenario-based autofill feature, when enabled, can automatically save and fill in tax IDs. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_ADDRESS_CITY_AND_STATE = 26 | Location. The scenario-based autofill feature, when enabled, can automatically save and fill in locations. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_FLIGHT_NUMBER = 27 | Flight number. Currently not supported for automatic saving and auto-filling. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_NUMBER = 28 | Driver's license number. Currently not supported for automatic saving and auto-filling. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_FILE_NUMBER = 29 | Driver's license file number. Currently not supported for automatic saving and auto-filling. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_PLATE = 30 | License plate number. The scenario-based autofill feature, when enabled, can automatically save and fill in license plate numbers. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_ENGINE_NUMBER = 31 | Vehicle registration engine number. Currently not supported for automatic saving and auto-filling. Since: 18 |
| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_CHASSIS_NUMBER = 32 | Chassis number. Auto-save and auto-fill are not yet supported. Since: 18 |
[h2]ArkUI_TextInputStyle
enum ArkUI_TextInputStyle
Description
Enumerates text input styles.
Since: 12
| Value | Description |
|---|---|
| ARKUI_TEXTINPUT_STYLE_DEFAULT = 0 | Default style. The caret width is 1.5 vp, and the selection background height is related to the font size. This style is suitable for most input box scenarios. |
| ARKUI_TEXTINPUT_STYLE_INLINE = 1 | Inline style. The text selection background height is the same as the input box height. This style is suitable for scenarios where the input box height is fixed and the text selection background height needs to be consistent with the input box height, such as input boxes in compact layouts or inline editing. |