1/* 2 * Copyright (c) 2021-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkUI 19 */ 20 21/** 22 * Declare sliderstyle 23 * 24 * @enum { number } 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 7 27 */ 28/** 29 * Declare sliderstyle 30 * 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @form 34 * @since 9 35 */ 36/** 37 * Declare sliderstyle 38 * 39 * @enum { number } 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @form 43 * @since 10 44 */ 45/** 46 * Declare sliderstyle 47 * 48 * @enum { number } 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @crossplatform 51 * @form 52 * @atomicservice 53 * @since 11 54 */ 55declare enum SliderStyle { 56 /** 57 * The slider is on the slide rail. 58 * 59 * @syscap SystemCapability.ArkUI.ArkUI.Full 60 * @since 7 61 */ 62 /** 63 * The slider is on the slide rail. 64 * 65 * @syscap SystemCapability.ArkUI.ArkUI.Full 66 * @form 67 * @since 9 68 */ 69 /** 70 * The slider is on the slide rail. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @crossplatform 74 * @form 75 * @since 10 76 */ 77 /** 78 * The slider is on the slide rail. 79 * 80 * @syscap SystemCapability.ArkUI.ArkUI.Full 81 * @crossplatform 82 * @form 83 * @atomicservice 84 * @since 11 85 */ 86 OutSet, 87 88 /** 89 * The slider is in the slide rail. 90 * 91 * @syscap SystemCapability.ArkUI.ArkUI.Full 92 * @since 7 93 */ 94 /** 95 * The slider is in the slide rail. 96 * 97 * @syscap SystemCapability.ArkUI.ArkUI.Full 98 * @form 99 * @since 9 100 */ 101 /** 102 * The slider is in the slide rail. 103 * 104 * @syscap SystemCapability.ArkUI.ArkUI.Full 105 * @crossplatform 106 * @form 107 * @since 10 108 */ 109 /** 110 * The slider is in the slide rail. 111 * 112 * @syscap SystemCapability.ArkUI.ArkUI.Full 113 * @crossplatform 114 * @form 115 * @atomicservice 116 * @since 11 117 */ 118 InSet, 119 /** 120 * No slider. 121 * 122 * @syscap SystemCapability.ArkUI.ArkUI.Full 123 * @crossplatform 124 * @form 125 * @atomicservice 126 * @since 12 127 */ 128 NONE, 129} 130 131/** 132 * Declare SliderChangeMode 133 * 134 * @enum { number } 135 * @syscap SystemCapability.ArkUI.ArkUI.Full 136 * @since 7 137 */ 138/** 139 * Declare SliderChangeMode 140 * 141 * @enum { number } 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @form 144 * @since 9 145 */ 146/** 147 * Declare SliderChangeMode 148 * 149 * @enum { number } 150 * @syscap SystemCapability.ArkUI.ArkUI.Full 151 * @crossplatform 152 * @form 153 * @since 10 154 */ 155/** 156 * Declare SliderChangeMode 157 * 158 * @enum { number } 159 * @syscap SystemCapability.ArkUI.ArkUI.Full 160 * @crossplatform 161 * @form 162 * @atomicservice 163 * @since 11 164 */ 165declare enum SliderChangeMode { 166 /** 167 * Start dragging the slider. 168 * 169 * @syscap SystemCapability.ArkUI.ArkUI.Full 170 * @since 7 171 */ 172 /** 173 * Start dragging the slider. 174 * 175 * @syscap SystemCapability.ArkUI.ArkUI.Full 176 * @form 177 * @since 9 178 */ 179 /** 180 * Start dragging the slider. 181 * 182 * @syscap SystemCapability.ArkUI.ArkUI.Full 183 * @crossplatform 184 * @form 185 * @since 10 186 */ 187 /** 188 * Start dragging the slider. 189 * 190 * @syscap SystemCapability.ArkUI.ArkUI.Full 191 * @crossplatform 192 * @form 193 * @atomicservice 194 * @since 11 195 */ 196 Begin, 197 198 /** 199 * Drag the slider. 200 * 201 * @syscap SystemCapability.ArkUI.ArkUI.Full 202 * @since 7 203 */ 204 /** 205 * Drag the slider. 206 * 207 * @syscap SystemCapability.ArkUI.ArkUI.Full 208 * @form 209 * @since 9 210 */ 211 /** 212 * Drag the slider. 213 * 214 * @syscap SystemCapability.ArkUI.ArkUI.Full 215 * @crossplatform 216 * @form 217 * @since 10 218 */ 219 /** 220 * Drag the slider. 221 * 222 * @syscap SystemCapability.ArkUI.ArkUI.Full 223 * @crossplatform 224 * @form 225 * @atomicservice 226 * @since 11 227 */ 228 Moving, 229 230 /** 231 * End dragging the slider. 232 * 233 * @syscap SystemCapability.ArkUI.ArkUI.Full 234 * @since 7 235 */ 236 /** 237 * End dragging the slider. 238 * 239 * @syscap SystemCapability.ArkUI.ArkUI.Full 240 * @form 241 * @since 9 242 */ 243 /** 244 * End dragging the slider. 245 * 246 * @syscap SystemCapability.ArkUI.ArkUI.Full 247 * @crossplatform 248 * @form 249 * @since 10 250 */ 251 /** 252 * End dragging the slider. 253 * 254 * @syscap SystemCapability.ArkUI.ArkUI.Full 255 * @crossplatform 256 * @form 257 * @atomicservice 258 * @since 11 259 */ 260 End, 261 262 /** 263 * Click the slider. 264 * 265 * @syscap SystemCapability.ArkUI.ArkUI.Full 266 * @since 8 267 */ 268 /** 269 * Click the slider. 270 * 271 * @syscap SystemCapability.ArkUI.ArkUI.Full 272 * @form 273 * @since 9 274 */ 275 /** 276 * Click the slider. 277 * 278 * @syscap SystemCapability.ArkUI.ArkUI.Full 279 * @crossplatform 280 * @form 281 * @since 10 282 */ 283 /** 284 * Click the slider. 285 * 286 * @syscap SystemCapability.ArkUI.ArkUI.Full 287 * @crossplatform 288 * @form 289 * @atomicservice 290 * @since 11 291 */ 292 Click, 293} 294 295/** 296 * Declare SliderInteraction 297 * 298 * @enum { number } 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @atomicservice 302 * @since 12 303 */ 304declare enum SliderInteraction { 305 /** 306 * Allow user to slide the block and click track to move the block 307 * 308 * @syscap SystemCapability.ArkUI.ArkUI.Full 309 * @crossplatform 310 * @atomicservice 311 * @since 12 312 */ 313 SLIDE_AND_CLICK, 314 315 /** 316 * Only allow user to slide the block 317 * 318 * @syscap SystemCapability.ArkUI.ArkUI.Full 319 * @crossplatform 320 * @atomicservice 321 * @since 12 322 */ 323 SLIDE_ONLY, 324 325 /** 326 * Allow user to slide the block and click track to move the block, but click value only change when touch up. 327 * 328 * @syscap SystemCapability.ArkUI.ArkUI.Full 329 * @crossplatform 330 * @atomicservice 331 * @since 12 332 */ 333 SLIDE_AND_CLICK_UP = 2 334} 335 336/** 337 * Defines the valid slidable range. If and only if MIN <= from <= to <= MAX, sliding range can be set successfully. 338 * 339 * @interface SlideRange 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @crossplatform 342 * @atomicservice 343 * @since 12 344 */ 345declare interface SlideRange { 346 /** 347 * Set the start point of sliding range. 348 * 349 * @type { ?number } 350 * @syscap SystemCapability.ArkUI.ArkUI.Full 351 * @crossplatform 352 * @atomicservice 353 * @since 12 354 */ 355 from?: number; 356 357 /** 358 * Set the end point of sliding range. 359 * 360 * @type { ?number } 361 * @syscap SystemCapability.ArkUI.ArkUI.Full 362 * @crossplatform 363 * @atomicservice 364 * @since 12 365 */ 366 to?: number; 367} 368 369/** 370 * Defines the options of Slider. 371 * 372 * @interface SliderOptions 373 * @syscap SystemCapability.ArkUI.ArkUI.Full 374 * @since 7 375 */ 376/** 377 * Defines the options of Slider. 378 * 379 * @interface SliderOptions 380 * @syscap SystemCapability.ArkUI.ArkUI.Full 381 * @form 382 * @since 9 383 */ 384/** 385 * Defines the options of Slider. 386 * 387 * @interface SliderOptions 388 * @syscap SystemCapability.ArkUI.ArkUI.Full 389 * @crossplatform 390 * @form 391 * @since 10 392 */ 393/** 394 * Defines the options of Slider. 395 * 396 * @interface SliderOptions 397 * @syscap SystemCapability.ArkUI.ArkUI.Full 398 * @crossplatform 399 * @form 400 * @atomicservice 401 * @since 11 402 */ 403declare interface SliderOptions { 404 /** 405 * Current value of Slider. 406 * 407 * @type { ?number } 408 * @syscap SystemCapability.ArkUI.ArkUI.Full 409 * @since 7 410 */ 411 /** 412 * Current value of Slider. 413 * 414 * @type { ?number } 415 * @syscap SystemCapability.ArkUI.ArkUI.Full 416 * @form 417 * @since 9 418 */ 419 /** 420 * Current value of Slider. 421 * 422 * @type { ?number } 423 * @syscap SystemCapability.ArkUI.ArkUI.Full 424 * @crossplatform 425 * @form 426 * @since 10 427 */ 428 /** 429 * Current value of Slider. 430 * 431 * @type { ?number } 432 * @syscap SystemCapability.ArkUI.ArkUI.Full 433 * @crossplatform 434 * @form 435 * @atomicservice 436 * @since 11 437 */ 438 value?: number; 439 440 /** 441 * Sets the min value of Slider. 442 * 443 * @type { ?number } 444 * @syscap SystemCapability.ArkUI.ArkUI.Full 445 * @since 7 446 */ 447 /** 448 * Sets the min value of Slider. 449 * 450 * @type { ?number } 451 * @syscap SystemCapability.ArkUI.ArkUI.Full 452 * @form 453 * @since 9 454 */ 455 /** 456 * Sets the min value of Slider. 457 * 458 * @type { ?number } 459 * @syscap SystemCapability.ArkUI.ArkUI.Full 460 * @crossplatform 461 * @form 462 * @since 10 463 */ 464 /** 465 * Sets the min value of Slider. 466 * 467 * @type { ?number } 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @crossplatform 470 * @form 471 * @atomicservice 472 * @since 11 473 */ 474 min?: number; 475 476 /** 477 * Sets the max value of Slider. 478 * 479 * @type { ?number } 480 * @syscap SystemCapability.ArkUI.ArkUI.Full 481 * @since 7 482 */ 483 /** 484 * Sets the max value of Slider. 485 * 486 * @type { ?number } 487 * @syscap SystemCapability.ArkUI.ArkUI.Full 488 * @form 489 * @since 9 490 */ 491 /** 492 * Sets the max value of Slider. 493 * 494 * @type { ?number } 495 * @syscap SystemCapability.ArkUI.ArkUI.Full 496 * @crossplatform 497 * @form 498 * @since 10 499 */ 500 /** 501 * Sets the max value of Slider. 502 * 503 * @type { ?number } 504 * @syscap SystemCapability.ArkUI.ArkUI.Full 505 * @crossplatform 506 * @form 507 * @atomicservice 508 * @since 11 509 */ 510 max?: number; 511 512 /** 513 * Sets the step of each slide value. 514 * 515 * @type { ?number } 516 * @syscap SystemCapability.ArkUI.ArkUI.Full 517 * @since 7 518 */ 519 /** 520 * Sets the step of each slide value. 521 * 522 * @type { ?number } 523 * @syscap SystemCapability.ArkUI.ArkUI.Full 524 * @form 525 * @since 9 526 */ 527 /** 528 * Sets the step of each slide value. 529 * 530 * @type { ?number } 531 * @syscap SystemCapability.ArkUI.ArkUI.Full 532 * @crossplatform 533 * @form 534 * @since 10 535 */ 536 /** 537 * Sets the step of each slide value. 538 * 539 * @type { ?number } 540 * @syscap SystemCapability.ArkUI.ArkUI.Full 541 * @crossplatform 542 * @form 543 * @atomicservice 544 * @since 11 545 */ 546 step?: number; 547 548 /** 549 * Sets the slider style. 550 * 551 * @type { ?SliderStyle } 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @since 7 554 */ 555 /** 556 * Sets the slider style. 557 * 558 * @type { ?SliderStyle } 559 * @syscap SystemCapability.ArkUI.ArkUI.Full 560 * @form 561 * @since 9 562 */ 563 /** 564 * Sets the slider style. 565 * 566 * @type { ?SliderStyle } 567 * @syscap SystemCapability.ArkUI.ArkUI.Full 568 * @crossplatform 569 * @form 570 * @since 10 571 */ 572 /** 573 * Sets the slider style. 574 * 575 * @type { ?SliderStyle } 576 * @syscap SystemCapability.ArkUI.ArkUI.Full 577 * @crossplatform 578 * @form 579 * @atomicservice 580 * @since 11 581 */ 582 style?: SliderStyle; 583 584 /** 585 * Sets the slider direction style. 586 * 587 * @type { ?Axis } 588 * @syscap SystemCapability.ArkUI.ArkUI.Full 589 * @since 8 590 */ 591 /** 592 * Sets the slider direction style. 593 * 594 * @type { ?Axis } 595 * @syscap SystemCapability.ArkUI.ArkUI.Full 596 * @form 597 * @since 9 598 */ 599 /** 600 * Sets the slider direction style. 601 * 602 * @type { ?Axis } 603 * @syscap SystemCapability.ArkUI.ArkUI.Full 604 * @crossplatform 605 * @form 606 * @since 10 607 */ 608 /** 609 * Sets the slider direction style. 610 * 611 * @type { ?Axis } 612 * @syscap SystemCapability.ArkUI.ArkUI.Full 613 * @crossplatform 614 * @form 615 * @atomicservice 616 * @since 11 617 */ 618 direction?: Axis; 619 620 /** 621 * Set whether the direction of the slider needs to be reversed. 622 * 623 * @type { ?boolean } 624 * @syscap SystemCapability.ArkUI.ArkUI.Full 625 * @since 8 626 */ 627 /** 628 * Set whether the direction of the slider needs to be reversed. 629 * 630 * @type { ?boolean } 631 * @syscap SystemCapability.ArkUI.ArkUI.Full 632 * @form 633 * @since 9 634 */ 635 /** 636 * Set whether the direction of the slider needs to be reversed. 637 * 638 * @type { ?boolean } 639 * @syscap SystemCapability.ArkUI.ArkUI.Full 640 * @crossplatform 641 * @form 642 * @since 10 643 */ 644 /** 645 * Set whether the direction of the slider needs to be reversed. 646 * 647 * @type { ?boolean } 648 * @syscap SystemCapability.ArkUI.ArkUI.Full 649 * @crossplatform 650 * @form 651 * @atomicservice 652 * @since 11 653 */ 654 reverse?: boolean; 655} 656 657/** 658 * Declare SliderBlockType 659 * 660 * @enum { number } 661 * @syscap SystemCapability.ArkUI.ArkUI.Full 662 * @crossplatform 663 * @since 10 664 */ 665/** 666 * Declare SliderBlockType 667 * 668 * @enum { number } 669 * @syscap SystemCapability.ArkUI.ArkUI.Full 670 * @crossplatform 671 * @atomicservice 672 * @since 11 673 */ 674declare enum SliderBlockType { 675 /** 676 * Use the default block. 677 * 678 * @syscap SystemCapability.ArkUI.ArkUI.Full 679 * @crossplatform 680 * @since 10 681 */ 682 /** 683 * Use the default block. 684 * 685 * @syscap SystemCapability.ArkUI.ArkUI.Full 686 * @crossplatform 687 * @atomicservice 688 * @since 11 689 */ 690 DEFAULT, 691 692 /** 693 * Use an image as the slider block. 694 * 695 * @syscap SystemCapability.ArkUI.ArkUI.Full 696 * @crossplatform 697 * @since 10 698 */ 699 /** 700 * Use an image as the slider block. 701 * 702 * @syscap SystemCapability.ArkUI.ArkUI.Full 703 * @crossplatform 704 * @atomicservice 705 * @since 11 706 */ 707 IMAGE, 708 709 /** 710 * Use a shape as the slider block. 711 * 712 * @syscap SystemCapability.ArkUI.ArkUI.Full 713 * @crossplatform 714 * @since 10 715 */ 716 /** 717 * Use a shape as the slider block. 718 * 719 * @syscap SystemCapability.ArkUI.ArkUI.Full 720 * @crossplatform 721 * @atomicservice 722 * @since 11 723 */ 724 SHAPE, 725} 726 727/** 728 * Defines the style of slider block. 729 * 730 * @interface SliderBlockStyle 731 * @syscap SystemCapability.ArkUI.ArkUI.Full 732 * @crossplatform 733 * @since 10 734 */ 735/** 736 * Defines the style of slider block. 737 * 738 * @interface SliderBlockStyle 739 * @syscap SystemCapability.ArkUI.ArkUI.Full 740 * @crossplatform 741 * @atomicservice 742 * @since 11 743 */ 744declare interface SliderBlockStyle { 745 /** 746 * Sets the type of slider block. 747 * 748 * @type { SliderBlockType } 749 * @syscap SystemCapability.ArkUI.ArkUI.Full 750 * @crossplatform 751 * @since 10 752 */ 753 /** 754 * Sets the type of slider block. 755 * 756 * @type { SliderBlockType } 757 * @syscap SystemCapability.ArkUI.ArkUI.Full 758 * @crossplatform 759 * @atomicservice 760 * @since 11 761 */ 762 type: SliderBlockType; 763 764 /** 765 * Sets the image of slider block while the type is set to SliderBlockType.Image. 766 * 767 * @type { ?ResourceStr } 768 * @syscap SystemCapability.ArkUI.ArkUI.Full 769 * @crossplatform 770 * @since 10 771 */ 772 /** 773 * Sets the image of slider block while the type is set to SliderBlockType.Image. 774 * 775 * @type { ?ResourceStr } 776 * @syscap SystemCapability.ArkUI.ArkUI.Full 777 * @crossplatform 778 * @atomicservice 779 * @since 11 780 */ 781 image?: ResourceStr; 782 783 /** 784 * Sets the shape of slider block while the type is set to SliderBlockType.Shape. 785 * 786 * @type { ?(CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute) } 787 * @syscap SystemCapability.ArkUI.ArkUI.Full 788 * @crossplatform 789 * @since 10 790 */ 791 /** 792 * Sets the shape of slider block while the type is set to SliderBlockType.Shape. 793 * 794 * @type { ?(CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute) } 795 * @syscap SystemCapability.ArkUI.ArkUI.Full 796 * @crossplatform 797 * @atomicservice 798 * @since 11 799 */ 800 shape?: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute; 801} 802 803/** 804 * Defines the callback type used in SliderConfiguration. 805 * 806 * @typedef {function} SliderTriggerChangeCallback 807 * @param { number } value - The value of slider. 808 * @param { SliderChangeMode } mode - The changeMode of slider. 809 * @syscap SystemCapability.ArkUI.ArkUI.Full 810 * @crossplatform 811 * @atomicservice 812 * @since 12 813 */ 814declare type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMode) => void; 815 816/** 817 * SliderConfiguration used by slider content modifier 818 * 819 * @interface SliderConfiguration 820 * @syscap SystemCapability.ArkUI.ArkUI.Full 821 * @crossplatform 822 * @atomicservice 823 * @since 12 824 */ 825declare interface SliderConfiguration extends CommonConfiguration<SliderConfiguration> { 826 /** 827 * Current progress value. 828 * 829 * @type { number } 830 * @syscap SystemCapability.ArkUI.ArkUI.Full 831 * @crossplatform 832 * @atomicservice 833 * @since 12 834 */ 835 value: number; 836 837 /** 838 * Minimum value. 839 * 840 * @type { number } 841 * @syscap SystemCapability.ArkUI.ArkUI.Full 842 * @crossplatform 843 * @atomicservice 844 * @since 12 845 */ 846 min: number; 847 848 /** 849 * Maximum value. 850 * 851 * @type { number } 852 * @syscap SystemCapability.ArkUI.ArkUI.Full 853 * @crossplatform 854 * @atomicservice 855 * @since 12 856 */ 857 max: number; 858 859 /** 860 * The sliding step size of Slider. 861 * 862 * @type { number } 863 * @syscap SystemCapability.ArkUI.ArkUI.Full 864 * @crossplatform 865 * @atomicservice 866 * @since 12 867 */ 868 step: number; 869 870 /** 871 * Trigger slider change 872 * 873 * @type { SliderTriggerChangeCallback } 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @crossplatform 876 * @atomicservice 877 * @since 12 878 */ 879 triggerChange: SliderTriggerChangeCallback; 880} 881 882/** 883 * Provides an interface for the slide bar component. 884 * 885 * @interface SliderInterface 886 * @syscap SystemCapability.ArkUI.ArkUI.Full 887 * @since 7 888 */ 889/** 890 * Provides an interface for the slide bar component. 891 * 892 * @interface SliderInterface 893 * @syscap SystemCapability.ArkUI.ArkUI.Full 894 * @form 895 * @since 9 896 */ 897/** 898 * Provides an interface for the slide bar component. 899 * 900 * @interface SliderInterface 901 * @syscap SystemCapability.ArkUI.ArkUI.Full 902 * @crossplatform 903 * @form 904 * @since 10 905 */ 906/** 907 * Provides an interface for the slide bar component. 908 * 909 * @interface SliderInterface 910 * @syscap SystemCapability.ArkUI.ArkUI.Full 911 * @crossplatform 912 * @form 913 * @atomicservice 914 * @since 11 915 */ 916interface SliderInterface { 917 /** 918 * Called when the slider bar component is used. 919 * 920 * @param { SliderOptions } options 921 * @returns { SliderAttribute } 922 * @syscap SystemCapability.ArkUI.ArkUI.Full 923 * @since 7 924 */ 925 /** 926 * Called when the slider bar component is used. 927 * 928 * @param { SliderOptions } options 929 * @returns { SliderAttribute } 930 * @syscap SystemCapability.ArkUI.ArkUI.Full 931 * @form 932 * @since 9 933 */ 934 /** 935 * Called when the slider bar component is used. 936 * 937 * @param { SliderOptions } options 938 * @returns { SliderAttribute } 939 * @syscap SystemCapability.ArkUI.ArkUI.Full 940 * @crossplatform 941 * @form 942 * @since 10 943 */ 944 /** 945 * Called when the slider bar component is used. 946 * 947 * @param { SliderOptions } options 948 * @returns { SliderAttribute } 949 * @syscap SystemCapability.ArkUI.ArkUI.Full 950 * @crossplatform 951 * @form 952 * @atomicservice 953 * @since 11 954 */ 955 (options?: SliderOptions): SliderAttribute; 956} 957 958/** 959 * Defines the attribute functions of Slider. 960 * 961 * @extends CommonMethod<SliderAttribute> 962 * @syscap SystemCapability.ArkUI.ArkUI.Full 963 * @since 7 964 */ 965/** 966 * Defines the attribute functions of Slider. 967 * 968 * @extends CommonMethod<SliderAttribute> 969 * @syscap SystemCapability.ArkUI.ArkUI.Full 970 * @form 971 * @since 9 972 */ 973/** 974 * Defines the attribute functions of Slider. 975 * 976 * @extends CommonMethod<SliderAttribute> 977 * @syscap SystemCapability.ArkUI.ArkUI.Full 978 * @crossplatform 979 * @form 980 * @since 10 981 */ 982/** 983 * Defines the attribute functions of Slider. 984 * 985 * @extends CommonMethod<SliderAttribute> 986 * @syscap SystemCapability.ArkUI.ArkUI.Full 987 * @crossplatform 988 * @form 989 * @atomicservice 990 * @since 11 991 */ 992declare class SliderAttribute extends CommonMethod<SliderAttribute> { 993 /** 994 * Called when the slider color of the slider bar is set. 995 * 996 * @param { ResourceColor } value 997 * @returns { SliderAttribute } 998 * @syscap SystemCapability.ArkUI.ArkUI.Full 999 * @since 7 1000 */ 1001 /** 1002 * Called when the slider color of the slider bar is set. 1003 * 1004 * @param { ResourceColor } value 1005 * @returns { SliderAttribute } 1006 * @syscap SystemCapability.ArkUI.ArkUI.Full 1007 * @form 1008 * @since 9 1009 */ 1010 /** 1011 * Called when the slider color of the slider bar is set. 1012 * 1013 * @param { ResourceColor } value 1014 * @returns { SliderAttribute } 1015 * @syscap SystemCapability.ArkUI.ArkUI.Full 1016 * @crossplatform 1017 * @form 1018 * @since 10 1019 */ 1020 /** 1021 * Called when the slider color of the slider bar is set. 1022 * 1023 * @param { ResourceColor } value 1024 * @returns { SliderAttribute } 1025 * @syscap SystemCapability.ArkUI.ArkUI.Full 1026 * @crossplatform 1027 * @form 1028 * @atomicservice 1029 * @since 11 1030 */ 1031 blockColor(value: ResourceColor): SliderAttribute; 1032 1033 /** 1034 * Called when the track color of the slider is set. 1035 * 1036 * @param { ResourceColor } value 1037 * @returns { SliderAttribute } 1038 * @syscap SystemCapability.ArkUI.ArkUI.Full 1039 * @since 7 1040 */ 1041 /** 1042 * Called when the track color of the slider is set. 1043 * 1044 * @param { ResourceColor } value 1045 * @returns { SliderAttribute } 1046 * @syscap SystemCapability.ArkUI.ArkUI.Full 1047 * @form 1048 * @since 9 1049 */ 1050 /** 1051 * Called when the track color of the slider is set. 1052 * 1053 * @param { ResourceColor } value 1054 * @returns { SliderAttribute } 1055 * @syscap SystemCapability.ArkUI.ArkUI.Full 1056 * @crossplatform 1057 * @form 1058 * @since 10 1059 */ 1060 /** 1061 * Called when the track color of the slider is set. 1062 * 1063 * @param { ResourceColor } value 1064 * @returns { SliderAttribute } 1065 * @syscap SystemCapability.ArkUI.ArkUI.Full 1066 * @crossplatform 1067 * @form 1068 * @atomicservice 1069 * @since 11 1070 */ 1071 /** 1072 * Called when the track color of the slider is set. 1073 * 1074 * @param { ResourceColor | LinearGradient } value 1075 * @returns { SliderAttribute } 1076 * @syscap SystemCapability.ArkUI.ArkUI.Full 1077 * @crossplatform 1078 * @form 1079 * @atomicservice 1080 * @since 12 1081 */ 1082 trackColor(value: ResourceColor | LinearGradient): SliderAttribute; 1083 1084 /** 1085 * Called when the slider of the slider bar is set to slide over the area color. 1086 * 1087 * @param { ResourceColor } value 1088 * @returns { SliderAttribute } 1089 * @syscap SystemCapability.ArkUI.ArkUI.Full 1090 * @since 7 1091 */ 1092 /** 1093 * Called when the slider of the slider bar is set to slide over the area color. 1094 * 1095 * @param { ResourceColor } value 1096 * @returns { SliderAttribute } 1097 * @syscap SystemCapability.ArkUI.ArkUI.Full 1098 * @form 1099 * @since 9 1100 */ 1101 /** 1102 * Called when the slider of the slider bar is set to slide over the area color. 1103 * 1104 * @param { ResourceColor } value 1105 * @returns { SliderAttribute } 1106 * @syscap SystemCapability.ArkUI.ArkUI.Full 1107 * @crossplatform 1108 * @form 1109 * @since 10 1110 */ 1111 /** 1112 * Called when the slider of the slider bar is set to slide over the area color. 1113 * 1114 * @param { ResourceColor } value 1115 * @returns { SliderAttribute } 1116 * @syscap SystemCapability.ArkUI.ArkUI.Full 1117 * @crossplatform 1118 * @form 1119 * @atomicservice 1120 * @since 11 1121 */ 1122 selectedColor(value: ResourceColor): SliderAttribute; 1123 1124 /** 1125 * Called when the minimum label is set. 1126 * 1127 * @param { string } value 1128 * @returns { SliderAttribute } 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @since 7 1131 * @deprecated since 9 1132 * @useinstead min 1133 */ 1134 minLabel(value: string): SliderAttribute; 1135 1136 /** 1137 * Called when the maximum label is set. 1138 * 1139 * @param { string } value 1140 * @returns { SliderAttribute } 1141 * @syscap SystemCapability.ArkUI.ArkUI.Full 1142 * @since 7 1143 * @deprecated since 9 1144 * @useinstead max 1145 */ 1146 maxLabel(value: string): SliderAttribute; 1147 1148 /** 1149 * Called when setting whether to display step size. 1150 * 1151 * @param { boolean } value 1152 * @returns { SliderAttribute } 1153 * @syscap SystemCapability.ArkUI.ArkUI.Full 1154 * @since 7 1155 */ 1156 /** 1157 * Called when setting whether to display step size. 1158 * 1159 * @param { boolean } value 1160 * @returns { SliderAttribute } 1161 * @syscap SystemCapability.ArkUI.ArkUI.Full 1162 * @form 1163 * @since 9 1164 */ 1165 /** 1166 * Called when setting whether to display step size. 1167 * 1168 * @param { boolean } value 1169 * @returns { SliderAttribute } 1170 * @syscap SystemCapability.ArkUI.ArkUI.Full 1171 * @crossplatform 1172 * @form 1173 * @since 10 1174 */ 1175 /** 1176 * Called when setting whether to display step size. 1177 * 1178 * @param { boolean } value 1179 * @returns { SliderAttribute } 1180 * @syscap SystemCapability.ArkUI.ArkUI.Full 1181 * @crossplatform 1182 * @form 1183 * @atomicservice 1184 * @since 11 1185 */ 1186 showSteps(value: boolean): SliderAttribute; 1187 1188 /** 1189 * Called when the percentage of bubble prompt is set when sliding. 1190 * 1191 * @param { boolean } value 1192 * @returns { SliderAttribute } 1193 * @syscap SystemCapability.ArkUI.ArkUI.Full 1194 * @since 7 1195 */ 1196 /** 1197 * Called when the percentage of bubble prompt is set when sliding. 1198 * 1199 * @param { boolean } value 1200 * @returns { SliderAttribute } 1201 * @syscap SystemCapability.ArkUI.ArkUI.Full 1202 * @form 1203 * @since 9 1204 */ 1205 /** 1206 * Called when the percentage of bubble prompt is set when sliding. 1207 * 1208 * @param { boolean } value - Whether to display the bubble. 1209 * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current 1210 * percentage is displayed by default. 1211 * @returns { SliderAttribute } 1212 * @syscap SystemCapability.ArkUI.ArkUI.Full 1213 * @crossplatform 1214 * @form 1215 * @since 10 1216 */ 1217 /** 1218 * Called when the percentage of bubble prompt is set when sliding. 1219 * 1220 * @param { boolean } value - Whether to display the bubble. 1221 * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current 1222 * percentage is displayed by default. 1223 * @returns { SliderAttribute } 1224 * @syscap SystemCapability.ArkUI.ArkUI.Full 1225 * @crossplatform 1226 * @form 1227 * @atomicservice 1228 * @since 11 1229 */ 1230 showTips(value: boolean, content?: ResourceStr): SliderAttribute; 1231 1232 /** 1233 * Called when the thickness of track is set. 1234 * 1235 * @param { Length } value 1236 * @returns { SliderAttribute } 1237 * @syscap SystemCapability.ArkUI.ArkUI.Full 1238 * @since 8 1239 */ 1240 /** 1241 * Called when the thickness of track is set. 1242 * 1243 * @param { Length } value 1244 * @returns { SliderAttribute } 1245 * @syscap SystemCapability.ArkUI.ArkUI.Full 1246 * @form 1247 * @since 9 1248 */ 1249 /** 1250 * Called when the thickness of track is set. 1251 * 1252 * @param { Length } value 1253 * @returns { SliderAttribute } 1254 * @syscap SystemCapability.ArkUI.ArkUI.Full 1255 * @crossplatform 1256 * @form 1257 * @since 10 1258 */ 1259 /** 1260 * Called when the thickness of track is set. 1261 * 1262 * @param { Length } value 1263 * @returns { SliderAttribute } 1264 * @syscap SystemCapability.ArkUI.ArkUI.Full 1265 * @crossplatform 1266 * @form 1267 * @atomicservice 1268 * @since 11 1269 */ 1270 trackThickness(value: Length): SliderAttribute; 1271 1272 /** 1273 * Called when the selection value changes. 1274 * 1275 * @param { function } callback 1276 * @returns { SliderAttribute } 1277 * @syscap SystemCapability.ArkUI.ArkUI.Full 1278 * @since 7 1279 */ 1280 /** 1281 * Called when the selection value changes. 1282 * 1283 * @param { function } callback 1284 * @returns { SliderAttribute } 1285 * @syscap SystemCapability.ArkUI.ArkUI.Full 1286 * @form 1287 * @since 9 1288 */ 1289 /** 1290 * Called when the selection value changes. 1291 * 1292 * @param { function } callback 1293 * @returns { SliderAttribute } 1294 * @syscap SystemCapability.ArkUI.ArkUI.Full 1295 * @crossplatform 1296 * @form 1297 * @since 10 1298 */ 1299 /** 1300 * Called when the selection value changes. 1301 * 1302 * @param { function } callback 1303 * @returns { SliderAttribute } 1304 * @syscap SystemCapability.ArkUI.ArkUI.Full 1305 * @crossplatform 1306 * @form 1307 * @atomicservice 1308 * @since 11 1309 */ 1310 onChange(callback: (value: number, mode: SliderChangeMode) => void): SliderAttribute; 1311 1312 /** 1313 * Called when the border color of block is set. 1314 * 1315 * @param { ResourceColor } value - the border color of block. 1316 * @returns { SliderAttribute } 1317 * @syscap SystemCapability.ArkUI.ArkUI.Full 1318 * @crossplatform 1319 * @since 10 1320 */ 1321 /** 1322 * Called when the border color of block is set. 1323 * 1324 * @param { ResourceColor } value - the border color of block. 1325 * @returns { SliderAttribute } 1326 * @syscap SystemCapability.ArkUI.ArkUI.Full 1327 * @crossplatform 1328 * @atomicservice 1329 * @since 11 1330 */ 1331 blockBorderColor(value: ResourceColor): SliderAttribute; 1332 1333 /** 1334 * Called when the border width of block is set. 1335 * 1336 * @param { Length } value - the border width of block. 1337 * @returns { SliderAttribute } 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @crossplatform 1340 * @since 10 1341 */ 1342 /** 1343 * Called when the border width of block is set. 1344 * 1345 * @param { Length } value - the border width of block. 1346 * @returns { SliderAttribute } 1347 * @syscap SystemCapability.ArkUI.ArkUI.Full 1348 * @crossplatform 1349 * @atomicservice 1350 * @since 11 1351 */ 1352 blockBorderWidth(value: Length): SliderAttribute; 1353 1354 /** 1355 * Called when the color of step is set. 1356 * 1357 * @param { ResourceColor } value - the color of step. 1358 * @returns { SliderAttribute } 1359 * @syscap SystemCapability.ArkUI.ArkUI.Full 1360 * @crossplatform 1361 * @since 10 1362 */ 1363 /** 1364 * Called when the color of step is set. 1365 * 1366 * @param { ResourceColor } value - the color of step. 1367 * @returns { SliderAttribute } 1368 * @syscap SystemCapability.ArkUI.ArkUI.Full 1369 * @crossplatform 1370 * @atomicservice 1371 * @since 11 1372 */ 1373 stepColor(value: ResourceColor): SliderAttribute; 1374 1375 /** 1376 * Called when the radius of track border is set. 1377 * 1378 * @param { Length } value - the radius of track border. 1379 * @returns { SliderAttribute } 1380 * @syscap SystemCapability.ArkUI.ArkUI.Full 1381 * @crossplatform 1382 * @since 10 1383 */ 1384 /** 1385 * Called when the radius of track border is set. 1386 * 1387 * @param { Length } value - the radius of track border. 1388 * @returns { SliderAttribute } 1389 * @syscap SystemCapability.ArkUI.ArkUI.Full 1390 * @crossplatform 1391 * @atomicservice 1392 * @since 11 1393 */ 1394 trackBorderRadius(value: Length): SliderAttribute; 1395 1396 /** 1397 * Called when the radius of selected part is set. 1398 * 1399 * @param { Dimension } value - the radius of selected part. 1400 * @returns { SliderAttribute } 1401 * @syscap SystemCapability.ArkUI.ArkUI.Full 1402 * @crossplatform 1403 * @atomicservice 1404 * @since 12 1405 */ 1406 selectedBorderRadius(value: Dimension): SliderAttribute; 1407 1408 /** 1409 * Called when the size of block is set. 1410 * 1411 * @param { SizeOptions } value - the size of block. 1412 * @returns { SliderAttribute } 1413 * @syscap SystemCapability.ArkUI.ArkUI.Full 1414 * @crossplatform 1415 * @since 10 1416 */ 1417 /** 1418 * Called when the size of block is set. 1419 * 1420 * @param { SizeOptions } value - the size of block. 1421 * @returns { SliderAttribute } 1422 * @syscap SystemCapability.ArkUI.ArkUI.Full 1423 * @crossplatform 1424 * @atomicservice 1425 * @since 11 1426 */ 1427 blockSize(value: SizeOptions): SliderAttribute; 1428 1429 /** 1430 * Called when the style of block is set. 1431 * 1432 * @param { SliderBlockStyle } value - the style of block. 1433 * @returns { SliderAttribute } 1434 * @syscap SystemCapability.ArkUI.ArkUI.Full 1435 * @crossplatform 1436 * @since 10 1437 */ 1438 /** 1439 * Called when the style of block is set. 1440 * 1441 * @param { SliderBlockStyle } value - the style of block. 1442 * @returns { SliderAttribute } 1443 * @syscap SystemCapability.ArkUI.ArkUI.Full 1444 * @crossplatform 1445 * @atomicservice 1446 * @since 11 1447 */ 1448 blockStyle(value: SliderBlockStyle): SliderAttribute; 1449 1450 /** 1451 * Called when the diameter of step is set. 1452 * 1453 * @param { Length } value - the diameter of step. 1454 * @returns { SliderAttribute } 1455 * @syscap SystemCapability.ArkUI.ArkUI.Full 1456 * @crossplatform 1457 * @since 10 1458 */ 1459 /** 1460 * Called when the diameter of step is set. 1461 * 1462 * @param { Length } value - the diameter of step. 1463 * @returns { SliderAttribute } 1464 * @syscap SystemCapability.ArkUI.ArkUI.Full 1465 * @crossplatform 1466 * @atomicservice 1467 * @since 11 1468 */ 1469 stepSize(value: Length): SliderAttribute; 1470 1471 /** 1472 * Sets the interaction mode of the slider. 1473 * 1474 * @param { SliderInteraction } value 1475 * @returns { SliderAttribute } 1476 * @syscap SystemCapability.ArkUI.ArkUI.Full 1477 * @crossplatform 1478 * @atomicservice 1479 * @since 12 1480 */ 1481 sliderInteractionMode(value: SliderInteraction): SliderAttribute; 1482 1483 /** 1484 * Sets the min value when Slider response to drag event. 1485 * 1486 * @param { number } value 1487 * @returns { SliderAttribute } 1488 * @syscap SystemCapability.ArkUI.ArkUI.Full 1489 * @crossplatform 1490 * @atomicservice 1491 * @since 12 1492 */ 1493 minResponsiveDistance(value: number): SliderAttribute; 1494 1495 /** 1496 * Set the content modifier of slider. 1497 * 1498 * @param { ContentModifier<SliderConfiguration> } modifier - The content modifier of slider. 1499 * @returns { SliderAttribute } 1500 * @syscap SystemCapability.ArkUI.ArkUI.Full 1501 * @crossplatform 1502 * @atomicservice 1503 * @since 12 1504 */ 1505 contentModifier(modifier: ContentModifier<SliderConfiguration>): SliderAttribute; 1506 1507 /** 1508 * Set the valid slidable range. 1509 * 1510 * @param { SlideRange } value 1511 * @returns { SliderAttribute } 1512 * @syscap SystemCapability.ArkUI.ArkUI.Full 1513 * @crossplatform 1514 * @atomicservice 1515 * @since 12 1516 */ 1517 slideRange(value: SlideRange): SliderAttribute; 1518} 1519 1520/** 1521 * Defines Slider Component. 1522 * 1523 * @syscap SystemCapability.ArkUI.ArkUI.Full 1524 * @since 7 1525 */ 1526/** 1527 * Defines Slider Component. 1528 * 1529 * @syscap SystemCapability.ArkUI.ArkUI.Full 1530 * @form 1531 * @since 9 1532 */ 1533/** 1534 * Defines Slider Component. 1535 * 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @crossplatform 1538 * @form 1539 * @since 10 1540 */ 1541/** 1542 * Defines Slider Component. 1543 * 1544 * @syscap SystemCapability.ArkUI.ArkUI.Full 1545 * @crossplatform 1546 * @form 1547 * @atomicservice 1548 * @since 11 1549 */ 1550declare const Slider: SliderInterface; 1551 1552/** 1553 * Defines Slider Component instance. 1554 * 1555 * @syscap SystemCapability.ArkUI.ArkUI.Full 1556 * @since 7 1557 */ 1558/** 1559 * Defines Slider Component instance. 1560 * 1561 * @syscap SystemCapability.ArkUI.ArkUI.Full 1562 * @form 1563 * @since 9 1564 */ 1565/** 1566 * Defines Slider Component instance. 1567 * 1568 * @syscap SystemCapability.ArkUI.ArkUI.Full 1569 * @crossplatform 1570 * @form 1571 * @since 10 1572 */ 1573/** 1574 * Defines Slider Component instance. 1575 * 1576 * @syscap SystemCapability.ArkUI.ArkUI.Full 1577 * @crossplatform 1578 * @form 1579 * @atomicservice 1580 * @since 11 1581 */ 1582declare const SliderInstance: SliderAttribute; 1583