• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2025 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 } from './common';
23import { CustomBuilder } from './builder'
24import { Length } from './units';
25import { ComponentContent } from '../ComponentContent'
26/*** endif */
27
28/**
29 * Declare item ceiling attribute.
30 *
31 * @enum { number }
32 * @syscap SystemCapability.ArkUI.ArkUI.Full
33 * @since 7
34 * @deprecated since 9
35 * @useinstead list/StickyStyle
36 */
37declare enum Sticky {
38  /**
39   * No sticky.
40   *
41   * @syscap SystemCapability.ArkUI.ArkUI.Full
42   * @since 7
43   * @deprecated since 9
44   */
45  None,
46
47  /**
48   * Normal mode
49   *
50   * @syscap SystemCapability.ArkUI.ArkUI.Full
51   * @since 7
52   * @deprecated since 9
53   */
54  Normal,
55
56  /**
57   * Set opacity.
58   *
59   * @syscap SystemCapability.ArkUI.ArkUI.Full
60   * @since 7
61   * @deprecated since 9
62   */
63  Opacity,
64}
65
66/**
67 * Declare whether the ListItem element is editable.
68 *
69 * @enum { number }
70 * @syscap SystemCapability.ArkUI.ArkUI.Full
71 * @since 7
72 * @deprecated since 9
73 */
74declare enum EditMode {
75  /**
76   * Unrestricted operations.
77   *
78   * @syscap SystemCapability.ArkUI.ArkUI.Full
79   * @since 7
80   * @deprecated since 9
81   */
82  None,
83
84  /**
85   * Deletable.
86   *
87   * @syscap SystemCapability.ArkUI.ArkUI.Full
88   * @since 7
89   * @deprecated since 9
90   */
91  Deletable,
92
93  /**
94   * Movable.
95   *
96   * @syscap SystemCapability.ArkUI.ArkUI.Full
97   * @since 7
98   * @deprecated since 9
99   */
100  Movable,
101}
102
103/**
104 * Sliding effect
105 *
106 * @enum { number }
107 * @syscap SystemCapability.ArkUI.ArkUI.Full
108 * @since 9
109 */
110/**
111 * Sliding effect
112 *
113 * @enum { number }
114 * @syscap SystemCapability.ArkUI.ArkUI.Full
115 * @crossplatform
116 * @since 10
117 */
118/**
119 * Sliding effect
120 *
121 * @enum { number }
122 * @syscap SystemCapability.ArkUI.ArkUI.Full
123 * @crossplatform
124 * @atomicservice
125 * @since arkts {'1.1':'11','1.2':'20'}
126 * @arkts 1.1&1.2
127 */
128declare enum SwipeEdgeEffect {
129  /**
130   * Elastic physical action, sliding to the edge can continue to slide for a distance based on the initial speed or touch event, and spring back when released.
131   *
132   * @syscap SystemCapability.ArkUI.ArkUI.Full
133   * @since 9
134   */
135  /**
136   * Elastic physical action, sliding to the edge can continue to slide for a distance based on the initial speed or touch event, and spring back when released.
137   *
138   * @syscap SystemCapability.ArkUI.ArkUI.Full
139   * @crossplatform
140   * @since 10
141   */
142  /**
143   * Elastic physical action, sliding to the edge can continue to slide for a distance based on the initial speed or touch event, and spring back when released.
144   *
145   * @syscap SystemCapability.ArkUI.ArkUI.Full
146   * @crossplatform
147   * @atomicservice
148   * @since arkts {'1.1':'11','1.2':'20'}
149   * @arkts 1.1&1.2
150   */
151  Spring,
152
153  /**
154   * Sliding to the edge has no effect.
155   *
156   * @syscap SystemCapability.ArkUI.ArkUI.Full
157   * @since 9
158   */
159  /**
160   * Sliding to the edge has no effect.
161   *
162   * @syscap SystemCapability.ArkUI.ArkUI.Full
163   * @crossplatform
164   * @since 10
165   */
166  /**
167   * Sliding to the edge has no effect.
168   *
169   * @syscap SystemCapability.ArkUI.ArkUI.Full
170   * @crossplatform
171   * @atomicservice
172   * @since arkts {'1.1':'11','1.2':'20'}
173   * @arkts 1.1&1.2
174   */
175  None,
176}
177
178/**
179 * Declare enum SwipeActionState.
180 *
181 * @enum { number }
182 * @syscap SystemCapability.ArkUI.ArkUI.Full
183 * @crossplatform
184 * @since 11
185 */
186/**
187 * Declare enum SwipeActionState.
188 *
189 * @enum { number }
190 * @syscap SystemCapability.ArkUI.ArkUI.Full
191 * @crossplatform
192 * @atomicservice
193 * @since arkts {'1.1':'12','1.2':'20'}
194 * @arkts 1.1&1.2
195 */
196declare enum SwipeActionState {
197  /**
198   * Collapsed type.
199   *
200   * @syscap SystemCapability.ArkUI.ArkUI.Full
201   * @since 11
202   */
203  /**
204   * Collapsed type.
205   *
206   * @syscap SystemCapability.ArkUI.ArkUI.Full
207   * @atomicservice
208   * @since arkts {'1.1':'12','1.2':'20'}
209   * @arkts 1.1&1.2
210   */
211  COLLAPSED,
212
213  /**
214   * EXPANDED type.
215   *
216   * @syscap SystemCapability.ArkUI.ArkUI.Full
217   * @since 11
218   */
219  /**
220   * EXPANDED type.
221   *
222   * @syscap SystemCapability.ArkUI.ArkUI.Full
223   * @atomicservice
224   * @since arkts {'1.1':'12','1.2':'20'}
225   * @arkts 1.1&1.2
226   */
227  EXPANDED,
228
229  /**
230   * Action type.
231   *
232   * @syscap SystemCapability.ArkUI.ArkUI.Full
233   * @since 11
234   */
235  /**
236   * Action type.
237   *
238   * @syscap SystemCapability.ArkUI.ArkUI.Full
239   * @atomicservice
240   * @since arkts {'1.1':'12','1.2':'20'}
241   * @arkts 1.1&1.2
242   */
243  ACTIONING,
244}
245
246/**
247 * Defines the swipe action item for SwipeActionOptions.
248 *
249 * @interface SwipeActionItem
250 * @syscap SystemCapability.ArkUI.ArkUI.Full
251 * @since 10
252 */
253/**
254 * Defines the swipe action item for SwipeActionOptions.
255 *
256 * @interface SwipeActionItem
257 * @syscap SystemCapability.ArkUI.ArkUI.Full
258 * @crossplatform
259 * @atomicservice
260 * @since arkts {'1.1':'11','1.2':'20'}
261 * @arkts 1.1&1.2
262 */
263declare interface SwipeActionItem {
264  /**
265   * An action item that appears when a list item slides right (when list direction is Vertical) or
266   * slides down (when list direction Horizontal).
267   *
268   * @type { ?CustomBuilder }
269   * @syscap SystemCapability.ArkUI.ArkUI.Full
270   * @since 10
271   */
272  /**
273   * An action item that appears when a list item slides right (when list direction is Vertical) or
274   * slides down (when list direction Horizontal).
275   *
276   * @type { ?CustomBuilder }
277   * @syscap SystemCapability.ArkUI.ArkUI.Full
278   * @crossplatform
279   * @atomicservice
280   * @since arkts {'1.1':'11','1.2':'20'}
281   * @arkts 1.1&1.2
282   */
283  builder?: CustomBuilder;
284
285  /**
286    * An action item that appears when a list item slides right (when list direction is Vertical) or
287    * slides down (when list direction Horizontal).
288    *
289    * @type { ?ComponentContent }
290    * @syscap SystemCapability.ArkUI.ArkUI.Full
291    * @crossplatform
292    * @atomicservice
293    * @since arkts {'1.1':'18','1.2':'20'}
294    * @arkts 1.1&1.2
295    */
296  builderComponent?: ComponentContent;
297
298  /**
299   * Defines distance for the delete area.
300   *
301   * @type { ?Length }
302   * @default 56vp
303   * @syscap SystemCapability.ArkUI.ArkUI.Full
304   * @since 10
305   */
306  /**
307   * Defines distance for the delete area.
308   *
309   * @type { ?Length }
310   * @default 56vp
311   * @syscap SystemCapability.ArkUI.ArkUI.Full
312   * @crossplatform
313   * @atomicservice
314   * @since arkts {'1.1':'11','1.2':'20'}
315   * @arkts 1.1&1.2
316   */
317  actionAreaDistance?: Length;
318
319  /**
320   * Called when ListItem need to be deleted.
321   *
322   * @type { ?function }
323   * @syscap SystemCapability.ArkUI.ArkUI.Full
324   * @since 10
325   */
326  /**
327   * Called when ListItem need to be deleted.
328   *
329   * @type { ?function }
330   * @syscap SystemCapability.ArkUI.ArkUI.Full
331   * @crossplatform
332   * @atomicservice
333   * @since arkts {'1.1':'11','1.2':'20'}
334   * @arkts 1.1&1.2
335   */
336  onAction?: () => void;
337
338  /**
339   * Called when swipe entry delete area.
340   *
341   * @type { ?function }
342   * @syscap SystemCapability.ArkUI.ArkUI.Full
343   * @since 10
344   */
345  /**
346   * Called when swipe entry delete area.
347   *
348   * @type { ?function }
349   * @syscap SystemCapability.ArkUI.ArkUI.Full
350   * @crossplatform
351   * @atomicservice
352   * @since arkts {'1.1':'11','1.2':'20'}
353   * @arkts 1.1&1.2
354   */
355  onEnterActionArea?: () => void;
356
357  /**
358   * Called when swipe exit delete area.
359   *
360   * @type { ?function }
361   * @syscap SystemCapability.ArkUI.ArkUI.Full
362   * @since 10
363   */
364  /**
365   * Called when swipe exit delete area.
366   *
367   * @type { ?function }
368   * @syscap SystemCapability.ArkUI.ArkUI.Full
369   * @crossplatform
370   * @atomicservice
371   * @since arkts {'1.1':'11','1.2':'20'}
372   * @arkts 1.1&1.2
373   */
374  onExitActionArea?: () => void;
375
376  /**
377   * Called when component swipe action state changed.
378   *
379   * @type { ?function }
380   * @syscap SystemCapability.ArkUI.ArkUI.Full
381   * @crossplatform
382   * @since 11
383   */
384  /**
385   * Called when component swipe action state changed.
386   *
387   * @type { ?function }
388   * @syscap SystemCapability.ArkUI.ArkUI.Full
389   * @crossplatform
390   * @atomicservice
391   * @since arkts {'1.1':'12','1.2':'20'}
392   * @arkts 1.1&1.2
393   */
394  onStateChange?: (state: SwipeActionState) => void;
395}
396
397/**
398 * Defines the SwipeActionOption of swipeAction attribute method.
399 *
400 * @interface SwipeActionOptions
401 * @syscap SystemCapability.ArkUI.ArkUI.Full
402 * @since 9
403 */
404/**
405 * Defines the SwipeActionOption of swipeAction attribute method.
406 *
407 * @interface SwipeActionOptions
408 * @syscap SystemCapability.ArkUI.ArkUI.Full
409 * @crossplatform
410 * @since 10
411 */
412/**
413 * Defines the SwipeActionOption of swipeAction attribute method.
414 *
415 * @interface SwipeActionOptions
416 * @syscap SystemCapability.ArkUI.ArkUI.Full
417 * @crossplatform
418 * @atomicservice
419 * @since arkts {'1.1':'11','1.2':'20'}
420 * @arkts 1.1&1.2
421 */
422declare interface SwipeActionOptions {
423  /**
424   * An action item that appears when a list item slides right (when list direction is Vertical) or
425   * slides down (when list direction Horizontal).
426   *
427   * @type { ?(CustomBuilder | SwipeActionItem) }
428   * @syscap SystemCapability.ArkUI.ArkUI.Full
429   * @since 9
430   */
431  /**
432   * An action item that appears when a list item slides right (when list direction is Vertical) or
433   * slides down (when list direction Horizontal).
434   *
435   * @type { ?(CustomBuilder | SwipeActionItem) }
436   * @syscap SystemCapability.ArkUI.ArkUI.Full
437   * @crossplatform
438   * @since 10
439   */
440  /**
441   * An action item that appears when a list item slides right (when list direction is Vertical) or
442   * slides down (when list direction Horizontal).
443   *
444   * @type { ?(CustomBuilder | SwipeActionItem) }
445   * @syscap SystemCapability.ArkUI.ArkUI.Full
446   * @crossplatform
447   * @atomicservice
448   * @since arkts {'1.1':'11','1.2':'20'}
449   * @arkts 1.1&1.2
450   */
451  start?: CustomBuilder | SwipeActionItem;
452
453  /**
454   * An action item that appears when a list item slides left (when list direction is Vertical) or
455   * slides up (when list direction Horizontal).
456   *
457   * @type { ?(CustomBuilder | SwipeActionItem) }
458   * @syscap SystemCapability.ArkUI.ArkUI.Full
459   * @since 9
460   */
461  /**
462   * An action item that appears when a list item slides left (when list direction is Vertical) or
463   * slides up (when list direction Horizontal).
464   *
465   * @type { ?(CustomBuilder | SwipeActionItem) }
466   * @syscap SystemCapability.ArkUI.ArkUI.Full
467   * @crossplatform
468   * @since 10
469   */
470  /**
471   * An action item that appears when a list item slides left (when list direction is Vertical) or
472   * slides up (when list direction Horizontal).
473   *
474   * @type { ?(CustomBuilder | SwipeActionItem) }
475   * @syscap SystemCapability.ArkUI.ArkUI.Full
476   * @crossplatform
477   * @atomicservice
478   * @since arkts {'1.1':'11','1.2':'20'}
479   * @arkts 1.1&1.2
480   */
481  end?: CustomBuilder | SwipeActionItem;
482
483  /**
484   * Sets whether sliding to a boundary has a spring effect.
485   *
486   * @type { ?SwipeEdgeEffect }
487   * @syscap SystemCapability.ArkUI.ArkUI.Full
488   * @since 9
489   */
490  /**
491   * Sets whether sliding to a boundary has a spring effect.
492   *
493   * @type { ?SwipeEdgeEffect }
494   * @syscap SystemCapability.ArkUI.ArkUI.Full
495   * @crossplatform
496   * @since 10
497   */
498  /**
499   * Sets whether sliding to a boundary has a spring effect.
500   *
501   * @type { ?SwipeEdgeEffect }
502   * @syscap SystemCapability.ArkUI.ArkUI.Full
503   * @crossplatform
504   * @atomicservice
505   * @since arkts {'1.1':'11','1.2':'20'}
506   * @arkts 1.1&1.2
507   */
508  edgeEffect?: SwipeEdgeEffect;
509
510  /**
511   * Called when swipe action offset changed.
512   *
513   * @type { ?function }
514   * @syscap SystemCapability.ArkUI.ArkUI.Full
515   * @crossplatform
516   * @since 11
517   */
518  /**
519   * Called when swipe action offset changed.
520   *
521   * @type { ?function }
522   * @syscap SystemCapability.ArkUI.ArkUI.Full
523   * @crossplatform
524   * @atomicservice
525   * @since arkts {'1.1':'12','1.2':'20'}
526   * @arkts 1.1&1.2
527   */
528  onOffsetChange?: (offset: number) => void;
529}
530
531/**
532 * Defines the list item style.
533 *
534 * @enum { number }
535 * @syscap SystemCapability.ArkUI.ArkUI.Full
536 * @since 10
537 */
538/**
539 * Defines the list item style.
540 *
541 * @enum { number }
542 * @syscap SystemCapability.ArkUI.ArkUI.Full
543 * @crossplatform
544 * @atomicservice
545 * @since arkts {'1.1':'11','1.2':'20'}
546 * @arkts 1.1&1.2
547 */
548declare enum ListItemStyle {
549  /**
550   * Show custom style.
551   *
552   * @syscap SystemCapability.ArkUI.ArkUI.Full
553   * @since 10
554   */
555  /**
556   * Show custom style.
557   *
558   * @syscap SystemCapability.ArkUI.ArkUI.Full
559   * @crossplatform
560   * @atomicservice
561   * @since arkts {'1.1':'11','1.2':'20'}
562   * @arkts 1.1&1.2
563   */
564  NONE = 0,
565
566  /**
567   * Show default style.
568   *
569   * @syscap SystemCapability.ArkUI.ArkUI.Full
570   * @since 10
571   */
572  /**
573   * Show default style.
574   *
575   * @syscap SystemCapability.ArkUI.ArkUI.Full
576   * @crossplatform
577   * @atomicservice
578   * @since arkts {'1.1':'11','1.2':'20'}
579   * @arkts 1.1&1.2
580   */
581  CARD = 1,
582}
583
584/**
585 * Defines the list item options.
586 *
587 * @interface ListItemOptions
588 * @syscap SystemCapability.ArkUI.ArkUI.Full
589 * @since 10
590 */
591/**
592 * Defines the list item options.
593 *
594 * @interface ListItemOptions
595 * @syscap SystemCapability.ArkUI.ArkUI.Full
596 * @crossplatform
597 * @atomicservice
598 * @since arkts {'1.1':'11','1.2':'20'}
599 * @arkts 1.1&1.2
600 */
601declare interface ListItemOptions {
602  /**
603   * Describes the ListItem style.
604   *
605   * @type { ?ListItemStyle }
606   * @syscap SystemCapability.ArkUI.ArkUI.Full
607   * @since 10
608   */
609  /**
610   * Describes the ListItem style.
611   *
612   * @type { ?ListItemStyle }
613   * @syscap SystemCapability.ArkUI.ArkUI.Full
614   * @crossplatform
615   * @atomicservice
616   * @since arkts {'1.1':'11','1.2':'20'}
617   * @arkts 1.1&1.2
618   */
619  style?: ListItemStyle;
620}
621
622/**
623 * Values in the list
624 *
625 * @interface ListItemInterface
626 * @syscap SystemCapability.ArkUI.ArkUI.Full
627 * @since 7
628 */
629/**
630 * Values in the list
631 *
632 * @interface ListItemInterface
633 * @syscap SystemCapability.ArkUI.ArkUI.Full
634 * @form
635 * @since 9
636 */
637/**
638 * Values in the list
639 *
640 * @interface ListItemInterface
641 * @syscap SystemCapability.ArkUI.ArkUI.Full
642 * @crossplatform
643 * @form
644 * @since 10
645 */
646/**
647 * Values in the list
648 *
649 * @interface ListItemInterface
650 * @syscap SystemCapability.ArkUI.ArkUI.Full
651 * @crossplatform
652 * @form
653 * @atomicservice
654 * @since arkts {'1.1':'11','1.2':'20'}
655 * @arkts 1.1&1.2
656 */
657interface ListItemInterface {
658  /**
659   * Called when an interface is used.
660   *
661   * @param { ListItemOptions } value
662   * @returns { ListItemAttribute }
663   * @syscap SystemCapability.ArkUI.ArkUI.Full
664   * @crossplatform
665   * @form
666   * @since 10
667   */
668  /**
669   * Called when an interface is used.
670   *
671   * @param { ListItemOptions } value
672   * @returns { ListItemAttribute }
673   * @syscap SystemCapability.ArkUI.ArkUI.Full
674   * @crossplatform
675   * @form
676   * @atomicservice
677   * @since arkts {'1.1':'11','1.2':'20'}
678   * @arkts 1.1&1.2
679   */
680  (value?: ListItemOptions): ListItemAttribute;
681
682  /**
683   * Called when an interface is used.
684   *
685   * @param { string } value
686   * @returns { ListItemAttribute }
687   * @syscap SystemCapability.ArkUI.ArkUI.Full
688   * @since 7
689   */
690  /**
691   * Called when an interface is used.
692   *
693   * @param { string } value
694   * @returns { ListItemAttribute }
695   * @syscap SystemCapability.ArkUI.ArkUI.Full
696   * @form
697   * @since 9
698   * @deprecated since 10
699   * @useinstead listItem/ListItemInterface
700   */
701  (value?: string): ListItemAttribute;
702}
703
704/**
705 * @extends CommonMethod<ListItemAttribute>
706 * @syscap SystemCapability.ArkUI.ArkUI.Full
707 * @since 7
708 */
709/**
710 * @extends CommonMethod<ListItemAttribute>
711 * @syscap SystemCapability.ArkUI.ArkUI.Full
712 * @form
713 * @since 9
714 */
715/**
716 * @extends CommonMethod<ListItemAttribute>
717 * @syscap SystemCapability.ArkUI.ArkUI.Full
718 * @crossplatform
719 * @form
720 * @since 10
721 */
722/**
723 * @extends CommonMethod<ListItemAttribute>
724 * @syscap SystemCapability.ArkUI.ArkUI.Full
725 * @crossplatform
726 * @form
727 * @atomicservice
728 * @since arkts {'1.1':'11','1.2':'20'}
729 * @arkts 1.1&1.2
730 */
731declare class ListItemAttribute extends CommonMethod<ListItemAttribute> {
732  /**
733   * Called when setting whether item is ceiling effect.
734   *
735   * @param { Sticky } value
736   * @returns { ListItemAttribute }
737   * @syscap SystemCapability.ArkUI.ArkUI.Full
738   * @since 7
739   * @deprecated since 9
740   * @useinstead list/List#sticky
741   */
742  sticky(value: Sticky): ListItemAttribute;
743
744  /**
745   * Called when judging whether it is editable.
746   *
747   * @param { boolean | EditMode } value
748   * @returns { ListItemAttribute }
749   * @syscap SystemCapability.ArkUI.ArkUI.Full
750   * @since 7
751   * @deprecated since 9
752   */
753  editable(value: boolean | EditMode): ListItemAttribute;
754
755  /**
756   * Called when judging whether it is selectable.
757   *
758   * @param { boolean } value
759   * @returns { ListItemAttribute }
760   * @syscap SystemCapability.ArkUI.ArkUI.Full
761   * @since 8
762   */
763  /**
764   * Called when judging whether it is selectable.
765   *
766   * @param { boolean } value
767   * @returns { ListItemAttribute }
768   * @syscap SystemCapability.ArkUI.ArkUI.Full
769   * @form
770   * @since 9
771   */
772  /**
773   * Called when judging whether it is selectable.
774   *
775   * @param { boolean } value
776   * @returns { ListItemAttribute }
777   * @syscap SystemCapability.ArkUI.ArkUI.Full
778   * @crossplatform
779   * @form
780   * @since 10
781   */
782  /**
783   * Called when judging whether it is selectable.
784   *
785   * @param { boolean } value
786   * @returns { ListItemAttribute }
787   * @syscap SystemCapability.ArkUI.ArkUI.Full
788   * @crossplatform
789   * @form
790   * @atomicservice
791   * @since arkts {'1.1':'11','1.2':'20'}
792   * @arkts 1.1&1.2
793   */
794  selectable(value: boolean): ListItemAttribute;
795
796  /**
797   * Called when judging whether it is selected.
798   * This parameter supports $$ for two-way binding of variables.
799   *
800   * @param { boolean } value - if the listItem is selected.
801   * @returns { ListItemAttribute } the attribute of the listItem.
802   * @syscap SystemCapability.ArkUI.ArkUI.Full
803   * @crossplatform
804   * @form
805   * @since 10
806   */
807  /**
808   * Called when judging whether it is selected.
809   * This parameter supports $$ for two-way binding of variables.
810   *
811   * @param { boolean } value - if the listItem is selected.
812   * @returns { ListItemAttribute } the attribute of the listItem.
813   * @syscap SystemCapability.ArkUI.ArkUI.Full
814   * @crossplatform
815   * @form
816   * @atomicservice
817   * @since arkts {'1.1':'11','1.2':'20'}
818   * @arkts 1.1&1.2
819   */
820  selected(value: boolean): ListItemAttribute;
821
822  /**
823   * Sets the action item that appears when the list item slides in the cross axis direction of the list.
824   *
825   * @param { SwipeActionOptions } value - items defines in the SwipeActionOption.
826   * @returns { ListItemAttribute }
827   * @syscap SystemCapability.ArkUI.ArkUI.Full
828   * @since 9
829   */
830  /**
831   * Sets the action item that appears when the list item slides in the cross axis direction of the list.
832   *
833   * @param { SwipeActionOptions } value - items defines in the SwipeActionOption.
834   * @returns { ListItemAttribute }
835   * @syscap SystemCapability.ArkUI.ArkUI.Full
836   * @crossplatform
837   * @since 10
838   */
839  /**
840   * Sets the action item that appears when the list item slides in the cross axis direction of the list.
841   *
842   * @param { SwipeActionOptions } value - items defines in the SwipeActionOption.
843   * @returns { ListItemAttribute }
844   * @syscap SystemCapability.ArkUI.ArkUI.Full
845   * @crossplatform
846   * @atomicservice
847   * @since arkts {'1.1':'11','1.2':'20'}
848   * @arkts 1.1&1.2
849   */
850  swipeAction(value: SwipeActionOptions): ListItemAttribute;
851
852  /**
853   * Called when the listItem is selected.
854   *
855   * @param { function } event
856   * @returns { ListItemAttribute }
857   * @syscap SystemCapability.ArkUI.ArkUI.Full
858   * @since 8
859   */
860  /**
861   * Called when the listItem is selected.
862   *
863   * @param { function } event
864   * @returns { ListItemAttribute }
865   * @syscap SystemCapability.ArkUI.ArkUI.Full
866   * @form
867   * @since 9
868   */
869  /**
870   * Called when the listItem is selected.
871   *
872   * @param { function } event
873   * @returns { ListItemAttribute }
874   * @syscap SystemCapability.ArkUI.ArkUI.Full
875   * @crossplatform
876   * @form
877   * @since 10
878   */
879  /**
880   * Called when the listItem is selected.
881   *
882   * @param { function } event
883   * @returns { ListItemAttribute }
884   * @syscap SystemCapability.ArkUI.ArkUI.Full
885   * @crossplatform
886   * @form
887   * @atomicservice
888   * @since arkts {'1.1':'11','1.2':'20'}
889   * @arkts 1.1&1.2
890   */
891  onSelect(event: (isSelected: boolean) => void): ListItemAttribute;
892}
893
894/**
895 * Defines ListItem Component instance.
896 *
897 * @syscap SystemCapability.ArkUI.ArkUI.Full
898 * @since 7
899 */
900/**
901 * Defines ListItem Component instance.
902 *
903 * @syscap SystemCapability.ArkUI.ArkUI.Full
904 * @form
905 * @since 9
906 */
907/**
908 * Defines ListItem Component instance.
909 *
910 * @syscap SystemCapability.ArkUI.ArkUI.Full
911 * @crossplatform
912 * @form
913 * @since 10
914 */
915/**
916 * Defines ListItem Component instance.
917 *
918 * @syscap SystemCapability.ArkUI.ArkUI.Full
919 * @crossplatform
920 * @form
921 * @atomicservice
922 * @since 11
923 */
924declare const ListItemInstance: ListItemAttribute;
925
926/**
927 * Defines ListItem Component.
928 *
929 * @syscap SystemCapability.ArkUI.ArkUI.Full
930 * @since 7
931 */
932/**
933 * Defines ListItem Component.
934 *
935 * @syscap SystemCapability.ArkUI.ArkUI.Full
936 * @form
937 * @since 9
938 */
939/**
940 * Defines ListItem Component.
941 *
942 * @syscap SystemCapability.ArkUI.ArkUI.Full
943 * @crossplatform
944 * @form
945 * @since 10
946 */
947/**
948 * Defines ListItem Component.
949 *
950 * @syscap SystemCapability.ArkUI.ArkUI.Full
951 * @crossplatform
952 * @form
953 * @atomicservice
954 * @since 11
955 */
956declare const ListItem: ListItemInterface;
957
958