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 * Declare scroll status 18 * 19 * @enum { number } 20 * @syscap SystemCapability.ArkUI.ArkUI.Full 21 * @since 7 22 */ 23/** 24 * Declare scroll status 25 * 26 * @enum { number } 27 * @syscap SystemCapability.ArkUI.ArkUI.Full 28 * @since 9 29 * @form 30 */ 31/** 32 * Declare scroll status 33 * 34 * @enum { number } 35 * @syscap SystemCapability.ArkUI.ArkUI.Full 36 * @crossplatform 37 * @since 10 38 * @form 39 */ 40declare enum ScrollState { 41 /** 42 * Not activated. 43 * 44 * @syscap SystemCapability.ArkUI.ArkUI.Full 45 * @since 7 46 */ 47 /** 48 * Not activated. 49 * 50 * @syscap SystemCapability.ArkUI.ArkUI.Full 51 * @since 9 52 * @form 53 */ 54 /** 55 * Not activated. 56 * 57 * @syscap SystemCapability.ArkUI.ArkUI.Full 58 * @crossplatform 59 * @since 10 60 * @form 61 */ 62 Idle, 63 64 /** 65 * Scrolling status. 66 * 67 * @syscap SystemCapability.ArkUI.ArkUI.Full 68 * @since 7 69 */ 70 /** 71 * Scrolling status. 72 * 73 * @syscap SystemCapability.ArkUI.ArkUI.Full 74 * @since 9 75 * @form 76 */ 77 /** 78 * Scrolling status. 79 * 80 * @syscap SystemCapability.ArkUI.ArkUI.Full 81 * @crossplatform 82 * @since 10 83 * @form 84 */ 85 Scroll, 86 87 /** 88 * Drag status. 89 * 90 * @syscap SystemCapability.ArkUI.ArkUI.Full 91 * @since 7 92 */ 93 /** 94 * Drag status. 95 * 96 * @syscap SystemCapability.ArkUI.ArkUI.Full 97 * @since 9 98 * @form 99 */ 100 /** 101 * Drag status. 102 * 103 * @syscap SystemCapability.ArkUI.ArkUI.Full 104 * @crossplatform 105 * @since 10 106 * @form 107 */ 108 Fling, 109} 110 111/** 112 * Declare list item alignment status 113 * 114 * @enum { number } 115 * @syscap SystemCapability.ArkUI.ArkUI.Full 116 * @since 9 117 * @form 118 */ 119/** 120 * Declare list item alignment status 121 * 122 * @enum { number } 123 * @syscap SystemCapability.ArkUI.ArkUI.Full 124 * @crossplatform 125 * @since 10 126 * @form 127 */ 128declare enum ListItemAlign { 129 /** 130 * Start position in the direction of cross axis. 131 * 132 * @syscap SystemCapability.ArkUI.ArkUI.Full 133 * @since 9 134 * @form 135 */ 136 /** 137 * Start position in the direction of cross axis. 138 * 139 * @syscap SystemCapability.ArkUI.ArkUI.Full 140 * @crossplatform 141 * @since 10 142 * @form 143 */ 144 Start, 145 146 /** 147 * Center position in the direction of cross axis. 148 * 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @since 9 151 * @form 152 */ 153 /** 154 * Center position in the direction of cross axis. 155 * 156 * @syscap SystemCapability.ArkUI.ArkUI.Full 157 * @crossplatform 158 * @since 10 159 * @form 160 */ 161 Center, 162 163 /** 164 * End position in the direction of cross axis 165 * 166 * @syscap SystemCapability.ArkUI.ArkUI.Full 167 * @since 9 168 * @form 169 */ 170 /** 171 * End position in the direction of cross axis 172 * 173 * @syscap SystemCapability.ArkUI.ArkUI.Full 174 * @crossplatform 175 * @since 10 176 * @form 177 */ 178 End, 179} 180 181/** 182 * Declare item group sticky style. 183 * 184 * @enum { number } 185 * @syscap SystemCapability.ArkUI.ArkUI.Full 186 * @since 9 187 * @form 188 */ 189/** 190 * Declare item group sticky style. 191 * 192 * @enum { number } 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @crossplatform 195 * @since 10 196 * @form 197 */ 198declare enum StickyStyle { 199 /** 200 * The header and footer of each item group will not be pinned. 201 * 202 * @syscap SystemCapability.ArkUI.ArkUI.Full 203 * @since 9 204 * @form 205 */ 206 /** 207 * The header and footer of each item group will not be pinned. 208 * 209 * @syscap SystemCapability.ArkUI.ArkUI.Full 210 * @crossplatform 211 * @since 10 212 * @form 213 */ 214 None = 0, 215 216 /** 217 * The header of each item group will be pinned. 218 * 219 * @syscap SystemCapability.ArkUI.ArkUI.Full 220 * @since 9 221 * @form 222 */ 223 /** 224 * The header of each item group will be pinned. 225 * 226 * @syscap SystemCapability.ArkUI.ArkUI.Full 227 * @crossplatform 228 * @since 10 229 * @form 230 */ 231 Header = 1, 232 233 /** 234 * The footer of each item group will be pinned. 235 * 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @since 9 238 * @form 239 */ 240 /** 241 * The footer of each item group will be pinned. 242 * 243 * @syscap SystemCapability.ArkUI.ArkUI.Full 244 * @crossplatform 245 * @since 10 246 * @form 247 */ 248 Footer = 2, 249} 250 251/** 252 * Declare edge effect of chain animation. 253 * 254 * @enum { number } 255 * @syscap SystemCapability.ArkUI.ArkUI.Full 256 * @systemapi 257 * @since 10 258 */ 259declare enum ChainEdgeEffect { 260 /** 261 * Default edge effect. Compress the space in the drag direction 262 * and stretch the space in the opposite drag direction. 263 * 264 * @syscap SystemCapability.ArkUI.ArkUI.Full 265 * @systemapi 266 * @since 10 267 */ 268 DEFAULT, 269 270 /** 271 * Stretch all space. 272 * 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @systemapi 275 * @since 10 276 */ 277 STRETCH, 278} 279 280/** 281 * Declare limited position when scroll end. 282 * 283 * @enum { number } 284 * @syscap SystemCapability.ArkUI.ArkUI.Full 285 * @since 10 286 */ 287declare enum ScrollSnapAlign { 288 /** 289 * Default no item scroll snap alignment effect. When scroll end, 290 * list item will stop without limit. 291 * 292 * @syscap SystemCapability.ArkUI.ArkUI.Full 293 * @since 10 294 */ 295 NONE, 296 297 /** 298 * The first item in view will be aligned at the start of list. 299 * 300 * @syscap SystemCapability.ArkUI.ArkUI.Full 301 * @since 10 302 */ 303 START, 304 305 /** 306 * The middle item in view will be aligned at the center of list. 307 * 308 * @syscap SystemCapability.ArkUI.ArkUI.Full 309 * @since 10 310 */ 311 CENTER, 312 313 /** 314 * The last item in view will be aligned at the end of list. 315 * 316 * @syscap SystemCapability.ArkUI.ArkUI.Full 317 * @since 10 318 */ 319 END, 320} 321 322/** 323 * Defines the chain animation options. 324 * 325 * @interface ChainAnimationOptions 326 * @syscap SystemCapability.ArkUI.ArkUI.Full 327 * @systemapi 328 * @since 10 329 */ 330declare interface ChainAnimationOptions { 331 /** 332 * Minimum space for chain animation. 333 * 334 * @type { Length } 335 * @syscap SystemCapability.ArkUI.ArkUI.Full 336 * @systemapi 337 * @since 10 338 */ 339 minSpace: Length; 340 341 /** 342 * Maximum space for chain animation. 343 * 344 * @type { Length } 345 * @syscap SystemCapability.ArkUI.ArkUI.Full 346 * @systemapi 347 * @since 10 348 */ 349 maxSpace: Length; 350 351 /** 352 * Conductivity of chain animation. 353 * 354 * @type { ?number } 355 * @default 0.7 356 * @syscap SystemCapability.ArkUI.ArkUI.Full 357 * @systemapi 358 * @since 10 359 */ 360 conductivity?: number; 361 362 /** 363 * Intensity of chain animation. 364 * 365 * @type { ?number } 366 * @default 0.3 367 * @syscap SystemCapability.ArkUI.ArkUI.Full 368 * @systemapi 369 * @since 10 370 */ 371 intensity?: number; 372 373 /** 374 * Edge effect of chain animation. 375 * 376 * @type { ?ChainEdgeEffect } 377 * @default ChainEdgeEffect.DEFAULT 378 * @syscap SystemCapability.ArkUI.ArkUI.Full 379 * @systemapi 380 * @since 10 381 */ 382 edgeEffect?: ChainEdgeEffect; 383 384 /** 385 * Stiffness of chain spring. 386 * 387 * @type { ?number } 388 * @default 228 389 * @syscap SystemCapability.ArkUI.ArkUI.Full 390 * @systemapi 391 * @since 10 392 */ 393 stiffness?: number; 394 395 /** 396 * Damping of chain spring. 397 * 398 * @type { ?number } 399 * @default 30 400 * @syscap SystemCapability.ArkUI.ArkUI.Full 401 * @systemapi 402 * @since 10 403 */ 404 damping?: number; 405} 406 407/** 408 * The list interface is extended. 409 * 410 * @interface ListInterface 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @since 7 413 */ 414/** 415 * The list interface is extended. 416 * 417 * @interface ListInterface 418 * @syscap SystemCapability.ArkUI.ArkUI.Full 419 * @since 9 420 * @form 421 */ 422/** 423 * The list interface is extended. 424 * 425 * @interface ListInterface 426 * @syscap SystemCapability.ArkUI.ArkUI.Full 427 * @crossplatform 428 * @since 10 429 * @form 430 */ 431interface ListInterface { 432 /** 433 * Called when interface data is called. 434 * 435 * @param { object } value 436 * @returns { ListAttribute } 437 * @syscap SystemCapability.ArkUI.ArkUI.Full 438 * @since 7 439 */ 440 /** 441 * Called when interface data is called. 442 * 443 * @param { object } value 444 * @returns { ListAttribute } 445 * @syscap SystemCapability.ArkUI.ArkUI.Full 446 * @since 9 447 * @form 448 */ 449 /** 450 * Called when interface data is called. 451 * 452 * @param { object } value 453 * @returns { ListAttribute } 454 * @syscap SystemCapability.ArkUI.ArkUI.Full 455 * @crossplatform 456 * @since 10 457 * @form 458 */ 459 (value?: { initialIndex?: number; space?: number | string; scroller?: Scroller }): ListAttribute; 460} 461 462/** 463 * @extends CommonMethod 464 * @syscap SystemCapability.ArkUI.ArkUI.Full 465 * @since 7 466 */ 467/** 468 * @extends CommonMethod 469 * @syscap SystemCapability.ArkUI.ArkUI.Full 470 * @since 9 471 * @form 472 */ 473/** 474 * @extends CommonMethod 475 * @syscap SystemCapability.ArkUI.ArkUI.Full 476 * @crossplatform 477 * @since 10 478 * @form 479 */ 480declare class ListAttribute extends CommonMethod<ListAttribute> { 481 /** 482 * Called when need to decide how much lanes the list will show. 483 * 484 * @param { number | LengthConstrain } value 485 * @param { Dimension } gutter 486 * @returns { ListAttribute } 487 * @syscap SystemCapability.ArkUI.ArkUI.Full 488 * @since 9 489 * @form 490 */ 491 /** 492 * Called when need to decide how much lanes the list will show. 493 * 494 * @param { number | LengthConstrain } value 495 * @param { Dimension } gutter 496 * @returns { ListAttribute } 497 * @syscap SystemCapability.ArkUI.ArkUI.Full 498 * @crossplatform 499 * @since 10 500 * @form 501 */ 502 lanes(value: number | LengthConstrain, gutter?: Dimension): ListAttribute; 503 504 /** 505 * Called when need to decide how to align lanes in the direction of the cross axis. 506 * 507 * @param { ListItemAlign } value 508 * @returns { ListAttribute } 509 * @syscap SystemCapability.ArkUI.ArkUI.Full 510 * @since 9 511 * @form 512 */ 513 /** 514 * Called when need to decide how to align lanes in the direction of the cross axis. 515 * 516 * @param { ListItemAlign } value 517 * @returns { ListAttribute } 518 * @syscap SystemCapability.ArkUI.ArkUI.Full 519 * @crossplatform 520 * @since 10 521 * @form 522 */ 523 alignListItem(value: ListItemAlign): ListAttribute; 524 525 /** 526 * Called when the arrangement direction of the list component is set. 527 * 528 * @param { Axis } value 529 * @returns { ListAttribute } 530 * @syscap SystemCapability.ArkUI.ArkUI.Full 531 * @since 7 532 */ 533 /** 534 * Called when the arrangement direction of the list component is set. 535 * 536 * @param { Axis } value 537 * @returns { ListAttribute } 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @since 9 540 * @form 541 */ 542 /** 543 * Called when the arrangement direction of the list component is set. 544 * 545 * @param { Axis } value 546 * @returns { ListAttribute } 547 * @syscap SystemCapability.ArkUI.ArkUI.Full 548 * @crossplatform 549 * @since 10 550 * @form 551 */ 552 listDirection(value: Axis): ListAttribute; 553 554 /** 555 * Called when the display mode of the side slider is set. 556 * 557 * @param { BarState } value 558 * @returns { ListAttribute } 559 * @syscap SystemCapability.ArkUI.ArkUI.Full 560 * @since 7 561 */ 562 /** 563 * Called when the display mode of the side slider is set. 564 * 565 * @param { BarState } value 566 * @returns { ListAttribute } 567 * @syscap SystemCapability.ArkUI.ArkUI.Full 568 * @since 9 569 * @form 570 */ 571 /** 572 * Called when the display mode of the side slider is set. 573 * 574 * @param { BarState } value 575 * @returns { ListAttribute } 576 * @syscap SystemCapability.ArkUI.ArkUI.Full 577 * @crossplatform 578 * @since 10 579 * @form 580 */ 581 scrollBar(value: BarState): ListAttribute; 582 583 /** 584 * Called when the sliding effect is set. 585 * 586 * @param { EdgeEffect } value 587 * @returns { ListAttribute } 588 * @syscap SystemCapability.ArkUI.ArkUI.Full 589 * @since 7 590 */ 591 /** 592 * Called when the sliding effect is set. 593 * 594 * @param { EdgeEffect } value 595 * @returns { ListAttribute } 596 * @syscap SystemCapability.ArkUI.ArkUI.Full 597 * @since 9 598 * @form 599 */ 600 /** 601 * Called when the sliding effect is set. 602 * 603 * @param { EdgeEffect } value 604 * @returns { ListAttribute } 605 * @syscap SystemCapability.ArkUI.ArkUI.Full 606 * @crossplatform 607 * @since 10 608 * @form 609 */ 610 edgeEffect(value: EdgeEffect): ListAttribute; 611 612 /** 613 * Called when the ListItem split line style is set. 614 * 615 * @param { object | null } value 616 * @returns { ListAttribute } 617 * @syscap SystemCapability.ArkUI.ArkUI.Full 618 * @since 7 619 */ 620 /** 621 * Called when the ListItem split line style is set. 622 * 623 * @param { {strokeWidth: Length;color?: ResourceColor;startMargin?: Length;endMargin?: Length;} | null } value 624 * @returns { ListAttribute } 625 * @syscap SystemCapability.ArkUI.ArkUI.Full 626 * @since 9 627 * @form 628 */ 629 /** 630 * Called when the ListItem split line style is set. 631 * 632 * @param { {strokeWidth: Length;color?: ResourceColor;startMargin?: Length;endMargin?: Length;} | null } value 633 * @returns { ListAttribute } 634 * @syscap SystemCapability.ArkUI.ArkUI.Full 635 * @crossplatform 636 * @since 10 637 * @form 638 */ 639 divider( 640 value: { 641 strokeWidth: Length; 642 color?: ResourceColor; 643 startMargin?: Length; 644 endMargin?: Length; 645 } | null, 646 ): ListAttribute; 647 648 /** 649 * Called when judging whether it is in editable mode. 650 * 651 * @param { boolean } value 652 * @returns { ListAttribute } 653 * @syscap SystemCapability.ArkUI.ArkUI.Full 654 * @since 7 655 * @deprecated since 9 656 */ 657 editMode(value: boolean): ListAttribute; 658 659 /** 660 * Called when judging whether it is multiSelectable. 661 * 662 * @param { boolean } value 663 * @returns { ListAttribute } 664 * @syscap SystemCapability.ArkUI.ArkUI.Full 665 * @since 8 666 */ 667 /** 668 * Called when judging whether it is multiSelectable. 669 * 670 * @param { boolean } value 671 * @returns { ListAttribute } 672 * @syscap SystemCapability.ArkUI.ArkUI.Full 673 * @since 9 674 * @form 675 */ 676 /** 677 * Called when judging whether it is multiSelectable. 678 * 679 * @param { boolean } value 680 * @returns { ListAttribute } 681 * @syscap SystemCapability.ArkUI.ArkUI.Full 682 * @crossplatform 683 * @since 10 684 * @form 685 */ 686 multiSelectable(value: boolean): ListAttribute; 687 688 /** 689 * Called when the minimum number of list item caches is set for long list deferred loading. 690 * 691 * @param { number } value 692 * @returns { ListAttribute } 693 * @syscap SystemCapability.ArkUI.ArkUI.Full 694 * @since 7 695 */ 696 /** 697 * Called when the minimum number of list item caches is set for long list deferred loading. 698 * 699 * @param { number } value 700 * @returns { ListAttribute } 701 * @syscap SystemCapability.ArkUI.ArkUI.Full 702 * @since 9 703 * @form 704 */ 705 /** 706 * Called when the minimum number of list item caches is set for long list deferred loading. 707 * 708 * @param { number } value 709 * @returns { ListAttribute } 710 * @syscap SystemCapability.ArkUI.ArkUI.Full 711 * @crossplatform 712 * @since 10 713 * @form 714 */ 715 cachedCount(value: number): ListAttribute; 716 717 /** 718 * Called when setting whether to enable chain linkage dynamic effect. 719 * 720 * @param { boolean } value 721 * @returns { ListAttribute } 722 * @syscap SystemCapability.ArkUI.ArkUI.Full 723 * @since 7 724 */ 725 /** 726 * Called when setting whether to enable chain linkage dynamic effect. 727 * 728 * @param { boolean } value 729 * @returns { ListAttribute } 730 * @syscap SystemCapability.ArkUI.ArkUI.Full 731 * @since 9 732 * @form 733 */ 734 /** 735 * Called when setting whether to enable chain linkage dynamic effect. 736 * 737 * @param { boolean } value 738 * @returns { ListAttribute } 739 * @syscap SystemCapability.ArkUI.ArkUI.Full 740 * @crossplatform 741 * @since 10 742 * @form 743 */ 744 chainAnimation(value: boolean): ListAttribute; 745 746 /** 747 * Called to setting chain linkage dynamic effect options. 748 * 749 * @param { ChainAnimationOptions } value - options of the chain animation. 750 * @returns { ListAttribute } the attribute of the list. 751 * @syscap SystemCapability.ArkUI.ArkUI.Full 752 * @systemapi 753 * @since 10 754 */ 755 chainAnimationOptions(value: ChainAnimationOptions): ListAttribute; 756 757 /** 758 * Called when header or footer of item group will be pinned. 759 * 760 * @param { StickyStyle } value 761 * @returns { ListAttribute } 762 * @syscap SystemCapability.ArkUI.ArkUI.Full 763 * @since 9 764 * @form 765 */ 766 /** 767 * Called when header or footer of item group will be pinned. 768 * 769 * @param { StickyStyle } value 770 * @returns { ListAttribute } 771 * @syscap SystemCapability.ArkUI.ArkUI.Full 772 * @crossplatform 773 * @since 10 774 * @form 775 */ 776 sticky(value: StickyStyle): ListAttribute; 777 778 /** 779 * Called to set list item scroll end alignment effect. 780 * 781 * @param { ScrollSnapAlign } value - options of the list alignment effect. 782 * @returns { ListAttribute } the attribute of the list. 783 * @syscap SystemCapability.ArkUI.ArkUI.Full 784 * @since 10 785 */ 786 scrollSnapAlign(value: ScrollSnapAlign): ListAttribute; 787 788 /** 789 * Called to setting the nested scroll options. 790 * 791 * @param { NestedScrollOptions } value - options for nested scrolling. 792 * @returns { ListAttribute } the attribute of the list. 793 * @syscap SystemCapability.ArkUI.ArkUI.Full 794 * @since 10 795 */ 796 nestedScroll(value: NestedScrollOptions): ListAttribute; 797 798 /** 799 * Called when setting whether to enable scroll by gesture or mouse. 800 * 801 * @param { boolean } value 802 * @returns { ListAttribute } The attribute of the list 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @crossplatform 805 * @since 10 806 */ 807 enableScrollInteraction(value: boolean): ListAttribute; 808 809 /** 810 * Called to setting the friction. 811 * 812 * @param { number | Resource } value - options for scrolling friction. 813 * @returns { ListAttribute } the attribute of the list. 814 * @syscap SystemCapability.ArkUI.ArkUI.Full 815 * @crossplatform 816 * @since 10 817 */ 818 friction(value: number | Resource): ListAttribute; 819 820 /** 821 * Called when the offset and status callback of the slide are set. 822 * 823 * @param { function } event 824 * @returns { ListAttribute } 825 * @syscap SystemCapability.ArkUI.ArkUI.Full 826 * @since 7 827 */ 828 /** 829 * Called when the offset and status callback of the slide are set. 830 * 831 * @param { function } event 832 * @returns { ListAttribute } 833 * @syscap SystemCapability.ArkUI.ArkUI.Full 834 * @since 9 835 * @form 836 */ 837 /** 838 * Called when the offset and status callback of the slide are set. 839 * 840 * @param { function } event 841 * @returns { ListAttribute } 842 * @syscap SystemCapability.ArkUI.ArkUI.Full 843 * @crossplatform 844 * @since 10 845 * @form 846 */ 847 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): ListAttribute; 848 849 /** 850 * Called when the start and end positions of the display change. 851 * 852 * @param { function } event 853 * @returns { ListAttribute } 854 * @syscap SystemCapability.ArkUI.ArkUI.Full 855 * @since 7 856 */ 857 /** 858 * Called when the start and end positions of the display change. 859 * 860 * @param { function } event 861 * @returns { ListAttribute } 862 * @syscap SystemCapability.ArkUI.ArkUI.Full 863 * @since 9 864 * @form 865 */ 866 /** 867 * Called when the start and end positions of the display change. 868 * 869 * @param { function } event 870 * @returns { ListAttribute } 871 * @syscap SystemCapability.ArkUI.ArkUI.Full 872 * @crossplatform 873 * @since 10 874 * @form 875 */ 876 onScrollIndex(event: (start: number, end: number, center: number) => void): ListAttribute; 877 878 /** 879 * Called when the list begins to arrive. 880 * 881 * @param { function } event 882 * @returns { ListAttribute } 883 * @syscap SystemCapability.ArkUI.ArkUI.Full 884 * @since 7 885 */ 886 /** 887 * Called when the list begins to arrive. 888 * 889 * @param { function } event 890 * @returns { ListAttribute } 891 * @syscap SystemCapability.ArkUI.ArkUI.Full 892 * @since 9 893 * @form 894 */ 895 /** 896 * Called when the list begins to arrive. 897 * 898 * @param { function } event 899 * @returns { ListAttribute } 900 * @syscap SystemCapability.ArkUI.ArkUI.Full 901 * @crossplatform 902 * @since 10 903 * @form 904 */ 905 onReachStart(event: () => void): ListAttribute; 906 907 /** 908 * Called when the list reaches the end. 909 * 910 * @param { function } event 911 * @returns { ListAttribute } 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @since 7 914 */ 915 /** 916 * Called when the list reaches the end. 917 * 918 * @param { function } event 919 * @returns { ListAttribute } 920 * @syscap SystemCapability.ArkUI.ArkUI.Full 921 * @since 9 922 * @form 923 */ 924 /** 925 * Called when the list reaches the end. 926 * 927 * @param { function } event 928 * @returns { ListAttribute } 929 * @syscap SystemCapability.ArkUI.ArkUI.Full 930 * @crossplatform 931 * @since 10 932 * @form 933 */ 934 onReachEnd(event: () => void): ListAttribute; 935 936 /** 937 * Called when the slider start. 938 * 939 * @param { function } event 940 * @returns { ListAttribute } 941 * @syscap SystemCapability.ArkUI.ArkUI.Full 942 * @since 9 943 * @form 944 */ 945 /** 946 * Called when the slider start. 947 * 948 * @param { function } event 949 * @returns { ListAttribute } 950 * @syscap SystemCapability.ArkUI.ArkUI.Full 951 * @crossplatform 952 * @since 10 953 * @form 954 */ 955 onScrollStart(event: () => void): ListAttribute; 956 957 /** 958 * Called when the slider stops. 959 * 960 * @param { function } event 961 * @returns { ListAttribute } 962 * @syscap SystemCapability.ArkUI.ArkUI.Full 963 * @since 7 964 */ 965 /** 966 * Called when the slider stops. 967 * 968 * @param { function } event 969 * @returns { ListAttribute } 970 * @syscap SystemCapability.ArkUI.ArkUI.Full 971 * @since 9 972 * @form 973 */ 974 /** 975 * Called when the slider stops. 976 * 977 * @param { function } event 978 * @returns { ListAttribute } 979 * @syscap SystemCapability.ArkUI.ArkUI.Full 980 * @crossplatform 981 * @since 10 982 * @form 983 */ 984 onScrollStop(event: () => void): ListAttribute; 985 986 /** 987 * Called when a list item is deleted. 988 * 989 * @param { function } event 990 * @returns { ListAttribute } 991 * @syscap SystemCapability.ArkUI.ArkUI.Full 992 * @since 7 993 * @deprecated since 9 994 */ 995 onItemDelete(event: (index: number) => boolean): ListAttribute; 996 997 /** 998 * Called when a list item is moved. 999 * 1000 * @param { function } event 1001 * @returns { ListAttribute } 1002 * @syscap SystemCapability.ArkUI.ArkUI.Full 1003 * @since 7 1004 */ 1005 /** 1006 * Called when a list item is moved. 1007 * 1008 * @param { function } event 1009 * @returns { ListAttribute } 1010 * @syscap SystemCapability.ArkUI.ArkUI.Full 1011 * @crossplatform 1012 * @since 10 1013 */ 1014 onItemMove(event: (from: number, to: number) => boolean): ListAttribute; 1015 1016 /** 1017 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 1018 * (To be triggered, press and hold for 170 milliseconds (ms)) 1019 * 1020 * @param { function } event 1021 * @returns { ListAttribute } 1022 * @syscap SystemCapability.ArkUI.ArkUI.Full 1023 * @since 8 1024 */ 1025 /** 1026 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 1027 * (To be triggered, press and hold for 170 milliseconds (ms)) 1028 * 1029 * @param { function } event 1030 * @returns { ListAttribute } 1031 * @syscap SystemCapability.ArkUI.ArkUI.Full 1032 * @crossplatform 1033 * @since 10 1034 */ 1035 onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) | void)): ListAttribute; 1036 1037 /** 1038 * After binding, a callback is triggered when the component is dragged to the range of the component. 1039 * 1040 * @param { function } event 1041 * @returns { ListAttribute } 1042 * @syscap SystemCapability.ArkUI.ArkUI.Full 1043 * @since 8 1044 */ 1045 /** 1046 * After binding, a callback is triggered when the component is dragged to the range of the component. 1047 * 1048 * @param { function } event 1049 * @returns { ListAttribute } 1050 * @syscap SystemCapability.ArkUI.ArkUI.Full 1051 * @crossplatform 1052 * @since 10 1053 */ 1054 onItemDragEnter(event: (event: ItemDragInfo) => void): ListAttribute; 1055 1056 /** 1057 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 1058 * 1059 * @param { function } event 1060 * @returns { ListAttribute } 1061 * @syscap SystemCapability.ArkUI.ArkUI.Full 1062 * @since 8 1063 */ 1064 /** 1065 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 1066 * 1067 * @param { function } event 1068 * @returns { ListAttribute } 1069 * @syscap SystemCapability.ArkUI.ArkUI.Full 1070 * @crossplatform 1071 * @since 10 1072 */ 1073 onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void): ListAttribute; 1074 1075 /** 1076 * After binding, a callback is triggered when the component is dragged out of the component range. 1077 * 1078 * @param { function } event 1079 * @returns { ListAttribute } 1080 * @syscap SystemCapability.ArkUI.ArkUI.Full 1081 * @since 8 1082 */ 1083 /** 1084 * After binding, a callback is triggered when the component is dragged out of the component range. 1085 * 1086 * @param { function } event 1087 * @returns { ListAttribute } 1088 * @syscap SystemCapability.ArkUI.ArkUI.Full 1089 * @crossplatform 1090 * @since 10 1091 */ 1092 onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void): ListAttribute; 1093 1094 /** 1095 * The component bound to this event can be used as the drag release target. 1096 * This callback is triggered when the drag behavior is stopped within the scope of the component. 1097 * 1098 * @param { function } event 1099 * @returns { ListAttribute } 1100 * @syscap SystemCapability.ArkUI.ArkUI.Full 1101 * @since 8 1102 */ 1103 /** 1104 * The component bound to this event can be used as the drag release target. 1105 * This callback is triggered when the drag behavior is stopped within the scope of the component. 1106 * 1107 * @param { function } event 1108 * @returns { ListAttribute } 1109 * @syscap SystemCapability.ArkUI.ArkUI.Full 1110 * @crossplatform 1111 * @since 10 1112 */ 1113 onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void): ListAttribute; 1114 1115 /** 1116 * Called when scrolling begin each frame. 1117 * 1118 * @param { function } event 1119 * @returns { ListAttribute } 1120 * @syscap SystemCapability.ArkUI.ArkUI.Full 1121 * @since 9 1122 * @form 1123 */ 1124 /** 1125 * Called when scrolling begin each frame. 1126 * 1127 * @param { function } event 1128 * @returns { ListAttribute } 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @since 10 1132 * @form 1133 */ 1134 onScrollFrameBegin(event: (offset: number, state: ScrollState) => { offsetRemain: number }): ListAttribute; 1135} 1136 1137/** 1138 * Defines List Component. 1139 * 1140 * @syscap SystemCapability.ArkUI.ArkUI.Full 1141 * @since 7 1142 */ 1143/** 1144 * Defines List Component. 1145 * 1146 * @syscap SystemCapability.ArkUI.ArkUI.Full 1147 * @since 9 1148 * @form 1149 */ 1150/** 1151 * Defines List Component. 1152 * 1153 * @syscap SystemCapability.ArkUI.ArkUI.Full 1154 * @crossplatform 1155 * @since 10 1156 * @form 1157 */ 1158declare const List: ListInterface; 1159 1160/** 1161 * Defines List Component instance. 1162 * 1163 * @syscap SystemCapability.ArkUI.ArkUI.Full 1164 * @since 7 1165 */ 1166/** 1167 * Defines List Component instance. 1168 * 1169 * @syscap SystemCapability.ArkUI.ArkUI.Full 1170 * @since 9 1171 * @form 1172 */ 1173/** 1174 * Defines List Component instance. 1175 * 1176 * @syscap SystemCapability.ArkUI.ArkUI.Full 1177 * @crossplatform 1178 * @since 10 1179 * @form 1180 */ 1181declare const ListInstance: ListAttribute; 1182