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