-
Notifications
You must be signed in to change notification settings - Fork 63
/
Copy pathindex.d.ts
5686 lines (4920 loc) · 215 KB
/
index.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
// Generated by scripts/generator.js
// https://github.com/sveltejs/language-tools/blob/master/docs/preprocessors/typescript.md#im-using-an-attributeevent-on-a-dom-element-and-it-throws-a-type-error
/* eslint-disable */
/* tslint:disable */
import type {
AccordionGroupChangeEventDetail,
ActionSheetButton,
AlertButton,
AlertInput,
BreadcrumbCollapsedClickEventDetail,
CheckboxChangeEventDetail,
ComponentProps,
DatetimeChangeEventDetail,
DatetimeHighlight,
InputChangeEventDetail,
InputInputEventDetail,
IonicConfig,
IonicSafeString,
ItemReorderEventDetail,
ModalBreakpointChangeEventDetail,
NavComponent,
NavComponentWithProps,
NavOptions,
OverlayEventDetail,
PickerButton,
PickerColumn,
RadioGroupChangeEventDetail,
RangeChangeEventDetail,
RangeKnobMoveEndEventDetail,
RangeKnobMoveStartEventDetail,
RefresherEventDetail,
RouterEventDetail,
ScrollBaseDetail,
ScrollDetail,
SearchbarChangeEventDetail,
SearchbarInputEventDetail,
SegmentChangeEventDetail,
SelectChangeEventDetail,
TextareaChangeEventDetail,
TextareaInputEventDetail,
ToastButton,
ToggleChangeEventDetail,
TransitionDoneFn,
ViewController
} from '@ionic/core';
import { DatetimeHighlightStyle } from '@ionic/core/dist/types/components/datetime/datetime-interface';
import { SvelteComponent } from 'svelte';
import type { HTMLAttributes } from 'svelte/elements';
export function setupIonicSvelte(config?: IonicConfig);
export function setupIonicBase(config?: IonicConfig);
export function registerMenu(menuId: string);
export function createNavPageFromSvelte(
component: new (...args: any) => SvelteComponent,
componentProps: {}
);
export { default as IonTabs } from './components/IonTabs.svelte';
// export { default as IonTabsLegacy } from "./components/IonTabsLegacy.svelte";
export { default as IonNav } from './components/IonNav.svelte';
export { default as IonPage } from './components/IonPage.svelte';
// thank you ChatGPT!
export const navController: {
canGoBack: (view?: ViewController) => boolean | undefined;
getActive: () => ViewController | undefined;
getByIndex: (index: number) => ViewController | undefined;
getPrevious: (view?: ViewController) => ViewController | undefined;
insert: <T extends NavComponent>(
insertIndex: number,
component: T,
componentProps?: ComponentProps<T> | null,
opts?: NavOptions | null,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
insertPages: (
insertIndex: number,
insertComponents: NavComponent[] | NavComponentWithProps[],
opts?: NavOptions | null,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
pop: (opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean> | undefined;
popTo: (
indexOrViewCtrl: number | ViewController,
opts?: NavOptions | null,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
popToRoot: (opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean> | undefined;
push: <T extends NavComponent>(
component: T,
componentProps?: ComponentProps<T>,
opts?: NavOptions,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
removeIndex: (
startIndex: number,
removeCount?: number,
opts?: NavOptions | null,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
setPages: (
views: NavComponent[] | NavComponentWithProps[],
opts?: NavOptions | null,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
setRoot: <T extends NavComponent>(
component: T,
componentProps?: ComponentProps<T>,
opts?: NavOptions,
done?: TransitionDoneFn
) => Promise<boolean> | undefined;
};
// we overload (modalcontroller and popovercontroller) from ionic-core with same types, so let's mirror these
export {
actionSheetController,
alertController,
loadingController,
menuController,
modalController,
pickerController,
popoverController,
toastController
} from '@ionic/core';
// platforms
declare const PLATFORMS_MAP: {
[key: string]: boolean;
};
declare type Platforms = keyof typeof PLATFORMS_MAP;
export function getPlatforms(win?: any): string[];
export function setupPlatforms(win: any);
interface IsPlatformSignature {
(plt: Platforms): boolean;
(win: Window, plt: Platforms): boolean;
}
export function isPlatform(
winOrPlatform: Window | Platforms | undefined,
platform?: Platforms
): IsPlatformSignature;
export function testUserAgent(win: Window, expr: RegExp);
// not exported by @ionic/core
export type NavigationHookResult = boolean | NavigationHookOptions;
export interface NavigationHookOptions {
redirect: string;
}
export interface HTMLBaseAttributes extends HTMLAttributes<HTMLBaseElement> {}
declare global {
namespace svelteHTML {
interface IonAccordion {
/**
* If `true`, the accordion cannot be interacted with.
* API info: https://ionicframework.com/docs/api/accordion#disabled
*/
disabled?: boolean;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/accordion#mode
*/
mode?: 'ios' | 'md';
/**
* If `true`, the accordion cannot be interacted with, but does not alter the opacity.
* API info: https://ionicframework.com/docs/api/accordion#readonly
*/
readonly?: boolean;
/**
* The toggle icon to use. This icon will be rotated when the accordion is expanded or collapsed.
* API info: https://ionicframework.com/docs/api/accordion#toggleicon
*/
'toggle-icon'?: string;
/**
* The slot inside of `ion-item` to place the toggle icon. Defaults to `"end"`.
* API info: https://ionicframework.com/docs/api/accordion#toggleiconslot
*/
'toggle-icon-slot'?: 'end' | 'start';
/**
* The value of the accordion. Defaults to an autogenerated value.
* API info: https://ionicframework.com/docs/api/accordion#value
*/
value?: string;
}
interface IonAccordionGroup {
/**
* If `true`, all accordions inside of the accordion group will animate when expanding or collapsing.
* API info: https://ionicframework.com/docs/api/accordion-group#animated
*/
animated?: boolean;
/**
* If `true`, the accordion group cannot be interacted with.
* API info: https://ionicframework.com/docs/api/accordion-group#disabled
*/
disabled?: boolean;
/**
* Describes the expansion behavior for each accordion. Possible values are `"compact"` and `"inset"`. Defaults to `"compact"`.
* API info: https://ionicframework.com/docs/api/accordion-group#expand
*/
expand?: 'compact' | 'inset';
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/accordion-group#mode
*/
mode?: 'ios' | 'md';
/**
* If `true`, the accordion group can have multiple accordion components expanded at the same time.
* API info: https://ionicframework.com/docs/api/accordion-group#multiple
*/
multiple?: boolean | undefined;
/**
* If `true`, the accordion group cannot be interacted with, but does not alter the opacity.
* API info: https://ionicframework.com/docs/api/accordion-group#readonly
*/
readonly?: boolean;
/**
* The value of the accordion group. This controls which accordions are expanded. This should be an array of strings only when `multiple="true"`
* API info: https://ionicframework.com/docs/api/accordion-group#value
*/
value?: null | string | string[] | undefined;
/**
* (event : AccordionGroupChangeEventDetail<any>) => void : Emitted when the value property has changed as a result of a user action such as a click. This event will not emit when programmatically setting the `value` property.
*/
'on:ionChange'?: (
event: CustomEvent<AccordionGroupChangeEventDetail<any>> & {
target: HTMLIonAccordionGroupElement;
}
) => void;
}
interface IonActionSheet {
/**
* If `true`, the action sheet will animate.
* API info: https://ionicframework.com/docs/api/action-sheet#animated
*/
animated?: boolean;
/**
* If `true`, the action sheet will be dismissed when the backdrop is clicked.
* API info: https://ionicframework.com/docs/api/action-sheet#backdropdismiss
*/
'backdrop-dismiss'?: boolean;
/**
* An array of buttons for the action sheet.
* API info: https://ionicframework.com/docs/api/action-sheet#buttons
*/
buttons?: (string | ActionSheetButton<any>)[];
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
* API info: https://ionicframework.com/docs/api/action-sheet#cssclass
*/
'css-class'?: string | string[] | undefined;
/**
* Animation to use when the action sheet is presented.
* API info: https://ionicframework.com/docs/api/action-sheet#enteranimation
*/
'enter-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* Title for the action sheet.
* API info: https://ionicframework.com/docs/api/action-sheet#header
*/
header?: string | undefined;
/**
* Additional attributes to pass to the action sheet.
* API info: https://ionicframework.com/docs/api/action-sheet#htmlattributes
*/
'html-attributes'?: undefined | { [key: string]: any };
/**
* If `true`, the action sheet will open. If `false`, the action sheet will close. Use this if you need finer grained control over presentation, otherwise just use the actionSheetController or the `trigger` property. Note: `isOpen` will not automatically be set back to `false` when the action sheet dismisses. You will need to do that in your code.
* API info: https://ionicframework.com/docs/api/action-sheet#isopen
*/
'is-open'?: boolean;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
* API info: https://ionicframework.com/docs/api/action-sheet#keyboardclose
*/
'keyboard-close'?: boolean;
/**
* Animation to use when the action sheet is dismissed.
* API info: https://ionicframework.com/docs/api/action-sheet#leaveanimation
*/
'leave-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/action-sheet#mode
*/
mode?: 'ios' | 'md';
/**
* Subtitle for the action sheet.
* API info: https://ionicframework.com/docs/api/action-sheet#subheader
*/
'sub-header'?: string | undefined;
/**
* If `true`, the action sheet will be translucent. Only applies when the mode is `"ios"` and the device supports [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
* API info: https://ionicframework.com/docs/api/action-sheet#translucent
*/
translucent?: boolean;
/**
* An ID corresponding to the trigger element that causes the action sheet to open when clicked.
* API info: https://ionicframework.com/docs/api/action-sheet#trigger
*/
trigger?: string | undefined;
/**
* (event : OverlayEventDetail<any>) => void : Emitted after the action sheet has dismissed. Shorthand for ionActionSheetDidDismiss.
*/
'on:didDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonActionSheetElement;
}
) => void;
/**
* () => void : Emitted after the action sheet has presented. Shorthand for ionActionSheetWillDismiss.
*/
'on:didPresent'?: () => void;
/**
* (event : OverlayEventDetail<any>) => void : Emitted after the action sheet has dismissed.
*/
'on:ionActionSheetDidDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonActionSheetElement;
}
) => void;
/**
* () => void : Emitted after the action sheet has presented.
*/
'on:ionActionSheetDidPresent'?: () => void;
/**
* (event : OverlayEventDetail<any>) => void : Emitted before the action sheet has dismissed.
*/
'on:ionActionSheetWillDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonActionSheetElement;
}
) => void;
/**
* () => void : Emitted before the action sheet has presented.
*/
'on:ionActionSheetWillPresent'?: () => void;
/**
* (event : OverlayEventDetail<any>) => void : Emitted before the action sheet has dismissed. Shorthand for ionActionSheetWillDismiss.
*/
'on:willDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonActionSheetElement;
}
) => void;
/**
* () => void : Emitted before the action sheet has presented. Shorthand for ionActionSheetWillPresent.
*/
'on:willPresent'?: () => void;
}
interface IonAlert {
/**
* If `true`, the alert will animate.
* API info: https://ionicframework.com/docs/api/alert#animated
*/
animated?: boolean;
/**
* If `true`, the alert will be dismissed when the backdrop is clicked.
* API info: https://ionicframework.com/docs/api/alert#backdropdismiss
*/
'backdrop-dismiss'?: boolean;
/**
* Array of buttons to be added to the alert.
* API info: https://ionicframework.com/docs/api/alert#buttons
*/
buttons?: (string | AlertButton)[];
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
* API info: https://ionicframework.com/docs/api/alert#cssclass
*/
'css-class'?: string | string[] | undefined;
/**
* Animation to use when the alert is presented.
* API info: https://ionicframework.com/docs/api/alert#enteranimation
*/
'enter-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* The main title in the heading of the alert.
* API info: https://ionicframework.com/docs/api/alert#header
*/
header?: string | undefined;
/**
* Additional attributes to pass to the alert.
* API info: https://ionicframework.com/docs/api/alert#htmlattributes
*/
'html-attributes'?: undefined | { [key: string]: any };
/**
* Array of input to show in the alert.
* API info: https://ionicframework.com/docs/api/alert#inputs
*/
inputs?: AlertInput[];
/**
* If `true`, the alert will open. If `false`, the alert will close. Use this if you need finer grained control over presentation, otherwise just use the alertController or the `trigger` property. Note: `isOpen` will not automatically be set back to `false` when the alert dismisses. You will need to do that in your code.
* API info: https://ionicframework.com/docs/api/alert#isopen
*/
'is-open'?: boolean;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
* API info: https://ionicframework.com/docs/api/alert#keyboardclose
*/
'keyboard-close'?: boolean;
/**
* Animation to use when the alert is dismissed.
* API info: https://ionicframework.com/docs/api/alert#leaveanimation
*/
'leave-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* The main message to be displayed in the alert. `message` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `<Ionic>` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
* API info: https://ionicframework.com/docs/api/alert#message
*/
message?: IonicSafeString | string | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/alert#mode
*/
mode?: 'ios' | 'md';
/**
* The subtitle in the heading of the alert. Displayed under the title.
* API info: https://ionicframework.com/docs/api/alert#subheader
*/
'sub-header'?: string | undefined;
/**
* If `true`, the alert will be translucent. Only applies when the mode is `"ios"` and the device supports [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
* API info: https://ionicframework.com/docs/api/alert#translucent
*/
translucent?: boolean;
/**
* An ID corresponding to the trigger element that causes the alert to open when clicked.
* API info: https://ionicframework.com/docs/api/alert#trigger
*/
trigger?: string | undefined;
/**
* (event : OverlayEventDetail<any>) => void : Emitted after the alert has dismissed. Shorthand for ionAlertDidDismiss.
*/
'on:didDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonAlertElement;
}
) => void;
/**
* () => void : Emitted after the alert has presented. Shorthand for ionAlertWillDismiss.
*/
'on:didPresent'?: () => void;
/**
* (event : OverlayEventDetail<any>) => void : Emitted after the alert has dismissed.
*/
'on:ionAlertDidDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonAlertElement;
}
) => void;
/**
* () => void : Emitted after the alert has presented.
*/
'on:ionAlertDidPresent'?: () => void;
/**
* (event : OverlayEventDetail<any>) => void : Emitted before the alert has dismissed.
*/
'on:ionAlertWillDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonAlertElement;
}
) => void;
/**
* () => void : Emitted before the alert has presented.
*/
'on:ionAlertWillPresent'?: () => void;
/**
* (event : OverlayEventDetail<any>) => void : Emitted before the alert has dismissed. Shorthand for ionAlertWillDismiss.
*/
'on:willDismiss'?: (
event: CustomEvent<OverlayEventDetail<any>> & {
target: HTMLIonAlertElement;
}
) => void;
/**
* () => void : Emitted before the alert has presented. Shorthand for ionAlertWillPresent.
*/
'on:willPresent'?: () => void;
}
interface IonApp {}
interface IonAvatar {}
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).
* API info: https://ionicframework.com/docs/api/back-button#color
*/
color?:
| 'danger'
| 'dark'
| 'light'
| 'medium'
| 'primary'
| 'secondary'
| 'success'
| 'tertiary'
| 'warning'
| (string & Record<never, never>)
| undefined;
/**
* The url to navigate back to by default when there is no history.
* API info: https://ionicframework.com/docs/api/back-button#defaulthref
*/
'default-href'?: string | undefined;
/**
* If `true`, the user cannot interact with the button.
* API info: https://ionicframework.com/docs/api/back-button#disabled
*/
disabled?: boolean;
/**
* The built-in named SVG icon name or the exact `src` of an SVG file to use for the back button.
* API info: https://ionicframework.com/docs/api/back-button#icon
*/
icon?: null | string | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/back-button#mode
*/
mode?: 'ios' | 'md';
/**
* When using a router, it specifies the transition animation when navigating to another page.
* API info: https://ionicframework.com/docs/api/back-button#routeranimation
*/
'router-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* The text to display in the back button.
* API info: https://ionicframework.com/docs/api/back-button#text
*/
text?: null | string | undefined;
/**
* The type of the button.
* API info: https://ionicframework.com/docs/api/back-button#type
*/
type?: 'button' | 'reset' | 'submit';
}
interface IonBackdrop {
/**
* If `true`, the backdrop will stop propagation on tap.
* API info: https://ionicframework.com/docs/api/backdrop#stoppropagation
*/
'stop-propagation'?: boolean;
/**
* If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event.
* API info: https://ionicframework.com/docs/api/backdrop#tappable
*/
tappable?: boolean;
/**
* If `true`, the backdrop will be visible.
* API info: https://ionicframework.com/docs/api/backdrop#visible
*/
visible?: boolean;
/**
* () => void : Emitted when the backdrop is tapped.
*/
'on:ionBackdropTap'?: () => void;
}
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).
* API info: https://ionicframework.com/docs/api/badge#color
*/
color?:
| 'danger'
| 'dark'
| 'light'
| 'medium'
| 'primary'
| 'secondary'
| 'success'
| 'tertiary'
| 'warning'
| (string & Record<never, never>)
| undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/badge#mode
*/
mode?: 'ios' | 'md';
}
interface IonBreadcrumb {
/**
* If `true`, the breadcrumb will take on a different look to show that it is the currently active breadcrumb. Defaults to `true` for the last breadcrumb if it is not set on any.
* API info: https://ionicframework.com/docs/api/breadcrumb#active
*/
active?: 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).
* API info: https://ionicframework.com/docs/api/breadcrumb#color
*/
color?:
| 'danger'
| 'dark'
| 'light'
| 'medium'
| 'primary'
| 'secondary'
| 'success'
| 'tertiary'
| 'warning'
| (string & Record<never, never>)
| undefined;
/**
* If `true`, the user cannot interact with the breadcrumb.
* API info: https://ionicframework.com/docs/api/breadcrumb#disabled
*/
disabled?: boolean;
/**
* This attribute instructs browsers to download a URL instead of navigating to it, so the user will be prompted to save it as a local file. If the attribute has a value, it is used as the pre-filled file name in the Save prompt (the user can still change the file name if they want).
* API info: https://ionicframework.com/docs/api/breadcrumb#download
*/
download?: string | undefined;
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
* API info: https://ionicframework.com/docs/api/breadcrumb#href
*/
href?: string | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/breadcrumb#mode
*/
mode?: 'ios' | 'md';
/**
* Specifies the relationship of the target object to the link object. The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types).
* API info: https://ionicframework.com/docs/api/breadcrumb#rel
*/
rel?: string | undefined;
/**
* When using a router, it specifies the transition animation when navigating to another page using `href`.
* API info: https://ionicframework.com/docs/api/breadcrumb#routeranimation
*/
'router-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
* API info: https://ionicframework.com/docs/api/breadcrumb#routerdirection
*/
'router-direction'?: 'back' | 'forward' | 'root';
/**
* If true, show a separator between this breadcrumb and the next. Defaults to `true` for all breadcrumbs except the last.
* API info: https://ionicframework.com/docs/api/breadcrumb#separator
*/
separator?: boolean | undefined;
/**
* Specifies where to display the linked URL. Only applies when an `href` is provided. Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.
* API info: https://ionicframework.com/docs/api/breadcrumb#target
*/
target?: string | undefined;
/**
* () => void : Emitted when the breadcrumb loses focus.
*/
'on:ionBlur'?: () => void;
/**
* () => void : Emitted when the breadcrumb has focus.
*/
'on:ionFocus'?: () => void;
}
interface IonBreadcrumbs {
/**
* 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).
* API info: https://ionicframework.com/docs/api/breadcrumbs#color
*/
color?:
| 'danger'
| 'dark'
| 'light'
| 'medium'
| 'primary'
| 'secondary'
| 'success'
| 'tertiary'
| 'warning'
| (string & Record<never, never>)
| undefined;
/**
* The number of breadcrumbs to show after the collapsed indicator. If `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`, the breadcrumbs will not be collapsed.
* API info: https://ionicframework.com/docs/api/breadcrumbs#itemsaftercollapse
*/
'items-after-collapse'?: number;
/**
* The number of breadcrumbs to show before the collapsed indicator. If `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`, the breadcrumbs will not be collapsed.
* API info: https://ionicframework.com/docs/api/breadcrumbs#itemsbeforecollapse
*/
'items-before-collapse'?: number;
/**
* The maximum number of breadcrumbs to show before collapsing.
* API info: https://ionicframework.com/docs/api/breadcrumbs#maxitems
*/
'max-items'?: number | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/breadcrumbs#mode
*/
mode?: 'ios' | 'md';
/**
* (event : BreadcrumbCollapsedClickEventDetail) => void : Emitted when the collapsed indicator is clicked on.
*/
'on:ionCollapsedClick'?: (
event: CustomEvent<BreadcrumbCollapsedClickEventDetail> & {
target: HTMLIonBreadcrumbsElement;
}
) => void;
}
interface IonButton {
/**
* The type of button.
* API info: https://ionicframework.com/docs/api/button#buttontype
*/
'button-type'?: 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).
* API info: https://ionicframework.com/docs/api/button#color
*/
color?:
| 'danger'
| 'dark'
| 'light'
| 'medium'
| 'primary'
| 'secondary'
| 'success'
| 'tertiary'
| 'warning'
| (string & Record<never, never>)
| undefined;
/**
* If `true`, the user cannot interact with the button.
* API info: https://ionicframework.com/docs/api/button#disabled
*/
disabled?: boolean;
/**
* This attribute instructs browsers to download a URL instead of navigating to it, so the user will be prompted to save it as a local file. If the attribute has a value, it is used as the pre-filled file name in the Save prompt (the user can still change the file name if they want).
* API info: https://ionicframework.com/docs/api/button#download
*/
download?: string | undefined;
/**
* Set to `"block"` for a full-width button or to `"full"` for a full-width button with square corners and no left or right borders.
* API info: https://ionicframework.com/docs/api/button#expand
*/
expand?: 'block' | 'full' | undefined;
/**
* Set to `"clear"` for a transparent button that resembles a flat button, to `"outline"` for a transparent button with a border, or to `"solid"` for a button with a filled background. The default fill is `"solid"` except inside of a toolbar, where the default is `"clear"`.
* API info: https://ionicframework.com/docs/api/button#fill
*/
fill?: 'clear' | 'default' | 'outline' | 'solid' | undefined;
/**
* The HTML form element or form element id. Used to submit a form when the button is not a child of the form.
* API info: https://ionicframework.com/docs/api/button#form
*/
form?: HTMLFormElement | string | undefined;
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
* API info: https://ionicframework.com/docs/api/button#href
*/
href?: string | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/button#mode
*/
mode?: 'ios' | 'md';
/**
* Specifies the relationship of the target object to the link object. The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types).
* API info: https://ionicframework.com/docs/api/button#rel
*/
rel?: string | undefined;
/**
* When using a router, it specifies the transition animation when navigating to another page using `href`.
* API info: https://ionicframework.com/docs/api/button#routeranimation
*/
'router-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
* API info: https://ionicframework.com/docs/api/button#routerdirection
*/
'router-direction'?: 'back' | 'forward' | 'root';
/**
* Set to `"round"` for a button with more rounded corners.
* API info: https://ionicframework.com/docs/api/button#shape
*/
shape?: 'round' | undefined;
/**
* Set to `"small"` for a button with less height and padding, to `"default"` for a button with the default height and padding, or to `"large"` for a button with more height and padding. By default the size is unset, unless the button is inside of an item, where the size is `"small"` by default. Set the size to `"default"` inside of an item to make it a standard size button.
* API info: https://ionicframework.com/docs/api/button#size
*/
size?: 'default' | 'large' | 'small' | undefined;
/**
* If `true`, activates a button with a heavier font weight.
* API info: https://ionicframework.com/docs/api/button#strong
*/
strong?: boolean;
/**
* Specifies where to display the linked URL. Only applies when an `href` is provided. Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.
* API info: https://ionicframework.com/docs/api/button#target
*/
target?: string | undefined;
/**
* The type of the button.
* API info: https://ionicframework.com/docs/api/button#type
*/
type?: 'button' | 'reset' | 'submit';
/**
* () => void : Emitted when the button loses focus.
*/
'on:ionBlur'?: () => void;
/**
* () => void : Emitted when the button has focus.
*/
'on:ionFocus'?: () => void;
}
interface IonButtons {
/**
* If true, buttons will disappear when its parent toolbar has fully collapsed if the toolbar is not the first toolbar. If the toolbar is the first toolbar, the buttons will be hidden and will only be shown once all toolbars have fully collapsed. Only applies in `ios` mode with `collapse` set to `true` on `ion-header`. Typically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)
* API info: https://ionicframework.com/docs/api/buttons#collapse
*/
collapse?: boolean;
}
interface IonCard {
/**
* If `true`, a button tag will be rendered and the card will be tappable.
* API info: https://ionicframework.com/docs/api/card#button
*/
button?: 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).
* API info: https://ionicframework.com/docs/api/card#color
*/
color?:
| 'danger'
| 'dark'
| 'light'
| 'medium'
| 'primary'
| 'secondary'
| 'success'
| 'tertiary'
| 'warning'
| (string & Record<never, never>)
| undefined;
/**
* If `true`, the user cannot interact with the card.
* API info: https://ionicframework.com/docs/api/card#disabled
*/
disabled?: boolean;
/**
* This attribute instructs browsers to download a URL instead of navigating to it, so the user will be prompted to save it as a local file. If the attribute has a value, it is used as the pre-filled file name in the Save prompt (the user can still change the file name if they want).
* API info: https://ionicframework.com/docs/api/card#download
*/
download?: string | undefined;
/**
* Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
* API info: https://ionicframework.com/docs/api/card#href
*/
href?: string | undefined;
/**
* The mode determines which platform styles to use.
* API info: https://ionicframework.com/docs/api/card#mode
*/
mode?: 'ios' | 'md';
/**
* Specifies the relationship of the target object to the link object. The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types).
* API info: https://ionicframework.com/docs/api/card#rel
*/
rel?: string | undefined;
/**
* When using a router, it specifies the transition animation when navigating to another page using `href`.
* API info: https://ionicframework.com/docs/api/card#routeranimation
*/
'router-animation'?: ((baseEl: any, opts?: any) => Animation) | undefined;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
* API info: https://ionicframework.com/docs/api/card#routerdirection
*/
'router-direction'?: 'back' | 'forward' | 'root';
/**
* Specifies where to display the linked URL. Only applies when an `href` is provided. Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.