@skf-design-system/ui-components 1.0.0-beta.7 → 1.0.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/dist/components/accordion/accordion.component.js +3 -3
  2. package/dist/components/alert/alert.component.d.ts +2 -2
  3. package/dist/components/alert/alert.component.js +32 -32
  4. package/dist/components/breadcrumb/breadcrumb.component.d.ts +29 -0
  5. package/dist/components/breadcrumb/breadcrumb.d.ts +8 -0
  6. package/dist/components/breadcrumb/breadcrumb.styles.d.ts +1 -0
  7. package/dist/components/breadcrumb-item/breadcrumb-item.component.d.ts +25 -0
  8. package/dist/components/breadcrumb-item/breadcrumb-item.d.ts +8 -0
  9. package/dist/components/breadcrumb-item/breadcrumb-item.styles.d.ts +1 -0
  10. package/dist/components/button/button.component.d.ts +3 -1
  11. package/dist/components/button/button.component.js +60 -47
  12. package/dist/components/button/button.styles.js +64 -45
  13. package/dist/components/card/card.component.js +4 -4
  14. package/dist/components/checkbox/checkbox.component.js +4 -4
  15. package/dist/components/dialog/dialog.component.d.ts +0 -1
  16. package/dist/components/dialog/dialog.component.js +21 -23
  17. package/dist/components/divider/divider.component.js +12 -12
  18. package/dist/components/heading/heading.component.js +13 -13
  19. package/dist/components/icon/icon.component.d.ts +1 -4
  20. package/dist/components/icon/icon.component.js +32 -23
  21. package/dist/components/icon/icon.styles.js +53 -47
  22. package/dist/components/link/link.component.d.ts +1 -0
  23. package/dist/components/link/link.component.js +42 -42
  24. package/dist/components/loader/loader.component.js +19 -19
  25. package/dist/components/logo/logo.component.js +6 -6
  26. package/dist/components/menu/menu.component.d.ts +24 -0
  27. package/dist/components/menu/menu.component.js +18 -0
  28. package/dist/components/menu/menu.d.ts +8 -0
  29. package/dist/components/menu/menu.js +6 -0
  30. package/dist/components/menu/menu.styles.d.ts +1 -0
  31. package/dist/components/menu/menu.styles.js +11 -0
  32. package/dist/components/menu-item/menu-item.component.d.ts +25 -0
  33. package/dist/components/menu-item/menu-item.component.js +13 -0
  34. package/dist/components/menu-item/menu-item.d.ts +8 -0
  35. package/dist/components/menu-item/menu-item.js +6 -0
  36. package/dist/components/menu-item/menu-item.styles.d.ts +1 -0
  37. package/dist/components/menu-item/menu-item.styles.js +19 -0
  38. package/dist/components/popover/popover.component.d.ts +29 -0
  39. package/dist/components/popover/popover.component.js +37 -0
  40. package/dist/components/popover/popover.d.ts +8 -0
  41. package/dist/components/popover/popover.js +6 -0
  42. package/dist/components/popover/popover.styles.d.ts +1 -0
  43. package/dist/components/popover/popover.styles.js +12 -0
  44. package/dist/components/progress/progress.component.js +7 -7
  45. package/dist/components/radio/radio.component.js +4 -4
  46. package/dist/components/select/select.component.d.ts +8 -10
  47. package/dist/components/select/select.component.js +115 -118
  48. package/dist/components/select/select.controllers.d.ts +0 -25
  49. package/dist/components/select/select.controllers.js +35 -95
  50. package/dist/components/select-option-group/select-option-group.component.js +9 -9
  51. package/dist/components/stepper/stepper.component.d.ts +38 -0
  52. package/dist/components/stepper/stepper.component.js +91 -0
  53. package/dist/components/stepper/stepper.d.ts +8 -0
  54. package/dist/components/stepper/stepper.helpers.d.ts +16 -0
  55. package/dist/components/stepper/stepper.helpers.js +18 -0
  56. package/dist/components/stepper/stepper.js +6 -0
  57. package/dist/components/stepper/stepper.styles.d.ts +1 -0
  58. package/dist/components/stepper/stepper.styles.js +15 -0
  59. package/dist/components/stepper-item/stepper-item.component.d.ts +47 -0
  60. package/dist/components/stepper-item/stepper-item.component.js +113 -0
  61. package/dist/components/stepper-item/stepper-item.d.ts +8 -0
  62. package/dist/components/stepper-item/stepper-item.js +6 -0
  63. package/dist/components/stepper-item/stepper-item.styles.d.ts +1 -0
  64. package/dist/components/stepper-item/stepper-item.styles.js +98 -0
  65. package/dist/components/tab/tab.component.js +4 -4
  66. package/dist/components/tab-panel/tab-panel.component.js +12 -12
  67. package/dist/components/tag/tag.component.js +9 -9
  68. package/dist/components/textarea/textarea.component.js +3 -3
  69. package/dist/components/toast/toast.component.d.ts +7 -4
  70. package/dist/components/toast/toast.component.js +30 -26
  71. package/dist/components/toast/toast.singleton.d.ts +2 -7
  72. package/dist/components/toast/toast.singleton.js +25 -25
  73. package/dist/components/toast-item/toast-item.component.js +15 -15
  74. package/dist/components/toast-item/toast-item.styles.js +13 -11
  75. package/dist/components/toast-wrapper/toast-wrapper.component.js +10 -10
  76. package/dist/components/tooltip/tooltip.component.d.ts +24 -0
  77. package/dist/components/tooltip/tooltip.component.js +18 -0
  78. package/dist/components/tooltip/tooltip.d.ts +8 -0
  79. package/dist/components/tooltip/tooltip.js +6 -0
  80. package/dist/components/tooltip/tooltip.styles.d.ts +1 -0
  81. package/dist/components/tooltip/tooltip.styles.js +12 -0
  82. package/dist/custom-elements.json +2179 -1002
  83. package/dist/index.d.ts +6 -0
  84. package/dist/index.js +72 -54
  85. package/dist/internal/base-classes/popover/popover.base.d.ts +29 -0
  86. package/dist/internal/base-classes/popover/popover.base.js +116 -0
  87. package/dist/internal/base-classes/popover/popover.styles.d.ts +1 -0
  88. package/dist/internal/base-classes/popover/popover.styles.js +29 -0
  89. package/dist/internal/components/hint/hint.component.js +13 -13
  90. package/dist/internal/controllers/popover.controller.d.ts +16 -0
  91. package/dist/internal/controllers/popover.controller.js +44 -0
  92. package/dist/internal/helpers/hintSeverity.d.ts +1 -1
  93. package/dist/react/index.d.ts +10 -2
  94. package/dist/react/index.js +10 -2
  95. package/dist/react/skf-breadcrumb/index.d.ts +9 -0
  96. package/dist/react/skf-breadcrumb/index.js +17 -0
  97. package/dist/react/skf-breadcrumb-item/index.d.ts +3 -0
  98. package/dist/react/skf-breadcrumb-item/index.js +13 -0
  99. package/dist/react/skf-menu/index.d.ts +12 -0
  100. package/dist/react/skf-menu/index.js +18 -0
  101. package/dist/react/skf-menu-item/index.d.ts +27 -0
  102. package/dist/react/skf-menu-item/index.js +23 -0
  103. package/dist/react/skf-popover/index.d.ts +12 -0
  104. package/dist/react/skf-popover/index.js +18 -0
  105. package/dist/react/skf-stepper/index.d.ts +9 -0
  106. package/dist/react/skf-stepper/index.js +17 -0
  107. package/dist/react/skf-stepper-item/index.d.ts +9 -0
  108. package/dist/react/skf-stepper-item/index.js +17 -0
  109. package/dist/react/skf-tooltip/index.d.ts +12 -0
  110. package/dist/react/skf-tooltip/index.js +18 -0
  111. package/dist/types/jsx/custom-element-jsx.d.ts +594 -163
  112. package/dist/types/vue/index.d.ts +326 -74
  113. package/dist/vscode.html-custom-data.json +722 -390
  114. package/dist/web-types.json +836 -290
  115. package/package.json +33 -33
