• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * Declare sliderstyle
18 *
19 * @enum { number }
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 7
22 */
23/**
24 * Declare sliderstyle
25 *
26 * @enum { number }
27 * @syscap SystemCapability.ArkUI.ArkUI.Full
28 * @since 9
29 * @form
30 */
31/**
32 * Declare sliderstyle
33 *
34 * @enum { number }
35 * @syscap SystemCapability.ArkUI.ArkUI.Full
36 * @crossplatform
37 * @since 10
38 * @form
39 */
40declare enum SliderStyle {
41  /**
42   * The slider is on the slide rail.
43   *
44   * @syscap SystemCapability.ArkUI.ArkUI.Full
45   * @since 7
46   */
47  /**
48   * The slider is on the slide rail.
49   *
50   * @syscap SystemCapability.ArkUI.ArkUI.Full
51   * @since 9
52   * @form
53   */
54  /**
55   * The slider is on the slide rail.
56   *
57   * @syscap SystemCapability.ArkUI.ArkUI.Full
58   * @crossplatform
59   * @since 10
60   * @form
61   */
62  OutSet,
63
64  /**
65   * The slider is in the slide rail.
66   *
67   * @syscap SystemCapability.ArkUI.ArkUI.Full
68   * @since 7
69   */
70  /**
71   * The slider is in the slide rail.
72   *
73   * @syscap SystemCapability.ArkUI.ArkUI.Full
74   * @since 9
75   * @form
76   */
77  /**
78   * The slider is in the slide rail.
79   *
80   * @syscap SystemCapability.ArkUI.ArkUI.Full
81   * @crossplatform
82   * @since 10
83   * @form
84   */
85  InSet,
86}
87
88/**
89 * Declare SliderChangeMode
90 *
91 * @enum { number }
92 * @syscap SystemCapability.ArkUI.ArkUI.Full
93 * @since 7
94 */
95/**
96 * Declare SliderChangeMode
97 *
98 * @enum { number }
99 * @syscap SystemCapability.ArkUI.ArkUI.Full
100 * @since 9
101 * @form
102 */
103/**
104 * Declare SliderChangeMode
105 *
106 * @enum { number }
107 * @syscap SystemCapability.ArkUI.ArkUI.Full
108 * @crossplatform
109 * @since 10
110 * @form
111 */
112declare enum SliderChangeMode {
113  /**
114   * Start dragging the slider.
115   *
116   * @syscap SystemCapability.ArkUI.ArkUI.Full
117   * @since 7
118   */
119  /**
120   * Start dragging the slider.
121   *
122   * @syscap SystemCapability.ArkUI.ArkUI.Full
123   * @since 9
124   * @form
125   */
126  /**
127   * Start dragging the slider.
128   *
129   * @syscap SystemCapability.ArkUI.ArkUI.Full
130   * @crossplatform
131   * @since 10
132   * @form
133   */
134  Begin,
135
136  /**
137   * Drag the slider.
138   *
139   * @syscap SystemCapability.ArkUI.ArkUI.Full
140   * @since 7
141   */
142  /**
143   * Drag the slider.
144   *
145   * @syscap SystemCapability.ArkUI.ArkUI.Full
146   * @since 9
147   * @form
148   */
149  /**
150   * Drag the slider.
151   *
152   * @syscap SystemCapability.ArkUI.ArkUI.Full
153   * @crossplatform
154   * @since 10
155   * @form
156   */
157  Moving,
158
159  /**
160   * End dragging the slider.
161   *
162   * @syscap SystemCapability.ArkUI.ArkUI.Full
163   * @since 7
164   */
165  /**
166   * End dragging the slider.
167   *
168   * @syscap SystemCapability.ArkUI.ArkUI.Full
169   * @since 9
170   * @form
171   */
172  /**
173   * End dragging the slider.
174   *
175   * @syscap SystemCapability.ArkUI.ArkUI.Full
176   * @crossplatform
177   * @since 10
178   * @form
179   */
180  End,
181
182  /**
183   * Click the slider.
184   *
185   * @syscap SystemCapability.ArkUI.ArkUI.Full
186   * @since 8
187   */
188  /**
189   * Click the slider.
190   *
191   * @syscap SystemCapability.ArkUI.ArkUI.Full
192   * @since 9
193   * @form
194   */
195  /**
196   * Click the slider.
197   *
198   * @syscap SystemCapability.ArkUI.ArkUI.Full
199   * @crossplatform
200   * @since 10
201   * @form
202   */
203  Click,
204}
205
206/**
207 * Defines the options of Slider.
208 *
209 * @interface SliderOptions
210 * @syscap SystemCapability.ArkUI.ArkUI.Full
211 * @since 7
212 */
213/**
214 * Defines the options of Slider.
215 *
216 * @interface SliderOptions
217 * @syscap SystemCapability.ArkUI.ArkUI.Full
218 * @since 9
219 * @form
220 */
221/**
222 * Defines the options of Slider.
223 *
224 * @interface SliderOptions
225 * @syscap SystemCapability.ArkUI.ArkUI.Full
226 * @crossplatform
227 * @since 10
228 * @form
229 */
230declare interface SliderOptions {
231  /**
232   * Current value of Slider.
233   *
234   * @type { ?number }
235   * @syscap SystemCapability.ArkUI.ArkUI.Full
236   * @since 7
237   */
238  /**
239   * Current value of Slider.
240   *
241   * @type { ?number }
242   * @syscap SystemCapability.ArkUI.ArkUI.Full
243   * @since 9
244   * @form
245   */
246  /**
247   * Current value of Slider.
248   *
249   * @type { ?number }
250   * @syscap SystemCapability.ArkUI.ArkUI.Full
251   * @crossplatform
252   * @since 10
253   * @form
254   */
255  value?: number;
256
257  /**
258   * Sets the min value of Slider.
259   *
260   * @type { ?number }
261   * @syscap SystemCapability.ArkUI.ArkUI.Full
262   * @since 7
263   */
264  /**
265   * Sets the min value of Slider.
266   *
267   * @type { ?number }
268   * @syscap SystemCapability.ArkUI.ArkUI.Full
269   * @since 9
270   * @form
271   */
272  /**
273   * Sets the min value of Slider.
274   *
275   * @type { ?number }
276   * @syscap SystemCapability.ArkUI.ArkUI.Full
277   * @crossplatform
278   * @since 10
279   * @form
280   */
281  min?: number;
282
283  /**
284   * Sets the max value of Slider.
285   *
286   * @type { ?number }
287   * @syscap SystemCapability.ArkUI.ArkUI.Full
288   * @since 7
289   */
290  /**
291   * Sets the max value of Slider.
292   *
293   * @type { ?number }
294   * @syscap SystemCapability.ArkUI.ArkUI.Full
295   * @since 9
296   * @form
297   */
298  /**
299   * Sets the max value of Slider.
300   *
301   * @type { ?number }
302   * @syscap SystemCapability.ArkUI.ArkUI.Full
303   * @crossplatform
304   * @since 10
305   * @form
306   */
307  max?: number;
308
309  /**
310   * Sets the step of each slide value.
311   *
312   * @type { ?number }
313   * @syscap SystemCapability.ArkUI.ArkUI.Full
314   * @since 7
315   */
316  /**
317   * Sets the step of each slide value.
318   *
319   * @type { ?number }
320   * @syscap SystemCapability.ArkUI.ArkUI.Full
321   * @since 9
322   * @form
323   */
324  /**
325   * Sets the step of each slide value.
326   *
327   * @type { ?number }
328   * @syscap SystemCapability.ArkUI.ArkUI.Full
329   * @crossplatform
330   * @since 10
331   * @form
332   */
333  step?: number;
334
335  /**
336   * Sets the slider style.
337   *
338   * @type { ?SliderStyle }
339   * @syscap SystemCapability.ArkUI.ArkUI.Full
340   * @since 7
341   */
342  /**
343   * Sets the slider style.
344   *
345   * @type { ?SliderStyle }
346   * @syscap SystemCapability.ArkUI.ArkUI.Full
347   * @since 9
348   * @form
349   */
350  /**
351   * Sets the slider style.
352   *
353   * @type { ?SliderStyle }
354   * @syscap SystemCapability.ArkUI.ArkUI.Full
355   * @crossplatform
356   * @since 10
357   * @form
358   */
359  style?: SliderStyle;
360
361  /**
362   * Sets the slider direction style.
363   *
364   * @type { ?Axis }
365   * @syscap SystemCapability.ArkUI.ArkUI.Full
366   * @since 8
367   */
368  /**
369   * Sets the slider direction style.
370   *
371   * @type { ?Axis }
372   * @syscap SystemCapability.ArkUI.ArkUI.Full
373   * @since 9
374   * @form
375   */
376  /**
377   * Sets the slider direction style.
378   *
379   * @type { ?Axis }
380   * @syscap SystemCapability.ArkUI.ArkUI.Full
381   * @crossplatform
382   * @since 10
383   * @form
384   */
385  direction?: Axis;
386
387  /**
388   * Set whether the direction of the slider needs to be reversed.
389   *
390   * @type { ?boolean }
391   * @syscap SystemCapability.ArkUI.ArkUI.Full
392   * @since 8
393   */
394  /**
395   * Set whether the direction of the slider needs to be reversed.
396   *
397   * @type { ?boolean }
398   * @syscap SystemCapability.ArkUI.ArkUI.Full
399   * @since 9
400   * @form
401   */
402  /**
403   * Set whether the direction of the slider needs to be reversed.
404   *
405   * @type { ?boolean }
406   * @syscap SystemCapability.ArkUI.ArkUI.Full
407   * @crossplatform
408   * @since 10
409   * @form
410   */
411  reverse?: boolean;
412}
413
414/**
415 * Declare SliderBlockType
416 *
417 * @enum { number }
418 * @syscap SystemCapability.ArkUI.ArkUI.Full
419 * @crossplatform
420 * @since 10
421 */
422declare enum SliderBlockType {
423  /**
424   * Use the default block.
425   *
426   * @syscap SystemCapability.ArkUI.ArkUI.Full
427   * @crossplatform
428   * @since 10
429   */
430  DEFAULT,
431
432  /**
433   * Use an image as the slider block.
434   *
435   * @syscap SystemCapability.ArkUI.ArkUI.Full
436   * @crossplatform
437   * @since 10
438   */
439  IMAGE,
440
441  /**
442   * Use a shape as the slider block.
443   *
444   * @syscap SystemCapability.ArkUI.ArkUI.Full
445   * @crossplatform
446   * @since 10
447   */
448  SHAPE,
449}
450
451/**
452 * Defines the style of slider block.
453 *
454 * @interface SliderBlockStyle
455 * @syscap SystemCapability.ArkUI.ArkUI.Full
456 * @crossplatform
457 * @since 10
458 */
459declare interface SliderBlockStyle {
460  /**
461   * Sets the type of slider block.
462   *
463   * @type { SliderBlockType }
464   * @syscap SystemCapability.ArkUI.ArkUI.Full
465   * @crossplatform
466   * @since 10
467   */
468  type: SliderBlockType;
469
470  /**
471   * Sets the image of slider block while the type is set to SliderBlockType.Image.
472   *
473   * @type { ?ResourceStr }
474   * @syscap SystemCapability.ArkUI.ArkUI.Full
475   * @crossplatform
476   * @since 10
477   */
478  image?: ResourceStr;
479
480  /**
481   * Sets the shape of slider block while the type is set to SliderBlockType.Shape.
482   *
483   * @type { ?(CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute) }
484   * @syscap SystemCapability.ArkUI.ArkUI.Full
485   * @crossplatform
486   * @since 10
487   */
488  shape?: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute;
489}
490
491/**
492 * Provides an interface for the slide bar component.
493 *
494 * @interface SliderInterface
495 * @syscap SystemCapability.ArkUI.ArkUI.Full
496 * @since 7
497 */
498/**
499 * Provides an interface for the slide bar component.
500 *
501 * @interface SliderInterface
502 * @syscap SystemCapability.ArkUI.ArkUI.Full
503 * @since 9
504 * @form
505 */
506/**
507 * Provides an interface for the slide bar component.
508 *
509 * @interface SliderInterface
510 * @syscap SystemCapability.ArkUI.ArkUI.Full
511 * @crossplatform
512 * @since 10
513 * @form
514 */
515interface SliderInterface {
516  /**
517   * Called when the slider bar component is used.
518   *
519   * @param { SliderOptions } options
520   * @returns { SliderAttribute }
521   * @syscap SystemCapability.ArkUI.ArkUI.Full
522   * @since 7
523   */
524  /**
525   * Called when the slider bar component is used.
526   *
527   * @param { SliderOptions } options
528   * @returns { SliderAttribute }
529   * @syscap SystemCapability.ArkUI.ArkUI.Full
530   * @since 9
531   * @form
532   */
533  /**
534   * Called when the slider bar component is used.
535   *
536   * @param { SliderOptions } options
537   * @returns { SliderAttribute }
538   * @syscap SystemCapability.ArkUI.ArkUI.Full
539   * @crossplatform
540   * @since 10
541   * @form
542   */
543  (options?: SliderOptions): SliderAttribute;
544}
545
546/**
547 * Defines the attribute functions of Slider.
548 *
549 * @extends CommonMethod
550 * @syscap SystemCapability.ArkUI.ArkUI.Full
551 * @since 7
552 */
553/**
554 * Defines the attribute functions of Slider.
555 *
556 * @extends CommonMethod
557 * @syscap SystemCapability.ArkUI.ArkUI.Full
558 * @since 9
559 * @form
560 */
561/**
562 * Defines the attribute functions of Slider.
563 *
564 * @extends CommonMethod
565 * @syscap SystemCapability.ArkUI.ArkUI.Full
566 * @crossplatform
567 * @since 10
568 * @form
569 */
570declare class SliderAttribute extends CommonMethod<SliderAttribute> {
571  /**
572   * Called when the slider color of the slider bar is set.
573   *
574   * @param { ResourceColor } value
575   * @returns { SliderAttribute }
576   * @syscap SystemCapability.ArkUI.ArkUI.Full
577   * @since 7
578   */
579  /**
580   * Called when the slider color of the slider bar is set.
581   *
582   * @param { ResourceColor } value
583   * @returns { SliderAttribute }
584   * @syscap SystemCapability.ArkUI.ArkUI.Full
585   * @since 9
586   * @form
587   */
588  /**
589   * Called when the slider color of the slider bar is set.
590   *
591   * @param { ResourceColor } value
592   * @returns { SliderAttribute }
593   * @syscap SystemCapability.ArkUI.ArkUI.Full
594   * @crossplatform
595   * @since 10
596   * @form
597   */
598  blockColor(value: ResourceColor): SliderAttribute;
599
600  /**
601   * Called when the track color of the slider is set.
602   *
603   * @param { ResourceColor } value
604   * @returns { SliderAttribute }
605   * @syscap SystemCapability.ArkUI.ArkUI.Full
606   * @since 7
607   */
608  /**
609   * Called when the track color of the slider is set.
610   *
611   * @param { ResourceColor } value
612   * @returns { SliderAttribute }
613   * @syscap SystemCapability.ArkUI.ArkUI.Full
614   * @since 9
615   * @form
616   */
617  /**
618   * Called when the track color of the slider is set.
619   *
620   * @param { ResourceColor } value
621   * @returns { SliderAttribute }
622   * @syscap SystemCapability.ArkUI.ArkUI.Full
623   * @crossplatform
624   * @since 10
625   * @form
626   */
627  trackColor(value: ResourceColor): SliderAttribute;
628
629  /**
630   * Called when the slider of the slider bar is set to slide over the area color.
631   *
632   * @param { ResourceColor } value
633   * @returns { SliderAttribute }
634   * @syscap SystemCapability.ArkUI.ArkUI.Full
635   * @since 7
636   */
637  /**
638   * Called when the slider of the slider bar is set to slide over the area color.
639   *
640   * @param { ResourceColor } value
641   * @returns { SliderAttribute }
642   * @syscap SystemCapability.ArkUI.ArkUI.Full
643   * @since 9
644   * @form
645   */
646  /**
647   * Called when the slider of the slider bar is set to slide over the area color.
648   *
649   * @param { ResourceColor } value
650   * @returns { SliderAttribute }
651   * @syscap SystemCapability.ArkUI.ArkUI.Full
652   * @crossplatform
653   * @since 10
654   * @form
655   */
656  selectedColor(value: ResourceColor): SliderAttribute;
657
658  /**
659   * Called when the minimum label is set.
660   *
661   * @param { string } value
662   * @returns { SliderAttribute }
663   * @syscap SystemCapability.ArkUI.ArkUI.Full
664   * @since 7
665   * @deprecated since 9
666   * @useinstead min
667   */
668  minLabel(value: string): SliderAttribute;
669
670  /**
671   * Called when the maximum label is set.
672   *
673   * @param { string } value
674   * @returns { SliderAttribute }
675   * @syscap SystemCapability.ArkUI.ArkUI.Full
676   * @since 7
677   * @deprecated since 9
678   * @useinstead max
679   */
680  maxLabel(value: string): SliderAttribute;
681
682  /**
683   * Called when setting whether to display step size.
684   *
685   * @param { boolean } value
686   * @returns { SliderAttribute }
687   * @syscap SystemCapability.ArkUI.ArkUI.Full
688   * @since 7
689   */
690  /**
691   * Called when setting whether to display step size.
692   *
693   * @param { boolean } value
694   * @returns { SliderAttribute }
695   * @syscap SystemCapability.ArkUI.ArkUI.Full
696   * @since 9
697   * @form
698   */
699  /**
700   * Called when setting whether to display step size.
701   *
702   * @param { boolean } value
703   * @returns { SliderAttribute }
704   * @syscap SystemCapability.ArkUI.ArkUI.Full
705   * @crossplatform
706   * @since 10
707   * @form
708   */
709  showSteps(value: boolean): SliderAttribute;
710
711  /**
712   * Called when the percentage of bubble prompt is set when sliding.
713   *
714   * @param { boolean } value
715   * @param { ResourceStr } content
716   * @returns { SliderAttribute }
717   * @syscap SystemCapability.ArkUI.ArkUI.Full
718   * @since 7
719   */
720  /**
721   * Called when the percentage of bubble prompt is set when sliding.
722   *
723   * @param { boolean } value
724   * @param { ResourceStr } content
725   * @returns { SliderAttribute }
726   * @syscap SystemCapability.ArkUI.ArkUI.Full
727   * @since 9
728   * @form
729   */
730  /**
731   * Called when the percentage of bubble prompt is set when sliding.
732   *
733   * @param { boolean } value - Whether to display the bubble.
734   * @param { ResourceStr } content - Text content in the bubble. If the content is not specified, the current
735   *                                  percentage is displayed by default.
736   * @returns { SliderAttribute }
737   * @syscap SystemCapability.ArkUI.ArkUI.Full
738   * @crossplatform
739   * @since 10
740   * @form
741   */
742  showTips(value: boolean, content?: ResourceStr): SliderAttribute;
743
744  /**
745   * Called when the thickness of track is set.
746   *
747   * @param { Length } value
748   * @returns { SliderAttribute }
749   * @syscap SystemCapability.ArkUI.ArkUI.Full
750   * @since 8
751   */
752  /**
753   * Called when the thickness of track is set.
754   *
755   * @param { Length } value
756   * @returns { SliderAttribute }
757   * @syscap SystemCapability.ArkUI.ArkUI.Full
758   * @since 9
759   * @form
760   */
761  /**
762   * Called when the thickness of track is set.
763   *
764   * @param { Length } value
765   * @returns { SliderAttribute }
766   * @syscap SystemCapability.ArkUI.ArkUI.Full
767   * @crossplatform
768   * @since 10
769   * @form
770   */
771  trackThickness(value: Length): SliderAttribute;
772
773  /**
774   * Called when the selection value changes.
775   *
776   * @param { function } callback
777   * @returns { SliderAttribute }
778   * @syscap SystemCapability.ArkUI.ArkUI.Full
779   * @since 7
780   */
781  /**
782   * Called when the selection value changes.
783   *
784   * @param { function } callback
785   * @returns { SliderAttribute }
786   * @syscap SystemCapability.ArkUI.ArkUI.Full
787   * @since 9
788   * @form
789   */
790  /**
791   * Called when the selection value changes.
792   *
793   * @param { function } callback
794   * @returns { SliderAttribute }
795   * @syscap SystemCapability.ArkUI.ArkUI.Full
796   * @crossplatform
797   * @since 10
798   * @form
799   */
800  onChange(callback: (value: number, mode: SliderChangeMode) => void): SliderAttribute;
801
802  /**
803   * Called when the border color of block is set.
804   *
805   * @param { ResourceColor } value - the border color of block.
806   * @returns { SliderAttribute }
807   * @syscap SystemCapability.ArkUI.ArkUI.Full
808   * @crossplatform
809   * @since 10
810   */
811  blockBorderColor(value: ResourceColor): SliderAttribute;
812
813  /**
814   * Called when the border width of block is set.
815   *
816   * @param { Length } value - the border width of block.
817   * @returns { SliderAttribute }
818   * @syscap SystemCapability.ArkUI.ArkUI.Full
819   * @crossplatform
820   * @since 10
821   */
822  blockBorderWidth(value: Length): SliderAttribute;
823
824  /**
825   * Called when the color of step is set.
826   *
827   * @param { ResourceColor } value - the color of step.
828   * @returns { SliderAttribute }
829   * @syscap SystemCapability.ArkUI.ArkUI.Full
830   * @crossplatform
831   * @since 10
832   */
833  stepColor(value: ResourceColor): SliderAttribute;
834
835  /**
836   * Called when the radius of track border is set.
837   *
838   * @param { Length } value - the radius of track border.
839   * @returns { SliderAttribute }
840   * @syscap SystemCapability.ArkUI.ArkUI.Full
841   * @crossplatform
842   * @since 10
843   */
844  trackBorderRadius(value: Length): SliderAttribute;
845
846  /**
847   * Called when the size of block is set.
848   *
849   * @param { SizeOptions } value - the size of block.
850   * @returns { SliderAttribute }
851   * @syscap SystemCapability.ArkUI.ArkUI.Full
852   * @crossplatform
853   * @since 10
854   */
855  blockSize(value: SizeOptions): SliderAttribute;
856
857  /**
858   * Called when the style of block is set.
859   *
860   * @param { SliderBlockStyle } value - the style of block.
861   * @returns { SliderAttribute }
862   * @syscap SystemCapability.ArkUI.ArkUI.Full
863   * @crossplatform
864   * @since 10
865   */
866  blockStyle(value: SliderBlockStyle): SliderAttribute;
867
868  /**
869   * Called when the diameter of step is set.
870   *
871   * @param { Length } value - the diameter of step.
872   * @returns { SliderAttribute }
873   * @syscap SystemCapability.ArkUI.ArkUI.Full
874   * @crossplatform
875   * @since 10
876   */
877  stepSize(value: Length): SliderAttribute;
878}
879
880/**
881 * Defines Slider Component.
882 *
883 * @syscap SystemCapability.ArkUI.ArkUI.Full
884 * @since 7
885 */
886/**
887 * Defines Slider Component.
888 *
889 * @syscap SystemCapability.ArkUI.ArkUI.Full
890 * @since 9
891 * @form
892 */
893/**
894 * Defines Slider Component.
895 *
896 * @syscap SystemCapability.ArkUI.ArkUI.Full
897 * @crossplatform
898 * @since 10
899 * @form
900 */
901declare const Slider: SliderInterface;
902
903/**
904 * Defines Slider Component instance.
905 *
906 * @syscap SystemCapability.ArkUI.ArkUI.Full
907 * @since 7
908 */
909/**
910 * Defines Slider Component instance.
911 *
912 * @syscap SystemCapability.ArkUI.ArkUI.Full
913 * @since 9
914 * @form
915 */
916/**
917 * Defines Slider Component instance.
918 *
919 * @syscap SystemCapability.ArkUI.ArkUI.Full
920 * @crossplatform
921 * @since 10
922 * @form
923 */
924declare const SliderInstance: SliderAttribute;
925