/
components.d.ts
6070 lines (5863 loc) · 223 KB
/
components.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import '@stencil/core';
import 'ionicons';
import {
ActionSheetButton,
ActionSheetOptions,
AlertButton,
AlertInput,
AlertOptions,
AnimationBuilder,
CheckboxChangeEventDetail,
Color,
ComponentProps,
ComponentRef,
DatetimeChangeEventDetail,
DatetimeOptions,
DomRenderFn,
FrameworkDelegate,
HeaderFn,
InputChangeEventDetail,
ItemHeightFn,
ItemRenderFn,
ItemReorderEventDetail,
LoadingOptions,
MenuChangeEventDetail,
MenuControllerI,
ModalOptions,
Mode,
NavComponent,
NavOptions,
OverlayEventDetail,
OverlaySelect,
PickerButton,
PickerColumn,
PickerOptions,
PopoverOptions,
RadioChangeEventDetail,
RadioGroupChangeEventDetail,
RangeChangeEventDetail,
RangeValue,
RefresherEventDetail,
RouteID,
RouterDirection,
RouterEventDetail,
RouterOutletOptions,
RouteWrite,
ScrollBaseDetail,
ScrollDetail,
SearchbarChangeEventDetail,
SegmentButtonLayout,
SegmentChangeEventDetail,
SelectChangeEventDetail,
SelectInterface,
SelectPopoverOption,
Side,
SpinnerTypes,
StyleEventDetail,
SwipeGestureHandler,
TabBarChangedEventDetail,
TabButtonClickEventDetail,
TabButtonLayout,
TextareaChangeEventDetail,
TextFieldTypes,
ToastOptions,
ToggleChangeEventDetail,
TransitionDoneFn,
TransitionInstruction,
ViewController,
} from './interface';
import {
EventEmitter,
} from '@stencil/core';
import {
SelectCompareFn,
} from './components/select/select-interface';
export namespace Components {
interface IonActionSheetController {
/**
* Create an action sheet overlay with action sheet options.
*/
'create': (opts: ActionSheetOptions) => Promise<HTMLIonActionSheetElement>;
/**
* Dismiss the open action sheet overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened action sheet overlay.
*/
'getTop': () => Promise<HTMLIonActionSheetElement | undefined>;
}
interface IonActionSheetControllerAttributes extends StencilHTMLAttributes {}
interface IonActionSheet {
/**
* If `true`, the action sheet will animate.
*/
'animated': boolean;
/**
* If `true`, the action sheet will be dismissed when the backdrop is clicked.
*/
'backdropDismiss': boolean;
/**
* An array of buttons for the action sheet.
*/
'buttons': (ActionSheetButton | string)[];
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
*/
'cssClass'?: string | string[];
/**
* Dismiss the action sheet overlay after it has been presented.
*/
'dismiss': (data?: any, role?: string | undefined) => Promise<boolean>;
/**
* Animation to use when the action sheet is presented.
*/
'enterAnimation'?: AnimationBuilder;
/**
* Title for the action sheet.
*/
'header'?: string;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
'keyboardClose': boolean;
/**
* Animation to use when the action sheet is dismissed.
*/
'leaveAnimation'?: AnimationBuilder;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the action-sheet did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the action-sheet will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the action sheet overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* Subtitle for the action sheet.
*/
'subHeader'?: string;
/**
* If `true`, the action sheet will be translucent. Only applies when the mode is `"ios"` and the device supports backdrop-filter.
*/
'translucent': boolean;
}
interface IonActionSheetAttributes extends StencilHTMLAttributes {
/**
* If `true`, the action sheet will animate.
*/
'animated'?: boolean;
/**
* If `true`, the action sheet will be dismissed when the backdrop is clicked.
*/
'backdropDismiss'?: boolean;
/**
* An array of buttons for the action sheet.
*/
'buttons': (ActionSheetButton | string)[];
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
*/
'cssClass'?: string | string[];
/**
* Animation to use when the action sheet is presented.
*/
'enterAnimation'?: AnimationBuilder;
/**
* Title for the action sheet.
*/
'header'?: string;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
'keyboardClose'?: boolean;
/**
* Animation to use when the action sheet is dismissed.
*/
'leaveAnimation'?: AnimationBuilder;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* Emitted after the alert has dismissed.
*/
'onIonActionSheetDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the alert has presented.
*/
'onIonActionSheetDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the alert has dismissed.
*/
'onIonActionSheetWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the alert has presented.
*/
'onIonActionSheetWillPresent'?: (event: CustomEvent<void>) => void;
/**
* Subtitle for the action sheet.
*/
'subHeader'?: string;
/**
* If `true`, the action sheet will be translucent. Only applies when the mode is `"ios"` and the device supports backdrop-filter.
*/
'translucent'?: boolean;
}
interface IonAlertController {
/**
* Create an alert overlay with alert options
*/
'create': (opts: AlertOptions) => Promise<HTMLIonAlertElement>;
/**
* Dismiss the open alert overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened alert overlay.
*/
'getTop': () => Promise<HTMLIonAlertElement | undefined>;
}
interface IonAlertControllerAttributes extends StencilHTMLAttributes {}
interface IonAlert {
/**
* If `true`, the alert will animate.
*/
'animated': boolean;
/**
* If `true`, the alert will be dismissed when the backdrop is clicked.
*/
'backdropDismiss': boolean;
/**
* Array of buttons to be added to the alert.
*/
'buttons': (AlertButton | string)[];
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
*/
'cssClass'?: string | string[];
/**
* Dismiss the alert overlay after it has been presented.
*/
'dismiss': (data?: any, role?: string | undefined) => Promise<boolean>;
/**
* Animation to use when the alert is presented.
*/
'enterAnimation'?: AnimationBuilder;
/**
* The main title in the heading of the alert.
*/
'header'?: string;
/**
* Array of input to show in the alert.
*/
'inputs': AlertInput[];
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
'keyboardClose': boolean;
/**
* Animation to use when the alert is dismissed.
*/
'leaveAnimation'?: AnimationBuilder;
/**
* The main message to be displayed in the alert.
*/
'message'?: string;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the alert did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the alert will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the alert overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* The subtitle in the heading of the alert. Displayed under the title.
*/
'subHeader'?: string;
/**
* If `true`, the alert will be translucent.
*/
'translucent': boolean;
}
interface IonAlertAttributes extends StencilHTMLAttributes {
/**
* If `true`, the alert will animate.
*/
'animated'?: boolean;
/**
* If `true`, the alert will be dismissed when the backdrop is clicked.
*/
'backdropDismiss'?: boolean;
/**
* Array of buttons to be added to the alert.
*/
'buttons'?: (AlertButton | string)[];
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
*/
'cssClass'?: string | string[];
/**
* Animation to use when the alert is presented.
*/
'enterAnimation'?: AnimationBuilder;
/**
* The main title in the heading of the alert.
*/
'header'?: string;
/**
* Array of input to show in the alert.
*/
'inputs'?: AlertInput[];
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
'keyboardClose'?: boolean;
/**
* Animation to use when the alert is dismissed.
*/
'leaveAnimation'?: AnimationBuilder;
/**
* The main message to be displayed in the alert.
*/
'message'?: string;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* Emitted after the alert has dismissed.
*/
'onIonAlertDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the alert has presented.
*/
'onIonAlertDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the alert has dismissed.
*/
'onIonAlertWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the alert has presented.
*/
'onIonAlertWillPresent'?: (event: CustomEvent<void>) => void;
/**
* The subtitle in the heading of the alert. Displayed under the title.
*/
'subHeader'?: string;
/**
* If `true`, the alert will be translucent.
*/
'translucent'?: boolean;
}
interface IonAnchor {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
*/
'href'?: string;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
*/
'routerDirection': RouterDirection;
}
interface IonAnchorAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
*/
'href'?: string;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
*/
'routerDirection'?: RouterDirection;
}
interface IonApp {}
interface IonAppAttributes extends StencilHTMLAttributes {}
interface IonAvatar {}
interface IonAvatarAttributes extends StencilHTMLAttributes {}
interface IonBackButton {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The url to navigate back to by default when there is no history.
*/
'defaultHref'?: string;
/**
* The icon name to use for the back button.
*/
'icon'?: string | null;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* The text to display in the back button.
*/
'text'?: string | null;
}
interface IonBackButtonAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The url to navigate back to by default when there is no history.
*/
'defaultHref'?: string;
/**
* The icon name to use for the back button.
*/
'icon'?: string | null;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* The text to display in the back button.
*/
'text'?: string | null;
}
interface IonBackdrop {
/**
* If `true`, the backdrop will stop propagation on tap.
*/
'stopPropagation': boolean;
/**
* If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event.
*/
'tappable': boolean;
/**
* If `true`, the backdrop will be visible.
*/
'visible': boolean;
}
interface IonBackdropAttributes extends StencilHTMLAttributes {
/**
* Emitted when the backdrop is tapped.
*/
'onIonBackdropTap'?: (event: CustomEvent<void>) => void;
/**
* If `true`, the backdrop will stop propagation on tap.
*/
'stopPropagation'?: boolean;
/**
* If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event.
*/
'tappable'?: boolean;
/**
* If `true`, the backdrop will be visible.
*/
'visible'?: boolean;
}
interface IonBadge {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
}
interface IonBadgeAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
}
interface IonButton {
/**
* The type of button.
*/
'buttonType': string;
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* If `true`, the user cannot interact with the button.
*/
'disabled': boolean;
/**
* Set to `"block"` for a full-width button or to `"full"` for a full-width button without left and right borders.
*/
'expand'?: 'full' | 'block';
/**
* Set to `"clear"` for a transparent button, to `"outline"` for a transparent button with a border, or to `"solid"`. The default style is `"solid"` except inside of a toolbar, where the default is `"clear"`.
*/
'fill'?: 'clear' | 'outline' | 'solid' | 'default';
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
*/
'href'?: string;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
*/
'routerDirection': RouterDirection;
/**
* The button shape.
*/
'shape'?: 'round';
/**
* The button size.
*/
'size'?: 'small' | 'default' | 'large';
/**
* If `true`, activates a button with a heavier font weight.
*/
'strong': boolean;
/**
* The type of the button.
*/
'type': 'submit' | 'reset' | 'button';
}
interface IonButtonAttributes extends StencilHTMLAttributes {
/**
* The type of button.
*/
'buttonType'?: string;
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* If `true`, the user cannot interact with the button.
*/
'disabled'?: boolean;
/**
* Set to `"block"` for a full-width button or to `"full"` for a full-width button without left and right borders.
*/
'expand'?: 'full' | 'block';
/**
* Set to `"clear"` for a transparent button, to `"outline"` for a transparent button with a border, or to `"solid"`. The default style is `"solid"` except inside of a toolbar, where the default is `"clear"`.
*/
'fill'?: 'clear' | 'outline' | 'solid' | 'default';
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
*/
'href'?: string;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* Emitted when the button loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the button has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
*/
'routerDirection'?: RouterDirection;
/**
* The button shape.
*/
'shape'?: 'round';
/**
* The button size.
*/
'size'?: 'small' | 'default' | 'large';
/**
* If `true`, activates a button with a heavier font weight.
*/
'strong'?: boolean;
/**
* The type of the button.
*/
'type'?: 'submit' | 'reset' | 'button';
}
interface IonButtons {}
interface IonButtonsAttributes extends StencilHTMLAttributes {}
interface IonCardContent {
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
}
interface IonCardContentAttributes extends StencilHTMLAttributes {
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
}
interface IonCardHeader {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* If `true`, the card header will be translucent.
*/
'translucent': boolean;
}
interface IonCardHeaderAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* If `true`, the card header will be translucent.
*/
'translucent'?: boolean;
}
interface IonCardSubtitle {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
}
interface IonCardSubtitleAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
}
interface IonCardTitle {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
}
interface IonCardTitleAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
}
interface IonCard {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
}
interface IonCardAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
}
interface IonCheckbox {
/**
* If `true`, the checkbox is selected.
*/
'checked': boolean;
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* If `true`, the user cannot interact with the checkbox.
*/
'disabled': boolean;
/**
* If `true`, the checkbox will visually appear as indeterminate.
*/
'indeterminate': boolean;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* The name of the control, which is submitted with the form data.
*/
'name': string;
/**
* The value of the toggle does not mean if it's checked or not, use the `checked` property for that. The value of a toggle is analogous to the value of a `<input type="checkbox">`, it's only used when the toggle participates in a native `<form>`.
*/
'value': string;
}
interface IonCheckboxAttributes extends StencilHTMLAttributes {
/**
* If `true`, the checkbox is selected.
*/
'checked'?: boolean;
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* If `true`, the user cannot interact with the checkbox.
*/
'disabled'?: boolean;
/**
* If `true`, the checkbox will visually appear as indeterminate.
*/
'indeterminate'?: boolean;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* The name of the control, which is submitted with the form data.
*/
'name'?: string;
/**
* Emitted when the toggle loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the checked property has changed.
*/
'onIonChange'?: (event: CustomEvent<CheckboxChangeEventDetail>) => void;
/**
* Emitted when the toggle has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* The value of the toggle does not mean if it's checked or not, use the `checked` property for that. The value of a toggle is analogous to the value of a `<input type="checkbox">`, it's only used when the toggle participates in a native `<form>`.
*/
'value'?: string;
}
interface IonChip {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode': Mode;
/**
* Display an outline style button.
*/
'outline': boolean;
}
interface IonChipAttributes extends StencilHTMLAttributes {
/**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/
'color'?: Color;
/**
* The mode determines which platform styles to use.
*/
'mode'?: Mode;
/**
* Display an outline style button.
*/
'outline'?: boolean;
}
interface IonCol {
/**
* The amount to offset the column, in terms of how many columns it should shift to the end of the total available.
*/
'offset'?: string;
/**
* The amount to offset the column for lg screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetLg'?: string;
/**
* The amount to offset the column for md screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetMd'?: string;
/**
* The amount to offset the column for sm screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetSm'?: string;
/**
* The amount to offset the column for xl screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetXl'?: string;
/**
* The amount to offset the column for xs screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetXs'?: string;
/**
* The amount to pull the column, in terms of how many columns it should shift to the start of the total available.
*/
'pull'?: string;
/**
* The amount to pull the column for lg screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullLg'?: string;
/**
* The amount to pull the column for md screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullMd'?: string;
/**
* The amount to pull the column for sm screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullSm'?: string;
/**
* The amount to pull the column for xl screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullXl'?: string;
/**
* The amount to pull the column for xs screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullXs'?: string;
/**
* The amount to push the column, in terms of how many columns it should shift to the end of the total available.
*/
'push'?: string;
/**
* The amount to push the column for lg screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushLg'?: string;
/**
* The amount to push the column for md screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushMd'?: string;
/**
* The amount to push the column for sm screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushSm'?: string;
/**
* The amount to push the column for xl screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushXl'?: string;
/**
* The amount to push the column for xs screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushXs'?: string;
/**
* The size of the column, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content.
*/
'size'?: string;
/**
* The size of the column for lg screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content.
*/
'sizeLg'?: string;
/**
* The size of the column for md screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content.
*/
'sizeMd'?: string;
/**
* The size of the column for sm screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content.
*/
'sizeSm'?: string;
/**
* The size of the column for xl screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content.
*/
'sizeXl'?: string;
/**
* The size of the column for xs screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content.
*/
'sizeXs'?: string;
}
interface IonColAttributes extends StencilHTMLAttributes {
/**
* The amount to offset the column, in terms of how many columns it should shift to the end of the total available.
*/
'offset'?: string;
/**
* The amount to offset the column for lg screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetLg'?: string;
/**
* The amount to offset the column for md screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetMd'?: string;
/**
* The amount to offset the column for sm screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetSm'?: string;
/**
* The amount to offset the column for xl screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetXl'?: string;
/**
* The amount to offset the column for xs screens, in terms of how many columns it should shift to the end of the total available.
*/
'offsetXs'?: string;
/**
* The amount to pull the column, in terms of how many columns it should shift to the start of the total available.
*/
'pull'?: string;
/**
* The amount to pull the column for lg screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullLg'?: string;
/**
* The amount to pull the column for md screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullMd'?: string;
/**
* The amount to pull the column for sm screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullSm'?: string;
/**
* The amount to pull the column for xl screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullXl'?: string;
/**
* The amount to pull the column for xs screens, in terms of how many columns it should shift to the start of the total available.
*/
'pullXs'?: string;
/**
* The amount to push the column, in terms of how many columns it should shift to the end of the total available.
*/
'push'?: string;
/**
* The amount to push the column for lg screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushLg'?: string;
/**
* The amount to push the column for md screens, in terms of how many columns it should shift to the end of the total available.
*/
'pushMd'?: string;
/**
* The amount to push the column for sm screens, in terms of how many columns it should shift to the end of the total available.