/
components.d.ts
1110 lines (1110 loc) · 40.5 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";
export namespace Components {
interface FwButton {
/**
* Identifier of the theme based on which the button is styled.
*/
"color": "primary" | "secondary" | "danger" | "link" | "text";
/**
* Disables the button on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* Sets the button to a full-width block. If the attribute’s value is undefined, the value is set to false.
*/
"expand": boolean;
/**
* Size of the button.
*/
"size": "normal" | "mini" | "small";
/**
* Button type based on which actions are performed when the button is clicked.
*/
"type": "button" | "reset" | "submit";
}
interface FwCheckbox {
/**
* Sets the state of the checkbox to selected. If the attribute’s value is undefined, the value is set to false.
*/
"checked": boolean;
/**
* Disables the check box on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* Label displayed on the interface, for the check box.
*/
"label": string;
/**
* Identifier corresponding to the component, that is saved when the form data is saved.
*/
"value": string;
}
interface FwDatepicker {
/**
* Selected Date will be retured in the given date format
*/
"dateFormat": string;
/**
* From date that is selected in the date range picker mode
*/
"fromDate": string;
/**
* Maximum date that are allowed to select in the calender
*/
"maxDate": string;
/**
* Minimum date that are allowed to select in the calender
*/
"minDate": string;
/**
* Shows single date or date range picker based on mode
*/
"mode": string;
/**
* Placeholder to display in the input field
*/
"placeholder": string;
/**
* To date that is selected in the date range picker mode
*/
"toDate": string;
/**
* Value selected in the single date picker mode
*/
"value": any;
}
interface FwIcon {
/**
* Color in which the icon is displayed, specified as a standard CSS color or as a HEX code.
*/
"color": string;
/**
* Identifier of the icon. The attribute’s value must be a valid svg file in the repo of icons (assets/icons).
*/
"name": string;
/**
* Size of the icon, specified in number of pixels.
*/
"size": number;
}
interface FwInput {
/**
* Specifies whether the browser can display suggestions to autocomplete the text value.
*/
"autocomplete": "on" | "off";
/**
* Displays a right-justified clear icon in the text box. Clicking the icon clears the input text. If the attribute’s value is undefined, the value is set to false. For a read-only input box, the clear icon is not displayed unless a default value is specified for the input box.
*/
"clearInput": boolean;
/**
* Disables the component on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* Identifier of the icon that is displayed in the left side of the text box. The attribute’s value must be a valid svg file in the repo of icons (assets/icons).
*/
"iconLeft": string;
/**
* Identifier of the icon that is displayed in the right side of the text box. The attribute’s value must be a valid svg file in the repo of icons (assets/icons).
*/
"iconRight": string;
/**
* Label displayed on the interface, for the component.
*/
"label": string;
/**
* Maximum number of characters a user can enter in the text box.
*/
"maxlength"?: number;
/**
* Minimum number of characters a user must enter in the text box for the value to be valid.
*/
"minlength"?: number;
/**
* Name of the component, saved as part of form data.
*/
"name": string;
/**
* Text displayed in the text box before a user enters a value.
*/
"placeholder"?: string | null;
/**
* If true, the user cannot enter a value in the input box. If the attribute’s value is undefined, the value is set to false.
*/
"readonly": boolean;
/**
* Specifies the input box as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false.
*/
"required": boolean;
/**
* Sets focus on a specific `fw-input`. Use this method instead of the global `input.focus()`.
*/
"setFocus": () => Promise<void>;
/**
* Theme based on which the text box is styled.
*/
"state": "normal" | "warning" | "error";
/**
* Descriptive or instructional text displayed below the text box.
*/
"stateText": string;
/**
* Type of value accepted as the input value. If a user enters a value other than the specified type, the input box is not populated.
*/
"type": "text" | "number";
/**
* Default value displayed in the input box.
*/
"value"?: string | null;
}
interface FwLabel {
/**
* Theme based on which the label is styled.
*/
"color": "blue" | "red" | "green" | "yellow" | "grey" | "normal";
/**
* Display text in the label.
*/
"value": string;
}
interface FwRadio {
/**
* Sets the state to selected. If the attribute’s value is undefined, the value is set to false.
*/
"checked": boolean;
/**
* Disables the component on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* Label displayed on the interface, for the component.
*/
"label": string;
/**
* Name of the component, saved as part of form data.
*/
"name": string;
/**
* Identifier corresponding to the component, that is saved when the form data is saved.
*/
"value": string;
}
interface FwRadioGroup {
/**
* If true, a radio group can be saved without selecting any option. If an option is selected, the selection can be cleared. If the attribute’s value is undefined, the value is set to false.
*/
"allowEmpty": boolean;
/**
* Name of the component, saved as part of form data.
*/
"name": string;
/**
* Default option that is selected when the radio group is displayed on the interface. Must be a valid value corresponding to the fw-radio components used in the Radio Group.
*/
"value"?: any | null;
}
interface FwSelect {
/**
* Disables the component on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* If true, the user must select a value. The default value is not displayed.
*/
"forceSelect": boolean;
"getSelectedItem": () => Promise<any>;
/**
* Label displayed on the interface, for the component.
*/
"label": string;
/**
* Enables selection of multiple options. If the attribute’s value is undefined, the value is set to false.
*/
"multiple": boolean;
/**
* Name of the component, saved as part of form data.
*/
"name": string;
/**
* Text displayed in the list box before an option is selected.
*/
"placeholder"?: string | null;
/**
* If true, the user cannot modify the default value selected. If the attribute's value is undefined, the value is set to true.
*/
"readonly": boolean;
/**
* Specifies the select field as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false.
*/
"required": boolean;
/**
* Theme based on which the list box is styled.
*/
"state": "normal" | "warning" | "error";
/**
* Descriptive or instructional text displayed below the list box.
*/
"stateText": string;
/**
* Type of option accepted as the input value. If a user tries to enter an option other than the specified type, the list is not populated.
*/
"type": "text" | "number";
/**
* Value of the option that is displayed as the default selection, in the list box. Must be a valid value corresponding to the fw-select-option components used in Select.
*/
"value": any;
}
interface FwSelectOption {
/**
* Sets the state of the option to disabled. The selected option is disabled and greyed out. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* States that the option is an HTML value. If the attribute's value is undefined, the value is set to true.
*/
"html": boolean;
/**
* HTML content that is displayed as the option.
*/
"htmlContent"?: string;
/**
* Alternate text displayed on the interface, in place of the actual HTML content.
*/
"optionText": string;
/**
* Sets the state of the option to selected. The selected option is highlighted and a check mark is displayed next to it. If the attribute’s value is undefined, the value is set to false.
*/
"selected": boolean;
/**
* Value corresponding to the option, that is saved when the form data is saved.
*/
"value": string;
}
interface FwSpinner {
/**
* Color in which the loader is displayed, specified as a standard CSS color.
*/
"color": string;
/**
* Size of the loader.
*/
"size": "small" | "medium" | "large" | "default";
}
interface FwTab {
/**
* Message that is displayed when a user navigates away from a tab.
*/
"message": string;
/**
* Name of the tab displayed on the UI.
*/
"tabHeader": string;
}
interface FwTabs {
}
interface FwTag {
/**
* Sets the state of the tag to disabled. The close button is disabled. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": false;
/**
* Display text in the tag component.
*/
"text": string;
/**
* Value associated with the tag component, that is saved when the form data is saved.
*/
"value": string;
}
interface FwTextarea {
/**
* Width of the input box, specified as number of columns.
*/
"cols"?: number;
/**
* Disables the text area on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* Label displayed on the interface, for the component.
*/
"label": string;
/**
* Maximum number of characters a user can enter in the input box.
*/
"maxlength"?: number;
/**
* Minimum number of characters a user must enter in the input box for the value to be valid.
*/
"minlength"?: number;
/**
* Name of the component, saved as part of form data.
*/
"name": string;
/**
* Text displayed in the input box before a user enters a value.
*/
"placeholder"?: string | null;
/**
* If true, the user cannot enter a value in the input box. If the attribute’s value is undefined, the value is set to false.
*/
"readonly": boolean;
/**
* Specifies the input box as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false.
*/
"required": boolean;
/**
* Height of the input box, specified as number of rows.
*/
"rows"?: number;
/**
* Sets focus on a specific `fw-textarea`. Use this method instead of the global `input.focus()`.
*/
"setFocus": () => Promise<void>;
/**
* Theme based on which the input box is styled.
*/
"state": "normal" | "warning" | "error";
/**
* Descriptive or instructional text displayed below the input box.
*/
"stateText": string;
/**
* Default value displayed in the input box.
*/
"value"?: string | null;
/**
* Type of text wrapping used by the input box. If the value is hard, the text in the textarea is wrapped (contains line breaks) when the form data is saved. If the value is soft, the text in the textarea is saved as a single line, when the form data is saved.
*/
"wrap": "soft" | "hard";
}
interface FwTimepicker {
/**
* Format in which time values are populated in the list box. If the value is hh:mm p, the time values are in the 12-hour format. If the value is hh:mm, the time values are in the 24-hr format.
*/
"format": "hh:mm A" | "HH:mm";
/**
* Time interval between the values displayed in the list, specified in minutes.
*/
"interval": number;
/**
* Upper time-limit for the values displayed in the list. If this attribute’s value is in the hh:mm format, it is assumed to be hh:mm AM.
*/
"maxTime"?: string;
/**
* Lower time-limit for the values displayed in the list. If this attribute’s value is in the hh:mm format, it is assumed to be hh:mm AM.
*/
"minTime"?: string;
/**
* Time output value
*/
"value"?: string;
}
interface FwToggle {
/**
* Sets the selected state as the default state. If the attribute’s value is undefined, the value is set to false.
*/
"checked": boolean;
/**
* Specifies whether to disable the control on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled": boolean;
/**
* Name of the component, saved as part of the form data.
*/
"name": string;
/**
* Size of the input control.
*/
"size": "small" | "medium" | "large";
}
}
declare global {
interface HTMLFwButtonElement extends Components.FwButton, HTMLStencilElement {
}
var HTMLFwButtonElement: {
prototype: HTMLFwButtonElement;
new (): HTMLFwButtonElement;
};
interface HTMLFwCheckboxElement extends Components.FwCheckbox, HTMLStencilElement {
}
var HTMLFwCheckboxElement: {
prototype: HTMLFwCheckboxElement;
new (): HTMLFwCheckboxElement;
};
interface HTMLFwDatepickerElement extends Components.FwDatepicker, HTMLStencilElement {
}
var HTMLFwDatepickerElement: {
prototype: HTMLFwDatepickerElement;
new (): HTMLFwDatepickerElement;
};
interface HTMLFwIconElement extends Components.FwIcon, HTMLStencilElement {
}
var HTMLFwIconElement: {
prototype: HTMLFwIconElement;
new (): HTMLFwIconElement;
};
interface HTMLFwInputElement extends Components.FwInput, HTMLStencilElement {
}
var HTMLFwInputElement: {
prototype: HTMLFwInputElement;
new (): HTMLFwInputElement;
};
interface HTMLFwLabelElement extends Components.FwLabel, HTMLStencilElement {
}
var HTMLFwLabelElement: {
prototype: HTMLFwLabelElement;
new (): HTMLFwLabelElement;
};
interface HTMLFwRadioElement extends Components.FwRadio, HTMLStencilElement {
}
var HTMLFwRadioElement: {
prototype: HTMLFwRadioElement;
new (): HTMLFwRadioElement;
};
interface HTMLFwRadioGroupElement extends Components.FwRadioGroup, HTMLStencilElement {
}
var HTMLFwRadioGroupElement: {
prototype: HTMLFwRadioGroupElement;
new (): HTMLFwRadioGroupElement;
};
interface HTMLFwSelectElement extends Components.FwSelect, HTMLStencilElement {
}
var HTMLFwSelectElement: {
prototype: HTMLFwSelectElement;
new (): HTMLFwSelectElement;
};
interface HTMLFwSelectOptionElement extends Components.FwSelectOption, HTMLStencilElement {
}
var HTMLFwSelectOptionElement: {
prototype: HTMLFwSelectOptionElement;
new (): HTMLFwSelectOptionElement;
};
interface HTMLFwSpinnerElement extends Components.FwSpinner, HTMLStencilElement {
}
var HTMLFwSpinnerElement: {
prototype: HTMLFwSpinnerElement;
new (): HTMLFwSpinnerElement;
};
interface HTMLFwTabElement extends Components.FwTab, HTMLStencilElement {
}
var HTMLFwTabElement: {
prototype: HTMLFwTabElement;
new (): HTMLFwTabElement;
};
interface HTMLFwTabsElement extends Components.FwTabs, HTMLStencilElement {
}
var HTMLFwTabsElement: {
prototype: HTMLFwTabsElement;
new (): HTMLFwTabsElement;
};
interface HTMLFwTagElement extends Components.FwTag, HTMLStencilElement {
}
var HTMLFwTagElement: {
prototype: HTMLFwTagElement;
new (): HTMLFwTagElement;
};
interface HTMLFwTextareaElement extends Components.FwTextarea, HTMLStencilElement {
}
var HTMLFwTextareaElement: {
prototype: HTMLFwTextareaElement;
new (): HTMLFwTextareaElement;
};
interface HTMLFwTimepickerElement extends Components.FwTimepicker, HTMLStencilElement {
}
var HTMLFwTimepickerElement: {
prototype: HTMLFwTimepickerElement;
new (): HTMLFwTimepickerElement;
};
interface HTMLFwToggleElement extends Components.FwToggle, HTMLStencilElement {
}
var HTMLFwToggleElement: {
prototype: HTMLFwToggleElement;
new (): HTMLFwToggleElement;
};
interface HTMLElementTagNameMap {
"fw-button": HTMLFwButtonElement;
"fw-checkbox": HTMLFwCheckboxElement;
"fw-datepicker": HTMLFwDatepickerElement;
"fw-icon": HTMLFwIconElement;
"fw-input": HTMLFwInputElement;
"fw-label": HTMLFwLabelElement;
"fw-radio": HTMLFwRadioElement;
"fw-radio-group": HTMLFwRadioGroupElement;
"fw-select": HTMLFwSelectElement;
"fw-select-option": HTMLFwSelectOptionElement;
"fw-spinner": HTMLFwSpinnerElement;
"fw-tab": HTMLFwTabElement;
"fw-tabs": HTMLFwTabsElement;
"fw-tag": HTMLFwTagElement;
"fw-textarea": HTMLFwTextareaElement;
"fw-timepicker": HTMLFwTimepickerElement;
"fw-toggle": HTMLFwToggleElement;
}
}
declare namespace LocalJSX {
interface FwButton {
/**
* Identifier of the theme based on which the button is styled.
*/
"color"?: "primary" | "secondary" | "danger" | "link" | "text";
/**
* Disables the button on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* Sets the button to a full-width block. If the attribute’s value is undefined, the value is set to false.
*/
"expand"?: boolean;
/**
* Triggered when the button loses focus.
*/
"onFwBlur"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the button is clicked.
*/
"onFwClick"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the button comes into focus.
*/
"onFwFocus"?: (event: CustomEvent<void>) => void;
/**
* Size of the button.
*/
"size"?: "normal" | "mini" | "small";
/**
* Button type based on which actions are performed when the button is clicked.
*/
"type"?: "button" | "reset" | "submit";
}
interface FwCheckbox {
/**
* Sets the state of the checkbox to selected. If the attribute’s value is undefined, the value is set to false.
*/
"checked"?: boolean;
/**
* Disables the check box on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* Label displayed on the interface, for the check box.
*/
"label"?: string;
/**
* Triggered when the check box loses focus.
*/
"onFwBlur"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the check box’s value is modified.
*/
"onFwChange"?: (event: CustomEvent<any>) => void;
/**
* Triggered when the check box comes into focus.
*/
"onFwFocus"?: (event: CustomEvent<void>) => void;
/**
* Identifier corresponding to the component, that is saved when the form data is saved.
*/
"value"?: string;
}
interface FwDatepicker {
/**
* Selected Date will be retured in the given date format
*/
"dateFormat"?: string;
/**
* From date that is selected in the date range picker mode
*/
"fromDate"?: string;
/**
* Maximum date that are allowed to select in the calender
*/
"maxDate"?: string;
/**
* Minimum date that are allowed to select in the calender
*/
"minDate"?: string;
/**
* Shows single date or date range picker based on mode
*/
"mode"?: string;
/**
* Triggered when the update button clicked
*/
"onFwChange"?: (event: CustomEvent<any>) => void;
/**
* Placeholder to display in the input field
*/
"placeholder"?: string;
/**
* To date that is selected in the date range picker mode
*/
"toDate"?: string;
/**
* Value selected in the single date picker mode
*/
"value"?: any;
}
interface FwIcon {
/**
* Color in which the icon is displayed, specified as a standard CSS color or as a HEX code.
*/
"color"?: string;
/**
* Identifier of the icon. The attribute’s value must be a valid svg file in the repo of icons (assets/icons).
*/
"name"?: string;
/**
* Size of the icon, specified in number of pixels.
*/
"size"?: number;
}
interface FwInput {
/**
* Specifies whether the browser can display suggestions to autocomplete the text value.
*/
"autocomplete"?: "on" | "off";
/**
* Displays a right-justified clear icon in the text box. Clicking the icon clears the input text. If the attribute’s value is undefined, the value is set to false. For a read-only input box, the clear icon is not displayed unless a default value is specified for the input box.
*/
"clearInput"?: boolean;
/**
* Disables the component on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* Identifier of the icon that is displayed in the left side of the text box. The attribute’s value must be a valid svg file in the repo of icons (assets/icons).
*/
"iconLeft"?: string;
/**
* Identifier of the icon that is displayed in the right side of the text box. The attribute’s value must be a valid svg file in the repo of icons (assets/icons).
*/
"iconRight"?: string;
/**
* Label displayed on the interface, for the component.
*/
"label"?: string;
/**
* Maximum number of characters a user can enter in the text box.
*/
"maxlength"?: number;
/**
* Minimum number of characters a user must enter in the text box for the value to be valid.
*/
"minlength"?: number;
/**
* Name of the component, saved as part of form data.
*/
"name"?: string;
/**
* Triggered when the input box loses focus.
*/
"onFwBlur"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the value in the input box is modified.
*/
"onFwChange"?: (event: CustomEvent<any>) => void;
/**
* Triggered when the input box comes into focus.
*/
"onFwFocus"?: (event: CustomEvent<void>) => void;
/**
* Triggered when a value is entered in the input box.
*/
"onFwInput"?: (event: CustomEvent<KeyboardEvent>) => void;
/**
* Text displayed in the text box before a user enters a value.
*/
"placeholder"?: string | null;
/**
* If true, the user cannot enter a value in the input box. If the attribute’s value is undefined, the value is set to false.
*/
"readonly"?: boolean;
/**
* Specifies the input box as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false.
*/
"required"?: boolean;
/**
* Theme based on which the text box is styled.
*/
"state"?: "normal" | "warning" | "error";
/**
* Descriptive or instructional text displayed below the text box.
*/
"stateText"?: string;
/**
* Type of value accepted as the input value. If a user enters a value other than the specified type, the input box is not populated.
*/
"type"?: "text" | "number";
/**
* Default value displayed in the input box.
*/
"value"?: string | null;
}
interface FwLabel {
/**
* Theme based on which the label is styled.
*/
"color"?: "blue" | "red" | "green" | "yellow" | "grey" | "normal";
/**
* Display text in the label.
*/
"value"?: string;
}
interface FwRadio {
/**
* Sets the state to selected. If the attribute’s value is undefined, the value is set to false.
*/
"checked"?: boolean;
/**
* Disables the component on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* Label displayed on the interface, for the component.
*/
"label"?: string;
/**
* Name of the component, saved as part of form data.
*/
"name"?: string;
/**
* Triggered when the radio button loses focus.
*/
"onFwBlur"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the radio button in focus is cleared.
*/
"onFwDeselect"?: (event: CustomEvent<any>) => void;
/**
* Triggered when the radio button comes into focus.
*/
"onFwFocus"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the radio button in focus is selected.
*/
"onFwSelect"?: (event: CustomEvent<any>) => void;
/**
* Identifier corresponding to the component, that is saved when the form data is saved.
*/
"value"?: string;
}
interface FwRadioGroup {
/**
* If true, a radio group can be saved without selecting any option. If an option is selected, the selection can be cleared. If the attribute’s value is undefined, the value is set to false.
*/
"allowEmpty"?: boolean;
/**
* Name of the component, saved as part of form data.
*/
"name"?: string;
/**
* Triggered when an option in the Radio Group is selected or deselected.
*/
"onFwChange"?: (event: CustomEvent<any>) => void;
/**
* Default option that is selected when the radio group is displayed on the interface. Must be a valid value corresponding to the fw-radio components used in the Radio Group.
*/
"value"?: any | null;
}
interface FwSelect {
/**
* Disables the component on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* If true, the user must select a value. The default value is not displayed.
*/
"forceSelect"?: boolean;
/**
* Label displayed on the interface, for the component.
*/
"label"?: string;
/**
* Enables selection of multiple options. If the attribute’s value is undefined, the value is set to false.
*/
"multiple"?: boolean;
/**
* Name of the component, saved as part of form data.
*/
"name"?: string;
/**
* Triggered when the list box loses focus.
*/
"onFwBlur"?: (event: CustomEvent<any>) => void;
/**
* Triggered when a value is selected or deselected from the list box options.
*/
"onFwChange"?: (event: CustomEvent<any>) => void;
/**
* Triggered when the list box comes into focus.
*/
"onFwFocus"?: (event: CustomEvent<any>) => void;
/**
* Text displayed in the list box before an option is selected.
*/
"placeholder"?: string | null;
/**
* If true, the user cannot modify the default value selected. If the attribute's value is undefined, the value is set to true.
*/
"readonly"?: boolean;
/**
* Specifies the select field as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false.
*/
"required"?: boolean;
/**
* Theme based on which the list box is styled.
*/
"state"?: "normal" | "warning" | "error";
/**
* Descriptive or instructional text displayed below the list box.
*/
"stateText"?: string;
/**
* Type of option accepted as the input value. If a user tries to enter an option other than the specified type, the list is not populated.
*/
"type"?: "text" | "number";
/**
* Value of the option that is displayed as the default selection, in the list box. Must be a valid value corresponding to the fw-select-option components used in Select.
*/
"value"?: any;
}
interface FwSelectOption {
/**
* Sets the state of the option to disabled. The selected option is disabled and greyed out. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* States that the option is an HTML value. If the attribute's value is undefined, the value is set to true.
*/
"html"?: boolean;
/**
* HTML content that is displayed as the option.
*/
"htmlContent"?: string;
/**
* Triggered when an option is selected.
*/
"onFwSelected"?: (event: CustomEvent<any>) => void;
/**
* Alternate text displayed on the interface, in place of the actual HTML content.
*/
"optionText"?: string;
/**
* Sets the state of the option to selected. The selected option is highlighted and a check mark is displayed next to it. If the attribute’s value is undefined, the value is set to false.
*/
"selected"?: boolean;
/**
* Value corresponding to the option, that is saved when the form data is saved.
*/
"value"?: string;
}
interface FwSpinner {
/**
* Color in which the loader is displayed, specified as a standard CSS color.
*/
"color"?: string;
/**
* Size of the loader.
*/
"size"?: "small" | "medium" | "large" | "default";
}
interface FwTab {
/**
* Message that is displayed when a user navigates away from a tab.
*/
"message"?: string;
/**
* Name of the tab displayed on the UI.
*/
"tabHeader"?: string;
}
interface FwTabs {
}
interface FwTag {
/**
* Sets the state of the tag to disabled. The close button is disabled. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: false;
/**
* Triggered when the tag is deselected.
*/
"onFwClosed"?: (event: CustomEvent<any>) => void;
/**
* Display text in the tag component.
*/
"text"?: string;
/**
* Value associated with the tag component, that is saved when the form data is saved.
*/
"value"?: string;
}
interface FwTextarea {
/**
* Width of the input box, specified as number of columns.
*/
"cols"?: number;
/**
* Disables the text area on the interface. If the attribute’s value is undefined, the value is set to false.
*/
"disabled"?: boolean;
/**
* Label displayed on the interface, for the component.
*/
"label"?: string;
/**
* Maximum number of characters a user can enter in the input box.
*/
"maxlength"?: number;
/**
* Minimum number of characters a user must enter in the input box for the value to be valid.
*/
"minlength"?: number;
/**
* Name of the component, saved as part of form data.
*/
"name"?: string;
/**
* Triggered when the input box loses focus.
*/
"onFwBlur"?: (event: CustomEvent<void>) => void;
/**
* Triggered when the value in the input box is modified.
*/
"onFwChange"?: (event: CustomEvent<any>) => void;
/**
* Triggered when the input box comes into focus.
*/
"onFwFocus"?: (event: CustomEvent<void>) => void;
/**
* Triggered when a value is entered in the input box.
*/
"onFwInput"?: (event: CustomEvent<KeyboardEvent>) => void;
/**
* Text displayed in the input box before a user enters a value.
*/
"placeholder"?: string | null;
/**
* If true, the user cannot enter a value in the input box. If the attribute’s value is undefined, the value is set to false.
*/
"readonly"?: boolean;
/**
* Specifies the input box as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false.
*/