1/* 2 * Copyright (c) 2021-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkUI 19 */ 20 21/** 22 * Declare the type of input box 23 * 24 * @enum { number } 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 7 27 */ 28/** 29 * Declare the type of input box 30 * 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 */ 36/** 37 * Declare the type of input box 38 * 39 * @enum { number } 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @atomicservice 43 * @since 11 44 */ 45declare enum InputType { 46 /** 47 * Basic input mode. 48 * 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @since 7 51 */ 52 /** 53 * Basic input mode. 54 * 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @crossplatform 57 * @since 10 58 */ 59 /** 60 * Basic input mode. 61 * 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @crossplatform 64 * @atomicservice 65 * @since 11 66 */ 67 Normal, 68 69 /** 70 * Pure digital input mode. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @since 7 74 */ 75 /** 76 * Pure digital input mode. 77 * 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @crossplatform 80 * @since 10 81 */ 82 /** 83 * Pure digital input mode. 84 * 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @atomicservice 88 * @since 11 89 */ 90 Number, 91 92 /** 93 * Phone number entry mode. 94 * 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @since 9 97 */ 98 /** 99 * Phone number entry mode. 100 * 101 * @syscap SystemCapability.ArkUI.ArkUI.Full 102 * @crossplatform 103 * @since 10 104 */ 105 /** 106 * Phone number entry mode. 107 * 108 * @syscap SystemCapability.ArkUI.ArkUI.Full 109 * @crossplatform 110 * @atomicservice 111 * @since 11 112 */ 113 PhoneNumber, 114 115 /** 116 * E-mail address input mode. 117 * 118 * @syscap SystemCapability.ArkUI.ArkUI.Full 119 * @since 7 120 */ 121 /** 122 * E-mail address input mode. 123 * 124 * @syscap SystemCapability.ArkUI.ArkUI.Full 125 * @crossplatform 126 * @since 10 127 */ 128 /** 129 * E-mail address input mode. 130 * 131 * @syscap SystemCapability.ArkUI.ArkUI.Full 132 * @crossplatform 133 * @atomicservice 134 * @since 11 135 */ 136 Email, 137 138 /** 139 * Password entry mode. 140 * 141 * @syscap SystemCapability.ArkUI.ArkUI.Full 142 * @since 7 143 */ 144 /** 145 * Password entry mode. 146 * 147 * @syscap SystemCapability.ArkUI.ArkUI.Full 148 * @crossplatform 149 * @since 10 150 */ 151 /** 152 * Password entry mode. 153 * 154 * @syscap SystemCapability.ArkUI.ArkUI.Full 155 * @crossplatform 156 * @atomicservice 157 * @since 11 158 */ 159 Password, 160 161 /** 162 * Number Password entry mode. 163 * 164 * @syscap SystemCapability.ArkUI.ArkUI.Full 165 * @crossplatform 166 * @since 11 167 */ 168 /** 169 * Number Password entry mode. 170 * 171 * @syscap SystemCapability.ArkUI.ArkUI.Full 172 * @crossplatform 173 * @atomicservice 174 * @since 12 175 */ 176 NUMBER_PASSWORD = 8, 177 178 /** 179 * Screen Lock Password entry mode. 180 * 181 * @syscap SystemCapability.ArkUI.ArkUI.Full 182 * @systemapi 183 * @since 11 184 */ 185 SCREEN_LOCK_PASSWORD = 9, 186 187 /** 188 * UserName entry mode. 189 * 190 * @syscap SystemCapability.ArkUI.ArkUI.Full 191 * @since 11 192 */ 193 /** 194 * UserName entry mode. 195 * 196 * @syscap SystemCapability.ArkUI.ArkUI.Full 197 * @atomicservice 198 * @since 12 199 */ 200 USER_NAME = 10, 201 202 /** 203 * NewPassword entry mode. 204 * 205 * @syscap SystemCapability.ArkUI.ArkUI.Full 206 * @since 11 207 */ 208 /** 209 * NewPassword entry mode. 210 * 211 * @syscap SystemCapability.ArkUI.ArkUI.Full 212 * @atomicservice 213 * @since 12 214 */ 215 NEW_PASSWORD = 11, 216 217 /** 218 * Number decimal entry mode. 219 * 220 * @syscap SystemCapability.ArkUI.ArkUI.Full 221 * @crossplatform 222 * @atomicservice 223 * @since 11 224 */ 225 NUMBER_DECIMAL = 12, 226 227 /** 228 * URL entry mode. 229 * 230 * @syscap SystemCapability.ArkUI.ArkUI.Full 231 * @crossplatform 232 * @atomicservice 233 * @since 12 234 */ 235 URL = 13, 236} 237 238/** 239 * Declare the type of input content 240 * 241 * @enum { number } 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @atomicservice 244 * @since 12 245 */ 246declare enum ContentType { 247 /** 248 * User name content type. 249 * 250 * @syscap SystemCapability.ArkUI.ArkUI.Full 251 * @atomicservice 252 * @since 12 253 */ 254 USER_NAME = 0, 255 256 /** 257 * Password content type. 258 * 259 * @syscap SystemCapability.ArkUI.ArkUI.Full 260 * @atomicservice 261 * @since 12 262 */ 263 PASSWORD = 1, 264 265 /** 266 * New password content type. 267 * 268 * @syscap SystemCapability.ArkUI.ArkUI.Full 269 * @atomicservice 270 * @since 12 271 */ 272 NEW_PASSWORD = 2, 273 274 /** 275 * Full street address content type. 276 * 277 * @syscap SystemCapability.ArkUI.ArkUI.Full 278 * @atomicservice 279 * @since 12 280 */ 281 FULL_STREET_ADDRESS = 3, 282 283 /** 284 * House number content type. 285 * 286 * @syscap SystemCapability.ArkUI.ArkUI.Full 287 * @atomicservice 288 * @since 12 289 */ 290 HOUSE_NUMBER = 4, 291 292 /** 293 * District address content type. 294 * 295 * @syscap SystemCapability.ArkUI.ArkUI.Full 296 * @atomicservice 297 * @since 12 298 */ 299 DISTRICT_ADDRESS = 5, 300 301 /** 302 * City address content type. 303 * 304 * @syscap SystemCapability.ArkUI.ArkUI.Full 305 * @atomicservice 306 * @since 12 307 */ 308 CITY_ADDRESS = 6, 309 310 /** 311 * Province address content type. 312 * 313 * @syscap SystemCapability.ArkUI.ArkUI.Full 314 * @atomicservice 315 * @since 12 316 */ 317 PROVINCE_ADDRESS = 7, 318 319 /** 320 * Country address content type. 321 * 322 * @syscap SystemCapability.ArkUI.ArkUI.Full 323 * @atomicservice 324 * @since 12 325 */ 326 COUNTRY_ADDRESS = 8, 327 328 /** 329 * Person full name content type. 330 * 331 * @syscap SystemCapability.ArkUI.ArkUI.Full 332 * @atomicservice 333 * @since 12 334 */ 335 PERSON_FULL_NAME = 9, 336 337 /** 338 * Person last name content type. 339 * 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @atomicservice 342 * @since 12 343 */ 344 PERSON_LAST_NAME = 10, 345 346 /** 347 * Person first name content type. 348 * 349 * @syscap SystemCapability.ArkUI.ArkUI.Full 350 * @atomicservice 351 * @since 12 352 */ 353 PERSON_FIRST_NAME = 11, 354 355 /** 356 * Phone number content type. 357 * 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @atomicservice 360 * @since 12 361 */ 362 PHONE_NUMBER = 12, 363 364 /** 365 * Phone country code content type. 366 * 367 * @syscap SystemCapability.ArkUI.ArkUI.Full 368 * @atomicservice 369 * @since 12 370 */ 371 PHONE_COUNTRY_CODE = 13, 372 373 /** 374 * Full phone number content type. 375 * 376 * @syscap SystemCapability.ArkUI.ArkUI.Full 377 * @atomicservice 378 * @since 12 379 */ 380 FULL_PHONE_NUMBER = 14, 381 382 /** 383 * Email address content type. 384 * 385 * @syscap SystemCapability.ArkUI.ArkUI.Full 386 * @atomicservice 387 * @since 12 388 */ 389 EMAIL_ADDRESS = 15, 390 391 /** 392 * Bank card number content type. 393 * 394 * @syscap SystemCapability.ArkUI.ArkUI.Full 395 * @atomicservice 396 * @since 12 397 */ 398 BANK_CARD_NUMBER = 16, 399 400 /** 401 * ID card number content type. 402 * 403 * @syscap SystemCapability.ArkUI.ArkUI.Full 404 * @atomicservice 405 * @since 12 406 */ 407 ID_CARD_NUMBER = 17, 408 409 /** 410 * Nickname content type. 411 * 412 * @syscap SystemCapability.ArkUI.ArkUI.Full 413 * @atomicservice 414 * @since 12 415 */ 416 NICKNAME = 23, 417 418 /** 419 * Detail info without street content type. 420 * 421 * @syscap SystemCapability.ArkUI.ArkUI.Full 422 * @atomicservice 423 * @since 12 424 */ 425 DETAIL_INFO_WITHOUT_STREET = 24, 426 427 /** 428 * Format address content type. 429 * 430 * @syscap SystemCapability.ArkUI.ArkUI.Full 431 * @atomicservice 432 * @since 12 433 */ 434 FORMAT_ADDRESS = 25, 435 436 /** 437 * Passport number content type. 438 * 439 * @syscap SystemCapability.ArkUI.ArkUI.Full 440 * @atomicservice 441 * @since 18 442 */ 443 PASSPORT_NUMBER = 26, 444 445 /** 446 * Passport validity content type. 447 * 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @atomicservice 450 * @since 18 451 */ 452 VALIDITY = 27, 453 454 /** 455 * Place of issue content type. 456 * 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @atomicservice 459 * @since 18 460 */ 461 ISSUE_AT = 28, 462 463 /** 464 * Invoice organization content type. 465 * 466 * @syscap SystemCapability.ArkUI.ArkUI.Full 467 * @atomicservice 468 * @since 18 469 */ 470 ORGANIZATION = 29, 471 472 /** 473 * Invoice tax id content type. 474 * 475 * @syscap SystemCapability.ArkUI.ArkUI.Full 476 * @atomicservice 477 * @since 18 478 */ 479 TAX_ID = 30, 480 481 /** 482 * Address city and state content type. 483 * 484 * @syscap SystemCapability.ArkUI.ArkUI.Full 485 * @atomicservice 486 * @since 18 487 */ 488 ADDRESS_CITY_AND_STATE = 31, 489 490 /** 491 * Airline flight number content type. 492 * 493 * @syscap SystemCapability.ArkUI.ArkUI.Full 494 * @atomicservice 495 * @since 18 496 */ 497 FLIGHT_NUMBER = 32, 498 499 /** 500 * License number for drivers content type. 501 * 502 * @syscap SystemCapability.ArkUI.ArkUI.Full 503 * @atomicservice 504 * @since 18 505 */ 506 LICENSE_NUMBER = 33, 507 508 /** 509 * License file number for drivers content type. 510 * 511 * @syscap SystemCapability.ArkUI.ArkUI.Full 512 * @atomicservice 513 * @since 18 514 */ 515 LICENSE_FILE_NUMBER = 34, 516 517 /** 518 * License plate for vehicles content type. 519 * 520 * @syscap SystemCapability.ArkUI.ArkUI.Full 521 * @atomicservice 522 * @since 18 523 */ 524 LICENSE_PLATE = 35, 525 526 /** 527 * Engine number for vehicles content type. 528 * 529 * @syscap SystemCapability.ArkUI.ArkUI.Full 530 * @atomicservice 531 * @since 18 532 */ 533 ENGINE_NUMBER = 36, 534 535 /** 536 * License chassis number for vehicles content type. 537 * 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @atomicservice 540 * @since 18 541 */ 542 LICENSE_CHASSIS_NUMBER = 37 543} 544 545/** 546 * Declare the type of soft keyboard. 547 * 548 * @enum { number } 549 * @syscap SystemCapability.ArkUI.ArkUI.Full 550 * @since 7 551 */ 552/** 553 * Declare the type of soft keyboard. 554 * 555 * @enum { number } 556 * @syscap SystemCapability.ArkUI.ArkUI.Full 557 * @crossplatform 558 * @since 10 559 */ 560/** 561 * Declare the type of soft keyboard. 562 * 563 * @enum { number } 564 * @syscap SystemCapability.ArkUI.ArkUI.Full 565 * @crossplatform 566 * @atomicservice 567 * @since 11 568 */ 569declare enum EnterKeyType { 570 /** 571 * Go. 572 * 573 * @syscap SystemCapability.ArkUI.ArkUI.Full 574 * @since 7 575 */ 576 /** 577 * Go. 578 * 579 * @syscap SystemCapability.ArkUI.ArkUI.Full 580 * @crossplatform 581 * @since 10 582 */ 583 /** 584 * Go. 585 * 586 * @syscap SystemCapability.ArkUI.ArkUI.Full 587 * @crossplatform 588 * @atomicservice 589 * @since 11 590 */ 591 Go = 2, 592 593 /** 594 * Search. 595 * 596 * @syscap SystemCapability.ArkUI.ArkUI.Full 597 * @since 7 598 */ 599 /** 600 * Search. 601 * 602 * @syscap SystemCapability.ArkUI.ArkUI.Full 603 * @crossplatform 604 * @since 10 605 */ 606 /** 607 * Search. 608 * 609 * @syscap SystemCapability.ArkUI.ArkUI.Full 610 * @crossplatform 611 * @atomicservice 612 * @since 11 613 */ 614 Search = 3, 615 616 /** 617 * Send. 618 * 619 * @syscap SystemCapability.ArkUI.ArkUI.Full 620 * @since 7 621 */ 622 /** 623 * Send. 624 * 625 * @syscap SystemCapability.ArkUI.ArkUI.Full 626 * @crossplatform 627 * @since 10 628 */ 629 /** 630 * Send. 631 * 632 * @syscap SystemCapability.ArkUI.ArkUI.Full 633 * @crossplatform 634 * @atomicservice 635 * @since 11 636 */ 637 Send = 4, 638 639 /** 640 * Next. 641 * 642 * @syscap SystemCapability.ArkUI.ArkUI.Full 643 * @since 7 644 */ 645 /** 646 * Next. 647 * 648 * @syscap SystemCapability.ArkUI.ArkUI.Full 649 * @crossplatform 650 * @since 10 651 */ 652 /** 653 * Next. 654 * 655 * @syscap SystemCapability.ArkUI.ArkUI.Full 656 * @crossplatform 657 * @atomicservice 658 * @since 11 659 */ 660 Next = 5, 661 662 /** 663 * Done. 664 * 665 * @syscap SystemCapability.ArkUI.ArkUI.Full 666 * @since 7 667 */ 668 /** 669 * Done. 670 * 671 * @syscap SystemCapability.ArkUI.ArkUI.Full 672 * @crossplatform 673 * @since 10 674 */ 675 /** 676 * Done. 677 * 678 * @syscap SystemCapability.ArkUI.ArkUI.Full 679 * @crossplatform 680 * @atomicservice 681 * @since 11 682 */ 683 Done = 6, 684 685 /** 686 * Showed as 'previous' pattern. 687 * 688 * @syscap SystemCapability.ArkUI.ArkUI.Full 689 * @crossplatform 690 * @since 11 691 */ 692 /** 693 * Showed as 'previous' pattern. 694 * 695 * @syscap SystemCapability.ArkUI.ArkUI.Full 696 * @crossplatform 697 * @atomicservice 698 * @since 12 699 */ 700 PREVIOUS = 7, 701 702 /** 703 * Showed as 'new line' pattern. 704 * 705 * @syscap SystemCapability.ArkUI.ArkUI.Full 706 * @crossplatform 707 * @since 11 708 */ 709 /** 710 * Showed as 'new line' pattern. 711 * 712 * @syscap SystemCapability.ArkUI.ArkUI.Full 713 * @crossplatform 714 * @atomicservice 715 * @since 12 716 */ 717 NEW_LINE = 8, 718} 719 720/** 721 * Defines the underline color width property. 722 * 723 * @interface UnderlineColor 724 * @syscap SystemCapability.ArkUI.ArkUI.Full 725 * @crossplatform 726 * @atomicservice 727 * @since 12 728 */ 729declare interface UnderlineColor { 730 /** 731 * Typing underline color width property. 732 * 733 * @type { ?(ResourceColor | undefined) } 734 * @syscap SystemCapability.ArkUI.ArkUI.Full 735 * @crossplatform 736 * @atomicservice 737 * @since 12 738 */ 739 typing?: ResourceColor | undefined; 740 /** 741 * Normal underline color width property. 742 * 743 * @type { ?(ResourceColor | undefined) } 744 * @syscap SystemCapability.ArkUI.ArkUI.Full 745 * @crossplatform 746 * @atomicservice 747 * @since 12 748 */ 749 normal?: ResourceColor | undefined; 750 /** 751 * Error underline color width property. 752 * 753 * @type { ?(ResourceColor | undefined) } 754 * @syscap SystemCapability.ArkUI.ArkUI.Full 755 * @crossplatform 756 * @atomicservice 757 * @since 12 758 */ 759 error?: ResourceColor | undefined; 760 /** 761 * Disable underline color width property. 762 * 763 * @type { ?(ResourceColor | undefined) } 764 * @syscap SystemCapability.ArkUI.ArkUI.Full 765 * @crossplatform 766 * @atomicservice 767 * @since 12 768 */ 769 disable?: ResourceColor | undefined; 770} 771 772/** 773 * Provides the method of keeping TextInput editable state when submitted. 774 * 775 * @interface SubmitEvent 776 * @syscap SystemCapability.ArkUI.ArkUI.Full 777 * @crossplatform 778 * @atomicservice 779 * @since 11 780 */ 781declare interface SubmitEvent { 782 /** 783 * Keeps TextInput editable state when submitted 784 * 785 * @syscap SystemCapability.ArkUI.ArkUI.Full 786 * @crossplatform 787 * @atomicservice 788 * @since 11 789 */ 790 keepEditableState(): void; 791 792 /** 793 * Sets the current value of TextInput. 794 * 795 * @type { string } 796 * @syscap SystemCapability.ArkUI.ArkUI.Full 797 * @crossplatform 798 * @atomicservice 799 * @since 11 800 */ 801 text: string; 802} 803 804/** 805 * Provides the method of switching the cursor position. 806 * 807 * @extends TextContentControllerBase 808 * @since 8 809 */ 810/** 811 * Provides the method of switching the cursor position. 812 * 813 * @extends TextContentControllerBase 814 * @syscap SystemCapability.ArkUI.ArkUI.Full 815 * @crossplatform 816 * @since 10 817 */ 818/** 819 * Provides the method of switching the cursor position. 820 * 821 * @extends TextContentControllerBase 822 * @syscap SystemCapability.ArkUI.ArkUI.Full 823 * @crossplatform 824 * @atomicservice 825 * @since 11 826 */ 827declare class TextInputController extends TextContentControllerBase { 828 /** 829 * constructor. 830 * 831 * @syscap SystemCapability.ArkUI.ArkUI.Full 832 * @since 8 833 */ 834 /** 835 * constructor. 836 * 837 * @syscap SystemCapability.ArkUI.ArkUI.Full 838 * @crossplatform 839 * @since 10 840 */ 841 /** 842 * constructor. 843 * 844 * @syscap SystemCapability.ArkUI.ArkUI.Full 845 * @crossplatform 846 * @atomicservice 847 * @since 11 848 */ 849 constructor(); 850 851 /** 852 * Called when the position of the insertion cursor is set. 853 * 854 * @param { number } value 855 * @syscap SystemCapability.ArkUI.ArkUI.Full 856 * @since 8 857 */ 858 /** 859 * Called when the position of the insertion cursor is set. 860 * 861 * @param { number } value 862 * @syscap SystemCapability.ArkUI.ArkUI.Full 863 * @crossplatform 864 * @since 10 865 */ 866 /** 867 * Called when the position of the insertion cursor is set. 868 * 869 * @param { number } value 870 * @syscap SystemCapability.ArkUI.ArkUI.Full 871 * @crossplatform 872 * @atomicservice 873 * @since 11 874 */ 875 caretPosition(value: number): void; 876 877 /** 878 * Text selection is achieved by specifying the start and end positions of the text. 879 * 880 * @param { number } selectionStart - The start position of the selected text. 881 * @param { number } selectionEnd - The end position of the selected text. 882 * @syscap SystemCapability.ArkUI.ArkUI.Full 883 * @crossplatform 884 * @since 10 885 */ 886 /** 887 * Text selection is achieved by specifying the start and end positions of the text. 888 * 889 * @param { number } selectionStart - The start position of the selected text. 890 * @param { number } selectionEnd - The end position of the selected text. 891 * @syscap SystemCapability.ArkUI.ArkUI.Full 892 * @crossplatform 893 * @atomicservice 894 * @since 11 895 */ 896 /** 897 * Text selection is achieved by specifying the start and end positions of the text. 898 * 899 * @param { number } selectionStart - The start position of the selected text. 900 * @param { number } selectionEnd - The end position of the selected text. 901 * @param { SelectionOptions } [options] - Indicates the options of the text selection. 902 * @syscap SystemCapability.ArkUI.ArkUI.Full 903 * @crossplatform 904 * @atomicservice 905 * @since 12 906 */ 907 setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; 908 909 /** 910 * Exit edit state. 911 * 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @crossplatform 914 * @since 10 915 */ 916 /** 917 * Exit edit state. 918 * 919 * @syscap SystemCapability.ArkUI.ArkUI.Full 920 * @crossplatform 921 * @atomicservice 922 * @since 11 923 */ 924 stopEditing(): void; 925} 926 927/** 928 * Defines the options of TextInput. 929 * 930 * @interface TextInputOptions 931 * @syscap SystemCapability.ArkUI.ArkUI.Full 932 * @since 7 933 */ 934/** 935 * Defines the options of TextInput. 936 * 937 * @interface TextInputOptions 938 * @syscap SystemCapability.ArkUI.ArkUI.Full 939 * @crossplatform 940 * @since 10 941 */ 942/** 943 * Defines the options of TextInput. 944 * 945 * @interface TextInputOptions 946 * @syscap SystemCapability.ArkUI.ArkUI.Full 947 * @crossplatform 948 * @atomicservice 949 * @since 11 950 */ 951declare interface TextInputOptions { 952 /** 953 * The place holder text string. 954 * 955 * @type { ?ResourceStr } 956 * @syscap SystemCapability.ArkUI.ArkUI.Full 957 * @since 7 958 */ 959 /** 960 * The place holder text string. 961 * 962 * @type { ?ResourceStr } 963 * @syscap SystemCapability.ArkUI.ArkUI.Full 964 * @crossplatform 965 * @since 10 966 */ 967 /** 968 * The place holder text string. 969 * 970 * @type { ?ResourceStr } 971 * @syscap SystemCapability.ArkUI.ArkUI.Full 972 * @crossplatform 973 * @atomicservice 974 * @since 11 975 */ 976 placeholder?: ResourceStr; 977 978 /** 979 * Sets the current value of TextInput. 980 * 981 * @type { ?ResourceStr } 982 * @syscap SystemCapability.ArkUI.ArkUI.Full 983 * @since 7 984 */ 985 /** 986 * Sets the current value of TextInput. 987 * 988 * @type { ?ResourceStr } 989 * @syscap SystemCapability.ArkUI.ArkUI.Full 990 * @crossplatform 991 * @since 10 992 */ 993 /** 994 * Sets the current value of TextInput. 995 * 996 * @type { ?ResourceStr } 997 * @syscap SystemCapability.ArkUI.ArkUI.Full 998 * @crossplatform 999 * @atomicservice 1000 * @since 11 1001 */ 1002 text?: ResourceStr; 1003 1004 /** 1005 * Called when the position of the insertion cursor is set. 1006 * 1007 * @type { ?TextInputController } 1008 * @syscap SystemCapability.ArkUI.ArkUI.Full 1009 * @since 8 1010 */ 1011 /** 1012 * Called when the position of the insertion cursor is set. 1013 * 1014 * @type { ?TextInputController } 1015 * @syscap SystemCapability.ArkUI.ArkUI.Full 1016 * @crossplatform 1017 * @since 10 1018 */ 1019 /** 1020 * Called when the position of the insertion cursor is set. 1021 * 1022 * @type { ?TextInputController } 1023 * @syscap SystemCapability.ArkUI.ArkUI.Full 1024 * @crossplatform 1025 * @atomicservice 1026 * @since 11 1027 */ 1028 controller?: TextInputController; 1029} 1030 1031/** 1032 * Text input style. 1033 * 1034 * @enum { number } 1035 * @syscap SystemCapability.ArkUI.ArkUI.Full 1036 * @since 9 1037 */ 1038/** 1039 * Text input style. 1040 * 1041 * @enum { number } 1042 * @syscap SystemCapability.ArkUI.ArkUI.Full 1043 * @crossplatform 1044 * @since 10 1045 */ 1046/** 1047 * Text input style. 1048 * 1049 * @enum { number } 1050 * @syscap SystemCapability.ArkUI.ArkUI.Full 1051 * @crossplatform 1052 * @atomicservice 1053 * @since 11 1054 */ 1055declare enum TextInputStyle { 1056 /** 1057 * Text input default style. 1058 * 1059 * @syscap SystemCapability.ArkUI.ArkUI.Full 1060 * @since 9 1061 */ 1062 /** 1063 * Text input default style. 1064 * 1065 * @syscap SystemCapability.ArkUI.ArkUI.Full 1066 * @crossplatform 1067 * @since 10 1068 */ 1069 /** 1070 * Text input default style. 1071 * 1072 * @syscap SystemCapability.ArkUI.ArkUI.Full 1073 * @crossplatform 1074 * @atomicservice 1075 * @since 11 1076 */ 1077 Default, 1078 1079 /** 1080 * Text input inline style. 1081 * 1082 * @syscap SystemCapability.ArkUI.ArkUI.Full 1083 * @since 9 1084 */ 1085 /** 1086 * Text input inline style. 1087 * 1088 * @syscap SystemCapability.ArkUI.ArkUI.Full 1089 * @crossplatform 1090 * @since 10 1091 */ 1092 /** 1093 * Text input inline style. 1094 * 1095 * @syscap SystemCapability.ArkUI.ArkUI.Full 1096 * @crossplatform 1097 * @atomicservice 1098 * @since 11 1099 */ 1100 Inline 1101} 1102 1103/** 1104 * Provides a single-line text input component interface. 1105 * 1106 * @interface TextInputInterface 1107 * @syscap SystemCapability.ArkUI.ArkUI.Full 1108 * @since 7 1109 */ 1110/** 1111 * Provides a single-line text input component interface. 1112 * 1113 * @interface TextInputInterface 1114 * @syscap SystemCapability.ArkUI.ArkUI.Full 1115 * @crossplatform 1116 * @since 10 1117 */ 1118/** 1119 * Provides a single-line text input component interface. 1120 * 1121 * @interface TextInputInterface 1122 * @syscap SystemCapability.ArkUI.ArkUI.Full 1123 * @crossplatform 1124 * @atomicservice 1125 * @since 11 1126 */ 1127interface TextInputInterface { 1128 /** 1129 * Called when writing a single line of text. 1130 * 1131 * @param { TextInputOptions } value 1132 * @returns { TextInputAttribute } 1133 * @syscap SystemCapability.ArkUI.ArkUI.Full 1134 * @since 7 1135 */ 1136 /** 1137 * Called when writing a single line of text. 1138 * 1139 * @param { TextInputOptions } value 1140 * @returns { TextInputAttribute } 1141 * @syscap SystemCapability.ArkUI.ArkUI.Full 1142 * @crossplatform 1143 * @since 10 1144 */ 1145 /** 1146 * Called when writing a single line of text. 1147 * 1148 * @param { TextInputOptions } value 1149 * @returns { TextInputAttribute } 1150 * @syscap SystemCapability.ArkUI.ArkUI.Full 1151 * @crossplatform 1152 * @atomicservice 1153 * @since 11 1154 */ 1155 (value?: TextInputOptions): TextInputAttribute; 1156} 1157 1158/** 1159 * PasswordIcon object. 1160 * 1161 * @interface PasswordIcon 1162 * @syscap SystemCapability.ArkUI.ArkUI.Full 1163 * @since 10 1164 */ 1165/** 1166 * PasswordIcon object. 1167 * 1168 * @interface PasswordIcon 1169 * @syscap SystemCapability.ArkUI.ArkUI.Full 1170 * @crossplatform 1171 * @atomicservice 1172 * @since 11 1173 */ 1174interface PasswordIcon { 1175 /** 1176 * Define the on icon source of PasswordIcon. 1177 * 1178 * @type { ?(string | Resource) } 1179 * @syscap SystemCapability.ArkUI.ArkUI.Full 1180 * @since 10 1181 */ 1182 /** 1183 * Define the on icon source of PasswordIcon. 1184 * 1185 * @type { ?(string | Resource) } 1186 * @syscap SystemCapability.ArkUI.ArkUI.Full 1187 * @crossplatform 1188 * @atomicservice 1189 * @since 11 1190 */ 1191 onIconSrc?: string | Resource; 1192 1193 /** 1194 * Define the off icon source of PasswordIcon. 1195 * 1196 * @type { ?(string | Resource) } 1197 * @syscap SystemCapability.ArkUI.ArkUI.Full 1198 * @since 10 1199 */ 1200 /** 1201 * Define the off icon source of PasswordIcon. 1202 * 1203 * @type { ?(string | Resource) } 1204 * @syscap SystemCapability.ArkUI.ArkUI.Full 1205 * @crossplatform 1206 * @atomicservice 1207 * @since 11 1208 */ 1209 offIconSrc?: string | Resource; 1210} 1211 1212/** 1213 * Defines a TextInput callback when onSubmit. 1214 * 1215 * Anonymous Object Rectification. 1216 * @typedef { function } OnSubmitCallback 1217 * @param { EnterKeyType } enterKey - Input method Enter key type. 1218 * @param { SubmitEvent } event - The event submitted. 1219 * @syscap SystemCapability.ArkUI.ArkUI.Full 1220 * @crossplatform 1221 * @atomicservice 1222 * @since 18 1223 */ 1224declare type OnSubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => void; 1225 1226/** 1227 * Defines a TextInput callback when onTextSelectionChange. 1228 * 1229 * Anonymous Object Rectification. 1230 * @typedef { function } OnTextSelectionChangeCallback 1231 * @param { number } selectionStart - The starting position of the selected text, the starting position of the text is 0. 1232 * @param { number } selectionEnd - The end location of the selected text. 1233 * @syscap SystemCapability.ArkUI.ArkUI.Full 1234 * @crossplatform 1235 * @atomicservice 1236 * @since 18 1237 */ 1238declare type OnTextSelectionChangeCallback = (selectionStart: number, selectionEnd: number) => void; 1239 1240/** 1241 * Defines a TextInput callback when onContentScroll. 1242 * 1243 * Anonymous Object Rectification. 1244 * @typedef { function } OnContentScrollCallback 1245 * @param { number } totalOffsetX - The text is offset in px on the horizontal axis of the content area. 1246 * @param { number } totalOffsetY - The text is offset in px on the vertical axis of the content area. 1247 * @syscap SystemCapability.ArkUI.ArkUI.Full 1248 * @crossplatform 1249 * @atomicservice 1250 * @since 18 1251 */ 1252declare type OnContentScrollCallback = (totalOffsetX: number, totalOffsetY: number) => void; 1253 1254 1255/** 1256 * Defines a TextInput callback when onPaste. 1257 * 1258 * Anonymous Object Rectification. 1259 * @typedef { function } OnPasteCallback 1260 * @param { string } content - The text content of the paste. 1261 * @param { PasteEvent } event - User-defined paste event. 1262 * @syscap SystemCapability.ArkUI.ArkUI.Full 1263 * @crossplatform 1264 * @atomicservice 1265 * @since 18 1266 */ 1267declare type OnPasteCallback = (content: string, event: PasteEvent) => void; 1268 1269/** 1270 * Defines the TextInput attribute functions. 1271 * 1272 * @extends CommonMethod<TextInputAttribute> 1273 * @syscap SystemCapability.ArkUI.ArkUI.Full 1274 * @since 7 1275 */ 1276/** 1277 * Defines the TextInput attribute functions. 1278 * 1279 * @extends CommonMethod<TextInputAttribute> 1280 * @syscap SystemCapability.ArkUI.ArkUI.Full 1281 * @crossplatform 1282 * @since 10 1283 */ 1284/** 1285 * Defines the TextInput attribute functions. 1286 * 1287 * @extends CommonMethod<TextInputAttribute> 1288 * @syscap SystemCapability.ArkUI.ArkUI.Full 1289 * @crossplatform 1290 * @atomicservice 1291 * @since 11 1292 */ 1293declare class TextInputAttribute extends CommonMethod<TextInputAttribute> { 1294 /** 1295 * Called when the input type is set. 1296 * 1297 * @param { InputType } value 1298 * @returns { TextInputAttribute } 1299 * @syscap SystemCapability.ArkUI.ArkUI.Full 1300 * @since 7 1301 */ 1302 /** 1303 * Called when the input type is set. 1304 * 1305 * @param { InputType } value 1306 * @returns { TextInputAttribute } 1307 * @syscap SystemCapability.ArkUI.ArkUI.Full 1308 * @crossplatform 1309 * @since 10 1310 */ 1311 /** 1312 * Called when the input type is set. 1313 * 1314 * @param { InputType } value 1315 * @returns { TextInputAttribute } 1316 * @syscap SystemCapability.ArkUI.ArkUI.Full 1317 * @crossplatform 1318 * @atomicservice 1319 * @since 11 1320 */ 1321 type(value: InputType): TextInputAttribute; 1322 1323 /** 1324 * Called when the content type is set. 1325 * 1326 * @param { ContentType } value 1327 * @returns { TextInputAttribute } 1328 * @syscap SystemCapability.ArkUI.ArkUI.Full 1329 * @atomicservice 1330 * @since 12 1331 */ 1332 contentType(value: ContentType): TextInputAttribute; 1333 1334 /** 1335 * Called when the color of the placeholder is set. 1336 * 1337 * @param { ResourceColor } value 1338 * @returns { TextInputAttribute } 1339 * @syscap SystemCapability.ArkUI.ArkUI.Full 1340 * @since 7 1341 */ 1342 /** 1343 * Called when the color of the placeholder is set. 1344 * 1345 * @param { ResourceColor } value 1346 * @returns { TextInputAttribute } 1347 * @syscap SystemCapability.ArkUI.ArkUI.Full 1348 * @crossplatform 1349 * @since 10 1350 */ 1351 /** 1352 * Called when the color of the placeholder is set. 1353 * 1354 * @param { ResourceColor } value 1355 * @returns { TextInputAttribute } 1356 * @syscap SystemCapability.ArkUI.ArkUI.Full 1357 * @crossplatform 1358 * @atomicservice 1359 * @since 11 1360 */ 1361 placeholderColor(value: ResourceColor): TextInputAttribute; 1362 1363 /** 1364 * Called when the overflow mode of the font is set. 1365 * 1366 * @param { TextOverflow } value 1367 * @returns { TextInputAttribute } 1368 * @syscap SystemCapability.ArkUI.ArkUI.Full 1369 * @crossplatform 1370 * @atomicservice 1371 * @since 12 1372 */ 1373 textOverflow(value: TextOverflow): TextInputAttribute; 1374 1375 /** 1376 * Specify the indentation of the first line in a text-block. 1377 * 1378 * @param { Dimension } value - The length of text indent. 1379 * @returns { TextInputAttribute } The attribute of the text. 1380 * @syscap SystemCapability.ArkUI.ArkUI.Full 1381 * @crossplatform 1382 * @atomicservice 1383 * @since 12 1384 */ 1385 textIndent(value: Dimension): TextInputAttribute; 1386 1387 /** 1388 * Called when the font property of the placeholder is set. 1389 * 1390 * @param { Font } value 1391 * @returns { TextInputAttribute } 1392 * @syscap SystemCapability.ArkUI.ArkUI.Full 1393 * @since 7 1394 */ 1395 /** 1396 * Called when the font property of the placeholder is set. 1397 * 1398 * @param { Font } value 1399 * @returns { TextInputAttribute } 1400 * @syscap SystemCapability.ArkUI.ArkUI.Full 1401 * @crossplatform 1402 * @since 10 1403 */ 1404 /** 1405 * Called when the font property of the placeholder is set. 1406 * 1407 * @param { Font } value 1408 * @returns { TextInputAttribute } 1409 * @syscap SystemCapability.ArkUI.ArkUI.Full 1410 * @crossplatform 1411 * @atomicservice 1412 * @since 11 1413 */ 1414 placeholderFont(value?: Font): TextInputAttribute; 1415 1416 /** 1417 * Called when the type of soft keyboard input button is set. 1418 * 1419 * @param { EnterKeyType } value 1420 * @returns { TextInputAttribute } 1421 * @syscap SystemCapability.ArkUI.ArkUI.Full 1422 * @since 7 1423 */ 1424 /** 1425 * Called when the type of soft keyboard input button is set. 1426 * 1427 * @param { EnterKeyType } value 1428 * @returns { TextInputAttribute } 1429 * @syscap SystemCapability.ArkUI.ArkUI.Full 1430 * @crossplatform 1431 * @since 10 1432 */ 1433 /** 1434 * Called when the type of soft keyboard input button is set. 1435 * 1436 * @param { EnterKeyType } value 1437 * @returns { TextInputAttribute } 1438 * @syscap SystemCapability.ArkUI.ArkUI.Full 1439 * @crossplatform 1440 * @atomicservice 1441 * @since 11 1442 */ 1443 enterKeyType(value: EnterKeyType): TextInputAttribute; 1444 1445 /** 1446 * Called when the color of the insertion cursor is set. 1447 * 1448 * @param { ResourceColor } value 1449 * @returns { TextInputAttribute } 1450 * @syscap SystemCapability.ArkUI.ArkUI.Full 1451 * @since 7 1452 */ 1453 /** 1454 * Called when the color of the insertion cursor is set. 1455 * 1456 * @param { ResourceColor } value 1457 * @returns { TextInputAttribute } 1458 * @syscap SystemCapability.ArkUI.ArkUI.Full 1459 * @crossplatform 1460 * @since 10 1461 */ 1462 /** 1463 * Called when the color of the insertion cursor is set. 1464 * 1465 * @param { ResourceColor } value 1466 * @returns { TextInputAttribute } 1467 * @syscap SystemCapability.ArkUI.ArkUI.Full 1468 * @crossplatform 1469 * @atomicservice 1470 * @since 11 1471 */ 1472 caretColor(value: ResourceColor): TextInputAttribute; 1473 1474 /** 1475 * Called when judging whether the text editing change finished. 1476 * 1477 * @param { function } callback 1478 * @returns { TextInputAttribute } 1479 * @syscap SystemCapability.ArkUI.ArkUI.Full 1480 * @since 7 1481 * @deprecated since 8 1482 * @useinstead onEditChange 1483 */ 1484 onEditChanged(callback: (isEditing: boolean) => void): TextInputAttribute; 1485 1486 /** 1487 * Called when judging whether the text editing change finished. 1488 * 1489 * @param { function } callback 1490 * @returns { TextInputAttribute } 1491 * @syscap SystemCapability.ArkUI.ArkUI.Full 1492 * @since 8 1493 */ 1494 /** 1495 * Called when judging whether the text editing change finished. 1496 * 1497 * @param { function } callback 1498 * @returns { TextInputAttribute } 1499 * @syscap SystemCapability.ArkUI.ArkUI.Full 1500 * @crossplatform 1501 * @since 10 1502 */ 1503 /** 1504 * Called when judging whether the text editing change finished. 1505 * 1506 * @param { function } callback 1507 * @returns { TextInputAttribute } 1508 * @syscap SystemCapability.ArkUI.ArkUI.Full 1509 * @crossplatform 1510 * @atomicservice 1511 * @since 11 1512 */ 1513 /** 1514 * Called when judging whether the text editing change finished. 1515 * 1516 * Anonymous Object Rectification. 1517 * @param { Callback<boolean> } callback 1518 * @returns { TextInputAttribute } 1519 * @syscap SystemCapability.ArkUI.ArkUI.Full 1520 * @crossplatform 1521 * @atomicservice 1522 * @since 18 1523 */ 1524 onEditChange(callback: Callback<boolean>): TextInputAttribute; 1525 1526 /** 1527 * Called when submitted. 1528 * 1529 * @param { function } callback 1530 * @returns { TextInputAttribute } 1531 * @syscap SystemCapability.ArkUI.ArkUI.Full 1532 * @since 7 1533 */ 1534 /** 1535 * Called when submitted. 1536 * 1537 * @param { function } callback 1538 * @returns { TextInputAttribute } 1539 * @syscap SystemCapability.ArkUI.ArkUI.Full 1540 * @crossplatform 1541 * @since 10 1542 */ 1543 /** 1544 * Called when submitted. 1545 * 1546 * @param { function } callback - callback of the listened event. 1547 * @returns { TextInputAttribute } 1548 * @syscap SystemCapability.ArkUI.ArkUI.Full 1549 * @crossplatform 1550 * @atomicservice 1551 * @since 11 1552 */ 1553 /** 1554 * Called when submitted. 1555 * 1556 * Anonymous Object Rectification. 1557 * @param { OnSubmitCallback } callback - Callback of the listened event. 1558 * @returns { TextInputAttribute } 1559 * @syscap SystemCapability.ArkUI.ArkUI.Full 1560 * @crossplatform 1561 * @atomicservice 1562 * @since 18 1563 */ 1564 onSubmit(callback: OnSubmitCallback): TextInputAttribute; 1565 1566 /** 1567 * Called when the input of the input box changes. 1568 * 1569 * @param { function } callback 1570 * @returns { TextInputAttribute } 1571 * @syscap SystemCapability.ArkUI.ArkUI.Full 1572 * @since 7 1573 */ 1574 /** 1575 * Called when the input of the input box changes. 1576 * 1577 * @param { function } callback 1578 * @returns { TextInputAttribute } 1579 * @syscap SystemCapability.ArkUI.ArkUI.Full 1580 * @crossplatform 1581 * @since 10 1582 */ 1583 /** 1584 * Called when the input of the input box changes. 1585 * 1586 * @param { function } callback 1587 * @returns { TextInputAttribute } 1588 * @syscap SystemCapability.ArkUI.ArkUI.Full 1589 * @crossplatform 1590 * @atomicservice 1591 * @since 11 1592 */ 1593 /** 1594 * Called when the input of the input box changes. 1595 * 1596 * @param { EditableTextOnChangeCallback } callback 1597 * @returns { TextInputAttribute } 1598 * @syscap SystemCapability.ArkUI.ArkUI.Full 1599 * @crossplatform 1600 * @atomicservice 1601 * @since 12 1602 */ 1603 onChange(callback: EditableTextOnChangeCallback): TextInputAttribute; 1604 1605 /** 1606 * Called when the text selection changes. 1607 * 1608 * @param { function } callback - callback of the listened event. 1609 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 1610 * @syscap SystemCapability.ArkUI.ArkUI.Full 1611 * @crossplatform 1612 * @since 10 1613 */ 1614 /** 1615 * Called when the text selection changes. 1616 * 1617 * @param { function } callback - callback of the listened event. 1618 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 1619 * @syscap SystemCapability.ArkUI.ArkUI.Full 1620 * @crossplatform 1621 * @atomicservice 1622 * @since 11 1623 */ 1624 /** 1625 * Called when the text selection changes. 1626 * 1627 * Anonymous Object Rectification. 1628 * @param { OnTextSelectionChangeCallback } callback - Callback of the listened event. 1629 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 1630 * @syscap SystemCapability.ArkUI.ArkUI.Full 1631 * @crossplatform 1632 * @atomicservice 1633 * @since 18 1634 */ 1635 onTextSelectionChange(callback: OnTextSelectionChangeCallback): TextInputAttribute; 1636 1637 /** 1638 * Called when the content scrolls. 1639 * 1640 * @param { function } callback - callback of the listened event. 1641 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 1642 * @syscap SystemCapability.ArkUI.ArkUI.Full 1643 * @crossplatform 1644 * @since 10 1645 */ 1646 /** 1647 * Called when the content scrolls. 1648 * 1649 * @param { function } callback - callback of the listened event. 1650 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @crossplatform 1653 * @atomicservice 1654 * @since 11 1655 */ 1656 /** 1657 * Called when the content scrolls. 1658 * 1659 * Anonymous Object Rectification. 1660 * @param { OnContentScrollCallback } callback - Callback of the listened event. 1661 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 1662 * @syscap SystemCapability.ArkUI.ArkUI.Full 1663 * @crossplatform 1664 * @atomicservice 1665 * @since 18 1666 */ 1667 onContentScroll(callback: OnContentScrollCallback): TextInputAttribute; 1668 1669 /** 1670 * Called when the input of maximum text length is set. 1671 * 1672 * @param { number } value 1673 * @returns { TextInputAttribute } 1674 * @syscap SystemCapability.ArkUI.ArkUI.Full 1675 * @since 7 1676 */ 1677 /** 1678 * Called when the input of maximum text length is set. 1679 * 1680 * @param { number } value 1681 * @returns { TextInputAttribute } 1682 * @syscap SystemCapability.ArkUI.ArkUI.Full 1683 * @crossplatform 1684 * @since 10 1685 */ 1686 /** 1687 * Called when the input of maximum text length is set. 1688 * 1689 * @param { number } value 1690 * @returns { TextInputAttribute } 1691 * @syscap SystemCapability.ArkUI.ArkUI.Full 1692 * @crossplatform 1693 * @atomicservice 1694 * @since 11 1695 */ 1696 maxLength(value: number): TextInputAttribute; 1697 1698 /** 1699 * Called when the font color is set. 1700 * 1701 * @param { ResourceColor } value 1702 * @returns { TextInputAttribute } 1703 * @syscap SystemCapability.ArkUI.ArkUI.Full 1704 * @since 7 1705 */ 1706 /** 1707 * Called when the font color is set. 1708 * 1709 * @param { ResourceColor } value 1710 * @returns { TextInputAttribute } 1711 * @syscap SystemCapability.ArkUI.ArkUI.Full 1712 * @crossplatform 1713 * @since 10 1714 */ 1715 /** 1716 * Called when the font color is set. 1717 * 1718 * @param { ResourceColor } value 1719 * @returns { TextInputAttribute } 1720 * @syscap SystemCapability.ArkUI.ArkUI.Full 1721 * @crossplatform 1722 * @atomicservice 1723 * @since 11 1724 */ 1725 fontColor(value: ResourceColor): TextInputAttribute; 1726 1727 /** 1728 * Called when the font size is set. 1729 * 1730 * @param { Length } value 1731 * @returns { TextInputAttribute } 1732 * @syscap SystemCapability.ArkUI.ArkUI.Full 1733 * @since 7 1734 */ 1735 /** 1736 * Called when the font size is set. 1737 * 1738 * @param { Length } value 1739 * @returns { TextInputAttribute } 1740 * @syscap SystemCapability.ArkUI.ArkUI.Full 1741 * @crossplatform 1742 * @since 10 1743 */ 1744 /** 1745 * Called when the font size is set. 1746 * 1747 * @param { Length } value 1748 * @returns { TextInputAttribute } 1749 * @syscap SystemCapability.ArkUI.ArkUI.Full 1750 * @crossplatform 1751 * @atomicservice 1752 * @since 11 1753 */ 1754 fontSize(value: Length): TextInputAttribute; 1755 1756 /** 1757 * Called when the font style of a font is set. 1758 * 1759 * @param { FontStyle } value 1760 * @returns { TextInputAttribute } 1761 * @syscap SystemCapability.ArkUI.ArkUI.Full 1762 * @since 7 1763 */ 1764 /** 1765 * Called when the font style of a font is set. 1766 * 1767 * @param { FontStyle } value 1768 * @returns { TextInputAttribute } 1769 * @syscap SystemCapability.ArkUI.ArkUI.Full 1770 * @crossplatform 1771 * @since 10 1772 */ 1773 /** 1774 * Called when the font style of a font is set. 1775 * 1776 * @param { FontStyle } value 1777 * @returns { TextInputAttribute } 1778 * @syscap SystemCapability.ArkUI.ArkUI.Full 1779 * @crossplatform 1780 * @atomicservice 1781 * @since 11 1782 */ 1783 fontStyle(value: FontStyle): TextInputAttribute; 1784 1785 /** 1786 * Called when the font weight is set. 1787 * 1788 * @param { number | FontWeight | string } value 1789 * @returns { TextInputAttribute } 1790 * @syscap SystemCapability.ArkUI.ArkUI.Full 1791 * @since 7 1792 */ 1793 /** 1794 * Called when the font weight is set. 1795 * 1796 * @param { number | FontWeight | string } value 1797 * @returns { TextInputAttribute } 1798 * @syscap SystemCapability.ArkUI.ArkUI.Full 1799 * @crossplatform 1800 * @since 10 1801 */ 1802 /** 1803 * Called when the font weight is set. 1804 * 1805 * @param { number | FontWeight | string } value 1806 * @returns { TextInputAttribute } 1807 * @syscap SystemCapability.ArkUI.ArkUI.Full 1808 * @crossplatform 1809 * @atomicservice 1810 * @since 11 1811 */ 1812 fontWeight(value: number | FontWeight | string): TextInputAttribute; 1813 1814 /** 1815 * Called when the font list of text is set. 1816 * 1817 * @param { ResourceStr } value 1818 * @returns { TextInputAttribute } 1819 * @syscap SystemCapability.ArkUI.ArkUI.Full 1820 * @since 7 1821 */ 1822 /** 1823 * Called when the font list of text is set. 1824 * 1825 * @param { ResourceStr } value 1826 * @returns { TextInputAttribute } 1827 * @syscap SystemCapability.ArkUI.ArkUI.Full 1828 * @crossplatform 1829 * @since 10 1830 */ 1831 /** 1832 * Called when the font list of text is set. 1833 * 1834 * @param { ResourceStr } value 1835 * @returns { TextInputAttribute } 1836 * @syscap SystemCapability.ArkUI.ArkUI.Full 1837 * @crossplatform 1838 * @atomicservice 1839 * @since 11 1840 */ 1841 fontFamily(value: ResourceStr): TextInputAttribute; 1842 1843 /** 1844 * Called when the inputFilter of text is set. 1845 * 1846 * @param { ResourceStr } value 1847 * @param { function } error 1848 * @returns { TextInputAttribute } 1849 * @syscap SystemCapability.ArkUI.ArkUI.Full 1850 * @since 8 1851 */ 1852 /** 1853 * Called when the inputFilter of text is set. 1854 * 1855 * @param { ResourceStr } value 1856 * @param { function } error 1857 * @returns { TextInputAttribute } 1858 * @syscap SystemCapability.ArkUI.ArkUI.Full 1859 * @crossplatform 1860 * @since 10 1861 */ 1862 /** 1863 * Called when the inputFilter of text is set. 1864 * 1865 * @param { ResourceStr } value 1866 * @param { function } error 1867 * @returns { TextInputAttribute } 1868 * @syscap SystemCapability.ArkUI.ArkUI.Full 1869 * @crossplatform 1870 * @atomicservice 1871 * @since 11 1872 */ 1873 /** 1874 * Called when the inputFilter of text is set. 1875 * 1876 * Anonymous Object Rectification. 1877 * @param { ResourceStr } value 1878 * @param { Callback<string> } [error] 1879 * @returns { TextInputAttribute } 1880 * @syscap SystemCapability.ArkUI.ArkUI.Full 1881 * @crossplatform 1882 * @atomicservice 1883 * @since 18 1884 */ 1885 inputFilter(value: ResourceStr, error?: Callback<string>): TextInputAttribute; 1886 1887 /** 1888 * Called when using the Clipboard menu 1889 * 1890 * @param { function } callback 1891 * @returns { TextInputAttribute } 1892 * @syscap SystemCapability.ArkUI.ArkUI.Full 1893 * @since 8 1894 */ 1895 /** 1896 * Called when using the Clipboard menu 1897 * 1898 * @param { function } callback 1899 * @returns { TextInputAttribute } 1900 * @syscap SystemCapability.ArkUI.ArkUI.Full 1901 * @crossplatform 1902 * @since 10 1903 */ 1904 /** 1905 * Called when using the Clipboard menu 1906 * 1907 * @param { function } callback 1908 * @returns { TextInputAttribute } 1909 * @syscap SystemCapability.ArkUI.ArkUI.Full 1910 * @crossplatform 1911 * @atomicservice 1912 * @since 11 1913 */ 1914 /** 1915 * Called when using the Clipboard menu. 1916 * 1917 * Anonymous Object Rectification. 1918 * @param { Callback<string> } callback 1919 * @returns { TextInputAttribute } 1920 * @syscap SystemCapability.ArkUI.ArkUI.Full 1921 * @crossplatform 1922 * @atomicservice 1923 * @since 18 1924 */ 1925 onCopy(callback: Callback<string>): TextInputAttribute; 1926 1927 /** 1928 * Called when using the Clipboard menu 1929 * 1930 * @param { function } callback 1931 * @returns { TextInputAttribute } 1932 * @syscap SystemCapability.ArkUI.ArkUI.Full 1933 * @since 8 1934 */ 1935 /** 1936 * Called when using the Clipboard menu 1937 * 1938 * @param { function } callback 1939 * @returns { TextInputAttribute } 1940 * @syscap SystemCapability.ArkUI.ArkUI.Full 1941 * @crossplatform 1942 * @since 10 1943 */ 1944 /** 1945 * Called when using the Clipboard menu 1946 * 1947 * @param { function } callback 1948 * @returns { TextInputAttribute } 1949 * @syscap SystemCapability.ArkUI.ArkUI.Full 1950 * @crossplatform 1951 * @atomicservice 1952 * @since 11 1953 */ 1954 /** 1955 * Called when using the Clipboard menu. 1956 * 1957 * Anonymous Object Rectification. 1958 * @param { Callback<string> } callback 1959 * @returns { TextInputAttribute } 1960 * @syscap SystemCapability.ArkUI.ArkUI.Full 1961 * @crossplatform 1962 * @atomicservice 1963 * @since 18 1964 */ 1965 onCut(callback: Callback<string>): TextInputAttribute; 1966 1967 /** 1968 * Called when using the Clipboard menu 1969 * 1970 * @param { function } callback 1971 * @returns { TextInputAttribute } 1972 * @syscap SystemCapability.ArkUI.ArkUI.Full 1973 * @since 8 1974 */ 1975 /** 1976 * Called when using the Clipboard menu 1977 * 1978 * @param { function } callback 1979 * @returns { TextInputAttribute } 1980 * @syscap SystemCapability.ArkUI.ArkUI.Full 1981 * @crossplatform 1982 * @since 10 1983 */ 1984 /** 1985 * Called when using the Clipboard menu 1986 * 1987 * @param { function } callback 1988 * Executed when a paste operation is performed. 1989 * { string } value - The text content to be pasted. 1990 * { PasteEvent } event - The user-defined paste event. 1991 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 1992 * @syscap SystemCapability.ArkUI.ArkUI.Full 1993 * @crossplatform 1994 * @atomicservice 1995 * @since 11 1996 */ 1997 /** 1998 * Called when using the Clipboard menu. 1999 * 2000 * Anonymous Object Rectification. 2001 * @param { OnPasteCallback } callback - Executed when a paste operation is performed. 2002 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2003 * @syscap SystemCapability.ArkUI.ArkUI.Full 2004 * @crossplatform 2005 * @atomicservice 2006 * @since 18 2007 */ 2008 onPaste(callback: OnPasteCallback): TextInputAttribute; 2009 2010 /** 2011 * Called when the copy option is set. 2012 * 2013 * @param { CopyOptions } value 2014 * @returns { TextInputAttribute } 2015 * @syscap SystemCapability.ArkUI.ArkUI.Full 2016 * @since 9 2017 */ 2018 /** 2019 * Called when the copy option is set. 2020 * 2021 * @param { CopyOptions } value 2022 * @returns { TextInputAttribute } 2023 * @syscap SystemCapability.ArkUI.ArkUI.Full 2024 * @crossplatform 2025 * @since 10 2026 */ 2027 /** 2028 * Called when the copy option is set. 2029 * 2030 * @param { CopyOptions } value 2031 * @returns { TextInputAttribute } 2032 * @syscap SystemCapability.ArkUI.ArkUI.Full 2033 * @crossplatform 2034 * @atomicservice 2035 * @since 11 2036 */ 2037 copyOption(value: CopyOptions): TextInputAttribute; 2038 2039 /** 2040 * Called when the password show/hide icon is set. 2041 * 2042 * @param { boolean } value 2043 * @returns { TextInputAttribute } 2044 * @syscap SystemCapability.ArkUI.ArkUI.Full 2045 * @since 9 2046 */ 2047 /** 2048 * Called when the password show/hide icon is set. 2049 * 2050 * @param { boolean } value 2051 * @returns { TextInputAttribute } 2052 * @syscap SystemCapability.ArkUI.ArkUI.Full 2053 * @crossplatform 2054 * @since 10 2055 */ 2056 /** 2057 * Called when the password show/hide icon is set. 2058 * 2059 * @param { boolean } value 2060 * @returns { TextInputAttribute } 2061 * @syscap SystemCapability.ArkUI.ArkUI.Full 2062 * @crossplatform 2063 * @atomicservice 2064 * @since 11 2065 */ 2066 showPasswordIcon(value: boolean): TextInputAttribute; 2067 2068 /** 2069 * Called when the text align is set. 2070 * 2071 * @param { TextAlign } value 2072 * @returns { TextInputAttribute } 2073 * @syscap SystemCapability.ArkUI.ArkUI.Full 2074 * @since 9 2075 */ 2076 /** 2077 * Called when the text align is set. 2078 * 2079 * @param { TextAlign } value 2080 * @returns { TextInputAttribute } 2081 * @syscap SystemCapability.ArkUI.ArkUI.Full 2082 * @crossplatform 2083 * @since 10 2084 */ 2085 /** 2086 * Called when the text align is set. 2087 * 2088 * @param { TextAlign } value 2089 * @returns { TextInputAttribute } 2090 * @syscap SystemCapability.ArkUI.ArkUI.Full 2091 * @crossplatform 2092 * @atomicservice 2093 * @since 11 2094 */ 2095 textAlign(value: TextAlign): TextInputAttribute; 2096 2097 /** 2098 * Text input style 2099 * 2100 * @param { TextInputStyle | TextContentStyle } value - Text input style 2101 * @returns { TextInputAttribute } 2102 * @syscap SystemCapability.ArkUI.ArkUI.Full 2103 * @since 9 2104 */ 2105 /** 2106 * Text input style 2107 * 2108 * @param { TextInputStyle | TextContentStyle } value - Text input style 2109 * @returns { TextInputAttribute } 2110 * @syscap SystemCapability.ArkUI.ArkUI.Full 2111 * @crossplatform 2112 * @since 10 2113 */ 2114 /** 2115 * Text input style 2116 * 2117 * @param { TextInputStyle | TextContentStyle } value - Text input style 2118 * @returns { TextInputAttribute } 2119 * @syscap SystemCapability.ArkUI.ArkUI.Full 2120 * @crossplatform 2121 * @atomicservice 2122 * @since 11 2123 */ 2124 style(value: TextInputStyle | TextContentStyle): TextInputAttribute; 2125 2126 /** 2127 * Define the caret style of the text input 2128 * 2129 * @param { CaretStyle } value 2130 * @returns { TextInputAttribute } 2131 * @syscap SystemCapability.ArkUI.ArkUI.Full 2132 * @crossplatform 2133 * @since 10 2134 */ 2135 /** 2136 * Define the caret style of the text input 2137 * 2138 * @param { CaretStyle } value 2139 * @returns { TextInputAttribute } 2140 * @syscap SystemCapability.ArkUI.ArkUI.Full 2141 * @crossplatform 2142 * @atomicservice 2143 * @since 11 2144 */ 2145 caretStyle(value: CaretStyle): TextInputAttribute; 2146 2147 /** 2148 * Define the text selected background color of the text input. 2149 * 2150 * @param { ResourceColor } value 2151 * @returns { TextInputAttribute } 2152 * @syscap SystemCapability.ArkUI.ArkUI.Full 2153 * @crossplatform 2154 * @since 10 2155 */ 2156 /** 2157 * Define the text selected background color of the text input. 2158 * 2159 * @param { ResourceColor } value 2160 * @returns { TextInputAttribute } 2161 * @syscap SystemCapability.ArkUI.ArkUI.Full 2162 * @crossplatform 2163 * @atomicservice 2164 * @since 11 2165 */ 2166 selectedBackgroundColor(value: ResourceColor): TextInputAttribute; 2167 2168 /** 2169 * Define the caret position of the text input. 2170 * 2171 * @param { number } value 2172 * @returns { TextInputAttribute } 2173 * @syscap SystemCapability.ArkUI.ArkUI.Full 2174 * @crossplatform 2175 * @since 10 2176 */ 2177 /** 2178 * Define the caret position of the text input. 2179 * 2180 * @param { number } value 2181 * @returns { TextInputAttribute } 2182 * @syscap SystemCapability.ArkUI.ArkUI.Full 2183 * @crossplatform 2184 * @atomicservice 2185 * @since 11 2186 */ 2187 caretPosition(value: number): TextInputAttribute; 2188 2189 /** 2190 * Sets whether request keyboard or not when on focus. 2191 * 2192 * @param { boolean } value 2193 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2194 * @syscap SystemCapability.ArkUI.ArkUI.Full 2195 * @crossplatform 2196 * @since 10 2197 */ 2198 /** 2199 * Sets whether request keyboard or not when on focus. 2200 * 2201 * @param { boolean } value 2202 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2203 * @syscap SystemCapability.ArkUI.ArkUI.Full 2204 * @crossplatform 2205 * @atomicservice 2206 * @since 11 2207 */ 2208 enableKeyboardOnFocus(value: boolean): TextInputAttribute; 2209 2210 /** 2211 * Define the password icon of the text input. 2212 * 2213 * @param { PasswordIcon } value 2214 * @returns { TextInputAttribute } 2215 * @syscap SystemCapability.ArkUI.ArkUI.Full 2216 * @since 10 2217 */ 2218 /** 2219 * Define the password icon of the text input. 2220 * 2221 * @param { PasswordIcon } value 2222 * @returns { TextInputAttribute } 2223 * @syscap SystemCapability.ArkUI.ArkUI.Full 2224 * @crossplatform 2225 * @atomicservice 2226 * @since 11 2227 */ 2228 passwordIcon(value: PasswordIcon): TextInputAttribute; 2229 2230 /** 2231 * Define the show error of the text input. 2232 * 2233 * @param { string | undefined } value 2234 * @returns { TextInputAttribute } 2235 * @syscap SystemCapability.ArkUI.ArkUI.Full 2236 * @since 10 2237 */ 2238 /** 2239 * Define the show error of the text input. 2240 * 2241 * @param { string | undefined } value 2242 * @returns { TextInputAttribute } 2243 * @syscap SystemCapability.ArkUI.ArkUI.Full 2244 * @crossplatform 2245 * @atomicservice 2246 * @since 11 2247 */ 2248 /** 2249 * Define the show error of the text input. 2250 * 2251 * @param { ResourceStr | undefined } [value] 2252 * @returns { TextInputAttribute } 2253 * @syscap SystemCapability.ArkUI.ArkUI.Full 2254 * @crossplatform 2255 * @atomicservice 2256 * @since 12 2257 */ 2258 showError(value?: ResourceStr | undefined): TextInputAttribute; 2259 2260 /** 2261 * Define the show unit of the text input. 2262 * 2263 * @param { CustomBuilder } value 2264 * @returns { TextInputAttribute } 2265 * @syscap SystemCapability.ArkUI.ArkUI.Full 2266 * @since 10 2267 */ 2268 /** 2269 * Define the show unit of the text input. 2270 * 2271 * @param { CustomBuilder } value 2272 * @returns { TextInputAttribute } 2273 * @syscap SystemCapability.ArkUI.ArkUI.Full 2274 * @crossplatform 2275 * @atomicservice 2276 * @since 11 2277 */ 2278 showUnit(value: CustomBuilder): TextInputAttribute; 2279 2280 /** 2281 * Define the show underline of the text input. 2282 * 2283 * @param { boolean } value 2284 * @returns { TextInputAttribute } 2285 * @syscap SystemCapability.ArkUI.ArkUI.Full 2286 * @since 10 2287 */ 2288 /** 2289 * Define the show underline of the text input. 2290 * 2291 * @param { boolean } value 2292 * @returns { TextInputAttribute } 2293 * @syscap SystemCapability.ArkUI.ArkUI.Full 2294 * @crossplatform 2295 * @atomicservice 2296 * @since 11 2297 */ 2298 showUnderline(value: boolean): TextInputAttribute; 2299 2300 /** 2301 * Define the underline color of the text input. 2302 * 2303 * @param { ResourceColor | UnderlineColor | undefined } value 2304 * @returns { TextInputAttribute } 2305 * @syscap SystemCapability.ArkUI.ArkUI.Full 2306 * @crossplatform 2307 * @atomicservice 2308 * @since 12 2309 */ 2310 underlineColor(value: ResourceColor | UnderlineColor | undefined): TextInputAttribute; 2311 2312 /** 2313 * Controls whether the selection menu pops up. 2314 * 2315 * @param { boolean } value 2316 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2317 * @syscap SystemCapability.ArkUI.ArkUI.Full 2318 * @crossplatform 2319 * @since 10 2320 */ 2321 /** 2322 * Controls whether the selection menu pops up. 2323 * 2324 * @param { boolean } value 2325 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2326 * @syscap SystemCapability.ArkUI.ArkUI.Full 2327 * @crossplatform 2328 * @atomicservice 2329 * @since 11 2330 */ 2331 selectionMenuHidden(value: boolean): TextInputAttribute; 2332 2333 /** 2334 * Define bar state of the text input. 2335 * 2336 * @param { BarState } value 2337 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2338 * @syscap SystemCapability.ArkUI.ArkUI.Full 2339 * @since 10 2340 */ 2341 /** 2342 * Define bar state of the text input. 2343 * 2344 * @param { BarState } value 2345 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2346 * @syscap SystemCapability.ArkUI.ArkUI.Full 2347 * @atomicservice 2348 * @since 11 2349 */ 2350 barState(value: BarState): TextInputAttribute; 2351 2352 /** 2353 * Define max lines of the text input. 2354 * 2355 * @param { number } value 2356 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2357 * @syscap SystemCapability.ArkUI.ArkUI.Full 2358 * @since 10 2359 */ 2360 /** 2361 * Define max lines of the text input. 2362 * 2363 * @param { number } value 2364 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2365 * @syscap SystemCapability.ArkUI.ArkUI.Full 2366 * @crossplatform 2367 * @atomicservice 2368 * @since 11 2369 */ 2370 maxLines(value: number): TextInputAttribute; 2371 2372 /** 2373 * Set the text inline style word break type. 2374 * 2375 * @param { WordBreak } value - The word break type. 2376 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2377 * @syscap SystemCapability.ArkUI.ArkUI.Full 2378 * @crossplatform 2379 * @atomicservice 2380 * @since 12 2381 */ 2382 wordBreak(value: WordBreak): TextInputAttribute; 2383 2384 /** 2385 * Set the text line break strategy type. 2386 * 2387 * @param { LineBreakStrategy } strategy - The text line break strategy type. 2388 * @returns { TextInputAttribute } The attribute of the TextInputAttribute. 2389 * @syscap SystemCapability.ArkUI.ArkUI.Full 2390 * @crossplatform 2391 * @atomicservice 2392 * @since 12 2393 */ 2394 lineBreakStrategy(strategy: LineBreakStrategy): TextInputAttribute; 2395 2396 /** 2397 * Define custom keyboard of the text input. 2398 * 2399 * @param { CustomBuilder } value 2400 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2401 * @syscap SystemCapability.ArkUI.ArkUI.Full 2402 * @since 10 2403 */ 2404 /** 2405 * Define custom keyboard of the text input. 2406 * 2407 * @param { CustomBuilder } value 2408 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2409 * @syscap SystemCapability.ArkUI.ArkUI.Full 2410 * @crossplatform 2411 * @atomicservice 2412 * @since 11 2413 */ 2414 2415 /** 2416 * Define custom keyboard of the text input. 2417 * 2418 * @param { CustomBuilder } value - Set up a custom keyboard of TextInput 2419 * @param { KeyboardOptions } [options] - Indicates the custom keyboard options of TextInput 2420 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2421 * @syscap SystemCapability.ArkUI.ArkUI.Full 2422 * @crossplatform 2423 * @atomicservice 2424 * @since 12 2425 */ 2426 customKeyboard(value: CustomBuilder, options?: KeyboardOptions): TextInputAttribute; 2427 2428 /** 2429 * Show the counter when the number of characters entered exceeds the threshold through InputCounterOptions. 2430 * 2431 * @param { boolean } value - Set showcounter of the text input. 2432 * @param { InputCounterOptions } options - Set the percentage of counter. 2433 * @returns { TextInputAttribute } 2434 * @syscap SystemCapability.ArkUI.ArkUI.Full 2435 * @crossplatform 2436 * @atomicservice 2437 * @since 11 2438 */ 2439 showCounter(value: boolean, options?: InputCounterOptions): TextInputAttribute; 2440 2441 /** 2442 * Set the cancel button style 2443 * 2444 * @param { object } value - indicates the style of the cancel button. 2445 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2446 * @syscap SystemCapability.ArkUI.ArkUI.Full 2447 * @crossplatform 2448 * @since 11 2449 */ 2450 /** 2451 * Set the cancel button style 2452 * 2453 * @param { object } value - indicates the style of the cancel button. 2454 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2455 * @syscap SystemCapability.ArkUI.ArkUI.Full 2456 * @crossplatform 2457 * @atomicservice 2458 * @since 12 2459 */ 2460 /** 2461 * Set the cancel button style. 2462 * 2463 * Anonymous Object Rectification. 2464 * @param { CancelButtonOptions } options - Indicates the style of the cancel button. 2465 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2466 * @syscap SystemCapability.ArkUI.ArkUI.Full 2467 * @crossplatform 2468 * @atomicservice 2469 * @since 18 2470 */ 2471 cancelButton(options: CancelButtonOptions): TextInputAttribute; 2472 2473 /** 2474 * Set the cancel button style 2475 * 2476 * @param { CancelButtonSymbolOptions } symbolOptions - indicates the style of the cancel button. 2477 * @returns { TextInputAttribute } 2478 * @syscap SystemCapability.ArkUI.ArkUI.Full 2479 * @atomicservice 2480 * @since 18 2481 */ 2482 cancelButton(symbolOptions: CancelButtonSymbolOptions): TextInputAttribute; 2483 2484 /** 2485 * Sets selection when on focus. 2486 * 2487 * @param { boolean } value - Sets selection or not. 2488 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2489 * @syscap SystemCapability.ArkUI.ArkUI.Full 2490 * @crossplatform 2491 * @since 11 2492 */ 2493 /** 2494 * Sets selection when on focus. 2495 * 2496 * @param { boolean } value - Sets selection or not. 2497 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2498 * @syscap SystemCapability.ArkUI.ArkUI.Full 2499 * @crossplatform 2500 * @atomicservice 2501 * @since 12 2502 */ 2503 selectAll(value: boolean): TextInputAttribute; 2504 2505 /** 2506 * Called when the minimum font size of the font is set. 2507 * 2508 * @param { number | string | Resource } value 2509 * @returns { TextInputAttribute } 2510 * @syscap SystemCapability.ArkUI.ArkUI.Full 2511 * @crossplatform 2512 * @atomicservice 2513 * @since 12 2514 */ 2515 minFontSize(value: number | string | Resource): TextInputAttribute; 2516 2517 /** 2518 * Called when the maximum font size of the font is set. 2519 * 2520 * @param { number | string | Resource } value 2521 * @returns { TextInputAttribute } 2522 * @syscap SystemCapability.ArkUI.ArkUI.Full 2523 * @crossplatform 2524 * @atomicservice 2525 * @since 12 2526 */ 2527 maxFontSize(value: number | string | Resource): TextInputAttribute; 2528 2529 /** 2530 * Called when the minimum font scale of the font is set. 2531 * 2532 * @param { Optional<number | Resource> } scale 2533 * @returns { TextInputAttribute } 2534 * @syscap SystemCapability.ArkUI.ArkUI.Full 2535 * @atomicservice 2536 * @since 18 2537 */ 2538 minFontScale(scale: Optional<number | Resource>): TextInputAttribute; 2539 2540 /** 2541 * Called when the maximum font scale of the font is set. 2542 * 2543 * @param { Optional<number | Resource> } scale 2544 * @returns { TextInputAttribute } 2545 * @syscap SystemCapability.ArkUI.ArkUI.Full 2546 * @atomicservice 2547 * @since 18 2548 */ 2549 maxFontScale(scale: Optional<number | Resource>): TextInputAttribute; 2550 2551 /** 2552 * Called when the height adaptive policy is set. 2553 * 2554 * @param { TextHeightAdaptivePolicy } value - The height adaptive policy. 2555 * @returns { TextInputAttribute } 2556 * @syscap SystemCapability.ArkUI.ArkUI.Full 2557 * @crossplatform 2558 * @atomicservice 2559 * @since 12 2560 */ 2561 heightAdaptivePolicy(value: TextHeightAdaptivePolicy): TextInputAttribute; 2562 2563 /** 2564 * Sets whether enable auto fill or not. 2565 * 2566 * @param { boolean } value - Indicates the flag whether autofill is enabled. 2567 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2568 * @syscap SystemCapability.ArkUI.ArkUI.Full 2569 * @since 11 2570 */ 2571 /** 2572 * Sets whether enable auto fill or not. 2573 * 2574 * @param { boolean } value - Indicates the flag whether autofill is enabled. 2575 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2576 * @syscap SystemCapability.ArkUI.ArkUI.Full 2577 * @atomicservice 2578 * @since 12 2579 */ 2580 enableAutoFill(value: boolean): TextInputAttribute; 2581 2582 /** 2583 * Called when the text decoration of the text is set. 2584 * 2585 * @param { TextDecorationOptions } value 2586 * @returns { TextInputAttribute } 2587 * @syscap SystemCapability.ArkUI.ArkUI.Full 2588 * @crossplatform 2589 * @atomicservice 2590 * @since 12 2591 */ 2592 decoration(value: TextDecorationOptions): TextInputAttribute; 2593 2594 /** 2595 * Called when the distance between text fonts is set. 2596 * 2597 * @param { number | string | Resource } value 2598 * @returns { TextInputAttribute } 2599 * @syscap SystemCapability.ArkUI.ArkUI.Full 2600 * @crossplatform 2601 * @atomicservice 2602 * @since 12 2603 */ 2604 letterSpacing(value: number | string | Resource): TextInputAttribute; 2605 2606 /** 2607 * Called when the line height of the font is set. 2608 * 2609 * @param { number | string | Resource } value 2610 * @returns { TextInputAttribute } 2611 * @syscap SystemCapability.ArkUI.ArkUI.Full 2612 * @crossplatform 2613 * @atomicservice 2614 * @since 12 2615 */ 2616 lineHeight(value: number | string | Resource): TextInputAttribute; 2617 2618 /** 2619 * Define the password rules of the text input. 2620 * 2621 * @param { string } value - Indicates the password rules. 2622 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2623 * @syscap SystemCapability.ArkUI.ArkUI.Full 2624 * @since 11 2625 */ 2626 /** 2627 * Define the password rules of the text input. 2628 * 2629 * @param { string } value - Indicates the password rules. 2630 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2631 * @syscap SystemCapability.ArkUI.ArkUI.Full 2632 * @atomicservice 2633 * @since 12 2634 */ 2635 passwordRules(value: string): TextInputAttribute; 2636 2637 /** 2638 * Set font feature. 2639 * 2640 * @param { string } value - The fontFeature. 2641 * normal | <feature-tag-value>, 2642 * where <feature-tag-value> = <string> [ <integer> | on | off ], like: "ss01" 0 2643 * the values of <feature-tag-value> reference to doc of TextInput component 2644 * number of <feature-tag-value> can be single or multiple, and separated by comma ','. 2645 * @returns { TextInputAttribute } 2646 * @syscap SystemCapability.ArkUI.ArkUI.Full 2647 * @crossplatform 2648 * @atomicservice 2649 * @since 12 2650 */ 2651 fontFeature(value: string): TextInputAttribute; 2652 2653 /** 2654 * Define the password visible mode of the text input. 2655 * 2656 * @param { boolean } visible - Indicates the password visible mode. 2657 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2658 * @syscap SystemCapability.ArkUI.ArkUI.Full 2659 * @crossplatform 2660 * @atomicservice 2661 * @since 12 2662 */ 2663 showPassword(visible: boolean): TextInputAttribute; 2664 2665 /** 2666 * Called when changing the password visible mode of the text input. 2667 * 2668 * @param { Callback<boolean> } callback - callback of the password visible mode change event. 2669 * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. 2670 * @syscap SystemCapability.ArkUI.ArkUI.Full 2671 * @crossplatform 2672 * @atomicservice 2673 * @since 12 2674 */ 2675 onSecurityStateChange(callback: Callback<boolean>): TextInputAttribute; 2676 2677 /** 2678 * Get text value information when about to input. 2679 * 2680 * @param { Callback<InsertValue, boolean> } callback - The triggered function when text content is about to insert. 2681 * @returns { TextInputAttribute } 2682 * @syscap SystemCapability.ArkUI.ArkUI.Full 2683 * @crossplatform 2684 * @atomicservice 2685 * @since 12 2686 */ 2687 onWillInsert(callback: Callback<InsertValue, boolean>): TextInputAttribute; 2688 2689 /** 2690 * Get text value information when completed input. 2691 * 2692 * @param { Callback<InsertValue> } callback - The triggered function when text content has been inserted. 2693 * @returns { TextInputAttribute } 2694 * @syscap SystemCapability.ArkUI.ArkUI.Full 2695 * @crossplatform 2696 * @atomicservice 2697 * @since 12 2698 */ 2699 onDidInsert(callback: Callback<InsertValue>): TextInputAttribute; 2700 2701 /** 2702 * Get text value information when about to delete. 2703 * 2704 * @param { Callback<DeleteValue, boolean> } callback - The triggered function when text content is about to delete. 2705 * @returns { TextInputAttribute } 2706 * @syscap SystemCapability.ArkUI.ArkUI.Full 2707 * @crossplatform 2708 * @atomicservice 2709 * @since 12 2710 */ 2711 onWillDelete(callback: Callback<DeleteValue, boolean>): TextInputAttribute; 2712 2713 /** 2714 * Get text value information when the deletion has been completed 2715 * 2716 * @param { Callback<DeleteValue> } callback - The triggered function when text content has been deleted. 2717 * @returns { TextInputAttribute } 2718 * @syscap SystemCapability.ArkUI.ArkUI.Full 2719 * @crossplatform 2720 * @atomicservice 2721 * @since 12 2722 */ 2723 onDidDelete(callback: Callback<DeleteValue>): TextInputAttribute; 2724 2725 /** 2726 * Set the custom text menu. 2727 * 2728 * @param { EditMenuOptions } editMenu - Customize text menu options. 2729 * @returns { TextInputAttribute } 2730 * @syscap SystemCapability.ArkUI.ArkUI.Full 2731 * @crossplatform 2732 * @atomicservice 2733 * @since 12 2734 */ 2735 editMenuOptions(editMenu: EditMenuOptions): TextInputAttribute; 2736 2737 /** 2738 * Define the preview text mode of the text input. 2739 * 2740 * @param { boolean } enable - Indicates the preview text mode. 2741 * @returns { TextInputAttribute } 2742 * @syscap SystemCapability.ArkUI.ArkUI.Full 2743 * @crossplatform 2744 * @atomicservice 2745 * @since 12 2746 */ 2747 enablePreviewText(enable: boolean): TextInputAttribute; 2748 2749 /** 2750 * Enable or disable haptic feedback. 2751 * 2752 * @param { boolean } isEnabled - Default value is true, set false to disable haptic feedback. 2753 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2754 * @syscap SystemCapability.ArkUI.ArkUI.Full 2755 * @crossplatform 2756 * @atomicservice 2757 * @since 13 2758 */ 2759 enableHapticFeedback(isEnabled: boolean): TextInputAttribute; 2760 2761 /** 2762 * Set the text with half leading. 2763 * 2764 * @param { Optional<boolean> } halfLeading 2765 * @returns { TextInputAttribute } 2766 * @syscap SystemCapability.ArkUI.ArkUI.Full 2767 * @crossplatform 2768 * @atomicservice 2769 * @since 18 2770 */ 2771 halfLeading(halfLeading: Optional<boolean>): TextInputAttribute; 2772 2773 /** 2774 * Set the ellipsis mode. 2775 * 2776 * @param { Optional<EllipsisMode> } mode - The ellipsis mode. 2777 * @returns { TextInputAttribute } The attribute of TextInput. 2778 * @syscap SystemCapability.ArkUI.ArkUI.Full 2779 * @crossplatform 2780 * @atomicservice 2781 * @since 18 2782 */ 2783 ellipsisMode(mode: Optional<EllipsisMode>): TextInputAttribute; 2784 2785 /** 2786 * Set whether stop backPressed callback event or not. 2787 * 2788 * @param { Optional<boolean> } isStopped - Default value is true, set false to trigger the latest callback event. 2789 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2790 * @syscap SystemCapability.ArkUI.ArkUI.Full 2791 * @atomicservice 2792 * @since 15 2793 */ 2794 stopBackPress(isStopped: Optional<boolean>): TextInputAttribute; 2795 2796 /** 2797 * Get text value information when about to change. 2798 * 2799 * @param { Callback<EditableTextChangeValue, boolean> } callback - The triggered function when text content is about to change. 2800 * @returns { TextInputAttribute } 2801 * @syscap SystemCapability.ArkUI.ArkUI.Full 2802 * @crossplatform 2803 * @atomicservice 2804 * @since 15 2805 */ 2806 onWillChange(callback: Callback<EditableTextChangeValue, boolean>): TextInputAttribute; 2807 2808 /** 2809 * Set the keyboard appearance. 2810 * 2811 * @param { Optional<KeyboardAppearance> } appearance - Default value is KeyboardAppearance.NONE_IMMERSIVE 2812 * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. 2813 * @syscap SystemCapability.ArkUI.ArkUI.Full 2814 * @atomicservice 2815 * @since 15 2816 2817 */ 2818 keyboardAppearance(appearance: Optional<KeyboardAppearance>): TextInputAttribute; 2819} 2820 2821/** 2822 * Defines TextInput Component. 2823 * 2824 * @syscap SystemCapability.ArkUI.ArkUI.Full 2825 * @since 7 2826 */ 2827/** 2828 * Defines TextInput Component. 2829 * 2830 * @syscap SystemCapability.ArkUI.ArkUI.Full 2831 * @crossplatform 2832 * @since 10 2833 */ 2834/** 2835 * Defines TextInput Component. 2836 * 2837 * @syscap SystemCapability.ArkUI.ArkUI.Full 2838 * @crossplatform 2839 * @atomicservice 2840 * @since 11 2841 */ 2842declare const TextInput: TextInputInterface; 2843 2844/** 2845 * Defines TextInput Component instance. 2846 * 2847 * @syscap SystemCapability.ArkUI.ArkUI.Full 2848 * @since 7 2849 */ 2850/** 2851 * Defines TextInput Component instance. 2852 * 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @crossplatform 2855 * @since 10 2856 */ 2857/** 2858 * Defines TextInput Component instance. 2859 * 2860 * @syscap SystemCapability.ArkUI.ArkUI.Full 2861 * @crossplatform 2862 * @atomicservice 2863 * @since 11 2864 */ 2865declare const TextInputInstance: TextInputAttribute; 2866