@@ -75,99 +75,13 @@ export type SkfAccordionProps = {
75
75
  truncate?: boolean | undefined;
76
76
  };
77
77
 
78
- export type SkfCardProps = {
79
- /** If true, removes border */
80
- "no-border"?: boolean;
81
- /** If true, removes padding */
82
- "no-padding"?: boolean;
83
- /** If true, the Card fills the parent element height */
84
- stretch?: boolean;
85
- };
86
-
87
- export type SkfCheckboxProps = {
88
- /** If true, sets disabled state */
89
- disabled?: boolean;
90
- /** If true, value is required or must be checked for the form to be submittable */
91
- required?: boolean;
92
- /** If defined, outputs helping hints in console */
93
- debug?: boolean | undefined;
94
- /** If true, outputs helping hints in console */
95
- checked?: boolean | undefined;
96
- /** If true, forces component to invalid state until removed */
97
- "custom-invalid"?: boolean | undefined;
98
- /** If true and the checkbox is unchecked, the checkbox will appear indeterminate */
99
- indeterminate?: boolean | undefined;
100
- /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
101
- label?: string | undefined;
102
- /** If defined, adds name to the input-element */
103
- name?: string | undefined;
104
- /** If defined, renders an alternative A11y text for the asterisk */
105
- "required-label"?: string | undefined;
106
- /** If defined, styles checkbox using provided severity */
107
- severity?: "alert" | "success" | "info" | "warning";
108
- /** If true, displays valid state after interaction */
109
- "show-valid"?: boolean | undefined;
110
- /** Size of the checkbox */
111
- size?: "sm" | "md";
112
- /** The current value of the input field */
113
- value?: string;
114
-
115
- /** {object} - When the value of the input changes */
116
- onchange?: (e: CustomEvent<never>) => void;
117
- };
118
-
119
- export type SkfCollapseProps = {
120
- /** If true, will animate the expand/collapse state */
121
- animated?: boolean;
122
- /** If true, will set the collapse to be expanded by default */
123
- expanded?: boolean;
124
- /** Heading for the collapse */
125
- heading?: string | undefined;
126
- /** Defines which heading element will be rendered */
127
- "heading-as"?: "h2" | "h3" | "h4";
128
- /** If true, renders the small version */
129
- small?: boolean;
130
- /** If true, will truncate the heading in collapsed state */
131
- truncate?: boolean;
132
-
133
- /** Event emitted when toggled */
134
- "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
135
- };
136
-
137
- export type SkfDialogProps = {
138
- /** If defined, sets the aria-label for the close button */
139
- "close-button-aria-label"?: string | undefined;
140
- /** Title for the modal/dialog */
141
- heading?: string | undefined;
142
- /** If true, makes the dialog stretch edge to edge on screen */
143
- fullscreen?: boolean;
144
- /** If true, removes the close button */
145
- "no-close-button"?: boolean;
146
- /** If defined, removes the inner padding */
147
- "no-padding"?: boolean;
148
- /** */
149
- open?: boolean | null | undefined;
150
- /** If provided, will run function on dialog close */
151
- onClose?: ((event: Event) => void) | null | undefined;
152
- /** Method that opens the dialog in modal state */
153
- showModal?: string;
154
- /** Method that closes the dialog */
155
- close?: string;
156
- /** Fires when the dialog is opened (after transitioned in) */
157
- "onskf-dialog-open"?: (e: CustomEvent<never>) => void;
158
- /** Fires when the dialog is closed (before transitioned out) */
159
- "onskf-dialog-close"?: (e: CustomEvent<never>) => void;
160
- /** Fires when the dialog is closed (after transitioned out) */
161
- onclose?: (e: CustomEvent<never>) => void;
162
- };
163
-
164
78
  export type SkfAlertProps = {
165
- /** If true, alert is being used as a toast (alertdialog) with an close button */
166
- closeable?: boolean | undefined;
167
79
  /** Close button aria-label */
168
80
  "button-label"?: string;
169
81
  /** If defined, displays leading icon */
170
82
  icon?: SkfIcon["name"] | undefined;
83
+ /** If true, renders with an close button and sets aria-role to `status` */
84
+ persistent?: boolean | undefined;
171
85
  /** If defined, gives the supplied appearance */
172
86
  severity?: "error" | "info" | "warning" | "success" | "alert";
173
87
 
@@ -175,13 +89,21 @@ export type SkfAlertProps = {
175
89
  "onskf-alert-close"?: (e: CustomEvent<never>) => void;
176
90
  };
177
91
 
178
- export type SkfDividerProps = {
179
- /** Defines the Divider color */
180
- color?: "emphasised" | "primary" | "secondary" | "tertiary" | "inverse";
181
- /** If true, renders a div for presentational purpose instead of the semantic hr-element */
182
- decorative?: boolean;
183
- /** If true, renders the divider vertically */
184
- vertical?: boolean;
92
+ export type SkfBreadcrumbProps = {
93
+ /** aria-label for the breadcrumb control */
94
+ label?: string;
95
+ /** Displays an alternative size */
96
+ size?: "md" | "sm";
97
+
98
+ /** Fired when the item is clicked */
99
+ onclick?: (e: CustomEvent<never>) => void;
100
+ };
101
+
102
+ export type SkfBreadcrumbItemProps = {
103
+ /** If defined, loads url on click */
104
+ href?: string | undefined;
105
+ /** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
106
+ onClick?: string;
185
107
  };
186
108
 
187
109
  export type SkfButtonProps = {
@@ -342,6 +264,8 @@ export type SkfButtonProps = {
342
264
  | "warningDiamond"
343
265
  | "zoomIn"
344
266
  | "zoomOut";
267
+ /** If true, removes border */
268
+ iconOnly?: boolean;
345
269
  /** If provided, determines the positioning of the icon in relation to the text */
346
270
  "icon-position"?: "left" | "right" | undefined;
347
271
  /** If true, hides text & icon and shows loading indicator. **Notice!** Only applicable if `variant` is `primary`. */
@@ -353,12 +277,107 @@ export type SkfButtonProps = {
353
277
  /** If provided, changes the button type */
354
278
  type?: "button" | "submit" | "reset";
355
279
  /** If provided, alters the appearance */
356
- variant?: "primary" | "secondary";
280
+ variant?: "primary" | "secondary" | "tertiary";
357
281
 
358
282
  /** Fires when the button is clicked */
359
283
  onclick?: (e: CustomEvent<never>) => void;
360
284
  };
361
285
 
286
+ export type SkfCardProps = {
287
+ /** If true, removes border */
288
+ "no-border"?: boolean;
289
+ /** If true, removes padding */
290
+ "no-padding"?: boolean;
291
+ /** If true, the Card fills the parent element height */
292
+ stretch?: boolean;
293
+ };
294
+
295
+ export type SkfCheckboxProps = {
296
+ /** If true, sets disabled state */
297
+ disabled?: boolean;
298
+ /** If true, value is required or must be checked for the form to be submittable */
299
+ required?: boolean;
300
+ /** If defined, outputs helping hints in console */
301
+ debug?: boolean | undefined;
302
+ /** If true, outputs helping hints in console */
303
+ checked?: boolean | undefined;
304
+ /** If true, forces component to invalid state until removed */
305
+ "custom-invalid"?: boolean | undefined;
306
+ /** If true and the checkbox is unchecked, the checkbox will appear indeterminate */
307
+ indeterminate?: boolean | undefined;
308
+ /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
309
+ label?: string | undefined;
310
+ /** If defined, adds name to the input-element */
311
+ name?: string | undefined;
312
+ /** If defined, renders an alternative A11y text for the asterisk */
313
+ "required-label"?: string | undefined;
314
+ /** If defined, styles checkbox using provided severity */
315
+ severity?: "alert" | "success" | "info" | "warning";
316
+ /** If true, displays valid state after interaction */
317
+ "show-valid"?: boolean | undefined;
318
+ /** Size of the checkbox */
319
+ size?: "sm" | "md";
320
+ /** The current value of the input field */
321
+ value?: string;
322
+
323
+ /** {object} - When the value of the input changes */
324
+ onchange?: (e: CustomEvent<never>) => void;
325
+ };
326
+
327
+ export type SkfCollapseProps = {
328
+ /** If true, will animate the expand/collapse state */
329
+ animated?: boolean;
330
+ /** If true, will set the collapse to be expanded by default */
331
+ expanded?: boolean;
332
+ /** Heading for the collapse */
333
+ heading?: string | undefined;
334
+ /** Defines which heading element will be rendered */
335
+ "heading-as"?: "h2" | "h3" | "h4";
336
+ /** If true, renders the small version */
337
+ small?: boolean;
338
+ /** If true, will truncate the heading in collapsed state */
339
+ truncate?: boolean;
340
+
341
+ /** Event emitted when toggled */
342
+ "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
343
+ };
344
+
345
+ export type SkfDialogProps = {
346
+ /** If defined, sets the aria-label for the close button */
347
+ "close-button-aria-label"?: string | undefined;
348
+ /** Title for the modal/dialog */
349
+ heading?: string | undefined;
350
+ /** If true, makes the dialog stretch edge to edge on screen */
351
+ fullscreen?: boolean;
352
+ /** If true, removes the close button */
353
+ "no-close-button"?: boolean;
354
+ /** If defined, removes the inner padding */
355
+ "no-padding"?: boolean;
356
+ /** */
357
+ open?: boolean | null | undefined;
358
+ /** If provided, will run function on dialog close */
359
+ onClose?: ((event: Event) => void) | null | undefined;
360
+ /** Method that opens the dialog in modal state */
361
+ showModal?: string;
362
+ /** Method that closes the dialog */
363
+ close?: string;
364
+ /** Fires when the dialog is opened (after transitioned in) */
365
+ "onskf-dialog-open"?: (e: CustomEvent<never>) => void;
366
+ /** Fires when the dialog is closed (before transitioned out) */
367
+ "onskf-dialog-close"?: (e: CustomEvent<never>) => void;
368
+ /** Fires when the dialog is closed (after transitioned out) */
369
+ onclose?: (e: CustomEvent<never>) => void;
370
+ };
371
+
372
+ export type SkfDividerProps = {
373
+ /** Defines the Divider color */
374
+ color?: "emphasised" | "primary" | "secondary" | "tertiary" | "inverse";
375
+ /** If true, renders a div for presentational purpose instead of the semantic hr-element */
376
+ decorative?: boolean;
377
+ /** If true, renders the divider vertically */
378
+ vertical?: boolean;
379
+ };
380
+
362
381
  export type SkfHeadingProps = {
363
382
  /** Controls which heading element will be rendered. Should not be used to affect appearance */
364
383
  as?: "h1" | "h2" | "h3" | "h4";
@@ -597,24 +616,249 @@ export type SkfInputProps = {
597
616
  | "range"
598
617
  | "reset"
599
618
  | "search"
600
- | "submit"
601
- | "tel"
602
- | "text"
603
- | "time"
604
- | "url"
605
- | "week";
606
- /** Sets validation start */
607
- "validate-on"?: "input" | "change" | "submit";
608
- /** The current value of the input field */
609
- value?: string;
619
+ | "submit"
620
+ | "tel"
621
+ | "text"
622
+ | "time"
623
+ | "url"
624
+ | "week";
625
+ /** Sets validation start */
626
+ "validate-on"?: "input" | "change" | "submit";
627
+ /** The current value of the input field */
628
+ value?: string;
629
+
630
+ /** Fires when the value of the input changes */
631
+ onchange?: (e: CustomEvent<never>) => void;
632
+ /** Fires when the input is invalid */
633
+ oninvalid?: (e: CustomEvent<never>) => void;
634
+ };
635
+
636
+ export type SkfLinkProps = {
637
+ /** Defines the semantic element to render */
638
+ as?: "button" | "a";
639
+ /** Defines the text-color */
640
+ color?: "primary" | "inverse";
641
+ /** If true, disables the link */
642
+ disabled?: boolean | undefined;
643
+ /** If defined, downloads the url */
644
+ download?: string | undefined;
645
+ /** If defined, loads url on click */
646
+ href?: string | undefined;
647
+ /** If defined, renders an icon before or after the text */
648
+ icon?:
649
+ | "arrowDown"
650
+ | "arrowDownUp"
651
+ | "arrowLeft"
652
+ | "arrowRight"
653
+ | "arrowUp"
654
+ | "article"
655
+ | "artificialIntelligence"
656
+ | "asset"
657
+ | "attachment"
658
+ | "bandCursor"
659
+ | "bands"
660
+ | "batteryEmpty"
661
+ | "batteryFull"
662
+ | "batteryLow"
663
+ | "bearingFault"
664
+ | "book"
665
+ | "bulb"
666
+ | "burger"
667
+ | "cPM"
668
+ | "calendar"
669
+ | "calendarBooked"
670
+ | "calendarEmpty"
671
+ | "calendarNotBooked"
672
+ | "calendarRecurring"
673
+ | "caretDown"
674
+ | "caretUp"
675
+ | "caretUpDown"
676
+ | "chat"
677
+ | "check"
678
+ | "checkCircle"
679
+ | "checkSmall"
680
+ | "chevronDown"
681
+ | "chevronLeft"
682
+ | "chevronRight"
683
+ | "chevronUp"
684
+ | "chevronUpDown"
685
+ | "close"
686
+ | "closeAllFaults"
687
+ | "closeFault"
688
+ | "closeSmall"
689
+ | "columnGraph"
690
+ | "comment"
691
+ | "connection1"
692
+ | "connection2"
693
+ | "connection3"
694
+ | "connection4"
695
+ | "danger"
696
+ | "defectFrequencies"
697
+ | "defectFrequenciesAlternative"
698
+ | "doubleChevronLeft"
699
+ | "doubleChevronRight"
700
+ | "download"
701
+ | "draft"
702
+ | "draftFilled"
703
+ | "draftOutlined"
704
+ | "dragNDrop"
705
+ | "drop"
706
+ | "duplicate"
707
+ | "edit"
708
+ | "emailFilled"
709
+ | "emailOutlined"
710
+ | "exclamation"
711
+ | "eye"
712
+ | "eyeHidden"
713
+ | "eyeVisible"
714
+ | "filter"
715
+ | "forbidden"
716
+ | "fullScreen"
717
+ | "fullScreenExit"
718
+ | "functionalLocation"
719
+ | "harmonicCursor"
720
+ | "heatmap"
721
+ | "hierarchy"
722
+ | "history"
723
+ | "historyAlt"
724
+ | "hourglassFramedFilled"
725
+ | "hourglassFramedOutlined"
726
+ | "hourglassOutlined"
727
+ | "hz"
728
+ | "iMX"
729
+ | "image"
730
+ | "infoCircleFilled"
731
+ | "infoCircleOutlined"
732
+ | "integration"
733
+ | "kebab"
734
+ | "link"
735
+ | "listGroup"
736
+ | "listItem"
737
+ | "locationPin"
738
+ | "lock"
739
+ | "logOut"
740
+ | "meatballs"
741
+ | "microphone"
742
+ | "minus"
743
+ | "minusSmall"
744
+ | "noData"
745
+ | "o"
746
+ | "openInNew"
747
+ | "overlayBaseline"
748
+ | "pDF"
749
+ | "paper"
750
+ | "pause"
751
+ | "pieChart"
752
+ | "pin"
753
+ | "play"
754
+ | "plus"
755
+ | "powerOff"
756
+ | "printer"
757
+ | "proCollect"
758
+ | "recAction"
759
+ | "received"
760
+ | "refresh"
761
+ | "reorder"
762
+ | "replace"
763
+ | "reply"
764
+ | "rewalkableRoute"
765
+ | "routes"
766
+ | "search"
767
+ | "send"
768
+ | "sensorA"
769
+ | "sensorB"
770
+ | "settings"
771
+ | "sidebandCursor"
772
+ | "singleCursor"
773
+ | "spectrum"
774
+ | "starFilled"
775
+ | "starOutlined"
776
+ | "statusCircle"
777
+ | "stop"
778
+ | "structuralVibration"
779
+ | "sync"
780
+ | "timewave"
781
+ | "trash"
782
+ | "trend"
783
+ | "trendingUp"
784
+ | "undo"
785
+ | "unknownCircle"
786
+ | "unknownDiamond"
787
+ | "unlink"
788
+ | "unlock"
789
+ | "unscheduledAction"
790
+ | "upload"
791
+ | "user"
792
+ | "viewFull"
793
+ | "viewHorizontal"
794
+ | "viewVertical"
795
+ | "warning"
796
+ | "warningCircle"
797
+ | "warningDiamond"
798
+ | "zoomIn"
799
+ | "zoomOut";
800
+ /** Defines the position of the icon in relation to the text */
801
+ "icon-placement"?: "left" | "right";
802
+ /** If defined, describes the relationship between a linked resource and the current document */
803
+ rel?: string | undefined;
804
+ /** If defined, used on conjunction with onClick property, second argument */
805
+ route?: string | undefined;
806
+ /** If true, fills the parents horizontal axis */
807
+ stretch?: boolean;
808
+ /** If defined, specifies where to open the linked document */
809
+ target?: "_blank" | "_parent" | "_self" | "_top" | undefined;
810
+ /** Defines the type of button */
811
+ type?: "button" | "submit" | "reset";
812
+ /** If provided, custom function triggered by click where the second return parameter enables custom routing. */
813
+ onClick?: function;
814
+ };
610
815
 
611
- /** Fires when the value of the input changes */
612
- onchange?: (e: CustomEvent<never>) => void;
613
- /** Fires when the input is invalid */
614
- oninvalid?: (e: CustomEvent<never>) => void;
816
+ export type SkfLoaderProps = {
817
+ /** Defines the aria-label */
818
+ "aria-label"?: string;
819
+ /** If true, inverts the color (to be used on colored backgrounds) */
820
+ invert?: boolean;
821
+ /** Defines the size of the loader */
822
+ size?: "md" | "sm" | undefined;
823
+ /** */
824
+ role?: string;
825
+ /** */
826
+ ariaLive?: string;
615
827
  };
616
828
 
617
- export type SkfLinkProps = {
829
+ export type SkfLogoProps = {
830
+ /** Defines the title of the logo */
831
+ title?: string;
832
+ /** Defines the color of the logo */
833
+ color?: "primary" | "secondary" | "inverse";
834
+ };
835
+
836
+ export type SkfMenuProps = {
837
+ /** The placement of the menu */
838
+ placement?:
839
+ | "top"
840
+ | "right"
841
+ | "bottom"
842
+ | "left"
843
+ | "top-start"
844
+ | "top-end"
845
+ | "right-start"
846
+ | "right-end"
847
+ | "bottom-start"
848
+ | "bottom-end"
849
+ | "left-start"
850
+ | "left-end";
851
+ /** Whether the menu is open */
852
+ isOpen?: boolean;
853
+ /** The id of the element the menu will be anchored to */
854
+ anchor?: string;
855
+ /** Fired when the menu is opened */
856
+ onopen?: (e: CustomEvent<never>) => void;
857
+ /** Fired when the menu is closed */
858
+ onclose?: (e: CustomEvent<never>) => void;
859
+ };
860
+
861
+ export type SkfMenuItemProps = {
618
862
  /** Defines the semantic element to render */
619
863
  as?: "button" | "a";
620
864
  /** Defines the text-color */
@@ -792,26 +1036,51 @@ export type SkfLinkProps = {
792
1036
  type?: "button" | "submit" | "reset";
793
1037
  /** If provided, custom function triggered by click where the second return parameter enables custom routing. */
794
1038
  onClick?: function;
1039
+ /** Fired when something happens */
1040
+ "onmy-tag-my-event"?: (e: CustomEvent<CustomEvent>) => void;
1041
+ /** Fired when the component is clicked */
1042
+ onclick?: (e: CustomEvent<never>) => void;
1043
+ /** Fired when the mouse is over the component */
1044
+ onmouseover?: (e: CustomEvent<never>) => void;
1045
+ /** Fired when the mouse is out of the component */
1046
+ onmouseout?: (e: CustomEvent<never>) => void;
1047
+ /** Fired when the component is focused */
1048
+ onfocus?: (e: CustomEvent<never>) => void;
1049
+ /** Fired when the component is blurred */
1050
+ onblur?: (e: CustomEvent<never>) => void;
1051
+ /** Fired when the component's value changes */
1052
+ onchange?: (e: CustomEvent<never>) => void;
795
1053
  };
796
1054
 
797
- export type SkfLoaderProps = {
798
- /** Defines the aria-label */
799
- "aria-label"?: string;
800
- /** If true, inverts the color (to be used on colored backgrounds) */
801
- invert?: boolean;
802
- /** Defines the size of the loader */
803
- size?: "md" | "sm" | undefined;
804
- /** */
805
- role?: string;
1055
+ export type SkfPopoverProps = {
1056
+ /** If defined, sets a custom offset for the popover */
1057
+ offset?: number;
1058
+ /** If true, hides the arrow */
1059
+ hideArrow?: boolean;
806
1060
  /** */
807
- ariaLive?: string;
808
- };
809
-
810
- export type SkfLogoProps = {
811
- /** Defines the title of the logo */
812
- title?: string;
813
- /** Defines the color of the logo */
814
- color?: "primary" | "secondary" | "inverse";
1061
+ arrow?: boolean;
1062
+ /** The placement of the menu */
1063
+ placement?:
1064
+ | "top"
1065
+ | "right"
1066
+ | "bottom"
1067
+ | "left"
1068
+ | "top-start"
1069
+ | "top-end"
1070
+ | "right-start"
1071
+ | "right-end"
1072
+ | "bottom-start"
1073
+ | "bottom-end"
1074
+ | "left-start"
1075
+ | "left-end";
1076
+ /** Whether the menu is open */
1077
+ isOpen?: boolean;
1078
+ /** The id of the element the menu will be anchored to */
1079
+ anchor?: string;
1080
+ /** Fired when the menu is opened */
1081
+ onopen?: (e: CustomEvent<never>) => void;
1082
+ /** Fired when the menu is closed */
1083
+ onclose?: (e: CustomEvent<never>) => void;
815
1084
  };
816
1085
 
817
1086
  export type SkfProgressProps = {
@@ -934,6 +1203,29 @@ export type SkfSelectOptionGroupProps = {
934
1203
  label?: string;
935
1204
  };
936
1205
 
1206
+ export type SkfStepperProps = {
1207
+ /** Sets the active item */
1208
+ activeIndex?: number;
1209
+ /** If true, sets linear mode (user can't go back to completed steps due to dependencies) */
1210
+ linear?: boolean;
1211
+
1212
+ /** Dispatched when the stepper item is selected */
1213
+ "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
1214
+ };
1215
+
1216
+ export type SkfStepperItemProps = {
1217
+ /** If defined, gives the supplied appearance */
1218
+ state?: Extract<SkfStepperItemState, "active" | "completed"> | undefined;
1219
+ /** If true, item marked as completed */
1220
+ completed?: boolean;
1221
+ /** */
1222
+ _setInternalState?: string;
1223
+ /** */
1224
+ role?: string;
1225
+ /** Dispatched when the stepper item is selected */
1226
+ "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
1227
+ };
1228
+
937
1229
  export type SkfSwitchProps = {
938
1230
  /** If true, sets disabled state */
939
1231
  disabled?: boolean;
@@ -1209,12 +1501,14 @@ export type SkfTextAreaProps = {
1209
1501
  };
1210
1502
 
1211
1503
  export type SkfToastProps = {
1212
- /** If provided, adds a close button to the toast and will not disapear until user actively dismisses it. */
1213
- closeable?: boolean;
1214
1504
  /** */
1215
1505
  debug?: boolean;
1216
- /** Severity of the toast. */
1217
- severity?: "info" | "success" | "warning" | "error";
1506
+ /** If defined, displays leading icon */
1507
+ icon?: SkfAlert["icon"] | undefined;
1508
+ /** If true, renders with an close button and sets aria-role to `status` */
1509
+ persistent?: SkfAlert["persistent"];
1510
+ /** If defined, gives the supplied appearance */
1511
+ severity?: SkfAlert["severity"];
1218
1512
  /** Time in seconds before the toast disappears. */
1219
1513
  timer?: number;
1220
1514
  /** offsets where toasts emerge vertically */
@@ -1226,6 +1520,33 @@ export type SkfToastWrapperProps = {
1226
1520
  debug?: boolean;
1227
1521
  };
1228
1522
 
1523
+ export type SkfTooltipProps = {
1524
+ /** */
1525
+ offset?: number;
1526
+ /** The placement of the dropdown */
1527
+ placement?:
1528
+ | "top"
1529
+ | "right"
1530
+ | "bottom"
1531
+ | "left"
1532
+ | "top-start"
1533
+ | "top-end"
1534
+ | "right-start"
1535
+ | "right-end"
1536
+ | "bottom-start"
1537
+ | "bottom-end"
1538
+ | "left-start"
1539
+ | "left-end";
1540
+ /** Whether the dropdown is open */
1541
+ isOpen?: boolean;
1542
+ /** The id of the element the dropdown will be anchored to */
1543
+ anchor?: string;
1544
+ /** Fired when the dropdown is opened */
1545
+ onopen?: (e: CustomEvent<never>) => void;
1546
+ /** Fired when the dropdown is closed */
1547
+ onclose?: (e: CustomEvent<never>) => void;
1548
+ };
1549
+
1229
1550
  export type CustomElements = {
1230
1551
  /**
1231
1552
  * The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
@@ -1239,6 +1560,59 @@ export type CustomElements = {
1239
1560
  */
1240
1561
  "skf-accordion": Partial<SkfAccordionProps & BaseProps & BaseEvents>;
1241
1562
 
1563
+ /**
1564
+ * The `<skf-alert>` is a type of notification that appears in-line
1565
+ * ---
1566
+ *
1567
+ *
1568
+ * ### **Events:**
1569
+ * - **skf-alert-close** - Fires when the close button is clicked
1570
+ *
1571
+ * ### **Slots:**
1572
+ * - _default_ - Alert message. **Notice!** See design principles for approved content
1573
+ * - **link** - Slot for the link
1574
+ */
1575
+ "skf-alert": Partial<SkfAlertProps & BaseProps & BaseEvents>;
1576
+
1577
+ /**
1578
+ * The `<skf-breadcrumb>` component consists of multiple `<skf-breadcrumb-item>`, working together.
1579
+ * ---
1580
+ *
1581
+ *
1582
+ * ### **Events:**
1583
+ * - **click** - Fired when the item is clicked
1584
+ *
1585
+ * ### **Slots:**
1586
+ * - _default_ - One or more `<skf-breadcrumb-item>`
1587
+ */
1588
+ "skf-breadcrumb": Partial<SkfBreadcrumbProps & BaseProps & BaseEvents>;
1589
+
1590
+ /**
1591
+ * The `<skf-breadcrumb-item>` is used in conjunction with the `<skf-breadcrumb>` component
1592
+ * ---
1593
+ *
1594
+ *
1595
+ * ### **Slots:**
1596
+ * - _default_ - Label of the breadcrumb item
1597
+ */
1598
+ "skf-breadcrumb-item": Partial<SkfBreadcrumbItemProps & BaseProps & BaseEvents>;
1599
+
1600
+ /**
1601
+ * Component to be used in forms or for interactivity
1602
+ * ---
1603
+ *
1604
+ *
1605
+ * ### **Events:**
1606
+ * - **click** - Fires when the button is clicked
1607
+ *
1608
+ * ### **Methods:**
1609
+ * - **click()** - Simulates a click on the button.
1610
+ *
1611
+ * ### **Slots:**
1612
+ * - _default_ - The Primary content
1613
+ */
1614
+ "skf-button": Partial<SkfButtonProps & BaseProps & BaseEvents>;
1615
+
1242
1616
  /**
1243
1617
  * The `<skf-card>` can be used to group related subjects in a container
1244
1618
  * ---
@@ -1293,7 +1667,6 @@ export type CustomElements = {
1293
1667
  *
1294
1668
  * ### **Slots:**
1295
1669
  * - _default_ - The dialog component's content
1296
- * - **heading** - The dialog component's heading
1297
1670
  * - **footer** - The dialog component's buttons goes here
1298
1671
  *
1299
1672
  * ### **CSS Properties:**
@@ -1302,20 +1675,6 @@ export type CustomElements = {
1302
1675
  */
1303
1676
  "skf-dialog": Partial<SkfDialogProps & BaseProps & BaseEvents>;
1304
1677
 
1305
- /**
1306
- * The `<skf-alert>` is a type of notification that appears in-line
1307
- * ---
1308
- *
1309
- *
1310
- * ### **Events:**
1311
- * - **skf-alert-close** - Fires when the close button is clicked
1312
- *
1313
- * ### **Slots:**
1314
- * - _default_ - Alert message. **Notice!** See design principles for approved content
1315
- * - **link** - Slot for the link
1316
- */
1317
- "skf-alert": Partial<SkfAlertProps & BaseProps & BaseEvents>;
1318
-
1319
1678
  /**
1320
1679
  * The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
1321
1680
  * ---
@@ -1327,22 +1686,6 @@ export type CustomElements = {
1327
1686
  */
1328
1687
  "skf-divider": Partial<SkfDividerProps & BaseProps & BaseEvents>;
1329
1688
 
1330
- /**
1331
- * Component to be used in forms or for interactivity
1332
- * ---
1333
- *
1334
- *
1335
- * ### **Events:**
1336
- * - **click** - Fires when the button is clicked
1337
- *
1338
- * ### **Methods:**
1339
- * - **click()** - Simulates a click on the button.
1340
- *
1341
- * ### **Slots:**
1342
- * - _default_ - The Primary content
1343
- */
1344
- "skf-button": Partial<SkfButtonProps & BaseProps & BaseEvents>;
1345
-
1346
1689
  /**
1347
1690
  * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
1348
1691
  * It extends the interface of native html `<h1>` to `<h4>` elements.
@@ -1402,6 +1745,54 @@ export type CustomElements = {
1402
1745
  */
1403
1746
  "skf-logo": Partial<SkfLogoProps & BaseProps & BaseEvents>;
1404
1747
 
1748
+ /**
1749
+ * The `<skf-menu>` is a component that displays a list of actions or options.
1750
+ * ---
1751
+ *
1752
+ *
1753
+ * ### **Events:**
1754
+ * - **open** - Fired when the menu is opened
1755
+ * - **close** - Fired when the menu is closed
1756
+ *
1757
+ * ### **Slots:**
1758
+ * - _default_ - The menu popover content
1759
+ */
1760
+ "skf-menu": Partial<SkfMenuProps & BaseProps & BaseEvents>;
1761
+
1762
+ /**
1763
+ * The `<skf-menu-item>` is a component that displays a list of actions or options.
1764
+ * ---
1765
+ *
1766
+ *
1767
+ * ### **Events:**
1768
+ * - **my-tag-my-event** - Fired when something happens
1769
+ * - **click** - Fired when the component is clicked
1770
+ * - **mouseover** - Fired when the mouse is over the component
1771
+ * - **mouseout** - Fired when the mouse is out of the component
1772
+ * - **focus** - Fired when the component is focused
1773
+ * - **blur** - Fired when the component is blurred
1774
+ * - **change** - Fired when the component's value changes
1775
+ *
1776
+ * ### **Slots:**
1777
+ * - _default_ - The component's main content
1778
+ * - **my-named-slot** - A named slot of the component
1779
+ */
1780
+ "skf-menu-item": Partial<SkfMenuItemProps & BaseProps & BaseEvents>;
1781
+
1782
+ /**
1783
+ * The `<skf-popover>` is a general purpose component that displays the slot content.
1784
+ * ---
1785
+ *
1786
+ *
1787
+ * ### **Events:**
1788
+ * - **open** - Fired when the menu is opened
1789
+ * - **close** - Fired when the menu is closed
1790
+ *
1791
+ * ### **Slots:**
1792
+ * - _default_ - The popover content
1793
+ */
1794
+ "skf-popover": Partial<SkfPopoverProps & BaseProps & BaseEvents>;
1795
+
1405
1796
  /**
1406
1797
  * The `<skf-progress>` element displays an indicator showing the completion progress of a task, typically displayed as a progress bar
1407
1798
  * ---
@@ -1463,6 +1854,32 @@ export type CustomElements = {
1463
1854
  */
1464
1855
  "skf-select-option-group": Partial<SkfSelectOptionGroupProps & BaseProps & BaseEvents>;
1465
1856
 
1857
+ /**
1858
+ * The `<skf-stepper>` is a component that displays a list of actions or options.
1859
+ * ---
1860
+ *
1861
+ *
1862
+ * ### **Events:**
1863
+ * - **skf-stepper-item-select** - Dispatched when the stepper item is selected
1864
+ *
1865
+ * ### **Slots:**
1866
+ * - _default_ - One or more `<skf-stepper-item>`
1867
+ */
1868
+ "skf-stepper": Partial<SkfStepperProps & BaseProps & BaseEvents>;
1869
+
1870
+ /**
1871
+ * The `<skf-stepper-item>` is used in conjunction with the `<skf-stepper>` component
1872
+ * ---
1873
+ *
1874
+ *
1875
+ * ### **Events:**
1876
+ * - **skf-stepper-item-select** - Dispatched when the stepper item is selected
1877
+ *
1878
+ * ### **Slots:**
1879
+ * - _default_ - Label of the stepper item
1880
+ */
1881
+ "skf-stepper-item": Partial<SkfStepperItemProps & BaseProps & BaseEvents>;
1882
+
1466
1883
  /**
1467
1884
  * The `<skf-switch>` is a component that displays a list of actions or options
1468
1885
  * ---
@@ -1551,4 +1968,18 @@ export type CustomElements = {
1551
1968
  * - _default_ - The alert components that the toast creates will render here.
1552
1969
  */
1553
1970
  "skf-toast-wrapper": Partial<SkfToastWrapperProps & BaseProps & BaseEvents>;
1971
+
1972
+ /**
1973
+ * The `<skf-tooltip>` is a component that displays a list of actions or options.
1974
+ * ---
1975
+ *
1976
+ *
1977
+ * ### **Events:**
1978
+ * - **open** - Fired when the dropdown is opened
1979
+ * - **close** - Fired when the dropdown is closed
1980
+ *
1981
+ * ### **Slots:**
1982
+ * - _default_ - The tooltip popover content
1983
+ */
1984
+ "skf-tooltip": Partial<SkfTooltipProps & BaseProps & BaseEvents>;
1554
1985
  };