-
Notifications
You must be signed in to change notification settings - Fork 60
/
components.d.ts
3453 lines (3453 loc) · 98.3 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
/* eslint-disable */
/* 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 { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
import { Buttons } from "./components/utils/button-variants";
import { FilterState } from "./components/category-filter/filter-state";
import { InputState } from "./components/category-filter/input-state";
import { DateTimeCardCorners } from "./components/date-time-card/date-time-card";
import { DateTimeCardCorners as DateTimeCardCorners1 } from "./components/date-time-card/date-time-card";
import { Placement, PositioningStrategy } from "@popperjs/core";
import { FlipTileState } from "./components/flip-tile/flip-tile-state";
import { NotificationColor } from "./components/utils/notification-color";
import { TypedEvent } from "./components/utils/typed-event";
import { ModalConfig } from "./components/modal/modal-utils";
import { ToastConfig, ToastType } from "./components/toast/toast-utils";
import { TreeContext, TreeItemContext, TreeModel, UpdateCallback } from "./components/tree/tree-model";
import { UploadFileState } from "./components/upload/upload-file-state";
export namespace Components {
interface IxAnimatedTab {
/**
* Show notification number
*/
"count": number;
/**
* Icon of the tab
*/
"icon": string;
}
interface IxAnimatedTabs {
/**
* @deprecated - For debugging purposes only
*/
"disableAnimations": boolean;
/**
* Current selected tab index
*/
"selectedIndex": number;
/**
* Placement of the tabs
*/
"tabPlacement": 'top' | 'bottom';
}
interface IxApplicationHeader {
/**
* Application name
*/
"name": string;
}
interface IxBasicNavigation {
/**
* Application name
*/
"applicationName": string;
/**
* Hide application header
*/
"hideHeader": boolean;
}
interface IxBlind {
/**
* Collapsed state
*/
"collapsed": boolean;
/**
* Label of blind
*/
"label": string;
}
interface IxBreadcrumb {
/**
* Ghost breadcrumbs will not show solid backgrounds on individual crumbs unless there is a mouse event (e.g. hover)
*/
"ghost": boolean;
/**
* Items will be accessible through a dropdown
*/
"nextItems": string[];
/**
* Excess items will get hidden inside of dropdown
*/
"visibleItemCount": number;
}
interface IxBreadcrumbItem {
/**
* Icon to be displayed next ot the label
*/
"icon": string;
/**
* Breadcrumb label
*/
"label": string;
}
interface IxButton {
/**
* Disable the button
*/
"disabled": boolean;
/**
* Button with no background or outline
*/
"ghost": boolean;
/**
* Invisible button
* @deprecated use ghost property
*/
"invisible": boolean;
/**
* Outline button
*/
"outline": boolean;
/**
* Show button as selected. Should be used with outline or invisible
*/
"selected": boolean;
/**
* Type of the button
*/
"type": 'button' | 'submit';
/**
* Button varaint
*/
"variant": Buttons;
}
interface IxCategoryFilter {
/**
* Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
*/
"categories": {
[id: string]: {
label: string;
options: string[];
};
};
/**
* A set of search criteria to populate the component with.
*/
"filterState": FilterState;
/**
* Allows to hide the icon inside the text input. Defaults to false
*/
"hideIcon": boolean;
/**
* i18n
*/
"i18nPlainText": string;
/**
* The icon next to the actual text input Defaults to 'search'
*/
"icon": string;
/**
* When set this will initially populate the component with the provided search criteria. This will trigger all input events accordingly.
* @deprecated will get removed with next major release (7.0.0). Use the member filterState instead.
*/
"initialState": FilterState;
/**
* i18n
*/
"labelCategories": string;
/**
* In certain use cases some categories are not available for selection any more. To allow proper display of set filters with these categories this ID to label mapping can be populated. Configuration object hash used to supply labels to the filter chips in the input field. Each ID maps to a string representing the label to display.
*/
"nonSelectableCategories"?: {
[id: string]: string;
};
/**
* Placeholder text to be displayed in an empty input field.
*/
"placeholder": string;
/**
* If set to true allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false. Defaults to true
*/
"repeatCategories": boolean;
/**
* A list of strings that will be supplied as typeahead suggestions not tied to any categories.
*/
"suggestions": string[];
/**
* @deprecated For debugging purposes only!
*/
"tmpDisableScrollIntoView": boolean;
}
interface IxChip {
/**
* Display chip in active state. Only working witht `variant="primary"`
*/
"active": boolean;
/**
* Custom color for pill. Only working for `variant='custom'`
*/
"background": string | undefined;
/**
* Show close icon
*/
"closable": boolean;
/**
* Custom font color for pill. Only working for `variant='custom'`
*/
"color": string | undefined;
/**
* Show icon
*/
"icon": string | undefined;
/**
* Show chip with outline style
*/
"outline": boolean;
/**
* Chip variant
*/
"variant": | 'primary'
| 'alarm'
| 'critical'
| 'warning'
| 'info'
| 'neutral'
| 'success'
| 'custom';
}
interface IxCounterPill {
/**
* Align pill content left
*/
"alignLeft": boolean;
/**
* Custom color for pill. Only working for `variant='custom'`
*/
"background": string | undefined;
/**
* Custom font color for pill. Only working for `variant='custom'`
*/
"color": string | undefined;
/**
* Show pill as outline
*/
"outline": boolean;
/**
* Pill variant
*/
"variant": | 'primary'
| 'alarm'
| 'critical'
| 'warning'
| 'info'
| 'neutral'
| 'success'
| 'custom';
}
interface IxDatePicker {
/**
* Set corners style
*/
"corners": DateTimeCardCorners;
/**
* output date format
*/
"format": string;
/**
* set styles
*/
"individual": boolean;
/**
* Set range size
*/
"range": boolean;
}
interface IxDateTimeCard {
/**
* Set corners style
*/
"corners": DateTimeCardCorners;
/**
* set styles
*/
"individual": boolean;
}
interface IxDatetimePicker {
/**
* Set range size
*/
"range": boolean;
/**
* Show Hour Input
*/
"showHour": boolean;
/**
* Show Minutes Input
*/
"showMinutes": boolean;
/**
* Show Seconds Input
*/
"showSeconds": boolean;
/**
* Show Time Reference Input
*/
"showTimeReference": boolean;
}
interface IxDrawer {
/**
* Fired in case of an outside click during drawer showed state
*/
"closeOnClickOutside": boolean;
/**
* Render the drawer with maximum height
*/
"fullHeight": boolean;
/**
* Max width interpreted as REM
*/
"maxWidth": number;
/**
* Min width interpreted as REM
*/
"minWidth": number;
/**
* Show or hide the drawer
*/
"show": boolean;
/**
* Toggle or define show state of drawer
* @param show Overwrite toggle state with boolean
*/
"toggleDrawer": (show: boolean) => Promise<void>;
/**
* Width interpreted as REM if not set to 'auto'
*/
"width": number | 'auto';
}
interface IxDropdown {
/**
* Adjust dropdown width to the parent width
*/
"adjustDropdownWidthToReferenceWidth": boolean;
/**
* Adjust dropdown width to the parent width
* @deprecated - property has a typo and will get removed in the next major version. Use `adjustDropdownWidthToReferenceWidth` instead.
*/
"adjustDropdownWidthToReferenceWith": boolean;
/**
* Define an anchor element
*/
"anchor": string | HTMLElement;
/**
* Close behavior
*/
"closeBehavior": 'inside' | 'outside' | 'both' | boolean;
/**
* An optional header shown at the top of the dropdown
*/
"header"?: string;
/**
* Placement of the dropdown
*/
"placement": Placement;
/**
* Position strategy
*/
"positioningStrategy": PositioningStrategy;
/**
* Show dropdown
*/
"show": boolean;
/**
* Define an element that triggers the dropdown. A trigger can either be a string that will be interprated as id attribute or a DOM element.
*/
"trigger": string | HTMLElement;
/**
* Update position of dropdown
*/
"updatePosition": () => Promise<void>;
}
interface IxDropdownItem {
/**
* Whether the item is checked or not. If true a checkmark will mark the item as checked.
*/
"checked": boolean;
/**
* Disable item and remove event listeners
*/
"disabled": boolean;
/**
* Internal usage only
*/
"emitItemClick": () => Promise<void>;
/**
* Display hover state
*/
"hover": boolean;
/**
* Icon of dropdown item
*/
"icon": string;
/**
* Label of dropdown item
*/
"label": string;
}
interface IxEventList {
/**
* Animate state change transitions. Defaults to 'true'.
*/
"animated": boolean;
/**
* Display a chevron icon in list items. Defaults to 'false'
*/
"chevron": boolean;
/**
* Make event-list items more compact
*/
"compact": boolean;
/**
* Determines the height of list items. This can either be one of two predefined sizes ('S' or 'L') or an absolute pixel value. In case a number is supplied it will get converted to rem internally. Defaults to 'S'.
*/
"itemHeight": 'S' | 'L' | number;
}
interface IxEventListItem {
/**
* Show chevron on right side of the event list item
*/
"chevron": boolean;
/**
* Color of the status indicator. Allowed values are all Core UI color names.
*/
"color": string;
/**
* Disable event list item
*/
"disabled": boolean;
/**
* Opacity of the status indicator. Defaults to 1.0
* @deprecated Will be removed in 7.0.0. Use color with alpha value.
*/
"opacity": number;
/**
* Show event list item as selected
*/
"selected": boolean;
}
interface IxExpandingSearch {
/**
* Search icon
*/
"icon": string;
/**
* Placeholder text
*/
"placeholder": string;
/**
* Default value
*/
"value": string;
}
interface IxFilterChip {
/**
* If true the filter chip will be in disabled state
*/
"disabled": boolean;
}
interface IxFlipTile {
/**
* Tmp property name
*/
"footer": string;
/**
* Variation of the Flip
*/
"state": FlipTileState;
}
interface IxFlipTileContent {
}
interface IxGroup {
/**
* Whether the group is collapsed or expanded. Defaults to true.
*/
"collapsed": boolean;
/**
* Expand the group if the header is clicked
*/
"expandOnHeaderClick": boolean;
/**
* Group header
*/
"header": string;
/**
* The index of the selected group entry. If undefined no group item is selected.
*/
"index": number;
/**
* Whether the group is selected.
*/
"selected": boolean;
/**
* Group header subtitle
*/
"subHeader": string;
/**
* Prevent header from being selectable
*/
"suppressHeaderSelection": boolean;
}
interface IxGroupDropdownItem {
/**
* Group dropdown icon
*/
"icon": string;
/**
* Group dropdown label
*/
"label": string;
}
interface IxGroupItem {
/**
* The elements tabindex attribute will get set accordingly. If true tabindex will be 0, -1 otherwise.
*/
"focusable": boolean;
/**
* Group item icon
*/
"icon": string;
/**
* Index
*/
"index": number;
/**
* Group item secondary text
*/
"secondaryText": string;
/**
* Show selected state
*/
"selected": boolean;
/**
* Supress the selection of the group
*/
"suppressSelection": boolean;
/**
* Group item text
*/
"text": string;
}
interface IxIcon {
/**
* Color of the icon
*/
"color": string;
/**
* Use one of our defined icon names e.g `copy`.
*/
"name": string;
/**
* Size of the icon
*/
"size": '12' | '16' | '24' | '32';
}
interface IxIconButton {
/**
* Color of icon in button
*/
"color": string;
/**
* Disabled
*/
"disabled": boolean;
/**
* Button invisible
*/
"ghost": boolean;
/**
* Button icon
*/
"icon": string;
/**
* Button invisible
* @deprecated use ghost property
*/
"invisible": boolean;
/**
* Button outline
*/
"outline": boolean;
/**
* Button in oval shape
*/
"oval": boolean;
/**
* Selected state only working with outline or invisible
*/
"selected": boolean;
/**
* Size of icon in button
*/
"size": '32' | '24' | '16' | '12';
/**
* Type of the button
*/
"type": 'button' | 'submit';
/**
* Variant of button
*/
"variant": 'Primary' | 'Secondary';
}
interface IxInputGroup {
}
interface IxKpi {
"label": string;
"orientation": 'horizontal' | 'vertical';
"state": 'neutral' | 'warning' | 'alarm';
"unit": string;
"value": string | number;
}
interface IxMapNavigation {
/**
* Application name
*/
"applicationName": string;
/**
* Close current shown overlay
*/
"closeOverlay": () => Promise<void>;
/**
* Hide the sidebar context menu button when set to true
*/
"hideContextMenu": boolean;
/**
* Navigation title
*/
"navigationTitle": string;
/**
* Open a overlay inside content area
* @param name
* @param component
* @param icon
* @param color
*/
"openOverlay": (name: string, component: HTMLElement, icon?: string, color?: string) => Promise<void>;
}
interface IxMapNavigationOverlay {
/**
* Color of icon
*/
"color": string;
/**
* Icon of overlay
*/
"icon": string;
/**
* Title of overlay
*/
"name": string;
}
interface IxMenu {
/**
* Should only be set if you use ix-menu standalone
*/
"applicationDescription": string;
/**
* Should only be set if you use ix-menu standalone
*/
"applicationName": string;
/**
* Internal
*/
"enableMapExpand": boolean;
/**
* Is settings tab is visible
*/
"enableSettings": boolean;
/**
* Show toggle between light and dark variant. Only if the provided theme have implemented both!
*/
"enableToggleTheme": boolean;
/**
* Expand menu
*/
"expand": boolean;
"i18nCollapse": string;
"i18nExpand": string;
"i18nLegal": string;
"i18nMore": string;
"i18nSettings": string;
"i18nToggleTheme": string;
/**
* Maximum number of menu items to show in case enough vertical space is available. Extra menu items will be collapsed to 'show more' menu item.
*/
"maxVisibleMenuItems": number;
/**
* Is about tab visible
*/
"showAbout": boolean;
/**
* Is settings tab visible
*/
"showSettings": boolean;
/**
* Toggle About tabs
* @param show
*/
"toggleAbout": (show: boolean) => Promise<void>;
/**
* Toggle map sidebar expand
* @param show
*/
"toggleMapExpand": (show?: boolean) => Promise<void>;
/**
* Toggle menu
* @param show
*/
"toggleMenu": (show?: boolean) => Promise<void>;
/**
* Toggle Settings tabs
* @param show
*/
"toggleSettings": (show: boolean) => Promise<void>;
}
interface IxMenuAbout {
/**
* Active tab
*/
"activeTabLabel": string;
"i18nImprintLabel": string;
/**
* Label of first tab
*/
"label": string;
/**
* Internal
*/
"show": boolean;
}
interface IxMenuAboutItem {
/**
* About Item label
*/
"label": string;
}
interface IxMenuAboutNews {
/**
* Subtitle of the about news
*/
"aboutItemLabel": string;
/**
* Internal
*/
"expanded": boolean;
"i18nShowMore": string;
/**
* Title of the about news
*/
"label": string;
/**
* Bottom offset
*/
"offsetBottom": number;
/**
* Show about news
*/
"show": boolean;
}
interface IxMenuAvatar {
/**
* Second line of text
*/
"bottom": string;
"i18nLogout": string;
/**
* First line of text
*/
"top": string;
}
interface IxMenuAvatarItem {
/**
* Avatar dropdown icon
*/
"icon": string;
/**
* Avatar dropdown label
*/
"label": string;
}
interface IxMenuItem {
/**
* State to display active
*/
"active": boolean;
/**
* Place tab on bottom
*/
"bottom": boolean;
/**
* Disable tab and remove event handlers
*/
"disabled": boolean;
/**
* Move the Tab to a top position.
*/
"home": boolean;
/**
* Show notification cound on tab
*/
"notifications": number;
/**
* Icon name from @siemens/ix-icons
*/
"tabIcon": string;
}
interface IxMenuSettings {
/**
* active tab
*/
"activeTabLabel": string;
/**
* Label
*/
"label": string;
/**
* Internal
*/
"show": boolean;
}
interface IxMenuSettingsItem {
/**
* Label
*/
"label": string;
}
interface IxMessageBar {
/**
* If true, close button is enabled and alert can be dismissed by the user
*/
"dismissible": boolean;
/**
* Specifies the type of the alert.
*/
"type": 'danger' | 'warning' | 'info';
}
interface IxModal {
/**
* Should the modal be animtated
*/
"animation": boolean;
"ariaDescribedBy": string;
"ariaLabelledBy": string;
/**
* Adds a dimming layer to the modal. This should only be used when it it necessary to focus the user's attention to the dialog content (e.g. errors, warnings, complex tasks).
*/
"backdrop": boolean | 'static';
/**
* Backdrop class
*/
"backdropClass": string;
/**
* BeforeDismiss callback
*/
"beforeDismiss": (reason?: any) => boolean | Promise<boolean>;
/**
* Centered modal
*/
"centered": boolean;
/**
* Close modal
* @param result
*/
"close": (result: any) => Promise<void>;
/**
* Content of modal
*/
"content": HTMLElement | string;
/**
* Dismiss modal instance
* @param reason
*/
"dismiss": (reason?: any) => Promise<void>;
/**
* Header title
*/
"headerTitle": string;
/**
* Optional icon displayed next to the title
*/
"icon": string;
/**
* Color of the header {@link icon}
*/
"iconColor": NotificationColor;
/**
* ESC close modal dialog
*/
"keyboard": boolean;
/**
* Modal dialog class
*/
"modalDialogClass": string;
/**
* Modal scollable
*/
"scrollable": boolean;
/**
* Modal size
*/
"size": 'sm' | 'lg' | 'xl';
/**
* Window class
*/
"windowClass": string;
}
interface IxModalContainer {
/**
* Display modal dialog
* @param config
*/
"showModal": (config: ModalConfig) => Promise<{ onClose: TypedEvent<any>; onDismiss: TypedEvent<any>; }>;
}
interface IxModalExample {
}
interface IxPill {
/**
* Align pill content left
*/
"alignLeft": boolean;
/**
* Custom color for pill. Only working for `variant='custom'`
*/
"background": string | undefined;
/**
* Custom font color for pill. Only working for `variant='custom'`
*/
"color": string | undefined;
/**
* Show icon
*/
"icon": string | undefined;
/**
* Show pill as outline
*/
"outline": boolean;
/**
* Pill variant
*/
"variant": | 'primary'
| 'alarm'
| 'critical'
| 'warning'
| 'info'
| 'neutral'
| 'success'
| 'custom';
}
interface IxSelect {
/**
* Show clear button
*/
"allowClear": boolean;
/**
* If true the select will be in disabled state
*/
"disabled": boolean;
/**
* Select is extendable
*/
"editable": boolean;
/**
* Input field placeholder
*/
"i18nPlaceholder": string;
/**
* Input field placeholder for editable select
*/
"i18nPlaceholderEditable": string;
/**
* Select list header
*/
"i18nSelectListHeader": string;
/**
* Selection mode
*/
"mode": 'single' | 'multiple';
/**
* If true the select will be in readonly mode
*/
"readonly": boolean;
/**
* Indices of selected items
*/
"selectedIndices": string | string[];
}
interface IxSelectItem {
/**
* ***Internal***
*/
"hover": boolean;
/**
* Displayed name of the item
*/
"label": string;
/**
* Internal
* @param event