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 * Provides methods for switching components. 23 * 24 * @syscap SystemCapability.ArkUI.ArkUI.Full 25 * @since 7 26 */ 27/** 28 * Provides methods for switching components. 29 * 30 * @syscap SystemCapability.ArkUI.ArkUI.Full 31 * @crossplatform 32 * @form 33 * @since 10 34 */ 35/** 36 * Provides methods for switching components. 37 * 38 * @syscap SystemCapability.ArkUI.ArkUI.Full 39 * @crossplatform 40 * @form 41 * @atomicservice 42 * @since 11 43 */ 44declare class SwiperController { 45 /** 46 * constructor. 47 * 48 * @syscap SystemCapability.ArkUI.ArkUI.Full 49 * @since 7 50 */ 51 /** 52 * constructor. 53 * 54 * @syscap SystemCapability.ArkUI.ArkUI.Full 55 * @crossplatform 56 * @form 57 * @since 10 58 */ 59 /** 60 * constructor. 61 * 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @crossplatform 64 * @form 65 * @atomicservice 66 * @since 11 67 */ 68 constructor(); 69 70 /** 71 * Called when the next child component is displayed. 72 * 73 * @syscap SystemCapability.ArkUI.ArkUI.Full 74 * @since 7 75 */ 76 /** 77 * Called when the next child component is displayed. 78 * 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @crossplatform 81 * @form 82 * @since 10 83 */ 84 /** 85 * Called when the next child component is displayed. 86 * 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @crossplatform 89 * @form 90 * @atomicservice 91 * @since 11 92 */ 93 showNext(); 94 95 /** 96 * Called when the previous subcomponent is displayed. 97 * 98 * @syscap SystemCapability.ArkUI.ArkUI.Full 99 * @since 7 100 */ 101 /** 102 * Called when the previous subcomponent is displayed. 103 * 104 * @syscap SystemCapability.ArkUI.ArkUI.Full 105 * @crossplatform 106 * @form 107 * @since 10 108 */ 109 /** 110 * Called when the previous subcomponent is displayed. 111 * 112 * @syscap SystemCapability.ArkUI.ArkUI.Full 113 * @crossplatform 114 * @form 115 * @atomicservice 116 * @since 11 117 */ 118 showPrevious(); 119 120 /** 121 * Controlling Swiper to change to the specified subcomponent. 122 * 123 * @param { number } index - the index of item to be redirected. 124 * @param { boolean } useAnimation - If true, swipe to index item with animation. If false, swipe to index item without animation. 125 * The default value is false. 126 * @syscap SystemCapability.ArkUI.ArkUI.Full 127 * @crossplatform 128 * @form 129 * @atomicservice 130 * @since 12 131 */ 132 changeIndex(index: number, useAnimation?: boolean); 133 134 /** 135 * Called when need to stop the swiper animation. 136 * 137 * @param { function } callback 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @since 7 140 */ 141 /** 142 * Called when need to stop the swiper animation. 143 * 144 * @param { function } callback 145 * @syscap SystemCapability.ArkUI.ArkUI.Full 146 * @crossplatform 147 * @form 148 * @since 10 149 */ 150 /** 151 * Called when need to stop the swiper animation. 152 * 153 * @param { function } callback 154 * @syscap SystemCapability.ArkUI.ArkUI.Full 155 * @crossplatform 156 * @form 157 * @atomicservice 158 * @since 11 159 */ 160 finishAnimation(callback?: () => void); 161} 162 163/** 164 * Defines the indicator class. 165 * 166 * @syscap SystemCapability.ArkUI.ArkUI.Full 167 * @crossplatform 168 * @form 169 * @since 10 170 */ 171/** 172 * Defines the indicator class. 173 * 174 * @syscap SystemCapability.ArkUI.ArkUI.Full 175 * @crossplatform 176 * @form 177 * @atomicservice 178 * @since 11 179 */ 180declare class Indicator<T> { 181 /** 182 * Set the indicator to the left. 183 * 184 * @param { Length } value - the indicator to the left. 185 * @returns { T } 186 * @syscap SystemCapability.ArkUI.ArkUI.Full 187 * @crossplatform 188 * @form 189 * @since 10 190 */ 191 /** 192 * Set the indicator to the left. 193 * 194 * @param { Length } value - the indicator to the left. 195 * @returns { T } 196 * @syscap SystemCapability.ArkUI.ArkUI.Full 197 * @crossplatform 198 * @form 199 * @atomicservice 200 * @since 11 201 */ 202 left(value: Length): T; 203 204 /** 205 * Set the indicator to the top. 206 * 207 * @param { Length } value - the indicator to the top. 208 * @returns { T } 209 * @syscap SystemCapability.ArkUI.ArkUI.Full 210 * @crossplatform 211 * @form 212 * @since 10 213 */ 214 /** 215 * Set the indicator to the top. 216 * 217 * @param { Length } value - the indicator to the top. 218 * @returns { T } 219 * @syscap SystemCapability.ArkUI.ArkUI.Full 220 * @crossplatform 221 * @form 222 * @atomicservice 223 * @since 11 224 */ 225 top(value: Length): T; 226 227 /** 228 * Set the indicator to the right. 229 * 230 * @param { Length } value - the indicator to the right. 231 * @returns { T } 232 * @syscap SystemCapability.ArkUI.ArkUI.Full 233 * @crossplatform 234 * @form 235 * @since 10 236 */ 237 /** 238 * Set the indicator to the right. 239 * 240 * @param { Length } value - the indicator to the right. 241 * @returns { T } 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @crossplatform 244 * @form 245 * @atomicservice 246 * @since 11 247 */ 248 right(value: Length): T; 249 250 /** 251 * Set the indicator to the bottom. 252 * 253 * @param { Length } value - the indicator to the bottom. 254 * @returns { T } 255 * @syscap SystemCapability.ArkUI.ArkUI.Full 256 * @crossplatform 257 * @form 258 * @since 10 259 */ 260 /** 261 * Set the indicator to the bottom. 262 * 263 * @param { Length } value - the indicator to the bottom. 264 * @returns { T } 265 * @syscap SystemCapability.ArkUI.ArkUI.Full 266 * @crossplatform 267 * @form 268 * @atomicservice 269 * @since 11 270 */ 271 bottom(value: Length): T; 272 273 /** 274 * Set the indicator to the left in LTR 275 * Set the indicator to the right in RTL 276 * 277 * @param { LengthMetrics } value - the indicator to the right in LTR, indicator to the left in RTL 278 * @returns { T } 279 * @syscap SystemCapability.ArkUI.ArkUI.Full 280 * @crossplatform 281 * @form 282 * @atomicservice 283 * @since 12 284 */ 285 start(value: LengthMetrics): T; 286 287 /** 288 * Set the indicator to the left in RTL 289 * Set the indicator to the right in LTR 290 * 291 * @param { LengthMetrics } value - the indicator to the left in RTL, Set the indicator to the right in LTR 292 * @returns { T } 293 * @syscap SystemCapability.ArkUI.ArkUI.Full 294 * @crossplatform 295 * @form 296 * @atomicservice 297 * @since 12 298 */ 299 end(value: LengthMetrics): T; 300 301 /** 302 * DotIndicator class object. 303 * 304 * @returns { DotIndicator } 305 * @static 306 * @syscap SystemCapability.ArkUI.ArkUI.Full 307 * @crossplatform 308 * @form 309 * @since 10 310 */ 311 /** 312 * DotIndicator class object. 313 * 314 * @returns { DotIndicator } 315 * @static 316 * @syscap SystemCapability.ArkUI.ArkUI.Full 317 * @crossplatform 318 * @form 319 * @atomicservice 320 * @since 11 321 */ 322 static dot(): DotIndicator; 323 324 /** 325 * DigitIndicator class object. 326 * 327 * @returns { DigitIndicator } 328 * @static 329 * @syscap SystemCapability.ArkUI.ArkUI.Full 330 * @crossplatform 331 * @form 332 * @since 10 333 */ 334 /** 335 * DigitIndicator class object. 336 * 337 * @returns { DigitIndicator } 338 * @static 339 * @syscap SystemCapability.ArkUI.ArkUI.Full 340 * @crossplatform 341 * @form 342 * @atomicservice 343 * @since 11 344 */ 345 static digit(): DigitIndicator; 346} 347 348/** 349 * Define DotIndicator, the indicator type is dot. 350 * 351 * @extends Indicator<DotIndicator> 352 * @syscap SystemCapability.ArkUI.ArkUI.Full 353 * @crossplatform 354 * @form 355 * @since 10 356 */ 357/** 358 * Define DotIndicator, the indicator type is dot. 359 * 360 * @extends Indicator<DotIndicator> 361 * @syscap SystemCapability.ArkUI.ArkUI.Full 362 * @crossplatform 363 * @form 364 * @atomicservice 365 * @since 11 366 */ 367declare class DotIndicator extends Indicator<DotIndicator> { 368 /** 369 * Constructor. 370 * 371 * @syscap SystemCapability.ArkUI.ArkUI.Full 372 * @crossplatform 373 * @form 374 * @since 10 375 */ 376 /** 377 * Constructor. 378 * 379 * @syscap SystemCapability.ArkUI.ArkUI.Full 380 * @crossplatform 381 * @form 382 * @atomicservice 383 * @since 11 384 */ 385 constructor(); 386 387 /** 388 * Set the indicator item width. 389 * 390 * @param { Length } value - the indicator item width. 391 * @returns { DotIndicator } 392 * @syscap SystemCapability.ArkUI.ArkUI.Full 393 * @crossplatform 394 * @form 395 * @since 10 396 */ 397 /** 398 * Set the indicator item width. 399 * 400 * @param { Length } value - the indicator item width. 401 * @returns { DotIndicator } 402 * @syscap SystemCapability.ArkUI.ArkUI.Full 403 * @crossplatform 404 * @form 405 * @atomicservice 406 * @since 11 407 */ 408 itemWidth(value: Length): DotIndicator; 409 410 /** 411 * Set the indicator item height. 412 * 413 * @param { Length } value - the indicator item height. 414 * @returns { DotIndicator } 415 * @syscap SystemCapability.ArkUI.ArkUI.Full 416 * @crossplatform 417 * @form 418 * @since 10 419 */ 420 /** 421 * Set the indicator item height. 422 * 423 * @param { Length } value - the indicator item height. 424 * @returns { DotIndicator } 425 * @syscap SystemCapability.ArkUI.ArkUI.Full 426 * @crossplatform 427 * @form 428 * @atomicservice 429 * @since 11 430 */ 431 itemHeight(value: Length): DotIndicator; 432 433 /** 434 * Set the indicator item width when selected. 435 * 436 * @param { Length } value - the indicator item width when selected. 437 * @returns { DotIndicator } 438 * @syscap SystemCapability.ArkUI.ArkUI.Full 439 * @crossplatform 440 * @form 441 * @since 10 442 */ 443 /** 444 * Set the indicator item width when selected. 445 * 446 * @param { Length } value - the indicator item width when selected. 447 * @returns { DotIndicator } 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @crossplatform 450 * @form 451 * @atomicservice 452 * @since 11 453 */ 454 selectedItemWidth(value: Length): DotIndicator; 455 456 /** 457 * Set the indicator item height when selected. 458 * 459 * @param { Length } value - the indicator item height when selected. 460 * @returns { DotIndicator } 461 * @syscap SystemCapability.ArkUI.ArkUI.Full 462 * @crossplatform 463 * @form 464 * @since 10 465 */ 466 /** 467 * Set the indicator item height when selected. 468 * 469 * @param { Length } value - the indicator item height when selected. 470 * @returns { DotIndicator } 471 * @syscap SystemCapability.ArkUI.ArkUI.Full 472 * @crossplatform 473 * @form 474 * @atomicservice 475 * @since 11 476 */ 477 selectedItemHeight(value: Length): DotIndicator; 478 479 /** 480 * Setting indicator style mask. 481 * 482 * @param { boolean } value - the indicator item mask. 483 * @returns { DotIndicator } 484 * @syscap SystemCapability.ArkUI.ArkUI.Full 485 * @crossplatform 486 * @form 487 * @since 10 488 */ 489 /** 490 * Setting indicator style mask. 491 * 492 * @param { boolean } value - the indicator item mask. 493 * @returns { DotIndicator } 494 * @syscap SystemCapability.ArkUI.ArkUI.Full 495 * @crossplatform 496 * @form 497 * @atomicservice 498 * @since 11 499 */ 500 mask(value: boolean): DotIndicator; 501 502 /** 503 * Set the indicator color. 504 * 505 * @param { ResourceColor } value - the indicator item color. 506 * @returns { DotIndicator } 507 * @syscap SystemCapability.ArkUI.ArkUI.Full 508 * @crossplatform 509 * @form 510 * @since 10 511 */ 512 /** 513 * Set the indicator color. 514 * 515 * @param { ResourceColor } value - the indicator item color. 516 * @returns { DotIndicator } 517 * @syscap SystemCapability.ArkUI.ArkUI.Full 518 * @crossplatform 519 * @form 520 * @atomicservice 521 * @since 11 522 */ 523 color(value: ResourceColor): DotIndicator; 524 525 /** 526 * Set the navigation point color. 527 * 528 * @param { ResourceColor } value - the indicator item when selected. 529 * @returns { DotIndicator } 530 * @syscap SystemCapability.ArkUI.ArkUI.Full 531 * @crossplatform 532 * @form 533 * @since 10 534 */ 535 /** 536 * Set the navigation point color. 537 * 538 * @param { ResourceColor } value - the indicator item when selected. 539 * @returns { DotIndicator } 540 * @syscap SystemCapability.ArkUI.ArkUI.Full 541 * @crossplatform 542 * @form 543 * @atomicservice 544 * @since 11 545 */ 546 selectedColor(value: ResourceColor): DotIndicator; 547 548 /** 549 * Set the Indicator maxDisplayCount when selected. 550 * 551 * @param { number } maxDisplayCount - the indicator item maxDisplayCount when selected. 552 * @returns { DotIndicator } return the DotIndicator 553 * @syscap SystemCapability.ArkUI.ArkUI.Full 554 * @crossplatform 555 * @atomicservice 556 * @since 12 557 */ 558 maxDisplayCount(maxDisplayCount: number): DotIndicator; 559} 560 561/** 562 * Set Swiper column count adaptation. 563 * 564 * @typedef { object } SwiperAutoFill 565 * @syscap SystemCapability.ArkUI.ArkUI.Full 566 * @form 567 * @since 10 568 */ 569/** 570 * Set Swiper column count adaptation. 571 * 572 * @typedef { object } SwiperAutoFill 573 * @syscap SystemCapability.ArkUI.ArkUI.Full 574 * @form 575 * @atomicservice 576 * @since 11 577 */ 578declare type SwiperAutoFill = { 579 /** 580 * Set minSize size. 581 * 582 * @syscap SystemCapability.ArkUI.ArkUI.Full 583 * @since 10 584 * @form 585 */ 586 /** 587 * Set minSize size. 588 * 589 * @syscap SystemCapability.ArkUI.ArkUI.Full 590 * @atomicservice 591 * @since 11 592 * @form 593 */ 594 minSize: VP; 595}; 596 597/** 598 * Define DigitIndicator, the indicator type is digit. 599 * 600 * @extends Indicator<DigitIndicator> 601 * @syscap SystemCapability.ArkUI.ArkUI.Full 602 * @crossplatform 603 * @form 604 * @since 10 605 */ 606/** 607 * Define DigitIndicator, the indicator type is digit. 608 * 609 * @extends Indicator<DigitIndicator> 610 * @syscap SystemCapability.ArkUI.ArkUI.Full 611 * @crossplatform 612 * @form 613 * @atomicservice 614 * @since 11 615 */ 616declare class DigitIndicator extends Indicator<DigitIndicator> { 617 /** 618 * Constructor. 619 * 620 * @syscap SystemCapability.ArkUI.ArkUI.Full 621 * @crossplatform 622 * @form 623 * @since 10 624 */ 625 /** 626 * Constructor. 627 * 628 * @syscap SystemCapability.ArkUI.ArkUI.Full 629 * @crossplatform 630 * @form 631 * @atomicservice 632 * @since 11 633 */ 634 constructor(); 635 636 /** 637 * Set font color of the digital indicator. 638 * 639 * @param { ResourceColor } value - the indicator font color. 640 * @returns { DigitIndicator } 641 * @syscap SystemCapability.ArkUI.ArkUI.Full 642 * @crossplatform 643 * @form 644 * @since 10 645 */ 646 /** 647 * Set font color of the digital indicator. 648 * 649 * @param { ResourceColor } value - the indicator font color. 650 * @returns { DigitIndicator } 651 * @syscap SystemCapability.ArkUI.ArkUI.Full 652 * @crossplatform 653 * @form 654 * @atomicservice 655 * @since 11 656 */ 657 fontColor(value: ResourceColor): DigitIndicator; 658 659 /** 660 * Set font color of the digital indicator when selected. 661 * 662 * @param { ResourceColor } value - the indicator font color when selected. 663 * @returns { DigitIndicator } 664 * @syscap SystemCapability.ArkUI.ArkUI.Full 665 * @crossplatform 666 * @form 667 * @since 10 668 */ 669 /** 670 * Set font color of the digital indicator when selected. 671 * 672 * @param { ResourceColor } value - the indicator font color when selected. 673 * @returns { DigitIndicator } 674 * @syscap SystemCapability.ArkUI.ArkUI.Full 675 * @crossplatform 676 * @form 677 * @atomicservice 678 * @since 11 679 */ 680 selectedFontColor(value: ResourceColor): DigitIndicator; 681 682 /** 683 * Set the digital indicator font (just support font size and weight). 684 * 685 * @param { Font } value - the indicator font size and weight. 686 * @returns { DigitIndicator } 687 * @syscap SystemCapability.ArkUI.ArkUI.Full 688 * @crossplatform 689 * @form 690 * @since 10 691 */ 692 /** 693 * Set the digital indicator font (just support font size and weight). 694 * 695 * @param { Font } value - the indicator font size and weight. 696 * @returns { DigitIndicator } 697 * @syscap SystemCapability.ArkUI.ArkUI.Full 698 * @crossplatform 699 * @form 700 * @atomicservice 701 * @since 11 702 */ 703 digitFont(value: Font): DigitIndicator; 704 705 /** 706 * Set the digital indicator font (just support font size and weight). 707 * 708 * @param { Font } value - the indicator font size and weight when selected. 709 * @returns { DigitIndicator } 710 * @syscap SystemCapability.ArkUI.ArkUI.Full 711 * @crossplatform 712 * @form 713 * @since 10 714 */ 715 /** 716 * Set the digital indicator font (just support font size and weight). 717 * 718 * @param { Font } value - the indicator font size and weight when selected. 719 * @returns { DigitIndicator } 720 * @syscap SystemCapability.ArkUI.ArkUI.Full 721 * @crossplatform 722 * @form 723 * @atomicservice 724 * @since 11 725 */ 726 selectedDigitFont(value: Font): DigitIndicator; 727} 728 729/** 730 * Arrow object. 731 * 732 * @interface ArrowStyle 733 * @syscap SystemCapability.ArkUI.ArkUI.Full 734 * @since 10 735 */ 736/** 737 * Arrow object. 738 * 739 * @interface ArrowStyle 740 * @syscap SystemCapability.ArkUI.ArkUI.Full 741 * @crossplatform 742 * @atomicservice 743 * @since 11 744 */ 745declare interface ArrowStyle { 746 /** 747 * Is show the arrow background or not. 748 * 749 * @type { ?boolean } 750 * @default false 751 * @syscap SystemCapability.ArkUI.ArkUI.Full 752 * @since 10 753 */ 754 /** 755 * Is show the arrow background or not. 756 * 757 * @type { ?boolean } 758 * @default false 759 * @syscap SystemCapability.ArkUI.ArkUI.Full 760 * @crossplatform 761 * @atomicservice 762 * @since 11 763 */ 764 showBackground?: boolean; 765 766 /** 767 * When the indicator show, set the arrow position is side of the indicator or in the middle of content area. 768 * The arrow is displayed on side of the indicator, if the value is false. 769 * 770 * @type { ?boolean } 771 * @default false 772 * @syscap SystemCapability.ArkUI.ArkUI.Full 773 * @since 10 774 */ 775 /** 776 * When the indicator show, set the arrow position is side of the indicator or in the middle of content area. 777 * The arrow is displayed on side of the indicator, if the value is false. 778 * 779 * @type { ?boolean } 780 * @default false 781 * @syscap SystemCapability.ArkUI.ArkUI.Full 782 * @crossplatform 783 * @atomicservice 784 * @since 11 785 */ 786 isSidebarMiddle?: boolean; 787 788 /** 789 * The arrow background size. 790 * The size of the arrow is three-quarters of the background size, when the background is displayed. 791 * 792 * @type { ?Length } 793 * @default When isSidebarMiddle is false, the default value is 24vp, Otherwise,the default value is 32vp 794 * @syscap SystemCapability.ArkUI.ArkUI.Full 795 * @since 10 796 */ 797 /** 798 * The arrow background size. 799 * The size of the arrow is three-quarters of the background size, when the background is displayed. 800 * 801 * @type { ?Length } 802 * @default When isSidebarMiddle is false, the default value is 24vp, Otherwise,the default value is 32vp 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @crossplatform 805 * @atomicservice 806 * @since 11 807 */ 808 backgroundSize?: Length; 809 810 /** 811 * The arrow background background color. 812 * 813 * @type { ?ResourceColor } 814 * @default When isSidebarMiddle is false, the default value is #00000000, Otherwise,the default value is #19182431 815 * @syscap SystemCapability.ArkUI.ArkUI.Full 816 * @since 10 817 */ 818 /** 819 * The arrow background background color. 820 * 821 * @type { ?ResourceColor } 822 * @default When isSidebarMiddle is false, the default value is #00000000, Otherwise, the default value is #19182431 823 * @syscap SystemCapability.ArkUI.ArkUI.Full 824 * @crossplatform 825 * @atomicservice 826 * @since 11 827 */ 828 backgroundColor?: ResourceColor; 829 830 /** 831 * The arrow size. 832 * The arrow size can be set, when the background is not displayed. 833 * The size of the arrow is three-quarters of the background size, when the background is displayed. 834 * 835 * @type { ?Length } 836 * @default When isSidebarMiddle is false, the default value is 18vp, Otherwise, the default value is 24vp 837 * @syscap SystemCapability.ArkUI.ArkUI.Full 838 * @since 10 839 */ 840 /** 841 * The arrow size. 842 * The arrow size can be set, when the background is not displayed. 843 * The size of the arrow is three-quarters of the background size, when the background is displayed. 844 * 845 * @type { ?Length } 846 * @default When isSidebarMiddle is false, the default value is 18vp, Otherwise, the default value is 24vp 847 * @syscap SystemCapability.ArkUI.ArkUI.Full 848 * @crossplatform 849 * @atomicservice 850 * @since 11 851 */ 852 arrowSize?: Length; 853 854 /** 855 * The arrow color. 856 * 857 * @type { ?ResourceColor } 858 * @default #182431 859 * @syscap SystemCapability.ArkUI.ArkUI.Full 860 * @since 10 861 */ 862 /** 863 * The arrow color. 864 * 865 * @type { ?ResourceColor } 866 * @default #182431 867 * @syscap SystemCapability.ArkUI.ArkUI.Full 868 * @crossplatform 869 * @atomicservice 870 * @since 11 871 */ 872 arrowColor?: ResourceColor; 873} 874 875/** 876 * Declare the size of the swiper on the spindle. 877 * 878 * @enum { number } 879 * @syscap SystemCapability.ArkUI.ArkUI.Full 880 * @since 7 881 */ 882/** 883 * Declare the size of the swiper on the spindle. 884 * 885 * @enum { number } 886 * @syscap SystemCapability.ArkUI.ArkUI.Full 887 * @crossplatform 888 * @form 889 * @since 10 890 */ 891/** 892 * Declare the size of the swiper on the spindle. 893 * 894 * @enum { number } 895 * @syscap SystemCapability.ArkUI.ArkUI.Full 896 * @crossplatform 897 * @form 898 * @atomicservice 899 * @since 11 900 */ 901declare enum SwiperDisplayMode { 902 /** 903 * Carousel map extension. 904 * 905 * @syscap SystemCapability.ArkUI.ArkUI.Full 906 * @form 907 * @since 7 908 * @deprecated since 10 909 * @useinstead SwiperDisplayMode#STRETCH 910 */ 911 Stretch, 912 913 /** 914 * The rotation chart is self linear. 915 * 916 * @syscap SystemCapability.ArkUI.ArkUI.Full 917 * @form 918 * @since 7 919 * @deprecated since 10 920 * @useinstead SwiperDisplayMode#AUTO_LINEAR 921 */ 922 AutoLinear, 923 924 /** 925 * Carousel map extension. 926 * 927 * @syscap SystemCapability.ArkUI.ArkUI.Full 928 * @crossplatform 929 * @form 930 * @since 10 931 */ 932 /** 933 * Carousel map extension. 934 * 935 * @syscap SystemCapability.ArkUI.ArkUI.Full 936 * @crossplatform 937 * @form 938 * @atomicservice 939 * @since 11 940 */ 941 STRETCH, 942 943 /** 944 * The rotation chart is self linear. 945 * 946 * @syscap SystemCapability.ArkUI.ArkUI.Full 947 * @crossplatform 948 * @form 949 * @since 10 950 */ 951 /** 952 * The rotation chart is self linear. 953 * 954 * @syscap SystemCapability.ArkUI.ArkUI.Full 955 * @crossplatform 956 * @form 957 * @atomicservice 958 * @since 11 959 * @deprecated since 12 960 * @useinstead Scroller#scrollTo 961 */ 962 AUTO_LINEAR, 963} 964 965/** 966 * Provides an interface for sliding containers. 967 * 968 * @interface SwiperInterface 969 * @syscap SystemCapability.ArkUI.ArkUI.Full 970 * @since 7 971 */ 972/** 973 * Provides an interface for sliding containers. 974 * 975 * @interface SwiperInterface 976 * @syscap SystemCapability.ArkUI.ArkUI.Full 977 * @crossplatform 978 * @form 979 * @since 10 980 */ 981/** 982 * Provides an interface for sliding containers. 983 * 984 * @interface SwiperInterface 985 * @syscap SystemCapability.ArkUI.ArkUI.Full 986 * @crossplatform 987 * @form 988 * @atomicservice 989 * @since 11 990 */ 991interface SwiperInterface { 992 /** 993 * Called when a sliding container is set. 994 * 995 * @param { SwiperController } controller 996 * @returns { SwiperAttribute } 997 * @syscap SystemCapability.ArkUI.ArkUI.Full 998 * @since 7 999 */ 1000 /** 1001 * Called when a sliding container is set. 1002 * 1003 * @param { SwiperController } controller 1004 * @returns { SwiperAttribute } 1005 * @syscap SystemCapability.ArkUI.ArkUI.Full 1006 * @crossplatform 1007 * @form 1008 * @since 10 1009 */ 1010 /** 1011 * Called when a sliding container is set. 1012 * 1013 * @param { SwiperController } controller 1014 * @returns { SwiperAttribute } 1015 * @syscap SystemCapability.ArkUI.ArkUI.Full 1016 * @crossplatform 1017 * @form 1018 * @atomicservice 1019 * @since 11 1020 */ 1021 (controller?: SwiperController): SwiperAttribute; 1022} 1023 1024/** 1025 * Setting indicator style navigation. 1026 * 1027 * @interface IndicatorStyle 1028 * @syscap SystemCapability.ArkUI.ArkUI.Full 1029 * @since 8 1030 * @deprecated since 10 1031 */ 1032declare interface IndicatorStyle { 1033 /** 1034 * Set the indicator to the left. 1035 * 1036 * @type { ?Length } 1037 * @syscap SystemCapability.ArkUI.ArkUI.Full 1038 * @since 8 1039 * @deprecated since 10 1040 */ 1041 left?: Length; 1042 1043 /** 1044 * Set the indicator to the top. 1045 * 1046 * @type { ?Length } 1047 * @syscap SystemCapability.ArkUI.ArkUI.Full 1048 * @since 8 1049 * @deprecated since 10 1050 */ 1051 top?: Length; 1052 1053 /** 1054 * Set the indicator to the right. 1055 * 1056 * @type { ?Length } 1057 * @syscap SystemCapability.ArkUI.ArkUI.Full 1058 * @since 8 1059 * @deprecated since 10 1060 */ 1061 right?: Length; 1062 1063 /** 1064 * Set the indicator to the bottom. 1065 * 1066 * @type { ?Length } 1067 * @syscap SystemCapability.ArkUI.ArkUI.Full 1068 * @since 8 1069 * @deprecated since 10 1070 */ 1071 bottom?: Length; 1072 1073 /** 1074 * Set the indicator size. 1075 * 1076 * @type { ?Length } 1077 * @syscap SystemCapability.ArkUI.ArkUI.Full 1078 * @since 8 1079 * @deprecated since 10 1080 */ 1081 size?: Length; 1082 1083 /** 1084 * Setting indicator style mask. 1085 * 1086 * @type { ?boolean } 1087 * @syscap SystemCapability.ArkUI.ArkUI.Full 1088 * @since 8 1089 * @deprecated since 10 1090 */ 1091 mask?: boolean; 1092 1093 /** 1094 * Set the indicator color. 1095 * 1096 * @type { ?ResourceColor } 1097 * @syscap SystemCapability.ArkUI.ArkUI.Full 1098 * @since 8 1099 * @deprecated since 10 1100 */ 1101 color?: ResourceColor; 1102 1103 /** 1104 * Set the navigation point color. 1105 * 1106 * @type { ?ResourceColor } 1107 * @syscap SystemCapability.ArkUI.ArkUI.Full 1108 * @since 8 1109 * @deprecated since 10 1110 */ 1111 selectedColor?: ResourceColor; 1112} 1113 1114/** 1115 * Provides an interface for swiper animation. 1116 * 1117 * @interface SwiperAnimationEvent 1118 * @syscap SystemCapability.ArkUI.ArkUI.Full 1119 * @crossplatform 1120 * @since 10 1121 */ 1122/** 1123 * Provides an interface for swiper animation. 1124 * 1125 * @interface SwiperAnimationEvent 1126 * @syscap SystemCapability.ArkUI.ArkUI.Full 1127 * @crossplatform 1128 * @atomicservice 1129 * @since 11 1130 */ 1131declare interface SwiperAnimationEvent { 1132 /** 1133 * Offset of the current page to the start position of the swiper main axis. The unit is vp. 1134 * 1135 * @type { number } 1136 * @default 0.0 vp 1137 * @syscap SystemCapability.ArkUI.ArkUI.Full 1138 * @since 10 1139 */ 1140 /** 1141 * Offset of the current page to the start position of the swiper main axis. The unit is vp. 1142 * 1143 * @type { number } 1144 * @default 0.0 vp 1145 * @syscap SystemCapability.ArkUI.ArkUI.Full 1146 * @crossplatform 1147 * @atomicservice 1148 * @since 11 1149 */ 1150 currentOffset: number; 1151 1152 /** 1153 * Offset of the target page to the start position of the swiper main axis. The unit is vp. 1154 * 1155 * @type { number } 1156 * @default 0.0 vp 1157 * @syscap SystemCapability.ArkUI.ArkUI.Full 1158 * @since 10 1159 */ 1160 /** 1161 * Offset of the target page to the start position of the swiper main axis. The unit is vp. 1162 * 1163 * @type { number } 1164 * @default 0.0 vp 1165 * @syscap SystemCapability.ArkUI.ArkUI.Full 1166 * @crossplatform 1167 * @atomicservice 1168 * @since 11 1169 */ 1170 targetOffset: number; 1171 1172 /** 1173 * Start speed of the page-turning animation. The unit is vp/s. 1174 * 1175 * @type { number } 1176 * @default 0.0 vp/s 1177 * @syscap SystemCapability.ArkUI.ArkUI.Full 1178 * @since 10 1179 */ 1180 /** 1181 * Start speed of the page-turning animation. The unit is vp/s. 1182 * 1183 * @type { number } 1184 * @default 0.0 vp/s 1185 * @syscap SystemCapability.ArkUI.ArkUI.Full 1186 * @crossplatform 1187 * @atomicservice 1188 * @since 11 1189 */ 1190 velocity: number; 1191} 1192 1193/** 1194 * Swiper nested scroll nested mode 1195 1196 * @enum { number } SwiperNestedScrollMode 1197 * @syscap SystemCapability.ArkUI.ArkUI.Full 1198 * @atomicservice 1199 * @since 11 1200 */ 1201declare enum SwiperNestedScrollMode { 1202 /** 1203 * Only Self response scrolling. 1204 * 1205 * @syscap SystemCapability.ArkUI.ArkUI.Full 1206 * @atomicservice 1207 * @since 11 1208 */ 1209 SELF_ONLY = 0, 1210 1211 /** 1212 * Self priority response scrolling. 1213 * 1214 * @syscap SystemCapability.ArkUI.ArkUI.Full 1215 * @atomicservice 1216 * @since 11 1217 */ 1218 SELF_FIRST = 1, 1219} 1220 1221/** 1222 * Defines the swiper attribute functions. 1223 * 1224 * @extends CommonMethod<SwiperAttribute> 1225 * @syscap SystemCapability.ArkUI.ArkUI.Full 1226 * @since 7 1227 */ 1228/** 1229 * Defines the swiper attribute functions. 1230 * 1231 * @extends CommonMethod<SwiperAttribute> 1232 * @syscap SystemCapability.ArkUI.ArkUI.Full 1233 * @crossplatform 1234 * @form 1235 * @since 10 1236 */ 1237/** 1238 * Defines the swiper attribute functions. 1239 * 1240 * @extends CommonMethod<SwiperAttribute> 1241 * @syscap SystemCapability.ArkUI.ArkUI.Full 1242 * @crossplatform 1243 * @form 1244 * @atomicservice 1245 * @since 11 1246 */ 1247declare class SwiperAttribute extends CommonMethod<SwiperAttribute> { 1248 /** 1249 * Called when the index value of the displayed subcomponent is set in the container. 1250 * 1251 * @param { number } value 1252 * @returns { SwiperAttribute } 1253 * @syscap SystemCapability.ArkUI.ArkUI.Full 1254 * @since 7 1255 */ 1256 /** 1257 * Called when the index value of the displayed subcomponent is set in the container. 1258 * 1259 * @param { number } value 1260 * @returns { SwiperAttribute } 1261 * @syscap SystemCapability.ArkUI.ArkUI.Full 1262 * @crossplatform 1263 * @form 1264 * @since 10 1265 */ 1266 /** 1267 * Called when the index value of the displayed subcomponent is set in the container. 1268 * 1269 * @param { number } value 1270 * @returns { SwiperAttribute } 1271 * @syscap SystemCapability.ArkUI.ArkUI.Full 1272 * @crossplatform 1273 * @form 1274 * @atomicservice 1275 * @since 11 1276 */ 1277 index(value: number): SwiperAttribute; 1278 1279 /** 1280 * Called when setting whether the subcomponent plays automatically. 1281 * 1282 * @param { boolean } value 1283 * @returns { SwiperAttribute } 1284 * @syscap SystemCapability.ArkUI.ArkUI.Full 1285 * @since 7 1286 */ 1287 /** 1288 * Called when setting whether the subcomponent plays automatically. 1289 * 1290 * @param { boolean } value 1291 * @returns { SwiperAttribute } 1292 * @syscap SystemCapability.ArkUI.ArkUI.Full 1293 * @crossplatform 1294 * @form 1295 * @since 10 1296 */ 1297 /** 1298 * Called when setting whether the subcomponent plays automatically. 1299 * 1300 * @param { boolean } value 1301 * @returns { SwiperAttribute } 1302 * @syscap SystemCapability.ArkUI.ArkUI.Full 1303 * @crossplatform 1304 * @form 1305 * @atomicservice 1306 * @since 11 1307 */ 1308 autoPlay(value: boolean): SwiperAttribute; 1309 1310 /** 1311 * Called when the time interval for automatic playback is set. 1312 * 1313 * @param { number } value 1314 * @returns { SwiperAttribute } 1315 * @syscap SystemCapability.ArkUI.ArkUI.Full 1316 * @since 7 1317 */ 1318 /** 1319 * Called when the time interval for automatic playback is set. 1320 * 1321 * @param { number } value 1322 * @returns { SwiperAttribute } 1323 * @syscap SystemCapability.ArkUI.ArkUI.Full 1324 * @crossplatform 1325 * @form 1326 * @since 10 1327 */ 1328 /** 1329 * Called when the time interval for automatic playback is set. 1330 * 1331 * @param { number } value 1332 * @returns { SwiperAttribute } 1333 * @syscap SystemCapability.ArkUI.ArkUI.Full 1334 * @crossplatform 1335 * @form 1336 * @atomicservice 1337 * @since 11 1338 */ 1339 interval(value: number): SwiperAttribute; 1340 1341 /** 1342 * Called when you set whether the navigation point indicator is enabled. 1343 * 1344 * @param { boolean } value - show indicator of the swiper indicator. 1345 * @returns { SwiperAttribute } 1346 * @syscap SystemCapability.ArkUI.ArkUI.Full 1347 * @since 7 1348 */ 1349 /** 1350 * Set indicator is enabled, or set type style. 1351 * 1352 * @param { DotIndicator | DigitIndicator | boolean } value - the style value or show indicator of the swiper indicator. 1353 * @returns { SwiperAttribute } 1354 * @syscap SystemCapability.ArkUI.ArkUI.Full 1355 * @crossplatform 1356 * @form 1357 * @since 10 1358 */ 1359 /** 1360 * Set indicator is enabled, or set type style. 1361 * 1362 * @param { DotIndicator | DigitIndicator | boolean } value - the style value or show indicator of the swiper indicator. 1363 * @returns { SwiperAttribute } 1364 * @syscap SystemCapability.ArkUI.ArkUI.Full 1365 * @crossplatform 1366 * @form 1367 * @atomicservice 1368 * @since 11 1369 */ 1370 indicator(value: DotIndicator | DigitIndicator | boolean): SwiperAttribute; 1371 1372 /** 1373 * Set arrow is enabled, or set the arrow style. 1374 * 1375 * @param { ArrowStyle | boolean } value - arrow is displayed or set the arrow style. 1376 * @param { boolean } isHoverShow - arrow is display when mouse hover in indicator hotspot. 1377 * @returns { SwiperAttribute } return the component attribute. 1378 * @syscap SystemCapability.ArkUI.ArkUI.Full 1379 * @since 10 1380 */ 1381 /** 1382 * Set arrow is enabled, or set the arrow style. 1383 * 1384 * @param { ArrowStyle | boolean } value - arrow is displayed or set the arrow style. 1385 * @param { boolean } isHoverShow - arrow is display when mouse hover in indicator hotspot. 1386 * @returns { SwiperAttribute } return the component attribute. 1387 * @syscap SystemCapability.ArkUI.ArkUI.Full 1388 * @crossplatform 1389 * @atomicservice 1390 * @since 11 1391 */ 1392 displayArrow(value: ArrowStyle | boolean, isHoverShow?: boolean): SwiperAttribute; 1393 1394 /** 1395 * Called when setting whether to turn on cyclic sliding. 1396 * 1397 * @param { boolean } value 1398 * @returns { SwiperAttribute } 1399 * @syscap SystemCapability.ArkUI.ArkUI.Full 1400 * @since 7 1401 */ 1402 /** 1403 * Called when setting whether to turn on cyclic sliding. 1404 * 1405 * @param { boolean } value 1406 * @returns { SwiperAttribute } 1407 * @syscap SystemCapability.ArkUI.ArkUI.Full 1408 * @crossplatform 1409 * @form 1410 * @since 10 1411 */ 1412 /** 1413 * Called when setting whether to turn on cyclic sliding. 1414 * 1415 * @param { boolean } value 1416 * @returns { SwiperAttribute } 1417 * @syscap SystemCapability.ArkUI.ArkUI.Full 1418 * @crossplatform 1419 * @form 1420 * @atomicservice 1421 * @since 11 1422 */ 1423 loop(value: boolean): SwiperAttribute; 1424 1425 /** 1426 * Called when the animation duration of the switch is set. 1427 * 1428 * @param { number } value 1429 * @returns { SwiperAttribute } 1430 * @syscap SystemCapability.ArkUI.ArkUI.Full 1431 * @since 7 1432 */ 1433 /** 1434 * Called when the animation duration of the switch is set. 1435 * 1436 * @param { number } value 1437 * @returns { SwiperAttribute } 1438 * @syscap SystemCapability.ArkUI.ArkUI.Full 1439 * @crossplatform 1440 * @since 10 1441 */ 1442 /** 1443 * Called when the animation duration of the switch is set. 1444 * 1445 * @param { number } value 1446 * @returns { SwiperAttribute } 1447 * @syscap SystemCapability.ArkUI.ArkUI.Full 1448 * @crossplatform 1449 * @atomicservice 1450 * @since 11 1451 */ 1452 duration(value: number): SwiperAttribute; 1453 1454 /** 1455 * Called when setting whether to slide vertically. 1456 * 1457 * @param { boolean } value 1458 * @returns { SwiperAttribute } 1459 * @syscap SystemCapability.ArkUI.ArkUI.Full 1460 * @since 7 1461 */ 1462 /** 1463 * Called when setting whether to slide vertically. 1464 * 1465 * @param { boolean } value 1466 * @returns { SwiperAttribute } 1467 * @syscap SystemCapability.ArkUI.ArkUI.Full 1468 * @crossplatform 1469 * @form 1470 * @since 10 1471 */ 1472 /** 1473 * Called when setting whether to slide vertically. 1474 * 1475 * @param { boolean } value 1476 * @returns { SwiperAttribute } 1477 * @syscap SystemCapability.ArkUI.ArkUI.Full 1478 * @crossplatform 1479 * @form 1480 * @atomicservice 1481 * @since 11 1482 */ 1483 vertical(value: boolean): SwiperAttribute; 1484 1485 /** 1486 * Sets the space between child components. 1487 * 1488 * @param { number | string } value 1489 * @returns { SwiperAttribute } 1490 * @syscap SystemCapability.ArkUI.ArkUI.Full 1491 * @since 7 1492 */ 1493 /** 1494 * Sets the space between child components. 1495 * 1496 * @param { number | string } value 1497 * @returns { SwiperAttribute } 1498 * @syscap SystemCapability.ArkUI.ArkUI.Full 1499 * @crossplatform 1500 * @form 1501 * @since 10 1502 */ 1503 /** 1504 * Sets the space between child components. 1505 * 1506 * @param { number | string } value 1507 * @returns { SwiperAttribute } 1508 * @syscap SystemCapability.ArkUI.ArkUI.Full 1509 * @crossplatform 1510 * @form 1511 * @atomicservice 1512 * @since 11 1513 */ 1514 itemSpace(value: number | string): SwiperAttribute; 1515 1516 /** 1517 * Called when setting the size of the swiper container on the spindle. 1518 * 1519 * @param { SwiperDisplayMode } value 1520 * @returns { SwiperAttribute } 1521 * @syscap SystemCapability.ArkUI.ArkUI.Full 1522 * @since 7 1523 */ 1524 /** 1525 * Called when setting the size of the swiper container on the spindle. 1526 * 1527 * @param { SwiperDisplayMode } value 1528 * @returns { SwiperAttribute } 1529 * @syscap SystemCapability.ArkUI.ArkUI.Full 1530 * @crossplatform 1531 * @form 1532 * @since 10 1533 */ 1534 /** 1535 * Called when setting the size of the swiper container on the spindle. 1536 * 1537 * @param { SwiperDisplayMode } value 1538 * @returns { SwiperAttribute } 1539 * @syscap SystemCapability.ArkUI.ArkUI.Full 1540 * @crossplatform 1541 * @form 1542 * @atomicservice 1543 * @since 11 1544 */ 1545 displayMode(value: SwiperDisplayMode): SwiperAttribute; 1546 1547 /** 1548 * Sets the number of child components to be preloaded(cached). 1549 * 1550 * @param { number } value 1551 * @returns { SwiperAttribute } 1552 * @syscap SystemCapability.ArkUI.ArkUI.Full 1553 * @since 8 1554 */ 1555 /** 1556 * Sets the number of child components to be preloaded(cached). 1557 * 1558 * @param { number } value 1559 * @returns { SwiperAttribute } 1560 * @syscap SystemCapability.ArkUI.ArkUI.Full 1561 * @crossplatform 1562 * @form 1563 * @since 10 1564 */ 1565 /** 1566 * Sets the number of child components to be preloaded(cached). 1567 * 1568 * @param { number } value 1569 * @returns { SwiperAttribute } 1570 * @syscap SystemCapability.ArkUI.ArkUI.Full 1571 * @crossplatform 1572 * @form 1573 * @atomicservice 1574 * @since 11 1575 */ 1576 cachedCount(value: number): SwiperAttribute; 1577 1578 /** 1579 * Sets the number of elements to display per page. 1580 * 1581 * @param { number | string } value 1582 * @returns { SwiperAttribute } 1583 * @syscap SystemCapability.ArkUI.ArkUI.Full 1584 * @since 8 1585 */ 1586 /** 1587 * Sets the number of elements to display per page. 1588 * 1589 * @param { number | string | SwiperAutoFill } value 1590 * @returns { SwiperAttribute } 1591 * @syscap SystemCapability.ArkUI.ArkUI.Full 1592 * @crossplatform 1593 * @form 1594 * @since 10 1595 */ 1596 /** 1597 * Sets the number of elements to display per page. 1598 * 1599 * If swipeByGroup is set to true: 1600 * 1、All sub-items are grouped from index 0. 1601 * 2、The number of sub-items in each group is the value of displayCount. 1602 * 3、If the number of sub-items in the last group is less than displayCount, placeholder items are added to supplement the number of last group. 1603 * 4、Placeholder items do not display any content and are only used as placeholders. 1604 * 5、When turning pages, turn pages by group. 1605 * 1606 * @param { number | string | SwiperAutoFill } value 1607 * @param { boolean } [swipeByGroup] - if swipe by group. 1608 * @returns { SwiperAttribute } 1609 * @syscap SystemCapability.ArkUI.ArkUI.Full 1610 * @crossplatform 1611 * @form 1612 * @atomicservice 1613 * @since 11 1614 */ 1615 displayCount(value: number | string | SwiperAutoFill, swipeByGroup?: boolean): SwiperAttribute; 1616 1617 /** 1618 * Invoked when setting the sliding effect 1619 * 1620 * @param { EdgeEffect } value 1621 * @returns { SwiperAttribute } 1622 * @syscap SystemCapability.ArkUI.ArkUI.Full 1623 * @since 8 1624 */ 1625 /** 1626 * Invoked when setting the sliding effect 1627 * 1628 * @param { EdgeEffect } value 1629 * @returns { SwiperAttribute } 1630 * @syscap SystemCapability.ArkUI.ArkUI.Full 1631 * @crossplatform 1632 * @form 1633 * @since 10 1634 */ 1635 /** 1636 * Invoked when setting the sliding effect 1637 * 1638 * @param { EdgeEffect } value 1639 * @returns { SwiperAttribute } 1640 * @syscap SystemCapability.ArkUI.ArkUI.Full 1641 * @crossplatform 1642 * @form 1643 * @atomicservice 1644 * @since 11 1645 */ 1646 effectMode(value: EdgeEffect): SwiperAttribute; 1647 1648 /** 1649 * Sets whether to disable the swipe feature 1650 * 1651 * @param { boolean } value 1652 * @returns { SwiperAttribute } 1653 * @syscap SystemCapability.ArkUI.ArkUI.Full 1654 * @since 8 1655 */ 1656 /** 1657 * Sets whether to disable the swipe feature 1658 * 1659 * @param { boolean } value 1660 * @returns { SwiperAttribute } 1661 * @syscap SystemCapability.ArkUI.ArkUI.Full 1662 * @crossplatform 1663 * @form 1664 * @since 10 1665 */ 1666 /** 1667 * Sets whether to disable the swipe feature 1668 * 1669 * @param { boolean } value 1670 * @returns { SwiperAttribute } 1671 * @syscap SystemCapability.ArkUI.ArkUI.Full 1672 * @crossplatform 1673 * @form 1674 * @atomicservice 1675 * @since 11 1676 */ 1677 disableSwipe(value: boolean): SwiperAttribute; 1678 1679 /** 1680 * Sets the animation curve 1681 * 1682 * @param { Curve | string } value 1683 * @returns { SwiperAttribute } 1684 * @syscap SystemCapability.ArkUI.ArkUI.Full 1685 * @since 8 1686 */ 1687 /** 1688 * Sets the animation curve 1689 * Curve is an enumeration type for common curves 1690 * ICurve is a curve object 1691 * 1692 * @param { Curve | string | ICurve } value 1693 * @returns { SwiperAttribute } 1694 * @syscap SystemCapability.ArkUI.ArkUI.Full 1695 * @crossplatform 1696 * @form 1697 * @since 10 1698 */ 1699 /** 1700 * Sets the animation curve 1701 * Curve is an enumeration type for common curves 1702 * ICurve is a curve object 1703 * 1704 * @param { Curve | string | ICurve } value 1705 * @returns { SwiperAttribute } 1706 * @syscap SystemCapability.ArkUI.ArkUI.Full 1707 * @crossplatform 1708 * @form 1709 * @atomicservice 1710 * @since 11 1711 */ 1712 curve(value: Curve | string | ICurve): SwiperAttribute; 1713 1714 /** 1715 * Called when the index value changes. 1716 * 1717 * @param { function } event 1718 * @returns { SwiperAttribute } 1719 * @syscap SystemCapability.ArkUI.ArkUI.Full 1720 * @since 7 1721 */ 1722 /** 1723 * Called when the index value changes. 1724 * 1725 * @param { function } event 1726 * @returns { SwiperAttribute } 1727 * @syscap SystemCapability.ArkUI.ArkUI.Full 1728 * @crossplatform 1729 * @form 1730 * @since 10 1731 */ 1732 /** 1733 * Called when the index value changes. 1734 * 1735 * @param { function } event 1736 * @returns { SwiperAttribute } 1737 * @syscap SystemCapability.ArkUI.ArkUI.Full 1738 * @crossplatform 1739 * @form 1740 * @atomicservice 1741 * @since 11 1742 */ 1743 onChange(event: (index: number) => void): SwiperAttribute; 1744 1745 /** 1746 * Setting indicator style navigation. 1747 * 1748 * @param { IndicatorStyle } value 1749 * @returns { SwiperAttribute } 1750 * @syscap SystemCapability.ArkUI.ArkUI.Full 1751 * @since 8 1752 * @deprecated since 10 1753 */ 1754 indicatorStyle(value?: IndicatorStyle): SwiperAttribute; 1755 1756 /** 1757 * The previous margin which can be used to expose a small portion of the previous item. 1758 * 1759 * @param { Length } value - The length of previous margin. 1760 * @returns { SwiperAttribute } The attribute of the swiper. 1761 * @syscap SystemCapability.ArkUI.ArkUI.Full 1762 * @since 10 1763 */ 1764 /** 1765 * The previous margin which can be used to expose a small portion of the previous item. 1766 * 1767 * @param { Length } value - The length of previous margin. 1768 * @returns { SwiperAttribute } The attribute of the swiper. 1769 * @syscap SystemCapability.ArkUI.ArkUI.Full 1770 * @crossplatform 1771 * @atomicservice 1772 * @since 11 1773 */ 1774 /** 1775 * The previous margin which can be used to expose a small portion of the previous item. 1776 * When the previous item is empty, do not display blank space. 1777 * 1778 * @param { Length } value - The length of previous margin. 1779 * @param { boolean } [ignoreBlank] - Whether to hide(ignore) the previous margin on the first page in non-loop scenarios. 1780 * @returns { SwiperAttribute } The attribute of the swiper. 1781 * @syscap SystemCapability.ArkUI.ArkUI.Full 1782 * @crossplatform 1783 * @atomicservice 1784 * @since 12 1785 */ 1786 prevMargin(value: Length, ignoreBlank?: boolean): SwiperAttribute; 1787 1788 /** 1789 * The next margin which can be used to expose a small portion of the latter item. 1790 * 1791 * @param { Length } value - The length of next margin. 1792 * @returns { SwiperAttribute } The attribute of the swiper. 1793 * @syscap SystemCapability.ArkUI.ArkUI.Full 1794 * @since 10 1795 */ 1796 /** 1797 * The next margin which can be used to expose a small portion of the latter item. 1798 * 1799 * @param { Length } value - The length of next margin. 1800 * @returns { SwiperAttribute } The attribute of the swiper. 1801 * @syscap SystemCapability.ArkUI.ArkUI.Full 1802 * @crossplatform 1803 * @atomicservice 1804 * @since 11 1805 */ 1806 /** 1807 * The next margin which can be used to expose a small portion of the latter item. 1808 * When the next item is empty, do not display blank space. 1809 * 1810 * @param { Length } value - The length of next margin. 1811 * @param { boolean } [ignoreBlank] - Whether to hide(ignore) the next margin on the last page in non-loop scenarios. 1812 * @returns { SwiperAttribute } The attribute of the swiper. 1813 * @syscap SystemCapability.ArkUI.ArkUI.Full 1814 * @crossplatform 1815 * @atomicservice 1816 * @since 12 1817 */ 1818 nextMargin(value: Length, ignoreBlank?: boolean): SwiperAttribute; 1819 1820 /** 1821 * Called when the swiper animation start. 1822 * 1823 * @param { function } event - the index value of the swiper page that when animation start. 1824 * @returns { SwiperAttribute } 1825 * @syscap SystemCapability.ArkUI.ArkUI.Full 1826 * @since 9 1827 */ 1828 /** 1829 * Called when the swiper animation start. 1830 * 1831 * @param { function } event 1832 * "index": the index value of the swiper page that when animation start. 1833 * "targetIndex": the target index value of the swiper page that when animation start. 1834 * "extraInfo": the extra callback info. 1835 * @returns { SwiperAttribute } 1836 * @syscap SystemCapability.ArkUI.ArkUI.Full 1837 * @crossplatform 1838 * @form 1839 * @since 10 1840 */ 1841 /** 1842 * Called when the swiper animation start. 1843 * 1844 * @param { function } event 1845 * "index": the index value of the swiper page that when animation start. 1846 * "targetIndex": the target index value of the swiper page that when animation start. 1847 * "extraInfo": the extra callback info. 1848 * @returns { SwiperAttribute } 1849 * @syscap SystemCapability.ArkUI.ArkUI.Full 1850 * @crossplatform 1851 * @form 1852 * @atomicservice 1853 * @since 11 1854 */ 1855 onAnimationStart(event: (index: number, targetIndex: number, extraInfo: SwiperAnimationEvent) => void): SwiperAttribute; 1856 1857 /** 1858 * Called when the swiper animation end. 1859 * 1860 * @param { function } event - the index value of the swiper page that when animation end. 1861 * @returns { SwiperAttribute } 1862 * @syscap SystemCapability.ArkUI.ArkUI.Full 1863 * @since 9 1864 */ 1865 /** 1866 * Called when the swiper animation end. 1867 * 1868 * @param { function } event 1869 * "index": the index value of the swiper page that when animation end. 1870 * "extraInfo": the extra callback info. 1871 * @returns { SwiperAttribute } 1872 * @syscap SystemCapability.ArkUI.ArkUI.Full 1873 * @crossplatform 1874 * @form 1875 * @since 10 1876 */ 1877 /** 1878 * Called when the swiper animation end. 1879 * 1880 * @param { function } event 1881 * "index": the index value of the swiper page that when animation end. 1882 * "extraInfo": the extra callback info. 1883 * @returns { SwiperAttribute } 1884 * @syscap SystemCapability.ArkUI.ArkUI.Full 1885 * @crossplatform 1886 * @form 1887 * @atomicservice 1888 * @since 11 1889 */ 1890 onAnimationEnd(event: (index: number, extraInfo: SwiperAnimationEvent) => void): SwiperAttribute; 1891 1892 /** 1893 * Called when the swiper swipe with the gesture. 1894 * 1895 * @param { function } event 1896 * "index": the index value of the swiper page before gesture swipe. 1897 * "extraInfo": the extra callback info. 1898 * @returns { SwiperAttribute } 1899 * @syscap SystemCapability.ArkUI.ArkUI.Full 1900 * @crossplatform 1901 * @since 10 1902 */ 1903 /** 1904 * Called when the swiper swipe with the gesture. 1905 * 1906 * @param { function } event 1907 * "index": the index value of the swiper page before gesture swipe. 1908 * "extraInfo": the extra callback info. 1909 * @returns { SwiperAttribute } 1910 * @syscap SystemCapability.ArkUI.ArkUI.Full 1911 * @crossplatform 1912 * @atomicservice 1913 * @since 11 1914 */ 1915 onGestureSwipe(event: (index: number, extraInfo: SwiperAnimationEvent) => void): SwiperAttribute; 1916 1917 /** 1918 * Called to setting the nested scroll mode. 1919 * 1920 * @param { SwiperNestedScrollMode } value - mode for nested scrolling. 1921 * @returns { SwiperAttribute } the attribute of the swiper. 1922 * @syscap SystemCapability.ArkUI.ArkUI.Full 1923 * @crossplatform 1924 * @atomicservice 1925 * @since 11 1926 */ 1927 nestedScroll(value: SwiperNestedScrollMode): SwiperAttribute; 1928 1929 /** 1930 * Custom swiper content transition animation. 1931 * 1932 * @param { SwiperContentAnimatedTransition } transition - custom content transition animation. 1933 * @returns { SwiperAttribute } the attribute of the swiper. 1934 * @syscap SystemCapability.ArkUI.ArkUI.Full 1935 * @crossplatform 1936 * @atomicservice 1937 * @since 12 1938 */ 1939 customContentTransition(transition: SwiperContentAnimatedTransition): SwiperAttribute; 1940 1941 /** 1942 * Called when the swiper content did scroll. 1943 * 1944 * @param { ContentDidScrollCallback } handler - callback of scroll, 1945 * selectedIndex is the index value of the swiper content selected before animation start. 1946 * index is the index value of the swiper content. 1947 * position is the moving ratio of the swiper content from the start position of the swiper main axis. 1948 * mainAxisLength is the swiper main axis length for calculating position. 1949 * @returns { SwiperAttribute } the attribute of the swiper. 1950 * @syscap SystemCapability.ArkUI.ArkUI.Full 1951 * @crossplatform 1952 * @atomicservice 1953 * @since 12 1954 */ 1955 onContentDidScroll(handler: ContentDidScrollCallback): SwiperAttribute; 1956 1957 /** 1958 * Setting whether the indicator is interactive. 1959 * 1960 * @param { boolean } value - Whether the indicator is interactive. 1961 * @returns { SwiperAttribute } 1962 * @syscap SystemCapability.ArkUI.ArkUI.Full 1963 * @crossplatform 1964 * @atomicservice 1965 * @since 12 1966 */ 1967 indicatorInteractive(value: boolean): SwiperAttribute; 1968} 1969 1970/** 1971 * Defines the swiper content animated transition options. 1972 * 1973 * @interface SwiperContentAnimatedTransition 1974 * @syscap SystemCapability.ArkUI.ArkUI.Full 1975 * @crossplatform 1976 * @atomicservice 1977 * @since 12 1978 */ 1979declare interface SwiperContentAnimatedTransition { 1980 /** 1981 * Defines the timeout of custom content transition animation after the page is moved out of the swiper. The unit is ms. 1982 * If SwiperContentTransitionProxy.finishTransition() is not invoked, use the timeout as animation end time. 1983 * 1984 * @type { ?number } 1985 * @default 0 ms 1986 * @syscap SystemCapability.ArkUI.ArkUI.Full 1987 * @crossplatform 1988 * @atomicservice 1989 * @since 12 1990 */ 1991 timeout?: number; 1992 1993 /** 1994 * Called when custom content transition animation start. 1995 * 1996 * @type { Callback<SwiperContentTransitionProxy> } 1997 * @syscap SystemCapability.ArkUI.ArkUI.Full 1998 * @crossplatform 1999 * @atomicservice 2000 * @since 12 2001 */ 2002 transition: Callback<SwiperContentTransitionProxy>; 2003} 2004 2005/** 2006 * The proxy of SwiperContentAnimatedTransition. 2007 * 2008 * @interface SwiperContentTransitionProxy 2009 * @syscap SystemCapability.ArkUI.ArkUI.Full 2010 * @crossplatform 2011 * @atomicservice 2012 * @since 12 2013 */ 2014declare interface SwiperContentTransitionProxy { 2015 /** 2016 * the index value of the swiper content selected before animation start. 2017 * 2018 * @type { number } 2019 * @syscap SystemCapability.ArkUI.ArkUI.Full 2020 * @crossplatform 2021 * @atomicservice 2022 * @since 12 2023 */ 2024 selectedIndex: number; 2025 2026 /** 2027 * The index value of the swiper content. 2028 * 2029 * @type { number } 2030 * @syscap SystemCapability.ArkUI.ArkUI.Full 2031 * @crossplatform 2032 * @atomicservice 2033 * @since 12 2034 */ 2035 index: number; 2036 2037 /** 2038 * the moving ratio of the swiper content from the start position of the swiper main axis. 2039 * 2040 * @type { number } 2041 * @syscap SystemCapability.ArkUI.ArkUI.Full 2042 * @crossplatform 2043 * @atomicservice 2044 * @since 12 2045 */ 2046 position: number; 2047 2048 /** 2049 * the swiper main axis length for calculating position. 2050 * 2051 * @type { number } 2052 * @syscap SystemCapability.ArkUI.ArkUI.Full 2053 * @crossplatform 2054 * @atomicservice 2055 * @since 12 2056 */ 2057 mainAxisLength: number; 2058 2059 /** 2060 * Notifies Swiper page the custom content transition animation is complete. 2061 * 2062 * @syscap SystemCapability.ArkUI.ArkUI.Full 2063 * @crossplatform 2064 * @atomicservice 2065 * @since 12 2066 */ 2067 finishTransition(): void; 2068} 2069 2070/** 2071 * The callback of onContentDidScroll. 2072 * 2073 * @typedef { Function } ContentDidScrollCallback 2074 * @param { number } selectedIndex - the index value of the swiper content selected before animation start. 2075 * @param { number } index - the index value of the swiper content. 2076 * @param { number } position - the moving ratio of the swiper content from the start position of the swiper main axis. 2077 * @param { number } mainAxisLength - the swiper main axis length for calculating position. 2078 * @syscap SystemCapability.ArkUI.ArkUI.Full 2079 * @crossplatform 2080 * @atomicservice 2081 * @since 12 2082 */ 2083declare type ContentDidScrollCallback = (selectedIndex: number, index: number, position: number, mainAxisLength: number) => void; 2084 2085/** 2086 * Defines Swiper Component. 2087 * 2088 * @syscap SystemCapability.ArkUI.ArkUI.Full 2089 * @since 7 2090 */ 2091/** 2092 * Defines Swiper Component. 2093 * 2094 * @syscap SystemCapability.ArkUI.ArkUI.Full 2095 * @crossplatform 2096 * @form 2097 * @since 10 2098 */ 2099/** 2100 * Defines Swiper Component. 2101 * 2102 * @syscap SystemCapability.ArkUI.ArkUI.Full 2103 * @crossplatform 2104 * @form 2105 * @atomicservice 2106 * @since 11 2107 */ 2108declare const Swiper: SwiperInterface; 2109 2110/** 2111 * Defines Swiper Component instance. 2112 * 2113 * @syscap SystemCapability.ArkUI.ArkUI.Full 2114 * @since 7 2115 */ 2116/** 2117 * Defines Swiper Component instance. 2118 * 2119 * @syscap SystemCapability.ArkUI.ArkUI.Full 2120 * @crossplatform 2121 * @form 2122 * @since 10 2123 */ 2124/** 2125 * Defines Swiper Component instance. 2126 * 2127 * @syscap SystemCapability.ArkUI.ArkUI.Full 2128 * @crossplatform 2129 * @form 2130 * @atomicservice 2131 * @since 11 2132 */ 2133declare const SwiperInstance: SwiperAttribute; 2134