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/*** if arkts 1.2 */ 22import { CommonMethod, CommonConfiguration, ContentModifier, Optional } from './common'; 23import { Axis, CrownSensitivity } from './enums'; 24import { ResourceStr, ResourceColor, Length, Dimension, SizeOptions } from './units'; 25import { CircleAttribute } from './circle'; 26import { RectAttribute } from './rect'; 27import { PathAttribute } from './path'; 28import { EllipseAttribute } from './ellipse'; 29import { LinearGradient } from './dataPanel'; 30 31/*** endif */ 32 33/** 34 * Declare sliderstyle 35 * 36 * @enum { number } 37 * @syscap SystemCapability.ArkUI.ArkUI.Full 38 * @since 7 39 */ 40/** 41 * Declare sliderstyle 42 * 43 * @enum { number } 44 * @syscap SystemCapability.ArkUI.ArkUI.Full 45 * @form 46 * @since 9 47 */ 48/** 49 * Declare sliderstyle 50 * 51 * @enum { number } 52 * @syscap SystemCapability.ArkUI.ArkUI.Full 53 * @crossplatform 54 * @form 55 * @since 10 56 */ 57/** 58 * Style of the slider thumb and track. 59 * 60 * @enum { number } 61 * @syscap SystemCapability.ArkUI.ArkUI.Full 62 * @crossplatform 63 * @form 64 * @atomicservice 65 * @since arkts {'1.1':'11','1.2':'20'} 66 * @arkts 1.1&1.2 67 */ 68declare enum SliderStyle { 69 /** 70 * The slider is on the slide rail. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @since 7 74 */ 75 /** 76 * The slider is on the slide rail. 77 * 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @form 80 * @since 9 81 */ 82 /** 83 * The slider is on the slide rail. 84 * 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @form 88 * @since 10 89 */ 90 /** 91 * The thumb is on the track. 92 * 93 * @syscap SystemCapability.ArkUI.ArkUI.Full 94 * @crossplatform 95 * @form 96 * @atomicservice 97 * @since arkts {'1.1':'11','1.2':'20'} 98 * @arkts 1.1&1.2 99 */ 100 OutSet, 101 102 /** 103 * The slider is in the slide rail. 104 * 105 * @syscap SystemCapability.ArkUI.ArkUI.Full 106 * @since 7 107 */ 108 /** 109 * The slider is in the slide rail. 110 * 111 * @syscap SystemCapability.ArkUI.ArkUI.Full 112 * @form 113 * @since 9 114 */ 115 /** 116 * The slider is in the slide rail. 117 * 118 * @syscap SystemCapability.ArkUI.ArkUI.Full 119 * @crossplatform 120 * @form 121 * @since 10 122 */ 123 /** 124 * The thumb is in the track. 125 * 126 * @syscap SystemCapability.ArkUI.ArkUI.Full 127 * @crossplatform 128 * @form 129 * @atomicservice 130 * @since arkts {'1.1':'11','1.2':'20'} 131 * @arkts 1.1&1.2 132 */ 133 InSet, 134 /** 135 * There is no thumb. 136 * 137 * @syscap SystemCapability.ArkUI.ArkUI.Full 138 * @crossplatform 139 * @form 140 * @atomicservice 141 * @since arkts {'1.1':'12','1.2':'20'} 142 * @arkts 1.1&1.2 143 */ 144 NONE, 145} 146 147/** 148 * Declare SliderChangeMode 149 * 150 * @enum { number } 151 * @syscap SystemCapability.ArkUI.ArkUI.Full 152 * @since 7 153 */ 154/** 155 * Declare SliderChangeMode 156 * 157 * @enum { number } 158 * @syscap SystemCapability.ArkUI.ArkUI.Full 159 * @form 160 * @since 9 161 */ 162/** 163 * Declare SliderChangeMode 164 * 165 * @enum { number } 166 * @syscap SystemCapability.ArkUI.ArkUI.Full 167 * @crossplatform 168 * @form 169 * @since 10 170 */ 171/** 172 * State triggered by the event. 173 * 174 * @enum { number } 175 * @syscap SystemCapability.ArkUI.ArkUI.Full 176 * @crossplatform 177 * @form 178 * @atomicservice 179 * @since arkts {'1.1':'11','1.2':'20'} 180 * @arkts 1.1&1.2 181 */ 182declare enum SliderChangeMode { 183 /** 184 * Start dragging the slider. 185 * 186 * @syscap SystemCapability.ArkUI.ArkUI.Full 187 * @since 7 188 */ 189 /** 190 * Start dragging the slider. 191 * 192 * @syscap SystemCapability.ArkUI.ArkUI.Full 193 * @form 194 * @since 9 195 */ 196 /** 197 * Start dragging the slider. 198 * 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @crossplatform 201 * @form 202 * @since 10 203 */ 204 /** 205 * The user touches or clicks the thumb. 206 * 207 * @syscap SystemCapability.ArkUI.ArkUI.Full 208 * @crossplatform 209 * @form 210 * @atomicservice 211 * @since arkts {'1.1':'11','1.2':'20'} 212 * @arkts 1.1&1.2 213 */ 214 Begin, 215 216 /** 217 * Drag the slider. 218 * 219 * @syscap SystemCapability.ArkUI.ArkUI.Full 220 * @since 7 221 */ 222 /** 223 * Drag the slider. 224 * 225 * @syscap SystemCapability.ArkUI.ArkUI.Full 226 * @form 227 * @since 9 228 */ 229 /** 230 * Drag the slider. 231 * 232 * @syscap SystemCapability.ArkUI.ArkUI.Full 233 * @crossplatform 234 * @form 235 * @since 10 236 */ 237 /** 238 * The user is dragging the slider. 239 * 240 * @syscap SystemCapability.ArkUI.ArkUI.Full 241 * @crossplatform 242 * @form 243 * @atomicservice 244 * @since arkts {'1.1':'11','1.2':'20'} 245 * @arkts 1.1&1.2 246 */ 247 Moving, 248 249 /** 250 * End dragging the slider. 251 * 252 * @syscap SystemCapability.ArkUI.ArkUI.Full 253 * @since 7 254 */ 255 /** 256 * End dragging the slider. 257 * 258 * @syscap SystemCapability.ArkUI.ArkUI.Full 259 * @form 260 * @since 9 261 */ 262 /** 263 * End dragging the slider. 264 * 265 * @syscap SystemCapability.ArkUI.ArkUI.Full 266 * @crossplatform 267 * @form 268 * @since 10 269 */ 270 /** 271 * The user stops dragging the slider by lifting their finger or releasing the mouse device. 272 * <p><strong>NOTE</strong>: 273 * <br>The trigger occurs when an invalid value is restored to the default value, that is, when the value is set to 274 * less than min or greater than max. 275 * </p> 276 * 277 * @syscap SystemCapability.ArkUI.ArkUI.Full 278 * @crossplatform 279 * @form 280 * @atomicservice 281 * @since arkts {'1.1':'11','1.2':'20'} 282 * @arkts 1.1&1.2 283 */ 284 End, 285 286 /** 287 * Click the slider. 288 * 289 * @syscap SystemCapability.ArkUI.ArkUI.Full 290 * @since 8 291 */ 292 /** 293 * Click the slider. 294 * 295 * @syscap SystemCapability.ArkUI.ArkUI.Full 296 * @form 297 * @since 9 298 */ 299 /** 300 * Click the slider. 301 * 302 * @syscap SystemCapability.ArkUI.ArkUI.Full 303 * @crossplatform 304 * @form 305 * @since 10 306 */ 307 /** 308 * The user moves the thumb by touching or clicking the track. 309 * 310 * @syscap SystemCapability.ArkUI.ArkUI.Full 311 * @crossplatform 312 * @form 313 * @atomicservice 314 * @since arkts {'1.1':'11','1.2':'20'} 315 * @arkts 1.1&1.2 316 */ 317 Click, 318} 319 320/** 321 * Interaction mode between the user and the slider. 322 * 323 * @enum { number } 324 * @syscap SystemCapability.ArkUI.ArkUI.Full 325 * @crossplatform 326 * @atomicservice 327 * @since arkts {'1.1':'12','1.2':'20'} 328 * @arkts 1.1&1.2 329 */ 330declare enum SliderInteraction { 331 /** 332 * Users can drag the slider or touch the track to move the slider. The slider moves as soon as the mouse or 333 * finger is pressed. 334 * 335 * @syscap SystemCapability.ArkUI.ArkUI.Full 336 * @crossplatform 337 * @atomicservice 338 * @since arkts {'1.1':'12','1.2':'20'} 339 * @arkts 1.1&1.2 340 */ 341 SLIDE_AND_CLICK, 342 343 /** 344 * Users are not allowed to move the slider by touching the slider. 345 * 346 * @syscap SystemCapability.ArkUI.ArkUI.Full 347 * @crossplatform 348 * @atomicservice 349 * @since arkts {'1.1':'12','1.2':'20'} 350 * @arkts 1.1&1.2 351 */ 352 SLIDE_ONLY, 353 354 /** 355 * Users can drag the slider or touch the track to move the slider. The slider moves when the mouse is released or 356 * finger is lifted, if the release/lift position coincides with the screen press position. 357 * 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @crossplatform 360 * @atomicservice 361 * @since arkts {'1.1':'12','1.2':'20'} 362 * @arkts 1.1&1.2 363 */ 364 SLIDE_AND_CLICK_UP = 2 365} 366 367/** 368 * Defines the callback type used in SlideRange. 369 * <p><strong>NOTE</strong>: 370 * <br>Currently, this API takes effect only when MIN ≤ from ≤ to ≤ MAX (the values of MIN and MAX do not depend on 371 * the values set, but on the actual values that take effect). You can set either from or to, or you can set both from 372 * and to. When the API is effective, if the set from value is between the adjacent multiples of step, then from takes 373 * the value of the left interval multiple of step or MIN as the corrected value. When the API is effective, if the set 374 * to value is between the adjacent multiples of step, then to takes the value of the right interval multiple of step 375 * or MAX as the corrected value. After from and to have taken their corrected values, when value is undefined or null, 376 * it takes the same value as from; when value is a number type, and if value ≤ from, then it takes from; 377 * if value > to, then it takes to. 378 * </p> 379 * 380 * @interface SlideRange 381 * @syscap SystemCapability.ArkUI.ArkUI.Full 382 * @crossplatform 383 * @atomicservice 384 * @since arkts {'1.1':'12','1.2':'20'} 385 * @arkts 1.1&1.2 386 */ 387declare interface SlideRange { 388 /** 389 * Start of the slide range. 390 * 391 * @type { ?number } 392 * @syscap SystemCapability.ArkUI.ArkUI.Full 393 * @crossplatform 394 * @atomicservice 395 * @since arkts {'1.1':'12','1.2':'20'} 396 * @arkts 1.1&1.2 397 */ 398 from?: number; 399 400 /** 401 * End of the slide range. 402 * 403 * @type { ?number } 404 * @syscap SystemCapability.ArkUI.ArkUI.Full 405 * @crossplatform 406 * @atomicservice 407 * @since arkts {'1.1':'12','1.2':'20'} 408 * @arkts 1.1&1.2 409 */ 410 to?: number; 411} 412 413/** 414 * Defines the options of Slider. 415 * 416 * @interface SliderOptions 417 * @syscap SystemCapability.ArkUI.ArkUI.Full 418 * @since 7 419 */ 420/** 421 * Defines the options of Slider. 422 * 423 * @interface SliderOptions 424 * @syscap SystemCapability.ArkUI.ArkUI.Full 425 * @form 426 * @since 9 427 */ 428/** 429 * Defines the options of Slider. 430 * 431 * @interface SliderOptions 432 * @syscap SystemCapability.ArkUI.ArkUI.Full 433 * @crossplatform 434 * @form 435 * @since 10 436 */ 437/** 438 * Parameters of the slider. 439 * 440 * @interface SliderOptions 441 * @syscap SystemCapability.ArkUI.ArkUI.Full 442 * @crossplatform 443 * @form 444 * @atomicservice 445 * @since arkts {'1.1':'11','1.2':'20'} 446 * @arkts 1.1&1.2 447 */ 448declare interface SliderOptions { 449 /** 450 * Current value of Slider. 451 * 452 * @type { ?number } 453 * @syscap SystemCapability.ArkUI.ArkUI.Full 454 * @since 7 455 */ 456 /** 457 * Current value of Slider. 458 * 459 * @type { ?number } 460 * @syscap SystemCapability.ArkUI.ArkUI.Full 461 * @form 462 * @since 9 463 */ 464 /** 465 * Current value of Slider. 466 * 467 * @type { ?number } 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @crossplatform 470 * @form 471 * @since 10 472 */ 473 /** 474 * Current progress. 475 * 476 * @type { ?number } 477 * @default same as the value of min 478 * @syscap SystemCapability.ArkUI.ArkUI.Full 479 * @crossplatform 480 * @form 481 * @atomicservice 482 * @since arkts {'1.1':'11','1.2':'20'} 483 * @arkts 1.1&1.2 484 */ 485 value?: number; 486 487 /** 488 * Sets the min value of Slider. 489 * 490 * @type { ?number } 491 * @syscap SystemCapability.ArkUI.ArkUI.Full 492 * @since 7 493 */ 494 /** 495 * Sets the min value of Slider. 496 * 497 * @type { ?number } 498 * @syscap SystemCapability.ArkUI.ArkUI.Full 499 * @form 500 * @since 9 501 */ 502 /** 503 * Sets the min value of Slider. 504 * 505 * @type { ?number } 506 * @syscap SystemCapability.ArkUI.ArkUI.Full 507 * @crossplatform 508 * @form 509 * @since 10 510 */ 511 /** 512 * Minimum value. 513 * 514 * @type { ?number } 515 * @default 0 516 * @syscap SystemCapability.ArkUI.ArkUI.Full 517 * @crossplatform 518 * @form 519 * @atomicservice 520 * @since arkts {'1.1':'11','1.2':'20'} 521 * @arkts 1.1&1.2 522 */ 523 min?: number; 524 525 /** 526 * Sets the max value of Slider. 527 * 528 * @type { ?number } 529 * @syscap SystemCapability.ArkUI.ArkUI.Full 530 * @since 7 531 */ 532 /** 533 * Sets the max value of Slider. 534 * 535 * @type { ?number } 536 * @syscap SystemCapability.ArkUI.ArkUI.Full 537 * @form 538 * @since 9 539 */ 540 /** 541 * Sets the max value of Slider. 542 * 543 * @type { ?number } 544 * @syscap SystemCapability.ArkUI.ArkUI.Full 545 * @crossplatform 546 * @form 547 * @since 10 548 */ 549 /** 550 * Maximum value. 551 * <p><strong>NOTE</strong>: 552 * <br>If the value of min is greater than or equal to the value of max, the min value defaults to 0, and the max 553 * value defaults to 100. If the value is not within the [min, max] range, the value of min or max is used, whichever 554 * is closer. 555 * </p> 556 * 557 * @type { ?number } 558 * @default 100 559 * @syscap SystemCapability.ArkUI.ArkUI.Full 560 * @crossplatform 561 * @form 562 * @atomicservice 563 * @since arkts {'1.1':'11','1.2':'20'} 564 * @arkts 1.1&1.2 565 */ 566 max?: number; 567 568 /** 569 * Sets the step of each slide value. 570 * 571 * @type { ?number } 572 * @syscap SystemCapability.ArkUI.ArkUI.Full 573 * @since 7 574 */ 575 /** 576 * Sets the step of each slide value. 577 * 578 * @type { ?number } 579 * @syscap SystemCapability.ArkUI.ArkUI.Full 580 * @form 581 * @since 9 582 */ 583 /** 584 * Sets the step of each slide value. 585 * 586 * @type { ?number } 587 * @syscap SystemCapability.ArkUI.ArkUI.Full 588 * @crossplatform 589 * @form 590 * @since 10 591 */ 592 /** 593 * Step of the slider. 594 * <p><strong>NOTE</strong>: 595 * <br>If this parameter is set to a value less than 0 or greater than the value of max, the default value is used. 596 * </p> 597 * 598 * @type { ?number } 599 * @default 1 - Value range: [0.01, max - min] 600 * @syscap SystemCapability.ArkUI.ArkUI.Full 601 * @crossplatform 602 * @form 603 * @atomicservice 604 * @since arkts {'1.1':'11','1.2':'20'} 605 * @arkts 1.1&1.2 606 */ 607 step?: number; 608 609 /** 610 * Sets the slider style. 611 * 612 * @type { ?SliderStyle } 613 * @syscap SystemCapability.ArkUI.ArkUI.Full 614 * @since 7 615 */ 616 /** 617 * Sets the slider style. 618 * 619 * @type { ?SliderStyle } 620 * @syscap SystemCapability.ArkUI.ArkUI.Full 621 * @form 622 * @since 9 623 */ 624 /** 625 * Sets the slider style. 626 * 627 * @type { ?SliderStyle } 628 * @syscap SystemCapability.ArkUI.ArkUI.Full 629 * @crossplatform 630 * @form 631 * @since 10 632 */ 633 /** 634 * Style of the slider thumb and track. 635 * 636 * @type { ?SliderStyle } 637 * @default SliderStyle.OutSet 638 * @syscap SystemCapability.ArkUI.ArkUI.Full 639 * @crossplatform 640 * @form 641 * @atomicservice 642 * @since arkts {'1.1':'11','1.2':'20'} 643 * @arkts 1.1&1.2 644 */ 645 style?: SliderStyle; 646 647 /** 648 * Sets the slider direction style. 649 * 650 * @type { ?Axis } 651 * @syscap SystemCapability.ArkUI.ArkUI.Full 652 * @since 8 653 */ 654 /** 655 * Sets the slider direction style. 656 * 657 * @type { ?Axis } 658 * @syscap SystemCapability.ArkUI.ArkUI.Full 659 * @form 660 * @since 9 661 */ 662 /** 663 * Sets the slider direction style. 664 * 665 * @type { ?Axis } 666 * @syscap SystemCapability.ArkUI.ArkUI.Full 667 * @crossplatform 668 * @form 669 * @since 10 670 */ 671 /** 672 * Whether the slider moves horizontally or vertically. 673 * 674 * @type { ?Axis } 675 * @default Axis.Horizontal 676 * @syscap SystemCapability.ArkUI.ArkUI.Full 677 * @crossplatform 678 * @form 679 * @atomicservice 680 * @since arkts {'1.1':'11','1.2':'20'} 681 * @arkts 1.1&1.2 682 */ 683 direction?: Axis; 684 685 /** 686 * Set whether the direction of the slider needs to be reversed. 687 * 688 * @type { ?boolean } 689 * @syscap SystemCapability.ArkUI.ArkUI.Full 690 * @since 8 691 */ 692 /** 693 * Set whether the direction of the slider needs to be reversed. 694 * 695 * @type { ?boolean } 696 * @syscap SystemCapability.ArkUI.ArkUI.Full 697 * @form 698 * @since 9 699 */ 700 /** 701 * Set whether the direction of the slider needs to be reversed. 702 * 703 * @type { ?boolean } 704 * @syscap SystemCapability.ArkUI.ArkUI.Full 705 * @crossplatform 706 * @form 707 * @since 10 708 */ 709 /** 710 * Whether the slider values are reversed. By default, the values increase from left to right for a horizontal 711 * slider and from top to bottom for a vertical slider. 712 * 713 * @type { ?boolean } 714 * @default false 715 * @syscap SystemCapability.ArkUI.ArkUI.Full 716 * @crossplatform 717 * @form 718 * @atomicservice 719 * @since arkts {'1.1':'11','1.2':'20'} 720 * @arkts 1.1&1.2 721 */ 722 reverse?: boolean; 723} 724 725/** 726 * Declare SliderBlockType 727 * 728 * @enum { number } 729 * @syscap SystemCapability.ArkUI.ArkUI.Full 730 * @crossplatform 731 * @since 10 732 */ 733/** 734 * Enumerates the types of the slider in the block direction. 735 * 736 * @enum { number } 737 * @syscap SystemCapability.ArkUI.ArkUI.Full 738 * @crossplatform 739 * @atomicservice 740 * @since arkts {'1.1':'11','1.2':'20'} 741 * @arkts 1.1&1.2 742 */ 743declare enum SliderBlockType { 744 /** 745 * Use the default block. 746 * 747 * @syscap SystemCapability.ArkUI.ArkUI.Full 748 * @crossplatform 749 * @since 10 750 */ 751 /** 752 * Round slider. 753 * 754 * @syscap SystemCapability.ArkUI.ArkUI.Full 755 * @crossplatform 756 * @atomicservice 757 * @since arkts {'1.1':'11','1.2':'20'} 758 * @arkts 1.1&1.2 759 */ 760 DEFAULT, 761 762 /** 763 * Use an image as the slider block. 764 * 765 * @syscap SystemCapability.ArkUI.ArkUI.Full 766 * @crossplatform 767 * @since 10 768 */ 769 /** 770 * Slider with an image background. 771 * 772 * @syscap SystemCapability.ArkUI.ArkUI.Full 773 * @crossplatform 774 * @atomicservice 775 * @since arkts {'1.1':'11','1.2':'20'} 776 * @arkts 1.1&1.2 777 */ 778 IMAGE, 779 780 /** 781 * Use a shape as the slider block. 782 * 783 * @syscap SystemCapability.ArkUI.ArkUI.Full 784 * @crossplatform 785 * @since 10 786 */ 787 /** 788 * Slider in a custom shape. 789 * 790 * @syscap SystemCapability.ArkUI.ArkUI.Full 791 * @crossplatform 792 * @atomicservice 793 * @since arkts {'1.1':'11','1.2':'20'} 794 * @arkts 1.1&1.2 795 */ 796 SHAPE, 797} 798 799/** 800 * Defines the style of slider block. 801 * 802 * @interface SliderBlockStyle 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @crossplatform 805 * @since 10 806 */ 807/** 808 * Describes the style of the slider in the block direction. 809 * 810 * @interface SliderBlockStyle 811 * @syscap SystemCapability.ArkUI.ArkUI.Full 812 * @crossplatform 813 * @atomicservice 814 * @since arkts {'1.1':'11','1.2':'20'} 815 * @arkts 1.1&1.2 816 */ 817declare interface SliderBlockStyle { 818 /** 819 * Sets the type of slider block. 820 * 821 * @type { SliderBlockType } 822 * @syscap SystemCapability.ArkUI.ArkUI.Full 823 * @crossplatform 824 * @since 10 825 */ 826 /** 827 * Type of the slider in the block direction. 828 * 829 * @type { SliderBlockType } 830 * @default SliderBlockType.DEFAULT - indicating the round slider. 831 * @syscap SystemCapability.ArkUI.ArkUI.Full 832 * @crossplatform 833 * @atomicservice 834 * @since arkts {'1.1':'11','1.2':'20'} 835 * @arkts 1.1&1.2 836 */ 837 type: SliderBlockType; 838 839 /** 840 * Sets the image of slider block while the type is set to SliderBlockType.Image. 841 * 842 * @type { ?ResourceStr } 843 * @syscap SystemCapability.ArkUI.ArkUI.Full 844 * @crossplatform 845 * @since 10 846 */ 847 /** 848 * Image resource of the slider. The area size for displaying the image is subject to the blockSize attribute. 849 * Be mindful of the image size when selecting an image. 850 * 851 * @type { ?ResourceStr } 852 * @syscap SystemCapability.ArkUI.ArkUI.Full 853 * @crossplatform 854 * @atomicservice 855 * @since arkts {'1.1':'11','1.2':'20'} 856 * @arkts 1.1&1.2 857 */ 858 image?: ResourceStr; 859 860 /** 861 * Sets the shape of slider block while the type is set to SliderBlockType.Shape. 862 * 863 * @type { ?(CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute) } 864 * @syscap SystemCapability.ArkUI.ArkUI.Full 865 * @crossplatform 866 * @since 10 867 */ 868 /** 869 * Custom shape of the slider. 870 * 871 * @type { ?(CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute) } 872 * @syscap SystemCapability.ArkUI.ArkUI.Full 873 * @crossplatform 874 * @atomicservice 875 * @since arkts {'1.1':'11','1.2':'20'} 876 * @arkts 1.1&1.2 877 */ 878 shape?: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute; 879} 880 881/** 882 * Defines the callback type used in SliderConfiguration. 883 * 884 * @typedef {function} SliderTriggerChangeCallback 885 * @param { number } value - Current progress. 886 * @param { SliderChangeMode } mode - State triggered by the event. 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @crossplatform 889 * @atomicservice 890 * @since arkts {'1.1':'12','1.2':'20'} 891 * @arkts 1.1&1.2 892 */ 893declare type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMode) => void; 894 895/** 896 * You need a custom class to implement the ContentModifier API. 897 * 898 * @extends CommonConfiguration<SliderConfiguration> 899 * @interface SliderConfiguration 900 * @syscap SystemCapability.ArkUI.ArkUI.Full 901 * @crossplatform 902 * @atomicservice 903 * @since arkts {'1.1':'12','1.2':'20'} 904 * @arkts 1.1&1.2 905 */ 906declare interface SliderConfiguration extends CommonConfiguration<SliderConfiguration> { 907 /** 908 * Current progress. 909 * 910 * @type { number } 911 * @syscap SystemCapability.ArkUI.ArkUI.Full 912 * @crossplatform 913 * @atomicservice 914 * @since arkts {'1.1':'12','1.2':'20'} 915 * @arkts 1.1&1.2 916 */ 917 value: number; 918 919 /** 920 * Minimum value. 921 * 922 * @type { number } 923 * @syscap SystemCapability.ArkUI.ArkUI.Full 924 * @crossplatform 925 * @atomicservice 926 * @since arkts {'1.1':'12','1.2':'20'} 927 * @arkts 1.1&1.2 928 */ 929 min: number; 930 931 /** 932 * Maximum value. 933 * 934 * @type { number } 935 * @syscap SystemCapability.ArkUI.ArkUI.Full 936 * @crossplatform 937 * @atomicservice 938 * @since arkts {'1.1':'12','1.2':'20'} 939 * @arkts 1.1&1.2 940 */ 941 max: number; 942 943 /** 944 * Step of the slider. 945 * 946 * @type { number } 947 * @syscap SystemCapability.ArkUI.ArkUI.Full 948 * @crossplatform 949 * @atomicservice 950 * @since arkts {'1.1':'12','1.2':'20'} 951 * @arkts 1.1&1.2 952 */ 953 step: number; 954 955 /** 956 * Triggers slider changes. 957 * 958 * @type { SliderTriggerChangeCallback } 959 * @syscap SystemCapability.ArkUI.ArkUI.Full 960 * @crossplatform 961 * @atomicservice 962 * @since arkts {'1.1':'12','1.2':'20'} 963 * @arkts 1.1&1.2 964 */ 965 triggerChange: SliderTriggerChangeCallback; 966} 967 968/** 969 * Provides an interface for the slide bar component. 970 * 971 * @interface SliderInterface 972 * @syscap SystemCapability.ArkUI.ArkUI.Full 973 * @since 7 974 */ 975/** 976 * Provides an interface for the slide bar component. 977 * 978 * @interface SliderInterface 979 * @syscap SystemCapability.ArkUI.ArkUI.Full 980 * @form 981 * @since 9 982 */ 983/** 984 * Provides an interface for the slide bar component. 985 * 986 * @interface SliderInterface 987 * @syscap SystemCapability.ArkUI.ArkUI.Full 988 * @crossplatform 989 * @form 990 * @since 10 991 */ 992/** 993 * Provides an interface for the slide bar component. 994 * 995 * @interface SliderInterface 996 * @syscap SystemCapability.ArkUI.ArkUI.Full 997 * @crossplatform 998 * @form 999 * @atomicservice 1000 * @since arkts {'1.1':'11','1.2':'20'} 1001 * @arkts 1.1&1.2 1002 */ 1003interface SliderInterface { 1004 /** 1005 * Called when the slider bar component is used. 1006 * 1007 * @param { SliderOptions } options 1008 * @returns { SliderAttribute } 1009 * @syscap SystemCapability.ArkUI.ArkUI.Full 1010 * @since 7 1011 */ 1012 /** 1013 * Called when the slider bar component is used. 1014 * 1015 * @param { SliderOptions } options 1016 * @returns { SliderAttribute } 1017 * @syscap SystemCapability.ArkUI.ArkUI.Full 1018 * @form 1019 * @since 9 1020 */ 1021 /** 1022 * Called when the slider bar component is used. 1023 * 1024 * @param { SliderOptions } options 1025 * @returns { SliderAttribute } 1026 * @syscap SystemCapability.ArkUI.ArkUI.Full 1027 * @crossplatform 1028 * @form 1029 * @since 10 1030 */ 1031 /** 1032 * Called when the slider bar component is used. 1033 * 1034 * @param { SliderOptions } options 1035 * @returns { SliderAttribute } 1036 * @syscap SystemCapability.ArkUI.ArkUI.Full 1037 * @crossplatform 1038 * @form 1039 * @atomicservice 1040 * @since arkts {'1.1':'11','1.2':'20'} 1041 * @arkts 1.1&1.2 1042 */ 1043 (options?: SliderOptions): SliderAttribute; 1044} 1045 1046/** 1047 * Defines the accessibility information of slider step point. 1048 * 1049 * @interface SliderStepItemAccessibility 1050 * @syscap SystemCapability.ArkUI.ArkUI.Full 1051 * @crossplatform 1052 * @atomicservice 1053 * @since 20 1054 */ 1055declare interface SliderStepItemAccessibility { 1056 /** 1057 * Set the accessibility of the slider step point. 1058 * 1059 * @type { ?ResourceStr } 1060 * @syscap SystemCapability.ArkUI.ArkUI.Full 1061 * @crossplatform 1062 * @atomicservice 1063 * @since 20 1064 */ 1065 text?: ResourceStr; 1066} 1067 1068/** 1069 * Defines the accessibility information of slider step point. 1070 * 1071 * @interface SliderShowStepOptions 1072 * @syscap SystemCapability.ArkUI.ArkUI.Full 1073 * @crossplatform 1074 * @atomicservice 1075 * @since 20 1076 */ 1077declare interface SliderShowStepOptions { 1078 /** 1079 * Set the accessibility of the slider step points. 1080 * 1081 * @type { ?Map<number, SliderStepItemAccessibility> } 1082 * @syscap SystemCapability.ArkUI.ArkUI.Full 1083 * @crossplatform 1084 * @atomicservice 1085 * @since 20 1086 */ 1087 stepsAccessibility?: Map<number, SliderStepItemAccessibility>; 1088} 1089 1090/** 1091 * Defines the options for customizing the accessibility of content within a slider. 1092 * These options can be used to enhance the user experience for assistive technologies. 1093 * 1094 * @interface SliderCustomContentOptions 1095 * @syscap SystemCapability.ArkUI.ArkUI.Full 1096 * @crossplatform 1097 * @atomicservice 1098 * @since 20 1099 */ 1100interface SliderCustomContentOptions { 1101 /** 1102 * The text used for accessibility purposes. This text will be read by screen readers 1103 * to provide a more descriptive label for the slider content. 1104 * 1105 * @type { ?ResourceStr } 1106 * @syscap SystemCapability.ArkUI.ArkUI.Full 1107 * @crossplatform 1108 * @atomicservice 1109 * @since 20 1110 */ 1111 accessibilityText?: ResourceStr; 1112 1113 /** 1114 * A more detailed description for accessibility. This can provide additional context 1115 * about the slider content for users relying on assistive technologies. 1116 * 1117 * @type { ?ResourceStr } 1118 * @syscap SystemCapability.ArkUI.ArkUI.Full 1119 * @crossplatform 1120 * @atomicservice 1121 * @since 20 1122 */ 1123 accessibilityDescription?: ResourceStr; 1124 1125 /** 1126 * The accessibility level of the slider content. This could be used to indicate the importance 1127 * or priority of the content for assistive technologies. 1128 * 1129 * @type { ?string } 1130 * @syscap SystemCapability.ArkUI.ArkUI.Full 1131 * @crossplatform 1132 * @atomicservice 1133 * @since 20 1134 */ 1135 accessibilityLevel?: string; 1136 1137 /** 1138 * Indicates whether the slider content should be treated as an accessibility group. 1139 * 1140 * @type { ?boolean } 1141 * @syscap SystemCapability.ArkUI.ArkUI.Full 1142 * @crossplatform 1143 * @atomicservice 1144 * @since 20 1145 */ 1146 accessibilityGroup?: boolean; 1147} 1148 1149/** 1150 * Options used for customizing the prefix part of the slider. 1151 * It extends the SliderCustomContentOptions to inherit accessibility customization options. 1152 * 1153 * @extends SliderCustomContentOptions 1154 * @interface SliderPrefixOptions 1155 * @syscap SystemCapability.ArkUI.ArkUI.Full 1156 * @crossplatform 1157 * @atomicservice 1158 * @since 20 1159 */ 1160interface SliderPrefixOptions extends SliderCustomContentOptions { 1161} 1162 1163/** 1164 * Options used for customizing the suffix part of the slider. 1165 * It extends the SliderCustomContentOptions to inherit accessibility customization options. 1166 * 1167 * @extends SliderCustomContentOptions 1168 * @interface SliderSuffixOptions 1169 * @syscap SystemCapability.ArkUI.ArkUI.Full 1170 * @crossplatform 1171 * @atomicservice 1172 * @since 20 1173 */ 1174interface SliderSuffixOptions extends SliderCustomContentOptions { 1175} 1176 1177/** 1178 * Defines the attribute functions of Slider. 1179 * 1180 * @extends CommonMethod<SliderAttribute> 1181 * @syscap SystemCapability.ArkUI.ArkUI.Full 1182 * @since 7 1183 */ 1184/** 1185 * Defines the attribute functions of Slider. 1186 * 1187 * @extends CommonMethod<SliderAttribute> 1188 * @syscap SystemCapability.ArkUI.ArkUI.Full 1189 * @form 1190 * @since 9 1191 */ 1192/** 1193 * Defines the attribute functions of Slider. 1194 * 1195 * @extends CommonMethod<SliderAttribute> 1196 * @syscap SystemCapability.ArkUI.ArkUI.Full 1197 * @crossplatform 1198 * @form 1199 * @since 10 1200 */ 1201/** 1202 * Defines the attribute functions of Slider. 1203 * 1204 * @extends CommonMethod<SliderAttribute> 1205 * @syscap SystemCapability.ArkUI.ArkUI.Full 1206 * @crossplatform 1207 * @form 1208 * @atomicservice 1209 * @since arkts {'1.1':'11','1.2':'20'} 1210 * @arkts 1.1&1.2 1211 */ 1212declare class SliderAttribute extends CommonMethod<SliderAttribute> { 1213 /** 1214 * Called when the slider color of the slider bar is set. 1215 * 1216 * @param { ResourceColor } value 1217 * @returns { SliderAttribute } 1218 * @syscap SystemCapability.ArkUI.ArkUI.Full 1219 * @since 7 1220 */ 1221 /** 1222 * Called when the slider color of the slider bar is set. 1223 * 1224 * @param { ResourceColor } value 1225 * @returns { SliderAttribute } 1226 * @syscap SystemCapability.ArkUI.ArkUI.Full 1227 * @form 1228 * @since 9 1229 */ 1230 /** 1231 * Called when the slider color of the slider bar is set. 1232 * 1233 * @param { ResourceColor } value 1234 * @returns { SliderAttribute } 1235 * @syscap SystemCapability.ArkUI.ArkUI.Full 1236 * @crossplatform 1237 * @form 1238 * @since 10 1239 */ 1240 /** 1241 * Called when the slider color of the slider bar is set. 1242 * 1243 * @param { ResourceColor } value 1244 * @returns { SliderAttribute } 1245 * @syscap SystemCapability.ArkUI.ArkUI.Full 1246 * @crossplatform 1247 * @form 1248 * @atomicservice 1249 * @since arkts {'1.1':'11','1.2':'20'} 1250 * @arkts 1.1&1.2 1251 */ 1252 blockColor(value: ResourceColor): SliderAttribute; 1253 1254 /** 1255 * Called when the track color of the slider is set. 1256 * 1257 * @param { ResourceColor } value 1258 * @returns { SliderAttribute } 1259 * @syscap SystemCapability.ArkUI.ArkUI.Full 1260 * @since 7 1261 */ 1262 /** 1263 * Called when the track color of the slider is set. 1264 * 1265 * @param { ResourceColor } value 1266 * @returns { SliderAttribute } 1267 * @syscap SystemCapability.ArkUI.ArkUI.Full 1268 * @form 1269 * @since 9 1270 */ 1271 /** 1272 * Called when the track color of the slider is set. 1273 * 1274 * @param { ResourceColor } value 1275 * @returns { SliderAttribute } 1276 * @syscap SystemCapability.ArkUI.ArkUI.Full 1277 * @crossplatform 1278 * @form 1279 * @since 10 1280 */ 1281 /** 1282 * Called when the track color of the slider is set. 1283 * 1284 * @param { ResourceColor } value 1285 * @returns { SliderAttribute } 1286 * @syscap SystemCapability.ArkUI.ArkUI.Full 1287 * @crossplatform 1288 * @form 1289 * @atomicservice 1290 * @since 11 1291 */ 1292 /** 1293 * Called when the track color of the slider is set. 1294 * 1295 * @param { ResourceColor | LinearGradient } value 1296 * @returns { SliderAttribute } 1297 * @syscap SystemCapability.ArkUI.ArkUI.Full 1298 * @crossplatform 1299 * @form 1300 * @atomicservice 1301 * @since arkts {'1.1':'12','1.2':'20'} 1302 * @arkts 1.1&1.2 1303 */ 1304 trackColor(value: ResourceColor | LinearGradient): SliderAttribute; 1305 1306 /** 1307 * Called when the slider of the slider bar is set to slide over the area color. 1308 * 1309 * @param { ResourceColor } value 1310 * @returns { SliderAttribute } 1311 * @syscap SystemCapability.ArkUI.ArkUI.Full 1312 * @since 7 1313 */ 1314 /** 1315 * Called when the slider of the slider bar is set to slide over the area color. 1316 * 1317 * @param { ResourceColor } value 1318 * @returns { SliderAttribute } 1319 * @syscap SystemCapability.ArkUI.ArkUI.Full 1320 * @form 1321 * @since 9 1322 */ 1323 /** 1324 * Called when the slider of the slider bar is set to slide over the area color. 1325 * 1326 * @param { ResourceColor } value 1327 * @returns { SliderAttribute } 1328 * @syscap SystemCapability.ArkUI.ArkUI.Full 1329 * @crossplatform 1330 * @form 1331 * @since 10 1332 */ 1333 /** 1334 * Called when the slider of the slider bar is set to slide over the area color. 1335 * 1336 * @param { ResourceColor } value 1337 * @returns { SliderAttribute } 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @crossplatform 1340 * @form 1341 * @atomicservice 1342 * @since arkts {'1.1':'11','1.2':'20'} 1343 * @arkts 1.1&1.2 1344 */ 1345 selectedColor(value: ResourceColor): SliderAttribute; 1346 /** 1347 * Called when the slider of the slider bar is set to slide over the area color. 1348 * 1349 * @param { ResourceColor | LinearGradient } selectedColor 1350 * @returns { SliderAttribute } 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @crossplatform 1353 * @form 1354 * @atomicservice 1355 * @since arkts {'1.1':'18','1.2':'20'} 1356 * @arkts 1.1&1.2 1357 */ 1358 selectedColor(selectedColor: ResourceColor | LinearGradient): SliderAttribute; 1359 1360 /** 1361 * Called when the minimum label is set. 1362 * 1363 * @param { string } value 1364 * @returns { SliderAttribute } 1365 * @syscap SystemCapability.ArkUI.ArkUI.Full 1366 * @since 7 1367 * @deprecated since 9 1368 * @useinstead min 1369 */ 1370 minLabel(value: string): SliderAttribute; 1371 1372 /** 1373 * Called when the maximum label is set. 1374 * 1375 * @param { string } value 1376 * @returns { SliderAttribute } 1377 * @syscap SystemCapability.ArkUI.ArkUI.Full 1378 * @since 7 1379 * @deprecated since 9 1380 * @useinstead max 1381 */ 1382 maxLabel(value: string): SliderAttribute; 1383 1384 /** 1385 * Called when setting whether to display step size. 1386 * 1387 * @param { boolean } value 1388 * @returns { SliderAttribute } 1389 * @syscap SystemCapability.ArkUI.ArkUI.Full 1390 * @since 7 1391 */ 1392 /** 1393 * Called when setting whether to display step size. 1394 * 1395 * @param { boolean } value 1396 * @returns { SliderAttribute } 1397 * @syscap SystemCapability.ArkUI.ArkUI.Full 1398 * @form 1399 * @since 9 1400 */ 1401 /** 1402 * Called when setting whether to display step size. 1403 * 1404 * @param { boolean } value 1405 * @returns { SliderAttribute } 1406 * @syscap SystemCapability.ArkUI.ArkUI.Full 1407 * @crossplatform 1408 * @form 1409 * @since 10 1410 */ 1411 /** 1412 * Called when setting whether to display step size. 1413 * 1414 * @param { boolean } value 1415 * @returns { SliderAttribute } 1416 * @syscap SystemCapability.ArkUI.ArkUI.Full 1417 * @crossplatform 1418 * @form 1419 * @atomicservice 1420 * @since arkts {'1.1':'11','1.2':'20'} 1421 * @arkts 1.1&1.2 1422 */ 1423 showSteps(value: boolean): SliderAttribute; 1424 1425 /** 1426 * Called when setting whether to display step size. 1427 * 1428 * @param { boolean } value 1429 * @param { SliderShowStepOptions } [options] 1430 * @returns { SliderAttribute } 1431 * @syscap SystemCapability.ArkUI.ArkUI.Full 1432 * @crossplatform 1433 * @form 1434 * @atomicservice 1435 * @since 20 1436 */ 1437 showSteps(value: boolean, options?: SliderShowStepOptions): SliderAttribute; 1438 1439 /** 1440 * Called when the percentage of bubble prompt is set when sliding. 1441 * 1442 * @param { boolean } value 1443 * @returns { SliderAttribute } 1444 * @syscap SystemCapability.ArkUI.ArkUI.Full 1445 * @since 7 1446 */ 1447 /** 1448 * Called when the percentage of bubble prompt is set when sliding. 1449 * 1450 * @param { boolean } value 1451 * @returns { SliderAttribute } 1452 * @syscap SystemCapability.ArkUI.ArkUI.Full 1453 * @form 1454 * @since 9 1455 */ 1456 /** 1457 * Called when the percentage of bubble prompt is set when sliding. 1458 * 1459 * @param { boolean } value - Whether to display the bubble. 1460 * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current 1461 * percentage is displayed by default. 1462 * @returns { SliderAttribute } 1463 * @syscap SystemCapability.ArkUI.ArkUI.Full 1464 * @crossplatform 1465 * @form 1466 * @since 10 1467 */ 1468 /** 1469 * Called when the percentage of bubble prompt is set when sliding. 1470 * 1471 * @param { boolean } value - Whether to display the bubble. 1472 * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current 1473 * percentage is displayed by default. 1474 * @returns { SliderAttribute } 1475 * @syscap SystemCapability.ArkUI.ArkUI.Full 1476 * @crossplatform 1477 * @form 1478 * @atomicservice 1479 * @since arkts {'1.1':'11','1.2':'20'} 1480 * @arkts 1.1&1.2 1481 */ 1482 showTips(value: boolean, content?: ResourceStr): SliderAttribute; 1483 1484 /** 1485 * Called when the thickness of track is set. 1486 * 1487 * @param { Length } value 1488 * @returns { SliderAttribute } 1489 * @syscap SystemCapability.ArkUI.ArkUI.Full 1490 * @since 8 1491 */ 1492 /** 1493 * Called when the thickness of track is set. 1494 * 1495 * @param { Length } value 1496 * @returns { SliderAttribute } 1497 * @syscap SystemCapability.ArkUI.ArkUI.Full 1498 * @form 1499 * @since 9 1500 */ 1501 /** 1502 * Called when the thickness of track is set. 1503 * 1504 * @param { Length } value 1505 * @returns { SliderAttribute } 1506 * @syscap SystemCapability.ArkUI.ArkUI.Full 1507 * @crossplatform 1508 * @form 1509 * @since 10 1510 */ 1511 /** 1512 * Called when the thickness of track is set. 1513 * 1514 * @param { Length } value 1515 * @returns { SliderAttribute } 1516 * @syscap SystemCapability.ArkUI.ArkUI.Full 1517 * @crossplatform 1518 * @form 1519 * @atomicservice 1520 * @since arkts {'1.1':'11','1.2':'20'} 1521 * @arkts 1.1&1.2 1522 */ 1523 trackThickness(value: Length): SliderAttribute; 1524 1525 /** 1526 * Called when the selection value changes. 1527 * 1528 * @param { function } callback 1529 * @returns { SliderAttribute } 1530 * @syscap SystemCapability.ArkUI.ArkUI.Full 1531 * @since 7 1532 */ 1533 /** 1534 * Called when the selection value changes. 1535 * 1536 * @param { function } callback 1537 * @returns { SliderAttribute } 1538 * @syscap SystemCapability.ArkUI.ArkUI.Full 1539 * @form 1540 * @since 9 1541 */ 1542 /** 1543 * Called when the selection value changes. 1544 * 1545 * @param { function } callback 1546 * @returns { SliderAttribute } 1547 * @syscap SystemCapability.ArkUI.ArkUI.Full 1548 * @crossplatform 1549 * @form 1550 * @since 10 1551 */ 1552 /** 1553 * Triggered when the slider is dragged or clicked. 1554 * <p><strong>NOTE</strong>: 1555 * <br>The Begin and End states are triggered when the slider is clicked with a gesture. The Moving and Click states 1556 * are triggered when the value of value changes. If the coherent action is a drag action, the Click state will 1557 * not be triggered. 1558 * </p> 1559 * 1560 * @param { function } callback 1561 * @returns { SliderAttribute } 1562 * @syscap SystemCapability.ArkUI.ArkUI.Full 1563 * @crossplatform 1564 * @form 1565 * @atomicservice 1566 * @since arkts {'1.1':'11','1.2':'20'} 1567 * @arkts 1.1&1.2 1568 */ 1569 onChange(callback: (value: number, mode: SliderChangeMode) => void): SliderAttribute; 1570 1571 /** 1572 * Called when the border color of block is set. 1573 * 1574 * @param { ResourceColor } value - the border color of block. 1575 * @returns { SliderAttribute } 1576 * @syscap SystemCapability.ArkUI.ArkUI.Full 1577 * @crossplatform 1578 * @since 10 1579 */ 1580 /** 1581 * Called when the border color of block is set. 1582 * 1583 * @param { ResourceColor } value - the border color of block. 1584 * @returns { SliderAttribute } 1585 * @syscap SystemCapability.ArkUI.ArkUI.Full 1586 * @crossplatform 1587 * @atomicservice 1588 * @since arkts {'1.1':'11','1.2':'20'} 1589 * @arkts 1.1&1.2 1590 */ 1591 blockBorderColor(value: ResourceColor): SliderAttribute; 1592 1593 /** 1594 * Called when the border width of block is set. 1595 * 1596 * @param { Length } value - the border width of block. 1597 * @returns { SliderAttribute } 1598 * @syscap SystemCapability.ArkUI.ArkUI.Full 1599 * @crossplatform 1600 * @since 10 1601 */ 1602 /** 1603 * Called when the border width of block is set. 1604 * 1605 * @param { Length } value - the border width of block. 1606 * @returns { SliderAttribute } 1607 * @syscap SystemCapability.ArkUI.ArkUI.Full 1608 * @crossplatform 1609 * @atomicservice 1610 * @since arkts {'1.1':'11','1.2':'20'} 1611 * @arkts 1.1&1.2 1612 */ 1613 blockBorderWidth(value: Length): SliderAttribute; 1614 1615 /** 1616 * Called when the color of step is set. 1617 * 1618 * @param { ResourceColor } value - the color of step. 1619 * @returns { SliderAttribute } 1620 * @syscap SystemCapability.ArkUI.ArkUI.Full 1621 * @crossplatform 1622 * @since 10 1623 */ 1624 /** 1625 * Called when the color of step is set. 1626 * 1627 * @param { ResourceColor } value - the color of step. 1628 * @returns { SliderAttribute } 1629 * @syscap SystemCapability.ArkUI.ArkUI.Full 1630 * @crossplatform 1631 * @atomicservice 1632 * @since arkts {'1.1':'11','1.2':'20'} 1633 * @arkts 1.1&1.2 1634 */ 1635 stepColor(value: ResourceColor): SliderAttribute; 1636 1637 /** 1638 * Called when the radius of track border is set. 1639 * 1640 * @param { Length } value - the radius of track border. 1641 * @returns { SliderAttribute } 1642 * @syscap SystemCapability.ArkUI.ArkUI.Full 1643 * @crossplatform 1644 * @since 10 1645 */ 1646 /** 1647 * Called when the radius of track border is set. 1648 * 1649 * @param { Length } value - the radius of track border. 1650 * @returns { SliderAttribute } 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @crossplatform 1653 * @atomicservice 1654 * @since arkts {'1.1':'11','1.2':'20'} 1655 * @arkts 1.1&1.2 1656 */ 1657 trackBorderRadius(value: Length): SliderAttribute; 1658 1659 /** 1660 * Called when the radius of selected part is set. 1661 * 1662 * @param { Dimension } value - the radius of selected part. 1663 * @returns { SliderAttribute } 1664 * @syscap SystemCapability.ArkUI.ArkUI.Full 1665 * @crossplatform 1666 * @atomicservice 1667 * @since arkts {'1.1':'12','1.2':'20'} 1668 * @arkts 1.1&1.2 1669 */ 1670 selectedBorderRadius(value: Dimension): SliderAttribute; 1671 1672 /** 1673 * Called when the size of block is set. 1674 * 1675 * @param { SizeOptions } value - the size of block. 1676 * @returns { SliderAttribute } 1677 * @syscap SystemCapability.ArkUI.ArkUI.Full 1678 * @crossplatform 1679 * @since 10 1680 */ 1681 /** 1682 * Called when the size of block is set. 1683 * 1684 * @param { SizeOptions } value - the size of block. 1685 * @returns { SliderAttribute } 1686 * @syscap SystemCapability.ArkUI.ArkUI.Full 1687 * @crossplatform 1688 * @atomicservice 1689 * @since arkts {'1.1':'11','1.2':'20'} 1690 * @arkts 1.1&1.2 1691 */ 1692 blockSize(value: SizeOptions): SliderAttribute; 1693 1694 /** 1695 * Called when the style of block is set. 1696 * 1697 * @param { SliderBlockStyle } value - the style of block. 1698 * @returns { SliderAttribute } 1699 * @syscap SystemCapability.ArkUI.ArkUI.Full 1700 * @crossplatform 1701 * @since 10 1702 */ 1703 /** 1704 * Sets the style of the slider in the block direction. 1705 * 1706 * @param { SliderBlockStyle } value - Style of the slider in the block direction. 1707 * <br>Default value is SliderBlockType.DEFAULT, indicating the round slider. 1708 * @returns { SliderAttribute } 1709 * @syscap SystemCapability.ArkUI.ArkUI.Full 1710 * @crossplatform 1711 * @atomicservice 1712 * @since arkts {'1.1':'11','1.2':'20'} 1713 * @arkts 1.1&1.2 1714 */ 1715 blockStyle(value: SliderBlockStyle): SliderAttribute; 1716 1717 /** 1718 * Called when the diameter of step is set. 1719 * 1720 * @param { Length } value - the diameter of step. 1721 * @returns { SliderAttribute } 1722 * @syscap SystemCapability.ArkUI.ArkUI.Full 1723 * @crossplatform 1724 * @since 10 1725 */ 1726 /** 1727 * Called when the diameter of step is set. 1728 * 1729 * @param { Length } value - the diameter of step. 1730 * @returns { SliderAttribute } 1731 * @syscap SystemCapability.ArkUI.ArkUI.Full 1732 * @crossplatform 1733 * @atomicservice 1734 * @since arkts {'1.1':'11','1.2':'20'} 1735 * @arkts 1.1&1.2 1736 */ 1737 stepSize(value: Length): SliderAttribute; 1738 1739 /** 1740 * Sets the interaction mode between the user and the slider. 1741 * 1742 * @param { SliderInteraction } value - Interaction mode between the user and the slider. 1743 * <br>Default value is SliderInteraction.SLIDE_AND_CLICK. 1744 * @returns { SliderAttribute } 1745 * @syscap SystemCapability.ArkUI.ArkUI.Full 1746 * @crossplatform 1747 * @atomicservice 1748 * @since arkts {'1.1':'12','1.2':'20'} 1749 * @arkts 1.1&1.2 1750 */ 1751 sliderInteractionMode(value: SliderInteraction): SliderAttribute; 1752 1753 /** 1754 * Sets the min value when Slider response to drag event. 1755 * 1756 * @param { number } value 1757 * @returns { SliderAttribute } 1758 * @syscap SystemCapability.ArkUI.ArkUI.Full 1759 * @crossplatform 1760 * @atomicservice 1761 * @since arkts {'1.1':'12','1.2':'20'} 1762 * @arkts 1.1&1.2 1763 */ 1764 minResponsiveDistance(value: number): SliderAttribute; 1765 1766 /** 1767 * Creates a content modifier. 1768 * 1769 * @param { ContentModifier<SliderConfiguration> } modifier - Content modifier to apply to the slider. 1770 * modifier: content modifier. You need a custom class to implement the ContentModifier API. 1771 * @returns { SliderAttribute } 1772 * @syscap SystemCapability.ArkUI.ArkUI.Full 1773 * @crossplatform 1774 * @atomicservice 1775 * @since arkts {'1.1':'12','1.2':'20'} 1776 * @arkts 1.1&1.2 1777 */ 1778 contentModifier(modifier: ContentModifier<SliderConfiguration>): SliderAttribute; 1779 1780 /** 1781 * Set the valid slidable range. 1782 * 1783 * @param { SlideRange } value 1784 * @returns { SliderAttribute } 1785 * @syscap SystemCapability.ArkUI.ArkUI.Full 1786 * @crossplatform 1787 * @atomicservice 1788 * @since arkts {'1.1':'12','1.2':'20'} 1789 * @arkts 1.1&1.2 1790 */ 1791 slideRange(value: SlideRange): SliderAttribute; 1792 1793 /** 1794 * Set the sensitivity of rotating crown. 1795 * 1796 * @param { Optional<CrownSensitivity> } sensitivity - The sensitivity of rotating crown, default value is { MEDIUM }. 1797 * @returns { SliderAttribute } 1798 * @syscap SystemCapability.ArkUI.ArkUI.Full 1799 * @crossplatform 1800 * @atomicservice 1801 * @since arkts {'1.1':'18','1.2':'20'} 1802 * @arkts 1.1&1.2 1803 */ 1804 digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>): SliderAttribute; 1805 1806 /** 1807 * Enable or disable haptic feedback. 1808 * 1809 * @param { boolean } enabled - Default value is true, set false to disable haptic feedback. 1810 * @returns { SliderAttribute } 1811 * @syscap SystemCapability.ArkUI.ArkUI.Full 1812 * @atomicservice 1813 * @since arkts {'1.1':'18','1.2':'20'} 1814 * @arkts 1.1&1.2 1815 */ 1816 enableHapticFeedback(enabled: boolean): SliderAttribute; 1817 1818 /** 1819 * Sets the prefix part of the slider. 1820 * The prefix is the content that appears before the main slider component. 1821 * 1822 * @param { ComponentContent } content - Custom components that will be displayed as the prefix. 1823 * This can be any valid custom UI component structure. 1824 * @param { SliderPrefixOptions } [options] - Optional options for customizing the prefix. 1825 * These options can include accessibility settings. 1826 * @returns { SliderAttribute } 1827 * @syscap SystemCapability.ArkUI.ArkUI.Full 1828 * @crossplatform 1829 * @atomicservice 1830 * @since 20 1831 */ 1832 prefix(content: ComponentContent, options?: SliderPrefixOptions): SliderAttribute; 1833 1834 /** 1835 * Sets the suffix part of the slider. 1836 * The suffix is the content that appears after the main slider component. 1837 * 1838 * @param { ComponentContent } content - Custom components that will be displayed as the suffix. 1839 * This can be any valid custom UI component structure. 1840 * @param { SliderSuffixOptions } [options] - Optional options for customizing the suffix. 1841 * These options can include accessibility settings. 1842 * @returns { SliderAttribute } 1843 * @syscap SystemCapability.ArkUI.ArkUI.Full 1844 * @crossplatform 1845 * @atomicservice 1846 * @since 20 1847 */ 1848 suffix(content: ComponentContent, options?: SliderSuffixOptions): SliderAttribute; 1849} 1850 1851/** 1852 * Defines Slider Component. 1853 * 1854 * @syscap SystemCapability.ArkUI.ArkUI.Full 1855 * @since 7 1856 */ 1857/** 1858 * Defines Slider Component. 1859 * 1860 * @syscap SystemCapability.ArkUI.ArkUI.Full 1861 * @form 1862 * @since 9 1863 */ 1864/** 1865 * Defines Slider Component. 1866 * 1867 * @syscap SystemCapability.ArkUI.ArkUI.Full 1868 * @crossplatform 1869 * @form 1870 * @since 10 1871 */ 1872/** 1873 * Defines Slider Component. 1874 * 1875 * @syscap SystemCapability.ArkUI.ArkUI.Full 1876 * @crossplatform 1877 * @form 1878 * @atomicservice 1879 * @since 11 1880 */ 1881declare const Slider: SliderInterface; 1882 1883/** 1884 * Defines Slider Component instance. 1885 * 1886 * @syscap SystemCapability.ArkUI.ArkUI.Full 1887 * @since 7 1888 */ 1889/** 1890 * Defines Slider Component instance. 1891 * 1892 * @syscap SystemCapability.ArkUI.ArkUI.Full 1893 * @form 1894 * @since 9 1895 */ 1896/** 1897 * Defines Slider Component instance. 1898 * 1899 * @syscap SystemCapability.ArkUI.ArkUI.Full 1900 * @crossplatform 1901 * @form 1902 * @since 10 1903 */ 1904/** 1905 * Defines Slider Component instance. 1906 * 1907 * @syscap SystemCapability.ArkUI.ArkUI.Full 1908 * @crossplatform 1909 * @form 1910 * @atomicservice 1911 * @since 11 1912 */ 1913declare const SliderInstance: SliderAttribute; 1914