1/* 2 * Copyright (c) 2021-2023 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 * indexer align property. 23 * 24 * @enum { number } 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 7 27 */ 28/** 29 * indexer align property. 30 * 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 */ 36/** 37 * indexer align property. 38 * 39 * @enum { number } 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @atomicservice 43 * @since 11 44 */ 45declare enum IndexerAlign { 46 /** 47 * A dialog box is displayed on the right of the index bar. 48 * 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @since 7 51 */ 52 /** 53 * A dialog box is displayed on the right of the index bar. 54 * 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @crossplatform 57 * @since 10 58 */ 59 /** 60 * A dialog box is displayed on the right of the index bar. 61 * 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @crossplatform 64 * @atomicservice 65 * @since 11 66 */ 67 Left, 68 69 /** 70 * A dialog box is displayed on the left of the index bar. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @since 7 74 */ 75 /** 76 * A dialog box is displayed on the left of the index bar. 77 * 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @crossplatform 80 * @since 10 81 */ 82 /** 83 * A dialog box is displayed on the left of the index bar. 84 * 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @atomicservice 88 * @since 11 89 */ 90 Right, 91 92 /** 93 * A dialog box is displayed on the start of the index bar. 94 * 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @crossplatform 97 * @atomicservice 98 * @since 12 99 */ 100 START, 101 102 /** 103 * A dialog box is displayed on the end of the index bar. 104 * 105 * @syscap SystemCapability.ArkUI.ArkUI.Full 106 * @crossplatform 107 * @atomicservice 108 * @since 12 109 */ 110 END, 111} 112 113/** 114 * AlphabetIndexer constructor options. 115 * 116 * @interface AlphabetIndexerOptions 117 * @syscap SystemCapability.ArkUI.ArkUI.Full 118 * @crossplatform 119 * @atomicservice 120 * @since 18 121 */ 122interface AlphabetIndexerOptions { 123 /** 124 * Alphabetical index string array. 125 * 126 * @type { Array<string> } 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @since 7 129 */ 130 /** 131 * Alphabetical index string array. 132 * 133 * @type { Array<string> } 134 * @syscap SystemCapability.ArkUI.ArkUI.Full 135 * @crossplatform 136 * @since 10 137 */ 138 /** 139 * Alphabetical index string array. 140 * 141 * @type { Array<string> } 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @crossplatform 144 * @atomicservice 145 * @since 11 146 */ 147 /** 148 * Alphabetical index string array. 149 * Anonymous Object Rectification. 150 * 151 * @type { Array<string> } 152 * @syscap SystemCapability.ArkUI.ArkUI.Full 153 * @crossplatform 154 * @atomicservice 155 * @since 18 156 */ 157 arrayValue: Array<string>; 158 /** 159 * ID of the selected item. 160 * 161 * @type { number } 162 * @syscap SystemCapability.ArkUI.ArkUI.Full 163 * @since 7 164 */ 165 /** 166 * ID of the selected item. 167 * 168 * @type { number } 169 * @syscap SystemCapability.ArkUI.ArkUI.Full 170 * @crossplatform 171 * @since 10 172 */ 173 /** 174 * ID of the selected item. 175 * 176 * @type { number } 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @crossplatform 179 * @atomicservice 180 * @since 11 181 */ 182 /** 183 * ID of the selected item. 184 * Anonymous Object Rectification. 185 * 186 * @type { number } 187 * @syscap SystemCapability.ArkUI.ArkUI.Full 188 * @crossplatform 189 * @atomicservice 190 * @since 18 191 */ 192 selected: number; 193} 194 195/** 196 * Alphabet index bar. 197 * 198 * @interface AlphabetIndexerInterface 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @since 7 201 */ 202/** 203 * Alphabet index bar. 204 * 205 * @interface AlphabetIndexerInterface 206 * @syscap SystemCapability.ArkUI.ArkUI.Full 207 * @crossplatform 208 * @since 10 209 */ 210/** 211 * Alphabet index bar. 212 * 213 * @interface AlphabetIndexerInterface 214 * @syscap SystemCapability.ArkUI.ArkUI.Full 215 * @crossplatform 216 * @atomicservice 217 * @since 11 218 */ 219interface AlphabetIndexerInterface { 220 /** 221 * ArrayValue: Alphabetical index string array. 222 * selected: ID of the selected item. 223 * 224 * @param { object } value 225 * @returns { AlphabetIndexerAttribute } 226 * @syscap SystemCapability.ArkUI.ArkUI.Full 227 * @since 7 228 */ 229 /** 230 * ArrayValue: Alphabetical index string array. 231 * selected: ID of the selected item. 232 * 233 * @param { object } value 234 * @returns { AlphabetIndexerAttribute } 235 * @syscap SystemCapability.ArkUI.ArkUI.Full 236 * @crossplatform 237 * @since 10 238 */ 239 /** 240 * ArrayValue: Alphabetical index string array. 241 * selected: ID of the selected item. 242 * 243 * @param { object } value 244 * @returns { AlphabetIndexerAttribute } 245 * @syscap SystemCapability.ArkUI.ArkUI.Full 246 * @crossplatform 247 * @atomicservice 248 * @since 11 249 */ 250 /** 251 * Construct the alphabet indexer component. 252 * Called when the alphabet indexer component is used. 253 * Anonymous Object Rectification. 254 * 255 * @param { AlphabetIndexerOptions } options - alphabet indexer options 256 * @returns { AlphabetIndexerAttribute } 257 * @syscap SystemCapability.ArkUI.ArkUI.Full 258 * @crossplatform 259 * @atomicservice 260 * @since 18 261 */ 262 (options: AlphabetIndexerOptions): AlphabetIndexerAttribute; 263} 264 265/** 266 * Defines an AlphabetIndexer callback when onSelect. 267 * 268 * @typedef { function } OnAlphabetIndexerSelectCallback 269 * @param { number } index - selected index 270 * @syscap SystemCapability.ArkUI.ArkUI.Full 271 * @crossplatform 272 * @atomicservice 273 * @since 18 274 */ 275declare type OnAlphabetIndexerSelectCallback = (index: number) => void; 276 277/** 278 * Defines an AlphabetIndexer callback when onPopupSelect. 279 * 280 * @typedef { function } OnAlphabetIndexerPopupSelectCallback 281 * @param { number } index - selected index 282 * @syscap SystemCapability.ArkUI.ArkUI.Full 283 * @crossplatform 284 * @atomicservice 285 * @since 18 286 */ 287declare type OnAlphabetIndexerPopupSelectCallback = (index: number) => void; 288 289/** 290 * Defines an AlphabetIndexer callback when onRequestPopupData. 291 * 292 * @typedef { function } OnAlphabetIndexerRequestPopupDataCallback 293 * @param { number } index - selected index 294 * @returns { Array<string> } string array corresponding to the index 295 * @syscap SystemCapability.ArkUI.ArkUI.Full 296 * @crossplatform 297 * @atomicservice 298 * @since 18 299 */ 300declare type OnAlphabetIndexerRequestPopupDataCallback = (index: number) => Array<string>; 301 302/** 303 * Defines the alphabet index bar attribute functions. 304 * 305 * @extends CommonMethod<AlphabetIndexerAttribute> 306 * @syscap SystemCapability.ArkUI.ArkUI.Full 307 * @since 7 308 */ 309/** 310 * Defines the alphabet index bar attribute functions. 311 * 312 * @extends CommonMethod<AlphabetIndexerAttribute> 313 * @syscap SystemCapability.ArkUI.ArkUI.Full 314 * @crossplatform 315 * @since 10 316 */ 317/** 318 * Defines the alphabet index bar attribute functions. 319 * 320 * @extends CommonMethod<AlphabetIndexerAttribute> 321 * @syscap SystemCapability.ArkUI.ArkUI.Full 322 * @crossplatform 323 * @atomicservice 324 * @since 11 325 */ 326declare class AlphabetIndexerAttribute extends CommonMethod<AlphabetIndexerAttribute> { 327 /** 328 * Index bar selection callback. 329 * 330 * @param { function } callback 331 * @returns { AlphabetIndexerAttribute } 332 * @syscap SystemCapability.ArkUI.ArkUI.Full 333 * @since 7 334 * @deprecated since 8 335 * @useinstead onSelect 336 */ 337 onSelected(callback: (index: number) => void): AlphabetIndexerAttribute; 338 339 /** 340 * Definitions color. 341 * 342 * @param { ResourceColor } value 343 * @returns { AlphabetIndexerAttribute } 344 * @syscap SystemCapability.ArkUI.ArkUI.Full 345 * @since 7 346 */ 347 /** 348 * Definitions color. 349 * 350 * @param { ResourceColor } value 351 * @returns { AlphabetIndexerAttribute } 352 * @syscap SystemCapability.ArkUI.ArkUI.Full 353 * @crossplatform 354 * @since 10 355 */ 356 /** 357 * Definitions color. 358 * 359 * @param { ResourceColor } value 360 * @returns { AlphabetIndexerAttribute } 361 * @syscap SystemCapability.ArkUI.ArkUI.Full 362 * @crossplatform 363 * @atomicservice 364 * @since 11 365 */ 366 color(value: ResourceColor): AlphabetIndexerAttribute; 367 368 /** 369 * Select the text color. 370 * 371 * @param { ResourceColor } value 372 * @returns { AlphabetIndexerAttribute } 373 * @syscap SystemCapability.ArkUI.ArkUI.Full 374 * @since 7 375 */ 376 /** 377 * Select the text color. 378 * 379 * @param { ResourceColor } value 380 * @returns { AlphabetIndexerAttribute } 381 * @syscap SystemCapability.ArkUI.ArkUI.Full 382 * @crossplatform 383 * @since 10 384 */ 385 /** 386 * Select the text color. 387 * 388 * @param { ResourceColor } value 389 * @returns { AlphabetIndexerAttribute } 390 * @syscap SystemCapability.ArkUI.ArkUI.Full 391 * @crossplatform 392 * @atomicservice 393 * @since 11 394 */ 395 selectedColor(value: ResourceColor): AlphabetIndexerAttribute; 396 397 /** 398 * Font color of the pop-up prompt text. 399 * 400 * @param { ResourceColor } value 401 * @returns { AlphabetIndexerAttribute } 402 * @syscap SystemCapability.ArkUI.ArkUI.Full 403 * @since 7 404 */ 405 /** 406 * Font color of the pop-up prompt text. 407 * 408 * @param { ResourceColor } value 409 * @returns { AlphabetIndexerAttribute } 410 * @syscap SystemCapability.ArkUI.ArkUI.Full 411 * @crossplatform 412 * @since 10 413 */ 414 /** 415 * Font color of the pop-up prompt text. 416 * 417 * @param { ResourceColor } value 418 * @returns { AlphabetIndexerAttribute } 419 * @syscap SystemCapability.ArkUI.ArkUI.Full 420 * @crossplatform 421 * @atomicservice 422 * @since 11 423 */ 424 popupColor(value: ResourceColor): AlphabetIndexerAttribute; 425 426 /** 427 * Select the text background color. 428 * 429 * @param { ResourceColor } value 430 * @returns { AlphabetIndexerAttribute } 431 * @syscap SystemCapability.ArkUI.ArkUI.Full 432 * @since 7 433 */ 434 /** 435 * Select the text background color. 436 * 437 * @param { ResourceColor } value 438 * @returns { AlphabetIndexerAttribute } 439 * @syscap SystemCapability.ArkUI.ArkUI.Full 440 * @crossplatform 441 * @since 10 442 */ 443 /** 444 * Select the text background color. 445 * 446 * @param { ResourceColor } value 447 * @returns { AlphabetIndexerAttribute } 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @crossplatform 450 * @atomicservice 451 * @since 11 452 */ 453 selectedBackgroundColor(value: ResourceColor): AlphabetIndexerAttribute; 454 455 /** 456 * Background color of the pop-up window index. 457 * 458 * @param { ResourceColor } value 459 * @returns { AlphabetIndexerAttribute } 460 * @syscap SystemCapability.ArkUI.ArkUI.Full 461 * @since 7 462 */ 463 /** 464 * Background color of the pop-up window index. 465 * 466 * @param { ResourceColor } value 467 * @returns { AlphabetIndexerAttribute } 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @crossplatform 470 * @since 10 471 */ 472 /** 473 * Background color of the pop-up window index. 474 * 475 * @param { ResourceColor } value 476 * @returns { AlphabetIndexerAttribute } 477 * @syscap SystemCapability.ArkUI.ArkUI.Full 478 * @crossplatform 479 * @atomicservice 480 * @since 11 481 */ 482 popupBackground(value: ResourceColor): AlphabetIndexerAttribute; 483 484 /** 485 * Set the selected font color of non-alphabetic part of the pop-up window. 486 * 487 * @param { ResourceColor } value - indicates the color of the selected font. 488 * @returns { AlphabetIndexerAttribute } 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @crossplatform 491 * @since 10 492 */ 493 /** 494 * Set the selected font color of non-alphabetic part of the pop-up window. 495 * 496 * @param { ResourceColor } value - indicates the color of the selected font. 497 * @returns { AlphabetIndexerAttribute } 498 * @syscap SystemCapability.ArkUI.ArkUI.Full 499 * @crossplatform 500 * @atomicservice 501 * @since 11 502 */ 503 popupSelectedColor(value: ResourceColor): AlphabetIndexerAttribute; 504 505 /** 506 * Set the unselected font color of non-alphabetic part of the pop-up window. 507 * 508 * @param { ResourceColor } value - indicates the color of the unselected font. 509 * @returns { AlphabetIndexerAttribute } 510 * @syscap SystemCapability.ArkUI.ArkUI.Full 511 * @crossplatform 512 * @since 10 513 */ 514 /** 515 * Set the unselected font color of non-alphabetic part of the pop-up window. 516 * 517 * @param { ResourceColor } value - indicates the color of the unselected font. 518 * @returns { AlphabetIndexerAttribute } 519 * @syscap SystemCapability.ArkUI.ArkUI.Full 520 * @crossplatform 521 * @atomicservice 522 * @since 11 523 */ 524 popupUnselectedColor(value: ResourceColor): AlphabetIndexerAttribute; 525 526 /** 527 * Set the background color of non-alphabetic part of the pop-up window. 528 * 529 * @param { ResourceColor } value - indicates the color of background. 530 * @returns { AlphabetIndexerAttribute } 531 * @syscap SystemCapability.ArkUI.ArkUI.Full 532 * @crossplatform 533 * @since 10 534 */ 535 /** 536 * Set the background color of non-alphabetic part of the pop-up window. 537 * 538 * @param { ResourceColor } value - indicates the color of background. 539 * @returns { AlphabetIndexerAttribute } 540 * @syscap SystemCapability.ArkUI.ArkUI.Full 541 * @crossplatform 542 * @atomicservice 543 * @since 11 544 */ 545 popupItemBackgroundColor(value: ResourceColor): AlphabetIndexerAttribute; 546 547 /** 548 * Whether to use pop-up index hints. 549 * 550 * @param { boolean } value 551 * @returns { AlphabetIndexerAttribute } 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @since 7 554 */ 555 /** 556 * Whether to use pop-up index hints. 557 * 558 * @param { boolean } value 559 * @returns { AlphabetIndexerAttribute } 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @crossplatform 562 * @since 10 563 */ 564 /** 565 * Whether to use pop-up index hints. 566 * 567 * @param { boolean } value 568 * @returns { AlphabetIndexerAttribute } 569 * @syscap SystemCapability.ArkUI.ArkUI.Full 570 * @crossplatform 571 * @atomicservice 572 * @since 11 573 */ 574 usingPopup(value: boolean): AlphabetIndexerAttribute; 575 576 /** 577 * Select the text text style, 578 * 579 * @param { Font } value 580 * @returns { AlphabetIndexerAttribute } 581 * @syscap SystemCapability.ArkUI.ArkUI.Full 582 * @since 7 583 */ 584 /** 585 * Select the text text style, 586 * 587 * @param { Font } value 588 * @returns { AlphabetIndexerAttribute } 589 * @syscap SystemCapability.ArkUI.ArkUI.Full 590 * @crossplatform 591 * @since 10 592 */ 593 /** 594 * Select the text text style, 595 * 596 * @param { Font } value 597 * @returns { AlphabetIndexerAttribute } 598 * @syscap SystemCapability.ArkUI.ArkUI.Full 599 * @crossplatform 600 * @atomicservice 601 * @since 11 602 */ 603 selectedFont(value: Font): AlphabetIndexerAttribute; 604 605 /** 606 * Select the text background color. 607 * 608 * @param { Font } value 609 * @returns { AlphabetIndexerAttribute } 610 * @syscap SystemCapability.ArkUI.ArkUI.Full 611 * @since 7 612 */ 613 /** 614 * Select the text background color. 615 * 616 * @param { Font } value 617 * @returns { AlphabetIndexerAttribute } 618 * @syscap SystemCapability.ArkUI.ArkUI.Full 619 * @crossplatform 620 * @since 10 621 */ 622 /** 623 * Select the text background color. 624 * 625 * @param { Font } value 626 * @returns { AlphabetIndexerAttribute } 627 * @syscap SystemCapability.ArkUI.ArkUI.Full 628 * @crossplatform 629 * @atomicservice 630 * @since 11 631 */ 632 popupFont(value: Font): AlphabetIndexerAttribute; 633 634 /** 635 * Set the font style of non-alphabetic part of the prompt pop-up window. 636 * Family and style are not supported currently and will be fixed in future. 637 * 638 * @param { Font } value - indicates the style of the font. 639 * @returns { AlphabetIndexerAttribute } 640 * @syscap SystemCapability.ArkUI.ArkUI.Full 641 * @crossplatform 642 * @since 10 643 */ 644 /** 645 * Set the font style of non-alphabetic part of the prompt pop-up window. 646 * Family and style are not supported currently and will be fixed in future. 647 * 648 * @param { Font } value - indicates the style of the font. 649 * @returns { AlphabetIndexerAttribute } 650 * @syscap SystemCapability.ArkUI.ArkUI.Full 651 * @crossplatform 652 * @atomicservice 653 * @since 11 654 */ 655 popupItemFont(value: Font): AlphabetIndexerAttribute; 656 657 /** 658 * Size of the letter area on the letter index bar. The letter area is a square. Set the length of the square side. 659 * 660 * @param { string | number } value 661 * @returns { AlphabetIndexerAttribute } 662 * @syscap SystemCapability.ArkUI.ArkUI.Full 663 * @since 7 664 */ 665 /** 666 * Size of the letter area on the letter index bar. The letter area is a square. Set the length of the square side. 667 * 668 * @param { string | number } value 669 * @returns { AlphabetIndexerAttribute } 670 * @syscap SystemCapability.ArkUI.ArkUI.Full 671 * @crossplatform 672 * @since 10 673 */ 674 /** 675 * Size of the letter area on the letter index bar. The letter area is a square. Set the length of the square side. 676 * 677 * @param { string | number } value 678 * @returns { AlphabetIndexerAttribute } 679 * @syscap SystemCapability.ArkUI.ArkUI.Full 680 * @crossplatform 681 * @atomicservice 682 * @since 11 683 */ 684 itemSize(value: string | number): AlphabetIndexerAttribute; 685 686 /** 687 * Definitions fonts. 688 * 689 * @param { Font } value 690 * @returns { AlphabetIndexerAttribute } 691 * @syscap SystemCapability.ArkUI.ArkUI.Full 692 * @since 7 693 */ 694 /** 695 * Definitions fonts. 696 * 697 * @param { Font } value 698 * @returns { AlphabetIndexerAttribute } 699 * @syscap SystemCapability.ArkUI.ArkUI.Full 700 * @crossplatform 701 * @since 10 702 */ 703 /** 704 * Definitions fonts. 705 * 706 * @param { Font } value 707 * @returns { AlphabetIndexerAttribute } 708 * @syscap SystemCapability.ArkUI.ArkUI.Full 709 * @crossplatform 710 * @atomicservice 711 * @since 11 712 */ 713 font(value: Font): AlphabetIndexerAttribute; 714 715 /** 716 * Alphabet index bar alignment style. The left and right alignment styles are supported, 717 * which affects the pop-up position of the pop-up window. 718 * 719 * @param { IndexerAlign } value - indicates the alignment style of Alphabet index. 720 * @returns { AlphabetIndexerAttribute } 721 * @syscap SystemCapability.ArkUI.ArkUI.Full 722 * @since 7 723 */ 724 /** 725 * Alphabet index bar alignment style. The left and right alignment styles are supported, 726 * which affects the pop-up position of the pop-up window. 727 * 728 * @param { IndexerAlign } value - indicates the alignment style of Alphabet index. 729 * @param { Length } [offset] - indicates the horizontal space between pop-up window and indexer bar. 730 * @returns { AlphabetIndexerAttribute } 731 * @syscap SystemCapability.ArkUI.ArkUI.Full 732 * @crossplatform 733 * @since 10 734 */ 735 /** 736 * Alphabet index bar alignment style. The left and right alignment styles are supported, 737 * which affects the pop-up position of the pop-up window. 738 * 739 * @param { IndexerAlign } value - indicates the alignment style of Alphabet index. 740 * @param { Length } [offset] - indicates the horizontal space between pop-up window and indexer bar. 741 * @returns { AlphabetIndexerAttribute } 742 * @syscap SystemCapability.ArkUI.ArkUI.Full 743 * @crossplatform 744 * @atomicservice 745 * @since 11 746 */ 747 alignStyle(value: IndexerAlign, offset?: Length): AlphabetIndexerAttribute; 748 749 /** 750 * Index bar selection callback. 751 * 752 * @param { function } callback 753 * @returns { AlphabetIndexerAttribute } 754 * @syscap SystemCapability.ArkUI.ArkUI.Full 755 * @since 8 756 */ 757 /** 758 * Index bar selection callback. 759 * 760 * @param { function } callback 761 * @returns { AlphabetIndexerAttribute } 762 * @syscap SystemCapability.ArkUI.ArkUI.Full 763 * @crossplatform 764 * @since 10 765 */ 766 /** 767 * Index bar selection callback. 768 * 769 * @param { function } callback 770 * @returns { AlphabetIndexerAttribute } 771 * @syscap SystemCapability.ArkUI.ArkUI.Full 772 * @crossplatform 773 * @atomicservice 774 * @since 11 775 */ 776 /** 777 * Index bar selection callback. 778 * Anonymous Object Rectification. 779 * 780 * @param { OnAlphabetIndexerSelectCallback } callback 781 * @returns { AlphabetIndexerAttribute } 782 * @syscap SystemCapability.ArkUI.ArkUI.Full 783 * @crossplatform 784 * @atomicservice 785 * @since 18 786 */ 787 onSelect(callback: OnAlphabetIndexerSelectCallback): AlphabetIndexerAttribute; 788 789 /** 790 * Index bar selection callback and return the strings which display on pop-up. 791 * 792 * @param { function } callback 793 * @returns { AlphabetIndexerAttribute } 794 * @syscap SystemCapability.ArkUI.ArkUI.Full 795 * @since 8 796 */ 797 /** 798 * Index bar selection callback and return the strings which display on pop-up. 799 * 800 * @param { function } callback 801 * @returns { AlphabetIndexerAttribute } 802 * @syscap SystemCapability.ArkUI.ArkUI.Full 803 * @crossplatform 804 * @since 10 805 */ 806 /** 807 * Index bar selection callback and return the strings which display on pop-up. 808 * 809 * @param { function } callback 810 * @returns { AlphabetIndexerAttribute } 811 * @syscap SystemCapability.ArkUI.ArkUI.Full 812 * @crossplatform 813 * @atomicservice 814 * @since 11 815 */ 816 /** 817 * Index bar selection callback and return the strings which display on pop-up. 818 * Anonymous Object Rectification. 819 * 820 * @param { OnAlphabetIndexerRequestPopupDataCallback } callback 821 * @returns { AlphabetIndexerAttribute } 822 * @syscap SystemCapability.ArkUI.ArkUI.Full 823 * @crossplatform 824 * @atomicservice 825 * @since 18 826 */ 827 onRequestPopupData(callback: OnAlphabetIndexerRequestPopupDataCallback): AlphabetIndexerAttribute; 828 829 /** 830 * Pop-up selection callback. 831 * 832 * @param { function } callback 833 * @returns { AlphabetIndexerAttribute } 834 * @syscap SystemCapability.ArkUI.ArkUI.Full 835 * @since 8 836 */ 837 /** 838 * Pop-up selection callback. 839 * 840 * @param { function } callback 841 * @returns { AlphabetIndexerAttribute } 842 * @syscap SystemCapability.ArkUI.ArkUI.Full 843 * @crossplatform 844 * @since 10 845 */ 846 /** 847 * Pop-up selection callback. 848 * 849 * @param { function } callback 850 * @returns { AlphabetIndexerAttribute } 851 * @syscap SystemCapability.ArkUI.ArkUI.Full 852 * @crossplatform 853 * @atomicservice 854 * @since 11 855 */ 856 /** 857 * Pop-up selection callback. 858 * Anonymous Object Rectification. 859 * 860 * @param { OnAlphabetIndexerPopupSelectCallback } callback 861 * @returns { AlphabetIndexerAttribute } 862 * @syscap SystemCapability.ArkUI.ArkUI.Full 863 * @crossplatform 864 * @atomicservice 865 * @since 18 866 */ 867 onPopupSelect(callback: OnAlphabetIndexerPopupSelectCallback): AlphabetIndexerAttribute; 868 869 /** 870 * Sets the selected index. 871 * 872 * @param { number } index 873 * @returns { AlphabetIndexerAttribute } 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @since 8 876 */ 877 /** 878 * Sets the selected index. 879 * 880 * @param { number } index 881 * @returns { AlphabetIndexerAttribute } 882 * @syscap SystemCapability.ArkUI.ArkUI.Full 883 * @crossplatform 884 * @since 10 885 */ 886 /** 887 * Sets the selected index. 888 * 889 * @param { number } index 890 * @returns { AlphabetIndexerAttribute } 891 * @syscap SystemCapability.ArkUI.ArkUI.Full 892 * @crossplatform 893 * @atomicservice 894 * @since 11 895 */ 896 selected(index: number): AlphabetIndexerAttribute; 897 898 /** 899 * Position of the pop-up windows, relative to the midpoint of the top border of the indexer bar. 900 * 901 * @param { Position } value 902 * @returns { AlphabetIndexerAttribute } 903 * @syscap SystemCapability.ArkUI.ArkUI.Full 904 * @since 8 905 */ 906 /** 907 * Position of the pop-up windows, relative to the midpoint of the top border of the indexer bar. 908 * 909 * @param { Position } value 910 * @returns { AlphabetIndexerAttribute } 911 * @syscap SystemCapability.ArkUI.ArkUI.Full 912 * @crossplatform 913 * @since 10 914 */ 915 /** 916 * Position of the pop-up windows, relative to the midpoint of the top border of the indexer bar. 917 * 918 * @param { Position } value 919 * @returns { AlphabetIndexerAttribute } 920 * @syscap SystemCapability.ArkUI.ArkUI.Full 921 * @crossplatform 922 * @atomicservice 923 * @since 11 924 */ 925 popupPosition(value: Position): AlphabetIndexerAttribute; 926 927 /** 928 * Automatically collapses the characters when the indexer bar not high enough to display all characters. 929 * 930 * @param { boolean } value - A boolean value determines whether auto collapses is enabled for indexer bar. 931 * @returns { AlphabetIndexerAttribute } 932 * @syscap SystemCapability.ArkUI.ArkUI.Full 933 * @crossplatform 934 * @since 11 935 */ 936 /** 937 * Automatically collapses the characters when the indexer bar not high enough to display all characters. 938 * 939 * @param { boolean } value - A boolean value determines whether auto collapses is enabled for indexer bar. 940 * @returns { AlphabetIndexerAttribute } 941 * @syscap SystemCapability.ArkUI.ArkUI.Full 942 * @crossplatform 943 * @atomicservice 944 * @since 12 945 */ 946 autoCollapse(value: boolean): AlphabetIndexerAttribute; 947 948 /** 949 * Set the radius of the item of the pop-up window. 950 * 951 * @param { number } value 952 * @returns { AlphabetIndexerAttribute } 953 * @syscap SystemCapability.ArkUI.ArkUI.Full 954 * @crossplatform 955 * @atomicservice 956 * @since 12 957 */ 958 popupItemBorderRadius(value: number): AlphabetIndexerAttribute; 959 960 /** 961 * Set the radius of the item of the indexer. 962 * 963 * @param { number } value 964 * @returns { AlphabetIndexerAttribute } 965 * @syscap SystemCapability.ArkUI.ArkUI.Full 966 * @crossplatform 967 * @atomicservice 968 * @since 12 969 */ 970 itemBorderRadius(value: number): AlphabetIndexerAttribute; 971 972 /** 973 * Set the background blurStyle of title of the pop-up window. 974 * 975 * @param { BlurStyle } value 976 * @returns { AlphabetIndexerAttribute } 977 * @syscap SystemCapability.ArkUI.ArkUI.Full 978 * @crossplatform 979 * @atomicservice 980 * @since 12 981 */ 982 popupBackgroundBlurStyle(value: BlurStyle): AlphabetIndexerAttribute; 983 984 /** 985 * Set the background color of title of the pop-up window. 986 * 987 * @param { ResourceColor } value 988 * @returns { AlphabetIndexerAttribute } 989 * @syscap SystemCapability.ArkUI.ArkUI.Full 990 * @crossplatform 991 * @atomicservice 992 * @since 12 993 */ 994 popupTitleBackground(value: ResourceColor): AlphabetIndexerAttribute; 995 996 /** 997 * Enable or disable haptic feedback. 998 * 999 * @param { boolean } value - Default value is true, set false to disable haptic feedback. 1000 * @returns { AlphabetIndexerAttribute } 1001 * @syscap SystemCapability.ArkUI.ArkUI.Full 1002 * @atomicservice 1003 * @since 12 1004 */ 1005 enableHapticFeedback(value: boolean): AlphabetIndexerAttribute; 1006} 1007 1008/** 1009 * Defines AlphabetIndexer Component. 1010 * 1011 * @syscap SystemCapability.ArkUI.ArkUI.Full 1012 * @since 7 1013 */ 1014/** 1015 * Defines AlphabetIndexer Component. 1016 * 1017 * @syscap SystemCapability.ArkUI.ArkUI.Full 1018 * @crossplatform 1019 * @since 10 1020 */ 1021/** 1022 * Defines AlphabetIndexer Component. 1023 * 1024 * @syscap SystemCapability.ArkUI.ArkUI.Full 1025 * @crossplatform 1026 * @atomicservice 1027 * @since 11 1028 */ 1029declare const AlphabetIndexer: AlphabetIndexerInterface; 1030 1031/** 1032 * Defines AlphabetIndexer Component instance. 1033 * 1034 * @syscap SystemCapability.ArkUI.ArkUI.Full 1035 * @since 7 1036 */ 1037/** 1038 * Defines AlphabetIndexer Component instance. 1039 * 1040 * @syscap SystemCapability.ArkUI.ArkUI.Full 1041 * @crossplatform 1042 * @since 10 1043 */ 1044/** 1045 * Defines AlphabetIndexer Component instance. 1046 * 1047 * @syscap SystemCapability.ArkUI.ArkUI.Full 1048 * @crossplatform 1049 * @atomicservice 1050 * @since 11 1051 */ 1052declare const AlphabetIndexerInstance: AlphabetIndexerAttribute; 1053