-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathcomponents.d.ts
More file actions
6089 lines (6089 loc) · 249 KB
/
Copy pathcomponents.d.ts
File metadata and controls
6089 lines (6089 loc) · 249 KB
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 { AutocompleteTypes, DaisySize, Density, IAutocompleteItem, IAutocompleteNoResults, IInputFeedbackProp, ModusSize, Orientation, PopoverPlacement, TextFieldTypes, WeekStartDay } from "./components/types";
import { IBreadcrumb } from "./components/modus-wc-breadcrumbs/modus-wc-breadcrumbs";
import { ICollapseOptions } from "./components/modus-wc-collapse/modus-wc-collapse";
import { IInputFeedbackLevel } from "./components/modus-wc-input-feedback/modus-wc-input-feedback";
import { LoaderColor, LoaderVariant } from "./components/modus-wc-loader/modus-wc-loader";
import { LogoName } from "./components/modus-wc-logo/logo-constants";
import { INavbarTextOverrides, INavbarUserCard, INavbarVisibility } from "./components/modus-wc-navbar/modus-wc-navbar";
import { IAriaLabelValues, IPageChange } from "./components/modus-wc-pagination/modus-wc-pagination";
import { IRatingChange, ModusWcRatingVariant } from "./components/modus-wc-rating/modus-wc-rating";
import { ISelectOption } from "./components/modus-wc-select/modus-wc-select";
import { IStepperItem } from "./components/modus-wc-stepper/modus-wc-stepper";
import { IPaginationChangeEventDetail, ITableColumn } from "./components/modus-wc-table/modus-wc-table";
import { SortingState } from "@tanstack/table-core";
import { ITab } from "./components/modus-wc-tabs/modus-wc-tabs";
import { IThemeConfig } from "./providers/theme/theme.types";
import { ToastPosition } from "./components/modus-wc-toast/modus-wc-toast";
import { ITreeItemActions } from "./components/modus-wc-content-tree/modus-wc-tree-actions/modus-wc-tree-actions";
import { ITreeItemActions as ITreeItemActions1 } from "./components/modus-wc-content-tree/modus-wc-tree-actions/modus-wc-tree-actions";
import { TypographyHierarchy, TypographySize, TypographyWeight } from "./components/modus-wc-typography/modus-wc-typography";
export { AutocompleteTypes, DaisySize, Density, IAutocompleteItem, IAutocompleteNoResults, IInputFeedbackProp, ModusSize, Orientation, PopoverPlacement, TextFieldTypes, WeekStartDay } from "./components/types";
export { IBreadcrumb } from "./components/modus-wc-breadcrumbs/modus-wc-breadcrumbs";
export { ICollapseOptions } from "./components/modus-wc-collapse/modus-wc-collapse";
export { IInputFeedbackLevel } from "./components/modus-wc-input-feedback/modus-wc-input-feedback";
export { LoaderColor, LoaderVariant } from "./components/modus-wc-loader/modus-wc-loader";
export { LogoName } from "./components/modus-wc-logo/logo-constants";
export { INavbarTextOverrides, INavbarUserCard, INavbarVisibility } from "./components/modus-wc-navbar/modus-wc-navbar";
export { IAriaLabelValues, IPageChange } from "./components/modus-wc-pagination/modus-wc-pagination";
export { IRatingChange, ModusWcRatingVariant } from "./components/modus-wc-rating/modus-wc-rating";
export { ISelectOption } from "./components/modus-wc-select/modus-wc-select";
export { IStepperItem } from "./components/modus-wc-stepper/modus-wc-stepper";
export { IPaginationChangeEventDetail, ITableColumn } from "./components/modus-wc-table/modus-wc-table";
export { SortingState } from "@tanstack/table-core";
export { ITab } from "./components/modus-wc-tabs/modus-wc-tabs";
export { IThemeConfig } from "./providers/theme/theme.types";
export { ToastPosition } from "./components/modus-wc-toast/modus-wc-toast";
export { ITreeItemActions } from "./components/modus-wc-content-tree/modus-wc-tree-actions/modus-wc-tree-actions";
export { ITreeItemActions as ITreeItemActions1 } from "./components/modus-wc-content-tree/modus-wc-tree-actions/modus-wc-tree-actions";
export { TypographyHierarchy, TypographySize, TypographyWeight } from "./components/modus-wc-typography/modus-wc-typography";
export namespace Components {
/**
* A customizable accordion component used for showing and hiding related groups of content.
* The component supports a `<slot>` called 'content' for injecting `<modus-wc-collapse>` elements. See [Collapse](/docs/components-collapse--docs) docs for additional info.
*/
interface ModusWcAccordion {
/**
* Custom CSS class to apply to the inner div.
*/
"customClass"?: string;
}
/**
* A customizable alert component used to inform the user about important events.
* The component supports `<slot>` elements for injecting custom content and buttons.
*/
interface ModusWcAlert {
/**
* The description of the alert.
*/
"alertDescription"?: string;
/**
* The title of the alert.
*/
"alertTitle": string;
/**
* Custom CSS class to apply to the outer div element.
*/
"customClass"?: string;
/**
* Time taken to dismiss the alert in milliseconds
*/
"delay"?: number;
/**
* Whether the alert has a dismiss button
*/
"dismissible"?: boolean;
/**
* The Modus icon to render.
*/
"icon"?: string;
/**
* The variant of the alert.
*/
"variant"?: 'error' | 'info' | 'success' | 'warning';
}
/**
* A customizable autocomplete component used to create searchable text inputs.
* The component supports a `<slot>` for injecting custom content.
*/
interface ModusWcAutocomplete {
/**
* Indicates that the autocomplete should have a border.
*/
"bordered"?: boolean;
/**
* Clear the input value and reset items
*/
"clearInput": () => Promise<void>;
/**
* Programmatically close the menu
*/
"closeMenu": () => Promise<void>;
/**
* Custom blur handler - if provided, overrides default blur behavior
*/
"customBlur"?: (event: FocusEvent) => void;
/**
* Custom CSS class to apply to host element.
*/
"customClass"?: string;
/**
* Custom input change handler - if provided, overrides default search filtering
*/
"customInputChange"?: (value: string) => void;
/**
* Custom item selection handler - if provided, overrides default selection logic
*/
"customItemSelect"?: (item: IAutocompleteItem) => void;
/**
* Custom key down handler - if provided, overrides default keyboard navigation
*/
"customKeyDown"?: (event: KeyboardEvent) => void;
/**
* The debounce timeout in milliseconds. Set to 0 to disable debouncing.
*/
"debounceMs"?: number;
/**
* Whether the form control is disabled.
*/
"disabled"?: boolean;
/**
* Feedback state for the input field.
*/
"feedback"?: IInputFeedbackProp;
/**
* Programmatically set focus to input
*/
"focusInput": () => Promise<void>;
/**
* Show the clear button within the input field.
*/
"includeClear"?: boolean;
/**
* Show the search icon within the input field.
*/
"includeSearch"?: boolean;
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* Determine the control's relative ordering for sequential focus navigation (typically with the Tab key).
*/
"inputTabIndex"?: number;
/**
* The items to display in the menu. Creating a new array of items will ensure proper component re-render.
*/
"items"?: IAutocompleteItem[];
/**
* The text to display within the label.
*/
"label"?: string;
/**
* Whether the menu should remain open after an item is selected.
*/
"leaveMenuOpen"?: boolean;
/**
* Maximum number of chips to display. When exceeded, shows expand/collapse button. Set to -1 to disable limit.
*/
"maxChips"?: number;
/**
* The minimum number of characters required to render the menu.
*/
"minChars": number;
/**
* Minimum width for the text input in pixels. When chips would make input smaller, container height increases instead.
*/
"minInputWidth"?: number;
/**
* Whether the input allows multiple items to be selected.
*/
"multiSelect"?: boolean;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
*/
"name"?: string;
/**
* The content to display when no results are found.
*/
"noResults"?: IAutocompleteNoResults;
/**
* Programmatically open the menu
*/
"openMenu": () => Promise<void>;
/**
* Text that appears in the form control when it has no value set.
*/
"placeholder"?: string;
/**
* Whether the value is editable.
*/
"readOnly"?: boolean;
/**
* A value is required for the form to be submittable.
*/
"required"?: boolean;
/**
* Programmatically select an item
*/
"selectItem": (item: IAutocompleteItem | null) => Promise<void>;
/**
* Whether to show the menu whenever the input has focus, regardless of input value.
*/
"showMenuOnFocus"?: boolean;
/**
* A spinner that appears when set to true
*/
"showSpinner"?: boolean;
/**
* The size of the autocomplete (input and menu).
*/
"size"?: ModusSize;
/**
* Programmatically toggle the menu open/closed
*/
"toggleMenu": () => Promise<void>;
/**
* The value of the control.
*/
"value": string;
}
/**
* A customizable avatar component used to create avatars with different images or user initials.
* When no image is provided, the component can display initials (up to 3 characters) from the initials prop.
* The component will extract the first letter of each word in the initials string.
*/
interface ModusWcAvatar {
/**
* The image alt attribute for accessibility.
*/
"alt": string;
/**
* Custom CSS class to apply to the inner div.
*/
"customClass"?: string;
/**
* The location of the image.
*/
"imgSrc": string;
/**
* The initials to display when no image is provided.
*/
"initials"?: string;
/**
* The shape of the avatar.
*/
"shape"?: 'circle' | 'square';
/**
* The size of the avatar.
*/
"size"?: DaisySize;
}
/**
* A customizable badge component used to create badges with different sizes, types, and colors.
* The component supports a `<slot>` for injecting content within the badge.
*/
interface ModusWcBadge {
/**
* The color variant of the badge.
*/
"color": | 'primary'
| 'secondary'
| 'tertiary'
| 'high-contrast'
| 'success'
| 'warning'
| 'danger';
/**
* Custom CSS class to apply to the span element.
*/
"customClass": string;
/**
* The size of the badge.
*/
"size": ModusSize;
/**
* The variant of the badge.
*/
"variant": 'counter' | 'filled' | 'outlined' | 'text';
}
/**
* A customizable breadcrumbs component used to help users navigate through a website.
*/
interface ModusWcBreadcrumbs {
/**
* Custom CSS class to apply to the inner div.
*/
"customClass"?: string;
/**
* The breadcrumbs to render.
*/
"items": IBreadcrumb[];
/**
* The size of the breadcrumbs.
*/
"size"?: ModusSize;
}
/**
* A customizable button component used to create buttons with different sizes, variants, and types.
* The component supports a `<slot>` for injecting content within the button, similar to a native HTML button.
*/
interface ModusWcButton {
/**
* The color variant of the button.
*/
"color": 'primary' | 'secondary' | 'tertiary' | 'warning' | 'danger';
/**
* Custom CSS class to apply to the button element.
*/
"customClass"?: string;
/**
* If true, the button will be disabled.
*/
"disabled"?: boolean;
/**
* If true, the button will take the full width of its container.
*/
"fullWidth"?: boolean;
/**
* If true, the button will be in a pressed state (for toggle buttons).
*/
"pressed"?: boolean;
/**
* The shape of the button.
*/
"shape": 'circle' | 'ellipse' | 'rectangle' | 'square';
/**
* The size of the button.
*/
"size": DaisySize;
/**
* The type of the button.
*/
"type": 'button' | 'submit' | 'reset';
/**
* The variant of the button.
*/
"variant": 'borderless' | 'filled' | 'outlined';
}
/**
* A customizable buttongroup component that groups multiple Modus buttons together.
* The component supports a `<slot>` for injecting content within the buttongroup.
*/
interface ModusWcButtonGroup {
/**
* Color to apply to all buttons within the button group
*/
"color"?: 'primary' | 'secondary' | 'tertiary' | 'warning' | 'danger';
/**
* Disables all buttons within the button group
*/
"disabled"?: boolean;
/**
* Orientation of the button group: horizontal or vertical
*/
"orientation"?: Orientation;
/**
* Selection type for button group
*/
"selectionType"?: 'default' | 'single' | 'multiple';
/**
* Style variant to apply to all buttons within the button group
*/
"variant": 'borderless' | 'filled' | 'outlined';
}
/**
* A customizable card component used to group and display content in a way that is easily readable.
* This component supports multiple `<slot>` elements including 'header' for images or custom content, 'title', 'subtitle', a default slot for main content, 'actions' for buttons or interactive elements, and 'footer'.
*/
interface ModusWcCard {
/**
* Makes any \<figure> in the 'header' slot cover the background
*/
"backgroundFigure"?: boolean;
/**
* Adds a hard border to the card
*/
"bordered"?: boolean;
/**
* Custom CSS class to apply
*/
"customClass"?: string;
/**
* Determines how the card is laid out
*/
"layout"?: 'vertical' | 'horizontal';
/**
* Determines the interior padding size
*/
"padding"?: 'compact' | 'comfortable';
}
/**
* A customizable checkbox component
*/
interface ModusWcCheckbox {
/**
* Custom CSS class to apply to the inner div.
*/
"customClass"?: string;
/**
* The disabled state of the checkbox.
*/
"disabled"?: boolean;
/**
* The indeterminate state of the checkbox.
*/
"indeterminate": boolean;
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* The tabindex of the input.
*/
"inputTabIndex"?: number;
/**
* The text to display within the label.
*/
"label"?: string;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
*/
"name"?: string;
/**
* A value is required for the form to be submittable.
*/
"required"?: boolean;
/**
* The size of the input.
*/
"size"?: ModusSize;
/**
* The value of the checkbox.
*/
"value": boolean;
}
/**
* A customizable chip component used to display information in a compact area
* The component supports a `<slot>` for injecting custom content such as avatar and icons.
*/
interface ModusWcChip {
/**
* Active state of chip.
*/
"active"?: boolean;
/**
* Custom CSS class to apply to the inner div.
*/
"customClass"?: string;
/**
* Whether the chip is disabled.
*/
"disabled"?: boolean;
/**
* Whether the chip has an error.
*/
"hasError"?: boolean;
/**
* The label to display in the chip.
*/
"label"?: string;
/**
* The shape of the chip: 'rectangle' (default) or 'circle'.
*/
"shape"?: 'rectangle' | 'circle';
/**
* Whether to show the close icon on right side of the chip.
*/
"showRemove"?: boolean;
/**
* The size of the chip.
*/
"size"?: ModusSize;
/**
* The variant of the chip.
*/
"variant"?: 'filled' | 'outline';
}
/**
* A customizable collapse component used for showing and hiding content.
* The component supports a 'header' and 'content' `<slot>` for injecting custom HTML.
*/
interface ModusWcCollapse {
/**
* Indicates that the component should have a border.
*/
"bordered"?: boolean;
/**
* A unique identifier used to set the id attributes of various elements.
*/
"collapseId"?: string;
/**
* Custom CSS class to apply to the outer div.
*/
"customClass"?: string;
/**
* Controls whether the collapse is expanded or not.
*/
"expanded"?: boolean;
/**
* Configuration options for rendering the pre-laid out collapse component. Do not set this prop if you intend to use the 'header' slot.
*/
"options"?: ICollapseOptions;
}
/**
* A customizable content tree component used to display hierarchical data in a tree structure.
*/
interface ModusWcContentTree {
/**
* Custom CSS class to apply to the component.
*/
"customClass"?: string;
/**
* If true, displays the action buttons (expand/collapse all, etc.).
*/
"includeActions"?: boolean;
/**
* If true, displays the search input to filter tree items.
*/
"includeSearch"?: boolean;
/**
* Placeholder text for the search input.
*/
"searchPlaceholder"?: string;
}
/**
* A customizable date picker component used to create date inputs.
* Adheres to WCAG 2.2 standards.
*/
interface ModusWcDate {
/**
* Indicates that the input should have a border.
*/
"bordered"?: boolean;
/**
* Custom CSS class to apply to the input.
*/
"customClass"?: string;
/**
* Whether the form control is disabled.
*/
"disabled"?: boolean;
/**
* Feedback to render below the input.
*/
"feedback"?: IInputFeedbackProp;
/**
* The date format for display and input.
*/
"format"?: | 'yyyy-mm-dd'
| 'dd-mm-yyyy'
| 'mm-dd-yyyy'
| 'yyyy/mm/dd'
| 'dd/mm/yyyy'
| 'mm/dd/yyyy'
| 'MMM DD, YYYY';
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* Determine the control's relative ordering for sequential focus navigation (typically with the Tab key).
*/
"inputTabIndex"?: number;
/**
* The text to display within the label.
*/
"label"?: string;
/**
* Maximum date value.
*/
"max"?: string;
/**
* Minimum date value.
*/
"min"?: string;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
*/
"name"?: string;
/**
* Whether the value is editable.
*/
"readOnly"?: boolean;
/**
* A value is required or must be checked for the form to be submittable.
*/
"required"?: boolean;
/**
* Displays ISO 8601 week numbers in the calendar.Week numbers are calculated with Monday as the first day of the week.
*/
"showWeekNumbers"?: boolean;
/**
* The size of the input.
*/
"size"?: ModusSize;
/**
* The value of the control.
*/
"value": string;
/**
* The first day of the week for the calendar display
*/
"weekStartDay"?: WeekStartDay;
}
/**
* A customizable divider component used to separate content horizontally or vertically
*/
interface ModusWcDivider {
/**
* The color of the divider line.
*/
"color"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'high-contrast'
| 'success'
| 'warning'
| 'danger';
/**
* The content to display in the divider.
*/
"content"?: string;
/**
* Custom CSS class to apply to the divider element.
*/
"customClass"?: string;
/**
* The orientation of the divider. This is in reference to how content will be rendered around the divider.
*/
"orientation"?: Orientation;
/**
* The position of the divider.
*/
"position"?: 'center' | 'end' | 'start';
/**
* Whether the divider is responsive or not.
*/
"responsive"?: boolean;
}
/**
* A customizable dropdown menu component used to render a button and toggleable menu.
* The component supports a 'button' and 'menu' `<slot>` for injecting custom HTML content.
*/
interface ModusWcDropdownMenu {
/**
* The aria-label for the dropdown button.
*/
"buttonAriaLabel"?: string;
/**
* The color variant of the button.
*/
"buttonColor"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'warning'
| 'danger';
/**
* The size of the button.
*/
"buttonSize"?: DaisySize;
/**
* The variant of the button.
*/
"buttonVariant"?: 'borderless' | 'filled' | 'outlined';
/**
* Custom CSS class to apply to the host element.
*/
"customClass"?: string;
/**
* If true, the button will be disabled.
*/
"disabled"?: boolean;
/**
* Indicates that the menu should have a border.
*/
"menuBordered"?: boolean;
/**
* Distance between the button and menu in pixels.
*/
"menuOffset"?: number;
/**
* The placement of the menu relative to the button.
*/
"menuPlacement"?: PopoverPlacement;
/**
* The size of the menu.
*/
"menuSize"?: ModusSize;
/**
* Indicates that the menu is visible.
*/
"menuVisible": boolean;
}
/**
* File dropzone component that allows users to drag and drop files for upload.
* The component supports a `<slot>` called 'dropzone' for adding custom content such as progress indicators or additional instructions within the dropzone area.
*/
interface ModusWcFileDropzone {
/**
* Accepted file types (e.g. '.jpg,.png' or 'image/*')
*/
"acceptFileTypes"?: string;
/**
* Custom CSS class to apply to the file dropzone element
*/
"customClass"?: string;
/**
* Disable the file input
*/
"disabled"?: boolean;
/**
* Custom instructions shown when files are dragged over the dropzone
*/
"fileDraggedOverInstructions"?: string;
/**
* Include state icon (upload, success, error)
*/
"includeStateIcon"?: boolean;
/**
* Custom instructions shown as the default dropzone message
*/
"instructions"?: string;
/**
* Custom error message displayed when an invalid file type is selected
*/
"invalidFileTypeMessage"?: string;
/**
* Maximum number of files allowed, will show error if exceeded
*/
"maxFileCount"?: number;
/**
* Maximum allowed length of filename, will show error if exceeded
*/
"maxFileNameLength"?: number;
/**
* Maximum total file size in bytes allowed, will show error if exceeded
*/
"maxTotalFileSizeBytes"?: number;
/**
* Allow multiple file selection
*/
"multiple"?: boolean;
/**
* Reset the dropzone to its initial state, clearing all error and success states
*/
"reset": () => Promise<void>;
/**
* Success message displayed when files are uploaded successfully
*/
"successMessage"?: string;
}
/**
* A draggable handle component for resizing adjacent elements
*/
interface ModusWcHandle {
/**
* The color of the button.
*/
"buttonColor"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'warning'
| 'danger';
/**
* The size of the button.
*/
"buttonSize"?: DaisySize;
/**
* The variant of the button.
*/
"buttonVariant"?: 'borderless' | 'filled' | 'outlined';
/**
* Custom CSS class to apply to the handle element.
*/
"customClass"?: string;
/**
* The initial split percentage for the left/top panel (1-100). The right/bottom panel gets the remaining percentage.
*/
"defaultSplit"?: number;
/**
* The density/spacing of the handle container (compact: 8px, comfortable: 12px, relaxed: 16px).
*/
"density"?: 'compact' | 'comfortable' | 'relaxed';
/**
* The left target element to resize (CSS selector or HTMLElement)
*/
"leftTarget"?: string | HTMLElement;
/**
* The orientation of the handle.
*/
"orientation"?: Orientation;
/**
* The right target element to resize (CSS selector or HTMLElement)
*/
"rightTarget"?: string | HTMLElement;
/**
* The size of the handle.
*/
"size"?: 'default' | 'lg' | 'xl' | '2xl';
/**
* The type of handle to display.
*/
"type"?: 'bar' | 'button';
}
/**
* A customizable icon component used to render Modus icons.
* <b>This component requires Modus icons to be installed in the host application. See [Modus Icon Usage](/docs/documentation-modus-icon-usage--docs) for steps.</b>
*/
interface ModusWcIcon {
/**
* Custom CSS class to apply to the i element.
*/
"customClass"?: string;
/**
* Indicates that the icon is decorative. When true, sets aria-hidden to hide the icon from screen readers.
*/
"decorative"?: boolean;
/**
* The icon name, should match the CSS class in the icon font.
*/
"name": string;
/**
* The icon size, can be "sm", "md", "lg" (a custom size can be specified in CSS). This adjusts the font size for the icon.
*/
"size"?: DaisySize;
/**
* The icon variant, can be "outlined" or "solid".
*/
"variant"?: 'outlined' | 'solid';
}
/**
* A customizable feedback component used to provide additional context related to form input interactions.
* <b>To use a custom icon, this component requires Modus icons to be installed in the host application. See [Modus Icon Usage](/docs/documentation-modus-icon-usage--docs) for steps.</b>
*/
interface ModusWcInputFeedback {
/**
* Custom CSS class to apply to the outer div element.
*/
"customClass"?: string;
/**
* The Modus icon to use instead of the pre-defined icons.
*/
"icon"?: string;
/**
* The level informs which icon and color that will be rendered.
*/
"level": IInputFeedbackLevel;
/**
* The message.
*/
"message"?: string;
/**
* The size of the feedback component.
*/
"size"?: ModusSize;
}
/**
* A customizable input label component.
* The component supports a `<slot>` for injecting additional custom content inside the label, such as icons or formatted text.
*/
interface ModusWcInputLabel {
/**
* Additional classes for custom styling.
*/
"customClass"?: string;
/**
* The `for` attribute of the label, matching the `id` of the associated input.
*/
"forId"?: string;
/**
* The text to display within the label.
*/
"labelText"?: string;
/**
* Whether the label indicates a required field.
*/
"required"?: boolean;
/**
* The size of the label.
*/
"size"?: ModusSize;
/**
* The text rendered beneath the label.
*/
"subLabelText"?: string;
}
/**
* A customizable loader component used to indicate the loading of content
*/
interface ModusWcLoader {
/**
* The color of the loader.
*/
"color": LoaderColor;
/**
* Custom CSS class to apply to the loader element.
*/
"customClass"?: string;
/**
* The size of the loader.
*/
"size": DaisySize;
/**
* The variant of the loader.
*/
"variant": LoaderVariant;
}
/**
* A component for displaying Trimble product logos with support for both fixed and scalable sizing.
* Provides consistent branding across applications with various product logo options.
*/
interface ModusWcLogo {
/**
* The alt text for accessibility. If not provided, defaults to the logo name.
*/
"alt"?: string;
/**
* Custom CSS class to apply to the logo container.
*/
"customClass"?: string;
/**
* Show emblem version (icon only) instead of full logo
*/
"emblem"?: boolean;
/**
* The name of the logo to display. Accepts values like 'trimble', 'viewpoint_field_view', etc.
*/
"name": LogoName;
}
/**
* A customizable menu component used to display a list of li elements vertically or horizontally.
* The component supports a `<slot>` for injecting custom li elements inside the ul element.
*/
interface ModusWcMenu {
/**
* Indicates that the menu should have a border.
*/
"bordered"?: boolean;
/**
* Custom CSS class to apply to the ul element.
*/
"customClass"?: string;
/**
* Indicates that this menu is a submenu (dropdown).
*/
"isSubMenu"?: boolean;
/**
* The orientation of the menu.
*/
"orientation"?: Orientation;
/**
* The size of the menu.
*/
"size"?: ModusSize;
}
/**
* A customizable menu item component used to display the item portion of a menu.
* This component supports a 'start-icon' `<slot>` that allows for custom icons to be placed at the beginning of the item.
*/
interface ModusWcMenuItem {
"bordered"?: boolean;
/**
* If true, renders a checkbox at the start of the menu item.
*/
"checkbox"?: boolean;
/**
* Public method to collapse the submenu if it's expanded
*/
"collapseSubmenu": () => Promise<void>;
/**
* Custom CSS class to apply to the li element.
*/
"customClass"?: string;
/**
* The disabled state of the menu item.
*/
"disabled"?: boolean;
/**
* The focused state of the menu item.
*/
"focused"?: boolean;
/**
* Whether this menu item has a collapsible submenu. When true, the item will show a caret and handle toggle behavior.
*/