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 * @extends CommonConfiguration<SliderConfiguration> 820 * @interface SliderConfiguration 821 * @syscap SystemCapability.ArkUI.ArkUI.Full 822 * @crossplatform 823 * @atomicservice 824 * @since 12 825 */ 826declare interface SliderConfiguration extends CommonConfiguration<SliderConfiguration> { 827 /** 828 * Current progress value. 829 * 830 * @type { number } 831 * @syscap SystemCapability.ArkUI.ArkUI.Full 832 * @crossplatform 833 * @atomicservice 834 * @since 12 835 */ 836 value: number; 837 838 /** 839 * Minimum value. 840 * 841 * @type { number } 842 * @syscap SystemCapability.ArkUI.ArkUI.Full 843 * @crossplatform 844 * @atomicservice 845 * @since 12 846 */ 847 min: number; 848 849 /** 850 * Maximum value. 851 * 852 * @type { number } 853 * @syscap SystemCapability.ArkUI.ArkUI.Full 854 * @crossplatform 855 * @atomicservice 856 * @since 12 857 */ 858 max: number; 859 860 /** 861 * The sliding step size of Slider. 862 * 863 * @type { number } 864 * @syscap SystemCapability.ArkUI.ArkUI.Full 865 * @crossplatform 866 * @atomicservice 867 * @since 12 868 */ 869 step: number; 870 871 /** 872 * Trigger slider change 873 * 874 * @type { SliderTriggerChangeCallback } 875 * @syscap SystemCapability.ArkUI.ArkUI.Full 876 * @crossplatform 877 * @atomicservice 878 * @since 12 879 */ 880 triggerChange: SliderTriggerChangeCallback; 881} 882 883/** 884 * Provides an interface for the slide bar component. 885 * 886 * @interface SliderInterface 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @since 7 889 */ 890/** 891 * Provides an interface for the slide bar component. 892 * 893 * @interface SliderInterface 894 * @syscap SystemCapability.ArkUI.ArkUI.Full 895 * @form 896 * @since 9 897 */ 898/** 899 * Provides an interface for the slide bar component. 900 * 901 * @interface SliderInterface 902 * @syscap SystemCapability.ArkUI.ArkUI.Full 903 * @crossplatform 904 * @form 905 * @since 10 906 */ 907/** 908 * Provides an interface for the slide bar component. 909 * 910 * @interface SliderInterface 911 * @syscap SystemCapability.ArkUI.ArkUI.Full 912 * @crossplatform 913 * @form 914 * @atomicservice 915 * @since 11 916 */ 917interface SliderInterface { 918 /** 919 * Called when the slider bar component is used. 920 * 921 * @param { SliderOptions } options 922 * @returns { SliderAttribute } 923 * @syscap SystemCapability.ArkUI.ArkUI.Full 924 * @since 7 925 */ 926 /** 927 * Called when the slider bar component is used. 928 * 929 * @param { SliderOptions } options 930 * @returns { SliderAttribute } 931 * @syscap SystemCapability.ArkUI.ArkUI.Full 932 * @form 933 * @since 9 934 */ 935 /** 936 * Called when the slider bar component is used. 937 * 938 * @param { SliderOptions } options 939 * @returns { SliderAttribute } 940 * @syscap SystemCapability.ArkUI.ArkUI.Full 941 * @crossplatform 942 * @form 943 * @since 10 944 */ 945 /** 946 * Called when the slider bar component is used. 947 * 948 * @param { SliderOptions } options 949 * @returns { SliderAttribute } 950 * @syscap SystemCapability.ArkUI.ArkUI.Full 951 * @crossplatform 952 * @form 953 * @atomicservice 954 * @since 11 955 */ 956 (options?: SliderOptions): SliderAttribute; 957} 958 959/** 960 * Defines the attribute functions of Slider. 961 * 962 * @extends CommonMethod<SliderAttribute> 963 * @syscap SystemCapability.ArkUI.ArkUI.Full 964 * @since 7 965 */ 966/** 967 * Defines the attribute functions of Slider. 968 * 969 * @extends CommonMethod<SliderAttribute> 970 * @syscap SystemCapability.ArkUI.ArkUI.Full 971 * @form 972 * @since 9 973 */ 974/** 975 * Defines the attribute functions of Slider. 976 * 977 * @extends CommonMethod<SliderAttribute> 978 * @syscap SystemCapability.ArkUI.ArkUI.Full 979 * @crossplatform 980 * @form 981 * @since 10 982 */ 983/** 984 * Defines the attribute functions of Slider. 985 * 986 * @extends CommonMethod<SliderAttribute> 987 * @syscap SystemCapability.ArkUI.ArkUI.Full 988 * @crossplatform 989 * @form 990 * @atomicservice 991 * @since 11 992 */ 993declare class SliderAttribute extends CommonMethod<SliderAttribute> { 994 /** 995 * Called when the slider color of the slider bar is set. 996 * 997 * @param { ResourceColor } value 998 * @returns { SliderAttribute } 999 * @syscap SystemCapability.ArkUI.ArkUI.Full 1000 * @since 7 1001 */ 1002 /** 1003 * Called when the slider color of the slider bar is set. 1004 * 1005 * @param { ResourceColor } value 1006 * @returns { SliderAttribute } 1007 * @syscap SystemCapability.ArkUI.ArkUI.Full 1008 * @form 1009 * @since 9 1010 */ 1011 /** 1012 * Called when the slider color of the slider bar is set. 1013 * 1014 * @param { ResourceColor } value 1015 * @returns { SliderAttribute } 1016 * @syscap SystemCapability.ArkUI.ArkUI.Full 1017 * @crossplatform 1018 * @form 1019 * @since 10 1020 */ 1021 /** 1022 * Called when the slider color of the slider bar is set. 1023 * 1024 * @param { ResourceColor } value 1025 * @returns { SliderAttribute } 1026 * @syscap SystemCapability.ArkUI.ArkUI.Full 1027 * @crossplatform 1028 * @form 1029 * @atomicservice 1030 * @since 11 1031 */ 1032 blockColor(value: ResourceColor): SliderAttribute; 1033 1034 /** 1035 * Called when the track color of the slider is set. 1036 * 1037 * @param { ResourceColor } value 1038 * @returns { SliderAttribute } 1039 * @syscap SystemCapability.ArkUI.ArkUI.Full 1040 * @since 7 1041 */ 1042 /** 1043 * Called when the track color of the slider is set. 1044 * 1045 * @param { ResourceColor } value 1046 * @returns { SliderAttribute } 1047 * @syscap SystemCapability.ArkUI.ArkUI.Full 1048 * @form 1049 * @since 9 1050 */ 1051 /** 1052 * Called when the track color of the slider is set. 1053 * 1054 * @param { ResourceColor } value 1055 * @returns { SliderAttribute } 1056 * @syscap SystemCapability.ArkUI.ArkUI.Full 1057 * @crossplatform 1058 * @form 1059 * @since 10 1060 */ 1061 /** 1062 * Called when the track color of the slider is set. 1063 * 1064 * @param { ResourceColor } value 1065 * @returns { SliderAttribute } 1066 * @syscap SystemCapability.ArkUI.ArkUI.Full 1067 * @crossplatform 1068 * @form 1069 * @atomicservice 1070 * @since 11 1071 */ 1072 /** 1073 * Called when the track color of the slider is set. 1074 * 1075 * @param { ResourceColor | LinearGradient } value 1076 * @returns { SliderAttribute } 1077 * @syscap SystemCapability.ArkUI.ArkUI.Full 1078 * @crossplatform 1079 * @form 1080 * @atomicservice 1081 * @since 12 1082 */ 1083 trackColor(value: ResourceColor | LinearGradient): SliderAttribute; 1084 1085 /** 1086 * Called when the slider of the slider bar is set to slide over the area color. 1087 * 1088 * @param { ResourceColor } value 1089 * @returns { SliderAttribute } 1090 * @syscap SystemCapability.ArkUI.ArkUI.Full 1091 * @since 7 1092 */ 1093 /** 1094 * Called when the slider of the slider bar is set to slide over the area color. 1095 * 1096 * @param { ResourceColor } value 1097 * @returns { SliderAttribute } 1098 * @syscap SystemCapability.ArkUI.ArkUI.Full 1099 * @form 1100 * @since 9 1101 */ 1102 /** 1103 * Called when the slider of the slider bar is set to slide over the area color. 1104 * 1105 * @param { ResourceColor } value 1106 * @returns { SliderAttribute } 1107 * @syscap SystemCapability.ArkUI.ArkUI.Full 1108 * @crossplatform 1109 * @form 1110 * @since 10 1111 */ 1112 /** 1113 * Called when the slider of the slider bar is set to slide over the area color. 1114 * 1115 * @param { ResourceColor } value 1116 * @returns { SliderAttribute } 1117 * @syscap SystemCapability.ArkUI.ArkUI.Full 1118 * @crossplatform 1119 * @form 1120 * @atomicservice 1121 * @since 11 1122 */ 1123 selectedColor(value: ResourceColor): SliderAttribute; 1124 /** 1125 * Called when the slider of the slider bar is set to slide over the area color. 1126 * 1127 * @param { ResourceColor | LinearGradient } selectedColor 1128 * @returns { SliderAttribute } 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @form 1132 * @atomicservice 1133 * @since 18 1134 */ 1135 selectedColor(selectedColor: ResourceColor | LinearGradient): SliderAttribute; 1136 1137 /** 1138 * Called when the minimum label is set. 1139 * 1140 * @param { string } value 1141 * @returns { SliderAttribute } 1142 * @syscap SystemCapability.ArkUI.ArkUI.Full 1143 * @since 7 1144 * @deprecated since 9 1145 * @useinstead min 1146 */ 1147 minLabel(value: string): SliderAttribute; 1148 1149 /** 1150 * Called when the maximum label is set. 1151 * 1152 * @param { string } value 1153 * @returns { SliderAttribute } 1154 * @syscap SystemCapability.ArkUI.ArkUI.Full 1155 * @since 7 1156 * @deprecated since 9 1157 * @useinstead max 1158 */ 1159 maxLabel(value: string): SliderAttribute; 1160 1161 /** 1162 * Called when setting whether to display step size. 1163 * 1164 * @param { boolean } value 1165 * @returns { SliderAttribute } 1166 * @syscap SystemCapability.ArkUI.ArkUI.Full 1167 * @since 7 1168 */ 1169 /** 1170 * Called when setting whether to display step size. 1171 * 1172 * @param { boolean } value 1173 * @returns { SliderAttribute } 1174 * @syscap SystemCapability.ArkUI.ArkUI.Full 1175 * @form 1176 * @since 9 1177 */ 1178 /** 1179 * Called when setting whether to display step size. 1180 * 1181 * @param { boolean } value 1182 * @returns { SliderAttribute } 1183 * @syscap SystemCapability.ArkUI.ArkUI.Full 1184 * @crossplatform 1185 * @form 1186 * @since 10 1187 */ 1188 /** 1189 * Called when setting whether to display step size. 1190 * 1191 * @param { boolean } value 1192 * @returns { SliderAttribute } 1193 * @syscap SystemCapability.ArkUI.ArkUI.Full 1194 * @crossplatform 1195 * @form 1196 * @atomicservice 1197 * @since 11 1198 */ 1199 showSteps(value: boolean): SliderAttribute; 1200 1201 /** 1202 * Called when the percentage of bubble prompt is set when sliding. 1203 * 1204 * @param { boolean } value 1205 * @returns { SliderAttribute } 1206 * @syscap SystemCapability.ArkUI.ArkUI.Full 1207 * @since 7 1208 */ 1209 /** 1210 * Called when the percentage of bubble prompt is set when sliding. 1211 * 1212 * @param { boolean } value 1213 * @returns { SliderAttribute } 1214 * @syscap SystemCapability.ArkUI.ArkUI.Full 1215 * @form 1216 * @since 9 1217 */ 1218 /** 1219 * Called when the percentage of bubble prompt is set when sliding. 1220 * 1221 * @param { boolean } value - Whether to display the bubble. 1222 * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current 1223 * percentage is displayed by default. 1224 * @returns { SliderAttribute } 1225 * @syscap SystemCapability.ArkUI.ArkUI.Full 1226 * @crossplatform 1227 * @form 1228 * @since 10 1229 */ 1230 /** 1231 * Called when the percentage of bubble prompt is set when sliding. 1232 * 1233 * @param { boolean } value - Whether to display the bubble. 1234 * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current 1235 * percentage is displayed by default. 1236 * @returns { SliderAttribute } 1237 * @syscap SystemCapability.ArkUI.ArkUI.Full 1238 * @crossplatform 1239 * @form 1240 * @atomicservice 1241 * @since 11 1242 */ 1243 showTips(value: boolean, content?: ResourceStr): SliderAttribute; 1244 1245 /** 1246 * Called when the thickness of track is set. 1247 * 1248 * @param { Length } value 1249 * @returns { SliderAttribute } 1250 * @syscap SystemCapability.ArkUI.ArkUI.Full 1251 * @since 8 1252 */ 1253 /** 1254 * Called when the thickness of track is set. 1255 * 1256 * @param { Length } value 1257 * @returns { SliderAttribute } 1258 * @syscap SystemCapability.ArkUI.ArkUI.Full 1259 * @form 1260 * @since 9 1261 */ 1262 /** 1263 * Called when the thickness of track is set. 1264 * 1265 * @param { Length } value 1266 * @returns { SliderAttribute } 1267 * @syscap SystemCapability.ArkUI.ArkUI.Full 1268 * @crossplatform 1269 * @form 1270 * @since 10 1271 */ 1272 /** 1273 * Called when the thickness of track is set. 1274 * 1275 * @param { Length } value 1276 * @returns { SliderAttribute } 1277 * @syscap SystemCapability.ArkUI.ArkUI.Full 1278 * @crossplatform 1279 * @form 1280 * @atomicservice 1281 * @since 11 1282 */ 1283 trackThickness(value: Length): SliderAttribute; 1284 1285 /** 1286 * Called when the selection value changes. 1287 * 1288 * @param { function } callback 1289 * @returns { SliderAttribute } 1290 * @syscap SystemCapability.ArkUI.ArkUI.Full 1291 * @since 7 1292 */ 1293 /** 1294 * Called when the selection value changes. 1295 * 1296 * @param { function } callback 1297 * @returns { SliderAttribute } 1298 * @syscap SystemCapability.ArkUI.ArkUI.Full 1299 * @form 1300 * @since 9 1301 */ 1302 /** 1303 * Called when the selection value changes. 1304 * 1305 * @param { function } callback 1306 * @returns { SliderAttribute } 1307 * @syscap SystemCapability.ArkUI.ArkUI.Full 1308 * @crossplatform 1309 * @form 1310 * @since 10 1311 */ 1312 /** 1313 * Called when the selection value changes. 1314 * 1315 * @param { function } callback 1316 * @returns { SliderAttribute } 1317 * @syscap SystemCapability.ArkUI.ArkUI.Full 1318 * @crossplatform 1319 * @form 1320 * @atomicservice 1321 * @since 11 1322 */ 1323 onChange(callback: (value: number, mode: SliderChangeMode) => void): SliderAttribute; 1324 1325 /** 1326 * Called when the border color of block is set. 1327 * 1328 * @param { ResourceColor } value - the border color of block. 1329 * @returns { SliderAttribute } 1330 * @syscap SystemCapability.ArkUI.ArkUI.Full 1331 * @crossplatform 1332 * @since 10 1333 */ 1334 /** 1335 * Called when the border color of block is set. 1336 * 1337 * @param { ResourceColor } value - the border color of block. 1338 * @returns { SliderAttribute } 1339 * @syscap SystemCapability.ArkUI.ArkUI.Full 1340 * @crossplatform 1341 * @atomicservice 1342 * @since 11 1343 */ 1344 blockBorderColor(value: ResourceColor): SliderAttribute; 1345 1346 /** 1347 * Called when the border width of block is set. 1348 * 1349 * @param { Length } value - the border width of block. 1350 * @returns { SliderAttribute } 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @crossplatform 1353 * @since 10 1354 */ 1355 /** 1356 * Called when the border width of block is set. 1357 * 1358 * @param { Length } value - the border width of block. 1359 * @returns { SliderAttribute } 1360 * @syscap SystemCapability.ArkUI.ArkUI.Full 1361 * @crossplatform 1362 * @atomicservice 1363 * @since 11 1364 */ 1365 blockBorderWidth(value: Length): SliderAttribute; 1366 1367 /** 1368 * Called when the color of step is set. 1369 * 1370 * @param { ResourceColor } value - the color of step. 1371 * @returns { SliderAttribute } 1372 * @syscap SystemCapability.ArkUI.ArkUI.Full 1373 * @crossplatform 1374 * @since 10 1375 */ 1376 /** 1377 * Called when the color of step is set. 1378 * 1379 * @param { ResourceColor } value - the color of step. 1380 * @returns { SliderAttribute } 1381 * @syscap SystemCapability.ArkUI.ArkUI.Full 1382 * @crossplatform 1383 * @atomicservice 1384 * @since 11 1385 */ 1386 stepColor(value: ResourceColor): SliderAttribute; 1387 1388 /** 1389 * Called when the radius of track border is set. 1390 * 1391 * @param { Length } value - the radius of track border. 1392 * @returns { SliderAttribute } 1393 * @syscap SystemCapability.ArkUI.ArkUI.Full 1394 * @crossplatform 1395 * @since 10 1396 */ 1397 /** 1398 * Called when the radius of track border is set. 1399 * 1400 * @param { Length } value - the radius of track border. 1401 * @returns { SliderAttribute } 1402 * @syscap SystemCapability.ArkUI.ArkUI.Full 1403 * @crossplatform 1404 * @atomicservice 1405 * @since 11 1406 */ 1407 trackBorderRadius(value: Length): SliderAttribute; 1408 1409 /** 1410 * Called when the radius of selected part is set. 1411 * 1412 * @param { Dimension } value - the radius of selected part. 1413 * @returns { SliderAttribute } 1414 * @syscap SystemCapability.ArkUI.ArkUI.Full 1415 * @crossplatform 1416 * @atomicservice 1417 * @since 12 1418 */ 1419 selectedBorderRadius(value: Dimension): SliderAttribute; 1420 1421 /** 1422 * Called when the size of block is set. 1423 * 1424 * @param { SizeOptions } value - the size of block. 1425 * @returns { SliderAttribute } 1426 * @syscap SystemCapability.ArkUI.ArkUI.Full 1427 * @crossplatform 1428 * @since 10 1429 */ 1430 /** 1431 * Called when the size of block is set. 1432 * 1433 * @param { SizeOptions } value - the size of block. 1434 * @returns { SliderAttribute } 1435 * @syscap SystemCapability.ArkUI.ArkUI.Full 1436 * @crossplatform 1437 * @atomicservice 1438 * @since 11 1439 */ 1440 blockSize(value: SizeOptions): SliderAttribute; 1441 1442 /** 1443 * Called when the style of block is set. 1444 * 1445 * @param { SliderBlockStyle } value - the style of block. 1446 * @returns { SliderAttribute } 1447 * @syscap SystemCapability.ArkUI.ArkUI.Full 1448 * @crossplatform 1449 * @since 10 1450 */ 1451 /** 1452 * Called when the style of block is set. 1453 * 1454 * @param { SliderBlockStyle } value - the style of block. 1455 * @returns { SliderAttribute } 1456 * @syscap SystemCapability.ArkUI.ArkUI.Full 1457 * @crossplatform 1458 * @atomicservice 1459 * @since 11 1460 */ 1461 blockStyle(value: SliderBlockStyle): SliderAttribute; 1462 1463 /** 1464 * Called when the diameter of step is set. 1465 * 1466 * @param { Length } value - the diameter of step. 1467 * @returns { SliderAttribute } 1468 * @syscap SystemCapability.ArkUI.ArkUI.Full 1469 * @crossplatform 1470 * @since 10 1471 */ 1472 /** 1473 * Called when the diameter of step is set. 1474 * 1475 * @param { Length } value - the diameter of step. 1476 * @returns { SliderAttribute } 1477 * @syscap SystemCapability.ArkUI.ArkUI.Full 1478 * @crossplatform 1479 * @atomicservice 1480 * @since 11 1481 */ 1482 stepSize(value: Length): SliderAttribute; 1483 1484 /** 1485 * Sets the interaction mode of the slider. 1486 * 1487 * @param { SliderInteraction } value 1488 * @returns { SliderAttribute } 1489 * @syscap SystemCapability.ArkUI.ArkUI.Full 1490 * @crossplatform 1491 * @atomicservice 1492 * @since 12 1493 */ 1494 sliderInteractionMode(value: SliderInteraction): SliderAttribute; 1495 1496 /** 1497 * Sets the min value when Slider response to drag event. 1498 * 1499 * @param { number } value 1500 * @returns { SliderAttribute } 1501 * @syscap SystemCapability.ArkUI.ArkUI.Full 1502 * @crossplatform 1503 * @atomicservice 1504 * @since 12 1505 */ 1506 minResponsiveDistance(value: number): SliderAttribute; 1507 1508 /** 1509 * Set the content modifier of slider. 1510 * 1511 * @param { ContentModifier<SliderConfiguration> } modifier - The content modifier of slider. 1512 * @returns { SliderAttribute } 1513 * @syscap SystemCapability.ArkUI.ArkUI.Full 1514 * @crossplatform 1515 * @atomicservice 1516 * @since 12 1517 */ 1518 contentModifier(modifier: ContentModifier<SliderConfiguration>): SliderAttribute; 1519 1520 /** 1521 * Set the valid slidable range. 1522 * 1523 * @param { SlideRange } value 1524 * @returns { SliderAttribute } 1525 * @syscap SystemCapability.ArkUI.ArkUI.Full 1526 * @crossplatform 1527 * @atomicservice 1528 * @since 12 1529 */ 1530 slideRange(value: SlideRange): SliderAttribute; 1531 1532 /** 1533 * Set the sensitivity of rotating crown. 1534 * 1535 * @param { Optional<CrownSensitivity> } sensitivity - The sensitivity of rotating crown, default value is { MEDIUM }. 1536 * @returns { SliderAttribute } 1537 * @syscap SystemCapability.ArkUI.ArkUI.Full 1538 * @crossplatform 1539 * @atomicservice 1540 * @since 18 1541 */ 1542 digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>): SliderAttribute; 1543 1544 /** 1545 * Enable or disable haptic feedback. 1546 * 1547 * @param { boolean } enabled - Default value is true, set false to disable haptic feedback. 1548 * @returns { SliderAttribute } 1549 * @syscap SystemCapability.ArkUI.ArkUI.Full 1550 * @atomicservice 1551 * @since 18 1552 */ 1553 enableHapticFeedback(enabled: boolean): SliderAttribute; 1554} 1555 1556/** 1557 * Defines Slider Component. 1558 * 1559 * @syscap SystemCapability.ArkUI.ArkUI.Full 1560 * @since 7 1561 */ 1562/** 1563 * Defines Slider Component. 1564 * 1565 * @syscap SystemCapability.ArkUI.ArkUI.Full 1566 * @form 1567 * @since 9 1568 */ 1569/** 1570 * Defines Slider Component. 1571 * 1572 * @syscap SystemCapability.ArkUI.ArkUI.Full 1573 * @crossplatform 1574 * @form 1575 * @since 10 1576 */ 1577/** 1578 * Defines Slider Component. 1579 * 1580 * @syscap SystemCapability.ArkUI.ArkUI.Full 1581 * @crossplatform 1582 * @form 1583 * @atomicservice 1584 * @since 11 1585 */ 1586declare const Slider: SliderInterface; 1587 1588/** 1589 * Defines Slider Component instance. 1590 * 1591 * @syscap SystemCapability.ArkUI.ArkUI.Full 1592 * @since 7 1593 */ 1594/** 1595 * Defines Slider Component instance. 1596 * 1597 * @syscap SystemCapability.ArkUI.ArkUI.Full 1598 * @form 1599 * @since 9 1600 */ 1601/** 1602 * Defines Slider Component instance. 1603 * 1604 * @syscap SystemCapability.ArkUI.ArkUI.Full 1605 * @crossplatform 1606 * @form 1607 * @since 10 1608 */ 1609/** 1610 * Defines Slider Component instance. 1611 * 1612 * @syscap SystemCapability.ArkUI.ArkUI.Full 1613 * @crossplatform 1614 * @form 1615 * @atomicservice 1616 * @since 11 1617 */ 1618declare const SliderInstance: SliderAttribute; 1619