@skf-design-system/ui-components 1.0.1-beta.1 → 1.0.2-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 (186) hide show
  1. package/README.md +1 -18
  2. package/dist/components/accordion/accordion.component.d.ts +4 -4
  3. package/dist/components/accordion/accordion.component.js +8 -8
  4. package/dist/components/alert/alert.component.d.ts +8 -9
  5. package/dist/components/alert/alert.component.js +7 -7
  6. package/dist/components/breadcrumb/breadcrumb.component.d.ts +1 -1
  7. package/dist/components/card/card.component.js +18 -30
  8. package/dist/components/card/card.styles.js +25 -28
  9. package/dist/components/checkbox/checkbox.component.d.ts +8 -8
  10. package/dist/components/checkbox/checkbox.component.js +3 -3
  11. package/dist/components/collapse/collapse.component.js +1 -1
  12. package/dist/components/date-picker/datepicker.calendar.component.d.ts +5 -0
  13. package/dist/components/date-picker/datepicker.calendar.component.js +128 -95
  14. package/dist/components/date-picker/datepicker.calendar.styles.js +35 -25
  15. package/dist/components/date-picker/datepicker.component.d.ts +5 -0
  16. package/dist/components/date-picker/datepicker.component.js +117 -97
  17. package/dist/components/date-picker/datepicker.helpers.d.ts +3 -2
  18. package/dist/components/date-picker/datepicker.helpers.js +46 -39
  19. package/dist/components/date-picker/datepicker.styles.js +14 -26
  20. package/dist/components/date-picker-input/datepicker-input.component.d.ts +13 -5
  21. package/dist/components/date-picker-input/datepicker-input.component.js +263 -219
  22. package/dist/components/date-picker-input/datepicker-input.helpers.d.ts +36 -2
  23. package/dist/components/date-picker-input/datepicker-input.helpers.js +25 -23
  24. package/dist/components/date-picker-input/datepicker-input.styles.js +6 -10
  25. package/dist/components/dialog/dialog.component.d.ts +18 -28
  26. package/dist/components/dialog/dialog.component.js +89 -79
  27. package/dist/components/divider/divider.component.d.ts +4 -8
  28. package/dist/components/divider/divider.component.js +24 -46
  29. package/dist/components/divider/divider.styles.js +34 -30
  30. package/dist/components/drawer/drawer.component.d.ts +57 -0
  31. package/dist/components/drawer/drawer.component.js +124 -0
  32. package/dist/components/drawer/drawer.d.ts +8 -0
  33. package/dist/components/drawer/drawer.js +6 -0
  34. package/dist/components/drawer/drawer.styles.d.ts +1 -0
  35. package/dist/components/drawer/drawer.styles.js +71 -0
  36. package/dist/components/header/header.component.d.ts +45 -0
  37. package/dist/components/header/header.component.js +110 -0
  38. package/dist/components/header/header.d.ts +8 -0
  39. package/dist/components/header/header.js +6 -0
  40. package/dist/components/header/header.styles.d.ts +1 -0
  41. package/dist/components/header/header.styles.js +68 -0
  42. package/dist/components/heading/heading.component.d.ts +6 -12
  43. package/dist/components/heading/heading.component.js +11 -11
  44. package/dist/components/heading/heading.styles.d.ts +1 -2
  45. package/dist/components/heading/heading.styles.js +1 -1
  46. package/dist/components/icon/icon.component.d.ts +1 -1
  47. package/dist/components/input/input.component.d.ts +2 -2
  48. package/dist/components/input/input.component.js +3 -3
  49. package/dist/components/input/input.controllers.d.ts +20 -6
  50. package/dist/components/input/input.controllers.js +14 -10
  51. package/dist/components/link/link.component.js +1 -0
  52. package/dist/components/link/link.styles.js +24 -20
  53. package/dist/components/menu/menu.component.d.ts +4 -5
  54. package/dist/components/menu/menu.component.js +1 -1
  55. package/dist/components/nav/nav.component.d.ts +17 -0
  56. package/dist/components/nav/nav.component.js +34 -0
  57. package/dist/components/nav/nav.d.ts +8 -0
  58. package/dist/components/nav/nav.js +6 -0
  59. package/dist/components/nav/nav.styles.d.ts +1 -0
  60. package/dist/components/nav/nav.styles.js +17 -0
  61. package/dist/components/nav-item/nav-item.component.d.ts +20 -0
  62. package/dist/components/nav-item/nav-item.component.js +38 -0
  63. package/dist/components/nav-item/nav-item.d.ts +8 -0
  64. package/dist/components/nav-item/nav-item.js +6 -0
  65. package/dist/components/nav-item/nav-item.styles.d.ts +1 -0
  66. package/dist/components/nav-item/nav-item.styles.js +39 -0
  67. package/dist/components/popover/popover.component.d.ts +5 -6
  68. package/dist/components/popover/popover.component.js +19 -19
  69. package/dist/components/radio/radio.component.d.ts +10 -6
  70. package/dist/components/radio/radio.component.js +10 -10
  71. package/dist/components/radio/radio.styles.d.ts +1 -2
  72. package/dist/components/radio/radio.styles.js +1 -1
  73. package/dist/components/segmented-button/segmented-button.component.d.ts +32 -0
  74. package/dist/components/segmented-button/segmented-button.d.ts +8 -0
  75. package/dist/components/segmented-button/segmented-button.styles.d.ts +1 -0
  76. package/dist/components/segmented-button-item/segmented-button-item.component.d.ts +36 -0
  77. package/dist/components/segmented-button-item/segmented-button-item.d.ts +8 -0
  78. package/dist/components/segmented-button-item/segmented-button-item.styles.d.ts +1 -0
  79. package/dist/components/select/select.component.js +2 -2
  80. package/dist/components/select/select.controllers.d.ts +20 -9
  81. package/dist/components/select/select.controllers.js +27 -22
  82. package/dist/components/select-option/select-option.controllers.d.ts +11 -5
  83. package/dist/components/stepper/stepper.component.d.ts +2 -1
  84. package/dist/components/stepper-item/stepper-item.component.js +2 -2
  85. package/dist/components/switch/switch.component.d.ts +7 -6
  86. package/dist/components/switch/switch.component.js +7 -7
  87. package/dist/components/tag/tag.component.d.ts +4 -2
  88. package/dist/components/tag/tag.component.js +6 -6
  89. package/dist/components/textarea/textarea.component.js +7 -7
  90. package/dist/components/toast/toast.component.d.ts +1 -1
  91. package/dist/components/tooltip/tooltip.component.d.ts +5 -6
  92. package/dist/components/tooltip/tooltip.component.js +11 -11
  93. package/dist/custom-elements.json +2477 -1745
  94. package/dist/index.d.ts +4 -0
  95. package/dist/index.js +82 -70
  96. package/dist/internal/base-classes/popover/popover.base.d.ts +17 -7
  97. package/dist/internal/base-classes/popover/popover.base.js +119 -75
  98. package/dist/internal/base-classes/popover/popover.styles.js +14 -1
  99. package/dist/internal/controllers/elementOverflowController.d.ts +13 -0
  100. package/dist/internal/controllers/popover.controller.d.ts +12 -7
  101. package/dist/internal/controllers/popover.controller.js +9 -14
  102. package/dist/internal/helpers/utilityTypes.d.ts +1 -1
  103. package/dist/internal/helpers/uuid.d.ts +15 -0
  104. package/dist/internal/helpers/uuid.js +14 -0
  105. package/dist/internal/storybook/styles.d.ts +1 -0
  106. package/dist/styles/form-field.styles.js +11 -6
  107. package/dist/styles/global.css +1 -1
  108. package/dist/types/jsx/custom-element-jsx.d.ts +642 -1261
  109. package/dist/types/vue/index.d.ts +422 -267
  110. package/dist/vscode.html-custom-data.json +805 -525
  111. package/dist/web-types.json +928 -653
  112. package/package.json +41 -51
  113. package/dist/react/index.d.ts +0 -36
  114. package/dist/react/index.js +0 -36
  115. package/dist/react/skf-accordion/index.d.ts +0 -3
  116. package/dist/react/skf-accordion/index.js +0 -13
  117. package/dist/react/skf-alert/index.d.ts +0 -9
  118. package/dist/react/skf-alert/index.js +0 -17
  119. package/dist/react/skf-breadcrumb/index.d.ts +0 -9
  120. package/dist/react/skf-breadcrumb/index.js +0 -17
  121. package/dist/react/skf-breadcrumb-item/index.d.ts +0 -3
  122. package/dist/react/skf-breadcrumb-item/index.js +0 -13
  123. package/dist/react/skf-button/index.d.ts +0 -9
  124. package/dist/react/skf-button/index.js +0 -17
  125. package/dist/react/skf-card/index.d.ts +0 -3
  126. package/dist/react/skf-card/index.js +0 -13
  127. package/dist/react/skf-checkbox/index.d.ts +0 -9
  128. package/dist/react/skf-checkbox/index.js +0 -17
  129. package/dist/react/skf-collapse/index.d.ts +0 -9
  130. package/dist/react/skf-collapse/index.js +0 -17
  131. package/dist/react/skf-datepicker/index.d.ts +0 -12
  132. package/dist/react/skf-datepicker/index.js +0 -18
  133. package/dist/react/skf-dialog/index.d.ts +0 -15
  134. package/dist/react/skf-dialog/index.js +0 -19
  135. package/dist/react/skf-divider/index.d.ts +0 -3
  136. package/dist/react/skf-divider/index.js +0 -13
  137. package/dist/react/skf-heading/index.d.ts +0 -3
  138. package/dist/react/skf-heading/index.js +0 -13
  139. package/dist/react/skf-icon/index.d.ts +0 -3
  140. package/dist/react/skf-icon/index.js +0 -13
  141. package/dist/react/skf-input/index.d.ts +0 -12
  142. package/dist/react/skf-input/index.js +0 -18
  143. package/dist/react/skf-link/index.d.ts +0 -3
  144. package/dist/react/skf-link/index.js +0 -13
  145. package/dist/react/skf-loader/index.d.ts +0 -3
  146. package/dist/react/skf-loader/index.js +0 -13
  147. package/dist/react/skf-logo/index.d.ts +0 -3
  148. package/dist/react/skf-logo/index.js +0 -13
  149. package/dist/react/skf-menu/index.d.ts +0 -12
  150. package/dist/react/skf-menu/index.js +0 -18
  151. package/dist/react/skf-menu-item/index.d.ts +0 -27
  152. package/dist/react/skf-menu-item/index.js +0 -23
  153. package/dist/react/skf-popover/index.d.ts +0 -12
  154. package/dist/react/skf-popover/index.js +0 -18
  155. package/dist/react/skf-progress/index.d.ts +0 -3
  156. package/dist/react/skf-progress/index.js +0 -13
  157. package/dist/react/skf-radio/index.d.ts +0 -9
  158. package/dist/react/skf-radio/index.js +0 -17
  159. package/dist/react/skf-select/index.d.ts +0 -21
  160. package/dist/react/skf-select/index.js +0 -21
  161. package/dist/react/skf-select-option/index.d.ts +0 -9
  162. package/dist/react/skf-select-option/index.js +0 -17
  163. package/dist/react/skf-select-option-group/index.d.ts +0 -3
  164. package/dist/react/skf-select-option-group/index.js +0 -13
  165. package/dist/react/skf-stepper/index.d.ts +0 -9
  166. package/dist/react/skf-stepper/index.js +0 -17
  167. package/dist/react/skf-stepper-item/index.d.ts +0 -9
  168. package/dist/react/skf-stepper-item/index.js +0 -17
  169. package/dist/react/skf-switch/index.d.ts +0 -3
  170. package/dist/react/skf-switch/index.js +0 -13
  171. package/dist/react/skf-tab/index.d.ts +0 -12
  172. package/dist/react/skf-tab/index.js +0 -18
  173. package/dist/react/skf-tab-group/index.d.ts +0 -3
  174. package/dist/react/skf-tab-group/index.js +0 -13
  175. package/dist/react/skf-tab-panel/index.d.ts +0 -3
  176. package/dist/react/skf-tab-panel/index.js +0 -13
  177. package/dist/react/skf-tag/index.d.ts +0 -3
  178. package/dist/react/skf-tag/index.js +0 -13
  179. package/dist/react/skf-textarea/index.d.ts +0 -12
  180. package/dist/react/skf-textarea/index.js +0 -18
  181. package/dist/react/skf-toast/index.d.ts +0 -3
  182. package/dist/react/skf-toast/index.js +0 -13
  183. package/dist/react/skf-toast-wrapper/index.d.ts +0 -3
  184. package/dist/react/skf-toast-wrapper/index.js +0 -13
  185. package/dist/react/skf-tooltip/index.d.ts +0 -12
  186. package/dist/react/skf-tooltip/index.js +0 -18
@@ -1,42 +1,80 @@
1
1
  import type { DefineComponent } from "vue";
2
2
 
3
+ import type { SkfIcon } from "../../components/icon/icon.component.js";
4
+ import type { SkfCollapse, CustomEvent } from "../../components/collapse/collapse.component.js";
3
5
  import type { SkfAccordion } from "../../components/accordion/accordion.component.js";
4
6
  import type { SkfAlert } from "../../components/alert/alert.component.js";
5
- import type { SkfBreadcrumb } from "../../components/breadcrumb/breadcrumb.component.js";
6
7
  import type { SkfBreadcrumbItem } from "../../components/breadcrumb-item/breadcrumb-item.component.js";
8
+ import type { SkfBreadcrumb } from "../../components/breadcrumb/breadcrumb.component.js";
9
+ import type { SkfLoader } from "../../components/loader/loader.component.js";
7
10
  import type { SkfButton } from "../../components/button/button.component.js";
8
11
  import type { SkfCard } from "../../components/card/card.component.js";
9
12
  import type { SkfCheckbox } from "../../components/checkbox/checkbox.component.js";
10
- import type { SkfCollapse, CustomEvent } from "../../components/collapse/collapse.component.js";
11
13
  import type { SkfDatePicker } from "../../components/datepicker/datepicker.component.js";
14
+ import type { SkfHeading } from "../../components/heading/heading.component.js";
12
15
  import type { SkfDialog } from "../../components/dialog/dialog.component.js";
13
16
  import type { SkfDivider } from "../../components/divider/divider.component.js";
14
- import type { SkfHeading } from "../../components/heading/heading.component.js";
15
- import type { SkfIcon } from "../../components/icon/icon.component.js";
17
+ import type { SkfDrawer } from "../../components/drawer/drawer.component.js";
18
+ import type { SkfLogo } from "../../components/logo/logo.component.js";
19
+ import type { SkfNav } from "../../components/nav/nav.component.js";
20
+ import type { SkfHeader } from "../../components/header/header.component.js";
16
21
  import type { SkfInput } from "../../components/input/input.component.js";
17
22
  import type { SkfLink } from "../../components/link/link.component.js";
18
- import type { SkfLoader } from "../../components/loader/loader.component.js";
19
- import type { SkfLogo } from "../../components/logo/logo.component.js";
20
23
  import type { SkfMenu } from "../../components/menu/menu.component.js";
21
24
  import type { SkfMenuItem, CustomEvent } from "../../components/menu-item/menu-item.component.js";
25
+ import type { SkfNavItem } from "../../components/nav-item/nav-item.component.js";
22
26
  import type { SkfPopover } from "../../components/popover/popover.component.js";
23
27
  import type { SkfProgress } from "../../components/progress/progress.component.js";
24
28
  import type { SkfRadio } from "../../components/radio/radio.component.js";
25
- import type { SkfSelect } from "../../components/select/select.component.js";
29
+ import type {
30
+ SkfSegmentedButtonItem,
31
+ CustomEvent,
32
+ } from "../../components/segmented-button-item/segmented-button-item.component.js";
33
+ import type { SkfSegmentedButton } from "../../components/segmented-button/segmented-button.component.js";
26
34
  import type { SkfSelectOption } from "../../components/select-option/select-option.component.js";
35
+ import type { SkfTag } from "../../components/tag/tag.component.js";
36
+ import type { SkfSelect } from "../../components/select/select.component.js";
27
37
  import type { SkfSelectOptionGroup } from "../../components/select-option-group/select-option-group.component.js";
28
- import type { SkfStepper } from "../../components/stepper/stepper.component.js";
29
38
  import type { SkfStepperItem } from "../../components/stepper-item/stepper-item.component.js";
39
+ import type { SkfStepper } from "../../components/stepper/stepper.component.js";
30
40
  import type { SkfSwitch } from "../../components/switch/switch.component.js";
31
- import type { SkfTab, CustomEvent } from "../../components/tab/tab.component.js";
32
- import type { SkfTabGroup } from "../../components/tab-group/tab-group.component.js";
33
41
  import type { SkfTabPanel } from "../../components/tab-panel/tab-panel.component.js";
34
- import type { SkfTag } from "../../components/tag/tag.component.js";
42
+ import type { SkfTabGroup } from "../../components/tab-group/tab-group.component.js";
43
+ import type { SkfTab, CustomEvent } from "../../components/tab/tab.component.js";
35
44
  import type { SkfTextArea } from "../../components/textarea/textarea.component.js";
36
- import type { SkfToast } from "../../components/toast/toast.component.js";
37
45
  import type { SkfToastWrapper } from "../../components/toast-wrapper/toast-wrapper.component.js";
46
+ import type { SkfToast } from "../../components/toast/toast.component.js";
38
47
  import type { SkfTooltip } from "../../components/tooltip/tooltip.component.js";
39
48
 
49
+ type SkfIconProps = {
50
+ /** Sets the color of the icon */
51
+ color?: SkfIcon["color"];
52
+ /** If defined, adds an alternate description to use for assistive devices */
53
+ label?: SkfIcon["label"];
54
+ /** Name of the icon to display */
55
+ name?: SkfIcon["name"];
56
+ /** Size of the icon */
57
+ size?: SkfIcon["size"];
58
+ };
59
+
60
+ type SkfCollapseProps = {
61
+ /** If true, will animate the expand/collapse state */
62
+ animated?: SkfCollapse["animated"];
63
+ /** If true, will set the collapse to be expanded by default */
64
+ expanded?: SkfCollapse["expanded"];
65
+ /** Heading for the collapse */
66
+ heading?: SkfCollapse["heading"];
67
+ /** Defines which heading element will be rendered */
68
+ "heading-as"?: SkfCollapse["headingAs"];
69
+ /** If true, renders the small version */
70
+ small?: SkfCollapse["small"];
71
+ /** If true, will truncate the heading in collapsed state */
72
+ truncate?: SkfCollapse["truncate"];
73
+
74
+ /** Event emitted when toggled */
75
+ "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
76
+ };
77
+
40
78
  type SkfAccordionProps = {
41
79
  /** If true, will animate the expand/collapse state */
42
80
  animated?: SkfAccordion["animated"];
@@ -66,6 +104,13 @@ type SkfAlertProps = {
66
104
  "onskf-alert-close"?: (e: CustomEvent<never>) => void;
67
105
  };
68
106
 
107
+ type SkfBreadcrumbItemProps = {
108
+ /** If defined, loads url on click */
109
+ href?: SkfBreadcrumbItem["href"];
110
+ /** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
111
+ onClick?: SkfBreadcrumbItem["onClick"];
112
+ };
113
+
69
114
  type SkfBreadcrumbProps = {
70
115
  /** aria-label for the breadcrumb control */
71
116
  label?: SkfBreadcrumb["label"];
@@ -76,11 +121,17 @@ type SkfBreadcrumbProps = {
76
121
  onclick?: (e: CustomEvent<never>) => void;
77
122
  };
78
123
 
79
- type SkfBreadcrumbItemProps = {
80
- /** If defined, loads url on click */
81
- href?: SkfBreadcrumbItem["href"];
82
- /** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
83
- onClick?: SkfBreadcrumbItem["onClick"];
124
+ type SkfLoaderProps = {
125
+ /** Defines the aria-label */
126
+ "aria-label"?: SkfLoader["ariaLabel"];
127
+ /** If true, inverts the color (to be used on colored backgrounds) */
128
+ invert?: SkfLoader["invert"];
129
+ /** Defines the size of the loader */
130
+ size?: SkfLoader["size"];
131
+ /** */
132
+ role?: SkfLoader["role"];
133
+ /** */
134
+ ariaLive?: SkfLoader["ariaLive"];
84
135
  };
85
136
 
86
137
  type SkfButtonProps = {
@@ -150,24 +201,6 @@ type SkfCheckboxProps = {
150
201
  onchange?: (e: CustomEvent<never>) => void;
151
202
  };
152
203
 
153
- type SkfCollapseProps = {
154
- /** If true, will animate the expand/collapse state */
155
- animated?: SkfCollapse["animated"];
156
- /** If true, will set the collapse to be expanded by default */
157
- expanded?: SkfCollapse["expanded"];
158
- /** Heading for the collapse */
159
- heading?: SkfCollapse["heading"];
160
- /** Defines which heading element will be rendered */
161
- "heading-as"?: SkfCollapse["headingAs"];
162
- /** If true, renders the small version */
163
- small?: SkfCollapse["small"];
164
- /** If true, will truncate the heading in collapsed state */
165
- truncate?: SkfCollapse["truncate"];
166
-
167
- /** Event emitted when toggled */
168
- "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
169
- };
170
-
171
204
  type SkfDatePickerProps = {
172
205
  /** The locale to use for formatting the date */
173
206
  locale?: SkfDatePicker["locale"];
@@ -193,6 +226,13 @@ type SkfDatePickerProps = {
193
226
  "onselected-date-range-changed"?: (e: CustomEvent<never>) => void;
194
227
  };
195
228
 
229
+ type SkfHeadingProps = {
230
+ /** Controls which heading element will be rendered. Should not be used to affect appearance */
231
+ as?: SkfHeading["as"];
232
+ /** If defined, changes the appearance of the heading */
233
+ "styled-as"?: SkfHeading["styledAs"];
234
+ };
235
+
196
236
  type SkfDialogProps = {
197
237
  /** If defined, sets the aria-label for the close button */
198
238
  "close-button-aria-label"?: SkfDialog["closeButtonAriaLabel"];
@@ -204,20 +244,15 @@ type SkfDialogProps = {
204
244
  "no-close-button"?: SkfDialog["noCloseButton"];
205
245
  /** If defined, removes the inner padding */
206
246
  "no-padding"?: SkfDialog["noPadding"];
207
- /** */
247
+ /** If true, indicates that the dialog is active and is available for interaction */
208
248
  open?: SkfDialog["open"];
209
- /** If provided, will run function on dialog close */
210
- onClose?: SkfDialog["onClose"];
211
- /** Method that opens the dialog in modal state */
212
- showModal?: SkfDialog["showModal"];
213
- /** Method that closes the dialog */
214
- close?: SkfDialog["close"];
249
+
215
250
  /** Fires when the dialog is opened (after transitioned in) */
216
- "onskf-dialog-open"?: (e: CustomEvent<never>) => void;
251
+ "onskf-dialog-opened"?: (e: CustomEvent<never>) => void;
217
252
  /** Fires when the dialog is closed (before transitioned out) */
218
- "onskf-dialog-close"?: (e: CustomEvent<never>) => void;
253
+ "onskf-dialog-closing"?: (e: CustomEvent<never>) => void;
219
254
  /** Fires when the dialog is closed (after transitioned out) */
220
- onclose?: (e: CustomEvent<never>) => void;
255
+ "onskf-dialog-closed"?: (e: CustomEvent<never>) => void;
221
256
  };
222
257
 
223
258
  type SkfDividerProps = {
@@ -229,22 +264,52 @@ type SkfDividerProps = {
229
264
  vertical?: SkfDivider["vertical"];
230
265
  };
231
266
 
232
- type SkfHeadingProps = {
233
- /** Controls which heading element will be rendered. Should not be used to affect appearance */
234
- as?: SkfHeading["as"];
235
- /** If provided, changes the appearance of the heading */
236
- "styled-as"?: SkfHeading["styledAs"];
267
+ type SkfDrawerProps = {
268
+ /** If defined, sets the aria-label for the close button */
269
+ "close-button-aria-label"?: SkfDrawer["closeButtonAriaLabel"];
270
+ /** Heading for the Drawer */
271
+ heading?: SkfDrawer["heading"];
272
+ /** Sets the max-width */
273
+ size?: SkfDrawer["size"];
274
+ /** If true, Drawer is open */
275
+ open?: SkfDrawer["open"];
276
+ /** Placement of the Drawer */
277
+ placement?: SkfDrawer["placement"];
278
+ /** */
279
+ _clickstartInDialog?: SkfDrawer["_clickstartInDialog"];
280
+ /** */
281
+ _handleMouseDown?: SkfDrawer["_handleMouseDown"];
282
+ /** */
283
+ _handleMouseUp?: SkfDrawer["_handleMouseUp"];
284
+ /** Fires when the drawer is opened (after transitioned in) */
285
+ "onskf-drawer-opened"?: (e: CustomEvent<never>) => void;
286
+ /** Fires when the drawer is closed (before transitioned out) */
287
+ "onskf-drawer-closing"?: (e: CustomEvent<never>) => void;
288
+ /** Fires when the drawer is closed (after transitioned out) */
289
+ "onskf-drawer-closed"?: (e: CustomEvent<never>) => void;
237
290
  };
238
291
 
239
- type SkfIconProps = {
240
- /** Sets the color of the icon */
241
- color?: SkfIcon["color"];
242
- /** If defined, adds an alternate description to use for assistive devices */
243
- label?: SkfIcon["label"];
244
- /** Name of the icon to display */
245
- name?: SkfIcon["name"];
246
- /** Size of the icon */
247
- size?: SkfIcon["size"];
292
+ type SkfLogoProps = {
293
+ /** Defines the title of the logo */
294
+ title?: SkfLogo["title"];
295
+ /** Defines the color of the logo */
296
+ color?: SkfLogo["color"];
297
+ };
298
+
299
+ type SkfNavProps = {
300
+ /** */
301
+ vertical?: SkfNav["vertical"];
302
+ };
303
+
304
+ type SkfHeaderProps = {
305
+ /** If true, sets header to display in compact mode only (hanburger menu and drawer) */
306
+ compact?: SkfHeader["compact"];
307
+ /** If defined, sets the aria-label for the hamburger button */
308
+ "hamburger-aria-label"?: SkfHeader["hamburgerAriaLabel"];
309
+ /** If defined, sets the app or site's name */
310
+ "site-name"?: SkfHeader["siteName"];
311
+ /** If defined, sets the site's base-url for the "logo-link" */
312
+ "site-url"?: SkfHeader["siteUrl"];
248
313
  };
249
314
 
250
315
  type SkfInputProps = {
@@ -252,7 +317,8 @@ type SkfInputProps = {
252
317
  disabled?: SkfInput["undefined"];
253
318
  /** If true, value is required or must be checked for the form to be submittable */
254
319
  required?: SkfInput["undefined"];
255
- /** -m } */
320
+ /** Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
321
+ [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values. */
256
322
  autocomplete?: SkfInput["autocomplete"];
257
323
  /** Custom aria-label for the clear button. **Notice!** Only applicable to type=search. */
258
324
  "button-aria-label-clear"?: SkfInput["buttonAriaLabelClear"];
@@ -342,37 +408,19 @@ type SkfLinkProps = {
342
408
  onClick?: SkfLink["onClick"];
343
409
  };
344
410
 
345
- type SkfLoaderProps = {
346
- /** Defines the aria-label */
347
- "aria-label"?: SkfLoader["ariaLabel"];
348
- /** If true, inverts the color (to be used on colored backgrounds) */
349
- invert?: SkfLoader["invert"];
350
- /** Defines the size of the loader */
351
- size?: SkfLoader["size"];
352
- /** */
353
- role?: SkfLoader["role"];
354
- /** */
355
- ariaLive?: SkfLoader["ariaLive"];
356
- };
357
-
358
- type SkfLogoProps = {
359
- /** Defines the title of the logo */
360
- title?: SkfLogo["title"];
361
- /** Defines the color of the logo */
362
- color?: SkfLogo["color"];
363
- };
364
-
365
411
  type SkfMenuProps = {
366
412
  /** The placement of the menu */
367
- placement?: SkfMenu["placement"];
368
- /** Whether the menu is open */
369
- isOpen?: SkfMenu["isOpen"];
413
+ placement?: SkfMenu["undefined"];
370
414
  /** The id of the element the menu will be anchored to */
371
- anchor?: SkfMenu["anchor"];
415
+ anchor?: SkfMenu["undefined"];
416
+ /** */
417
+ placement?: SkfMenu["placement"];
418
+ /** */
419
+ triggerEvent?: SkfMenu["triggerEvent"];
372
420
  /** Fired when the menu is opened */
373
- onopen?: (e: CustomEvent<never>) => void;
421
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
374
422
  /** Fired when the menu is closed */
375
- onclose?: (e: CustomEvent<never>) => void;
423
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
376
424
  };
377
425
 
378
426
  type SkfMenuItemProps = {
@@ -418,23 +466,32 @@ type SkfMenuItemProps = {
418
466
  onchange?: (e: CustomEvent<never>) => void;
419
467
  };
420
468
 
469
+ type SkfNavItemProps = {
470
+ /** */
471
+ href?: SkfNavItem["href"];
472
+ /** */
473
+ icon?: SkfNavItem["icon"];
474
+ };
475
+
421
476
  type SkfPopoverProps = {
477
+ /** The placement of the menu */
478
+ placement?: SkfPopover["undefined"];
479
+ /** The id of the element the menu will be anchored to */
480
+ anchor?: SkfPopover["undefined"];
422
481
  /** If defined, sets a custom offset for the popover */
423
482
  offset?: SkfPopover["offset"];
424
483
  /** If true, hides the arrow */
425
484
  hideArrow?: SkfPopover["hideArrow"];
426
485
  /** */
427
486
  arrow?: SkfPopover["arrow"];
428
- /** The placement of the menu */
487
+ /** */
429
488
  placement?: SkfPopover["placement"];
430
- /** Whether the menu is open */
431
- isOpen?: SkfPopover["isOpen"];
432
- /** The id of the element the menu will be anchored to */
433
- anchor?: SkfPopover["anchor"];
489
+ /** */
490
+ triggerEvent?: SkfPopover["triggerEvent"];
434
491
  /** Fired when the menu is opened */
435
- onopen?: (e: CustomEvent<never>) => void;
492
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
436
493
  /** Fired when the menu is closed */
437
- onclose?: (e: CustomEvent<never>) => void;
494
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
438
495
  };
439
496
 
440
497
  type SkfProgressProps = {
@@ -476,6 +533,63 @@ type SkfRadioProps = {
476
533
  onchange?: (e: CustomEvent<never>) => void;
477
534
  };
478
535
 
536
+ type SkfSegmentedButtonItemProps = {
537
+ /** If true, items is marked as disabled */
538
+ disabled?: SkfSegmentedButtonItem["disabled"];
539
+ /** Sets the item value */
540
+ value?: SkfSegmentedButtonItem["value"];
541
+
542
+ /** Fired when something happens */
543
+ "onmy-tag-my-event"?: (e: CustomEvent<CustomEvent>) => void;
544
+ };
545
+
546
+ type SkfSegmentedButtonProps = {
547
+ /** Sets the default selected control */
548
+ "default-selected"?: SkfSegmentedButton["defaultSelected"];
549
+ /** If true, allowes multiple items to be selected */
550
+ multiple?: SkfSegmentedButton["multiple"];
551
+ };
552
+
553
+ type SkfSelectOptionProps = {
554
+ /** If true, prevents interaction with the option */
555
+ disabled?: SkfSelectOption["disabled"];
556
+ /** If defined, set an icon */
557
+ icon?: SkfSelectOption["icon"];
558
+ /** If defined, sets provided color on the icon */
559
+ "icon-color"?: SkfSelectOption["iconColor"];
560
+ /** If true, sets the option as selected */
561
+ selected?: SkfSelectOption["selected"];
562
+ /** If defined, sets a short label */
563
+ "short-label"?: SkfSelectOption["shortLabel"];
564
+ /** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
565
+ value?: SkfSelectOption["value"];
566
+ /** The option's label text (equivalent to the tags textContent) */
567
+ text?: SkfSelectOption["text"];
568
+ /** */
569
+ role?: SkfSelectOption["role"];
570
+ /** */
571
+ _parent?: SkfSelectOption["_parent"];
572
+ /** */
573
+ _shortcutUpdate?: SkfSelectOption["_shortcutUpdate"];
574
+ /** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
575
+ "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
576
+ };
577
+
578
+ type SkfTagProps = {
579
+ /** Specifies Tag size */
580
+ size?: SkfTag["size"];
581
+ /** If defined, displays leading/provided icon */
582
+ icon?: SkfTag["icon"];
583
+ /** If defined, gives the supplied appearance */
584
+ color?: SkfTag["color"];
585
+ /** If true, adds trailing button to remove tag */
586
+ removable?: SkfTag["removable"];
587
+ /** If defined, accepts a function that runs on click */
588
+ onClick?: SkfTag["onClick"];
589
+ /** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
590
+ onRemove?: SkfTag["onRemove"];
591
+ };
592
+
479
593
  type SkfSelectProps = {
480
594
  /** If true, the select is disabled `default: false` */
481
595
  disabled?: SkfSelect["undefined"];
@@ -527,46 +641,11 @@ type SkfSelectProps = {
527
641
  "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
528
642
  };
529
643
 
530
- type SkfSelectOptionProps = {
531
- /** If true, prevents interaction with the option */
532
- disabled?: SkfSelectOption["disabled"];
533
- /** If defined, set an icon */
534
- icon?: SkfSelectOption["icon"];
535
- /** If defined, sets provided color on the icon */
536
- "icon-color"?: SkfSelectOption["iconColor"];
537
- /** If true, sets the option as selected */
538
- selected?: SkfSelectOption["selected"];
539
- /** If defined, sets a short label */
540
- "short-label"?: SkfSelectOption["shortLabel"];
541
- /** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
542
- value?: SkfSelectOption["value"];
543
- /** The option's label text (equivalent to the tags textContent) */
544
- text?: SkfSelectOption["text"];
545
- /** */
546
- role?: SkfSelectOption["role"];
547
- /** */
548
- _parent?: SkfSelectOption["_parent"];
549
- /** */
550
- _shortcutUpdate?: SkfSelectOption["_shortcutUpdate"];
551
- /** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
552
- "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
553
- };
554
-
555
644
  type SkfSelectOptionGroupProps = {
556
645
  /** */
557
646
  label?: SkfSelectOptionGroup["label"];
558
647
  };
559
648
 
560
- type SkfStepperProps = {
561
- /** Sets the active item */
562
- activeIndex?: SkfStepper["activeIndex"];
563
- /** If true, sets linear mode (user can't go back to completed steps due to dependencies) */
564
- linear?: SkfStepper["linear"];
565
-
566
- /** Dispatched when the stepper item is selected */
567
- "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
568
- };
569
-
570
649
  type SkfStepperItemProps = {
571
650
  /** If defined, gives the supplied appearance */
572
651
  state?: SkfStepperItem["state"];
@@ -580,6 +659,16 @@ type SkfStepperItemProps = {
580
659
  "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
581
660
  };
582
661
 
662
+ type SkfStepperProps = {
663
+ /** Sets the active item */
664
+ activeIndex?: SkfStepper["activeIndex"];
665
+ /** If true, sets linear mode (user can't go back to completed steps due to dependencies) */
666
+ linear?: SkfStepper["linear"];
667
+
668
+ /** Dispatched when the stepper item is selected */
669
+ "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
670
+ };
671
+
583
672
  type SkfSwitchProps = {
584
673
  /** If true, sets disabled state */
585
674
  disabled?: SkfSwitch["undefined"];
@@ -603,19 +692,13 @@ type SkfSwitchProps = {
603
692
  value?: SkfSwitch["value"];
604
693
  };
605
694
 
606
- type SkfTabProps = {
607
- /** The name of the tab-panel this tab is associated with. The panel must be located in the same tab group. */
608
- panel?: SkfTab["panel"];
609
- /** */
610
- selected?: SkfTab["selected"];
695
+ type SkfTabPanelProps = {
696
+ /** The tab panel's name. */
697
+ name?: SkfTabPanel["name"];
611
698
  /** */
612
- variant?: SkfTab["variant"];
699
+ active?: SkfTabPanel["active"];
613
700
  /** */
614
- role?: SkfTab["role"];
615
- /** {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected */
616
- "onskf-tab-select"?: (e: CustomEvent<CustomEvent>) => void;
617
- /** Fired when the component is clicked */
618
- onclick?: (e: CustomEvent<never>) => void;
701
+ role?: SkfTabPanel["role"];
619
702
  };
620
703
 
621
704
  type SkfTabGroupProps = {
@@ -631,28 +714,19 @@ type SkfTabGroupProps = {
631
714
  variant?: SkfTabGroup["variant"];
632
715
  };
633
716
 
634
- type SkfTabPanelProps = {
635
- /** The tab panel's name. */
636
- name?: SkfTabPanel["name"];
717
+ type SkfTabProps = {
718
+ /** The name of the tab-panel this tab is associated with. The panel must be located in the same tab group. */
719
+ panel?: SkfTab["panel"];
637
720
  /** */
638
- active?: SkfTabPanel["active"];
721
+ selected?: SkfTab["selected"];
639
722
  /** */
640
- role?: SkfTabPanel["role"];
641
- };
642
-
643
- type SkfTagProps = {
644
- /** Specifies Tag size */
645
- size?: SkfTag["size"];
646
- /** If defined, displays leading/provided icon */
647
- icon?: SkfTag["icon"];
648
- /** If defined, gives the supplied appearance */
649
- color?: SkfTag["color"];
650
- /** If true, adds trailing button to remove tag */
651
- removable?: SkfTag["removable"];
652
- /** If defined, accepts a function that runs on click */
653
- onClick?: SkfTag["onClick"];
654
- /** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
655
- onRemove?: SkfTag["onRemove"];
723
+ variant?: SkfTab["variant"];
724
+ /** */
725
+ role?: SkfTab["role"];
726
+ /** {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected */
727
+ "onskf-tab-select"?: (e: CustomEvent<CustomEvent>) => void;
728
+ /** Fired when the component is clicked */
729
+ onclick?: (e: CustomEvent<never>) => void;
656
730
  };
657
731
 
658
732
  type SkfTextAreaProps = {
@@ -703,6 +777,11 @@ type SkfTextAreaProps = {
703
777
  oninvalid?: (e: CustomEvent<never>) => void;
704
778
  };
705
779
 
780
+ type SkfToastWrapperProps = {
781
+ /** */
782
+ debug?: SkfToastWrapper["debug"];
783
+ };
784
+
706
785
  type SkfToastProps = {
707
786
  /** */
708
787
  debug?: SkfToast["debug"];
@@ -718,27 +797,48 @@ type SkfToastProps = {
718
797
  topOffset?: SkfToast["topOffset"];
719
798
  };
720
799
 
721
- type SkfToastWrapperProps = {
722
- /** */
723
- debug?: SkfToastWrapper["debug"];
724
- };
725
-
726
800
  type SkfTooltipProps = {
801
+ /** The placement of the dropdown */
802
+ placement?: SkfTooltip["undefined"];
803
+ /** The id of the element the dropdown will be anchored to */
804
+ anchor?: SkfTooltip["undefined"];
727
805
  /** */
728
806
  offset?: SkfTooltip["offset"];
729
- /** The placement of the dropdown */
807
+ /** */
730
808
  placement?: SkfTooltip["placement"];
731
- /** Whether the dropdown is open */
732
- isOpen?: SkfTooltip["isOpen"];
733
- /** The id of the element the dropdown will be anchored to */
734
- anchor?: SkfTooltip["anchor"];
735
809
  /** Fired when the dropdown is opened */
736
- onopen?: (e: CustomEvent<never>) => void;
810
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
737
811
  /** Fired when the dropdown is closed */
738
- onclose?: (e: CustomEvent<never>) => void;
812
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
739
813
  };
740
814
 
741
815
  export type CustomElements = {
816
+ /**
817
+ * The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text
818
+ * ---
819
+ *
820
+ */
821
+ "skf-icon": DefineComponent<SkfIconProps>;
822
+
823
+ /**
824
+ * The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
825
+ *
826
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
827
+ * ---
828
+ *
829
+ *
830
+ * ### **Events:**
831
+ * - **skf-collapse-toggle** - Event emitted when toggled
832
+ *
833
+ * ### **Methods:**
834
+ * - **setClose()** - Class method as alternative to manipulate attribute
835
+ * - **setOpen()** - Class method as alternative to manipulate attribute
836
+ *
837
+ * ### **Slots:**
838
+ * - _default_ - Main content
839
+ */
840
+ "skf-collapse": DefineComponent<SkfCollapseProps>;
841
+
742
842
  /**
743
843
  * The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
744
844
  *
@@ -765,8 +865,20 @@ export type CustomElements = {
765
865
  */
766
866
  "skf-alert": DefineComponent<SkfAlertProps>;
767
867
 
868
+ /**
869
+ * The `<skf-breadcrumb-item>` is used in conjunction with the `<skf-breadcrumb>` component
870
+ * ---
871
+ *
872
+ *
873
+ * ### **Slots:**
874
+ * - _default_ - Label of the breadcrumb item
875
+ */
876
+ "skf-breadcrumb-item": DefineComponent<SkfBreadcrumbItemProps>;
877
+
768
878
  /**
769
879
  * The `<skf-breadcrumb>` component consists of multiple `<skf-breadcrumb-item>`, working together.
880
+ *
881
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/3338ef-breadcrumbs) for design principles.
770
882
  * ---
771
883
  *
772
884
  *
@@ -779,14 +891,11 @@ export type CustomElements = {
779
891
  "skf-breadcrumb": DefineComponent<SkfBreadcrumbProps>;
780
892
 
781
893
  /**
782
- * The `<skf-breadcrumb-item>` is used in conjunction with the `<skf-breadcrumb>` component
894
+ * The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
783
895
  * ---
784
896
  *
785
- *
786
- * ### **Slots:**
787
- * - _default_ - Label of the breadcrumb item
788
897
  */
789
- "skf-breadcrumb-item": DefineComponent<SkfBreadcrumbItemProps>;
898
+ "skf-loader": DefineComponent<SkfLoaderProps>;
790
899
 
791
900
  /**
792
901
  * Component to be used in forms or for interactivity
@@ -828,50 +937,49 @@ export type CustomElements = {
828
937
  "skf-checkbox": DefineComponent<SkfCheckboxProps>;
829
938
 
830
939
  /**
831
- * The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
832
- *
833
- * See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
940
+ * A date picker component that allows users to select a date or a range of dates.
834
941
  * ---
835
942
  *
836
943
  *
837
944
  * ### **Events:**
838
- * - **skf-collapse-toggle** - Event emitted when toggled
945
+ * - **selected-date-changed** - When a date is selected
946
+ * - **selected-date-range-changed** - When a range of dates is selected
839
947
  *
840
948
  * ### **Methods:**
841
- * - **setClose()** - Class method as alternative to manipulate attribute
842
- * - **setOpen()** - Class method as alternative to manipulate attribute
949
+ * - **gotoDate(date: _Date | string_)** - Navigates to the given date.
843
950
  *
844
951
  * ### **Slots:**
845
- * - _default_ - Main content
952
+ * - _default_ - Default hint content placed inside the date picker
953
+ *
954
+ * ### **CSS Properties:**
955
+ * - **--max-width** - The maximum width of the date picker _(default: undefined)_
846
956
  */
847
- "skf-collapse": DefineComponent<SkfCollapseProps>;
957
+ "skf-datepicker": DefineComponent<SkfDatePickerProps>;
848
958
 
849
959
  /**
850
- * A date picker component that allows users to select a date or a range of dates.
960
+ * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
961
+ * It extends the interface of native html `<h1>` to `<h4>` elements.
851
962
  * ---
852
963
  *
853
964
  *
854
- * ### **Events:**
855
- * - **selected-date-changed** - When a date is selected
856
- * - **selected-date-range-changed** - When a range of dates is selected
857
- *
858
965
  * ### **Slots:**
859
- * - _default_ - Default hint content placed inside the date picker
860
- *
861
- * ### **CSS Properties:**
862
- * - **--max-width** - The maximum width of the date picker _(default: undefined)_
966
+ * - _default_ - The headings content
863
967
  */
864
- "skf-datepicker": DefineComponent<SkfDatePickerProps>;
968
+ "skf-heading": DefineComponent<SkfHeadingProps>;
865
969
 
866
970
  /**
867
- * The `<skf-dialog>` is a component that open up a dialog with the content provided
971
+ * The `<skf-dialog>` is a component that open up a dialog of type modal with the content provided. (MDN refrains from opening the dialog using the `open` attribute, however skf-dialog does not have that limitation)
868
972
  * ---
869
973
  *
870
974
  *
871
975
  * ### **Events:**
872
- * - **skf-dialog-open** - Fires when the dialog is opened (after transitioned in)
873
- * - **skf-dialog-close** - Fires when the dialog is closed (before transitioned out)
874
- * - **close** - Fires when the dialog is closed (after transitioned out)
976
+ * - **skf-dialog-opened** - Fires when the dialog is opened (after transitioned in)
977
+ * - **skf-dialog-closing** - Fires when the dialog is closed (before transitioned out)
978
+ * - **skf-dialog-closed** - Fires when the dialog is closed (after transitioned out)
979
+ *
980
+ * ### **Methods:**
981
+ * - **showModal()** - Method that opens the dialog in modal state
982
+ * - **close()** - Method that closes the dialog
875
983
  *
876
984
  * ### **Slots:**
877
985
  * - _default_ - The dialog component's content
@@ -895,63 +1003,73 @@ export type CustomElements = {
895
1003
  "skf-divider": DefineComponent<SkfDividerProps>;
896
1004
 
897
1005
  /**
898
- * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
899
- * It extends the interface of native html `<h1>` to `<h4>` elements.
1006
+ * The `<skf-drawer>` is a modal component that displays content and toggle by sliding from left/right viewport edge.
900
1007
  * ---
901
1008
  *
902
1009
  *
1010
+ * ### **Events:**
1011
+ * - **skf-drawer-opened** - Fires when the drawer is opened (after transitioned in)
1012
+ * - **skf-drawer-closing** - Fires when the drawer is closed (before transitioned out)
1013
+ * - **skf-drawer-closed** - Fires when the drawer is closed (after transitioned out)
1014
+ *
903
1015
  * ### **Slots:**
904
- * - _default_ - The headings content
1016
+ * - _default_ - The Drawer's main content
905
1017
  */
906
- "skf-heading": DefineComponent<SkfHeadingProps>;
1018
+ "skf-drawer": DefineComponent<SkfDrawerProps>;
907
1019
 
908
1020
  /**
909
- * The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text
1021
+ * The `<skf-logo>` component is used to display the SKF logo.
910
1022
  * ---
911
1023
  *
1024
+ *
1025
+ * ### **CSS Properties:**
1026
+ * - **--skf-logo-height** - The height of the logo _(default: undefined)_
912
1027
  */
913
- "skf-icon": DefineComponent<SkfIconProps>;
1028
+ "skf-logo": DefineComponent<SkfLogoProps>;
914
1029
 
915
1030
  /**
916
- * The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.
1031
+ * The `<skf-nav>` is a component that displays a list of <nav-items>.
917
1032
  * ---
918
1033
  *
919
1034
  *
920
- * ### **Events:**
921
- * - **change** - Fires when the value of the input changes
922
- * - **invalid** - Fires when the input is invalid
923
- *
924
1035
  * ### **Slots:**
925
- * - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
1036
+ * - _default_ - The component's main content
926
1037
  */
927
- "skf-input": DefineComponent<SkfInputProps>;
1038
+ "skf-nav": DefineComponent<SkfNavProps>;
928
1039
 
929
1040
  /**
930
- * The `<skf-link>` can be used as either a regular link or a link styled semantic button
1041
+ * The `<skf-header>` component is to be used as the site-header in the app
931
1042
  * ---
932
1043
  *
933
1044
  *
934
1045
  * ### **Slots:**
935
- * - _default_ - The links' main content
1046
+ * - _default_ - Navigation items
936
1047
  */
937
- "skf-link": DefineComponent<SkfLinkProps>;
1048
+ "skf-header": DefineComponent<SkfHeaderProps>;
938
1049
 
939
1050
  /**
940
- * The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
1051
+ * The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.
941
1052
  * ---
942
1053
  *
1054
+ *
1055
+ * ### **Events:**
1056
+ * - **change** - Fires when the value of the input changes
1057
+ * - **invalid** - Fires when the input is invalid
1058
+ *
1059
+ * ### **Slots:**
1060
+ * - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
943
1061
  */
944
- "skf-loader": DefineComponent<SkfLoaderProps>;
1062
+ "skf-input": DefineComponent<SkfInputProps>;
945
1063
 
946
1064
  /**
947
- * The `<skf-logo>` component is used to display the SKF logo.
1065
+ * The `<skf-link>` can be used as either a regular link or a link styled semantic button
948
1066
  * ---
949
1067
  *
950
1068
  *
951
- * ### **CSS Properties:**
952
- * - **--skf-logo-height** - The height of the logo _(default: undefined)_
1069
+ * ### **Slots:**
1070
+ * - _default_ - The links' main content
953
1071
  */
954
- "skf-logo": DefineComponent<SkfLogoProps>;
1072
+ "skf-link": DefineComponent<SkfLinkProps>;
955
1073
 
956
1074
  /**
957
1075
  * The `<skf-menu>` is a component that displays a list of actions or options.
@@ -959,8 +1077,8 @@ export type CustomElements = {
959
1077
  *
960
1078
  *
961
1079
  * ### **Events:**
962
- * - **open** - Fired when the menu is opened
963
- * - **close** - Fired when the menu is closed
1080
+ * - **skf-opened** - Fired when the menu is opened
1081
+ * - **skf-closed** - Fired when the menu is closed
964
1082
  *
965
1083
  * ### **Slots:**
966
1084
  * - _default_ - The menu popover content
@@ -988,13 +1106,23 @@ export type CustomElements = {
988
1106
  "skf-menu-item": DefineComponent<SkfMenuItemProps>;
989
1107
 
990
1108
  /**
991
- * The `<skf-popover>` is a general purpose component that displays the slot content.
1109
+ * The `<skf-nav>` is a component that displays a list of <nav-items>.
1110
+ * ---
1111
+ *
1112
+ *
1113
+ * ### **Slots:**
1114
+ * - _default_ - The component's main content
1115
+ */
1116
+ "skf-nav-item": DefineComponent<SkfNavItemProps>;
1117
+
1118
+ /**
1119
+ * The `<skf-popover>` is a general purpose component that displays the slot content in a popover.
992
1120
  * ---
993
1121
  *
994
1122
  *
995
1123
  * ### **Events:**
996
- * - **open** - Fired when the menu is opened
997
- * - **close** - Fired when the menu is closed
1124
+ * - **skf-opened** - Fired when the menu is opened
1125
+ * - **skf-closed** - Fired when the menu is closed
998
1126
  *
999
1127
  * ### **Slots:**
1000
1128
  * - _default_ - The popover content
@@ -1022,21 +1150,29 @@ export type CustomElements = {
1022
1150
  "skf-radio": DefineComponent<SkfRadioProps>;
1023
1151
 
1024
1152
  /**
1025
- * The `<skf-select>` is a component that displays a list of actions or options. A click in the options list toggle the selected state of the option. Use it together with the ´skf-select-option` tag.
1153
+ * The `<skf-segmented-button-item>` is used in conjunction with the `<skf-segmented-button>` component
1026
1154
  * ---
1027
1155
  *
1028
1156
  *
1029
1157
  * ### **Events:**
1030
- * - **change** - Fired when the selected option(s) changes
1031
- * - **invalid** - Fired when the select is invalid
1032
- * - **reset** - Fired when the form is reset
1033
- * - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
1034
- * - **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
1158
+ * - **my-tag-my-event** - Fired when something happens
1035
1159
  *
1036
1160
  * ### **Slots:**
1037
- * - _default_ - The select's placeholder content
1161
+ * - _default_ - The items label
1038
1162
  */
1039
- "skf-select": DefineComponent<SkfSelectProps>;
1163
+ "skf-segmented-button-item": DefineComponent<SkfSegmentedButtonItemProps>;
1164
+
1165
+ /**
1166
+ * The `<skf-segmented-button>` component consists of multiple `<skf-segmented-button-item>`, working together.
1167
+ *
1168
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/68ff54-segmented-buttons) for design principles
1169
+ * ---
1170
+ *
1171
+ *
1172
+ * ### **Slots:**
1173
+ * - _default_ - One or more `<skf-segmented-button-item>`
1174
+ */
1175
+ "skf-segmented-button": DefineComponent<SkfSegmentedButtonProps>;
1040
1176
 
1041
1177
  /**
1042
1178
  * The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
@@ -1053,27 +1189,41 @@ export type CustomElements = {
1053
1189
  "skf-select-option": DefineComponent<SkfSelectOptionProps>;
1054
1190
 
1055
1191
  /**
1056
- * The `<skf-select-option-group>` is a component that groups select-options
1192
+ * The `<skf-tag>` is a component that displays a list of actions or options
1057
1193
  * ---
1058
1194
  *
1059
1195
  *
1060
1196
  * ### **Slots:**
1061
1197
  * - _default_ - The component's placeholder content
1062
1198
  */
1063
- "skf-select-option-group": DefineComponent<SkfSelectOptionGroupProps>;
1199
+ "skf-tag": DefineComponent<SkfTagProps>;
1064
1200
 
1065
1201
  /**
1066
- * The `<skf-stepper>` is a component that displays a list of actions or options.
1202
+ * The `<skf-select>` is a component that displays a list of actions or options. A click in the options list toggle the selected state of the option. Use it together with the ´skf-select-option` tag.
1067
1203
  * ---
1068
1204
  *
1069
1205
  *
1070
1206
  * ### **Events:**
1071
- * - **skf-stepper-item-select** - Dispatched when the stepper item is selected
1207
+ * - **change** - Fired when the selected option(s) changes
1208
+ * - **invalid** - Fired when the select is invalid
1209
+ * - **reset** - Fired when the form is reset
1210
+ * - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
1211
+ * - **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
1072
1212
  *
1073
1213
  * ### **Slots:**
1074
- * - _default_ - One or more `<skf-stepper-item>`
1214
+ * - _default_ - The select's placeholder content
1075
1215
  */
1076
- "skf-stepper": DefineComponent<SkfStepperProps>;
1216
+ "skf-select": DefineComponent<SkfSelectProps>;
1217
+
1218
+ /**
1219
+ * The `<skf-select-option-group>` is a component that groups select-options
1220
+ * ---
1221
+ *
1222
+ *
1223
+ * ### **Slots:**
1224
+ * - _default_ - The component's placeholder content
1225
+ */
1226
+ "skf-select-option-group": DefineComponent<SkfSelectOptionGroupProps>;
1077
1227
 
1078
1228
  /**
1079
1229
  * The `<skf-stepper-item>` is used in conjunction with the `<skf-stepper>` component
@@ -1088,8 +1238,23 @@ export type CustomElements = {
1088
1238
  */
1089
1239
  "skf-stepper-item": DefineComponent<SkfStepperItemProps>;
1090
1240
 
1241
+ /**
1242
+ * The `<skf-stepper>` is a component that displays a list of actions or options.
1243
+ * ---
1244
+ *
1245
+ *
1246
+ * ### **Events:**
1247
+ * - **skf-stepper-item-select** - Dispatched when the stepper item is selected
1248
+ *
1249
+ * ### **Slots:**
1250
+ * - _default_ - One or more `<skf-stepper-item>`
1251
+ */
1252
+ "skf-stepper": DefineComponent<SkfStepperProps>;
1253
+
1091
1254
  /**
1092
1255
  * The `<skf-switch>` is a component that displays a list of actions or options
1256
+ *
1257
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/7282a2-switch) for design principle
1093
1258
  * ---
1094
1259
  *
1095
1260
  *
@@ -1099,18 +1264,14 @@ export type CustomElements = {
1099
1264
  "skf-switch": DefineComponent<SkfSwitchProps>;
1100
1265
 
1101
1266
  /**
1102
- * The `<skf-tab>` is a component that displays a list of actions or options
1267
+ * The `<skf-tab-panel>` is a component that displays a list of actions or options.
1103
1268
  * ---
1104
1269
  *
1105
1270
  *
1106
- * ### **Events:**
1107
- * - **skf-tab-select** - {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
1108
- * - **click** - Fired when the component is clicked
1109
- *
1110
1271
  * ### **Slots:**
1111
- * - _default_ - The tab's label
1272
+ * - _default_ - The tab panel's content
1112
1273
  */
1113
- "skf-tab": DefineComponent<SkfTabProps>;
1274
+ "skf-tab-panel": DefineComponent<SkfTabPanelProps>;
1114
1275
 
1115
1276
  /**
1116
1277
  * The `<skf-tab-group>` is a component that displays a list of actions or options.
@@ -1124,24 +1285,18 @@ export type CustomElements = {
1124
1285
  "skf-tab-group": DefineComponent<SkfTabGroupProps>;
1125
1286
 
1126
1287
  /**
1127
- * The `<skf-tab-panel>` is a component that displays a list of actions or options.
1288
+ * The `<skf-tab>` is a component that displays a list of actions or options
1128
1289
  * ---
1129
1290
  *
1130
1291
  *
1131
- * ### **Slots:**
1132
- * - _default_ - The tab panel's content
1133
- */
1134
- "skf-tab-panel": DefineComponent<SkfTabPanelProps>;
1135
-
1136
- /**
1137
- * The `<skf-tag>` is a component that displays a list of actions or options
1138
- * ---
1139
- *
1292
+ * ### **Events:**
1293
+ * - **skf-tab-select** - {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
1294
+ * - **click** - Fired when the component is clicked
1140
1295
  *
1141
1296
  * ### **Slots:**
1142
- * - _default_ - The component's placeholder content
1297
+ * - _default_ - The tab's label
1143
1298
  */
1144
- "skf-tag": DefineComponent<SkfTagProps>;
1299
+ "skf-tab": DefineComponent<SkfTabProps>;
1145
1300
 
1146
1301
  /**
1147
1302
  * The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
@@ -1158,33 +1313,33 @@ export type CustomElements = {
1158
1313
  "skf-textarea": DefineComponent<SkfTextAreaProps>;
1159
1314
 
1160
1315
  /**
1161
- * A simple toast component that displays a message to the user. Use by appending a &lt;skf-toast&gt; tag to the DOM. Position in DOM is irrelevant.
1316
+ * The `<skf-toast-wrapper>` is a component without UI that positions where the toast shows up on the screen. The toast-wrapper is used internally by the toast component.
1162
1317
  * ---
1163
1318
  *
1164
1319
  *
1165
1320
  * ### **Slots:**
1166
- * - _default_ - The component's placeholder content
1321
+ * - _default_ - The alert components that the toast creates will render here.
1167
1322
  */
1168
- "skf-toast": DefineComponent<SkfToastProps>;
1323
+ "skf-toast-wrapper": DefineComponent<SkfToastWrapperProps>;
1169
1324
 
1170
1325
  /**
1171
- * The `<skf-toast-wrapper>` is a component without UI that positions where the toast shows up on the screen. The toast-wrapper is used internally by the toast component.
1326
+ * A simple toast component that displays a message to the user. Invoke a toast message by appending a &lt;skf-toast&gt; tag to the DOM. Position in DOM is irrelevant. A transient toast will disappear after a set amount of time. Once toast is dismissed it will be removed from the DOM.
1172
1327
  * ---
1173
1328
  *
1174
1329
  *
1175
1330
  * ### **Slots:**
1176
- * - _default_ - The alert components that the toast creates will render here.
1331
+ * - _default_ - The component's placeholder content
1177
1332
  */
1178
- "skf-toast-wrapper": DefineComponent<SkfToastWrapperProps>;
1333
+ "skf-toast": DefineComponent<SkfToastProps>;
1179
1334
 
1180
1335
  /**
1181
- * The `<skf-tooltip>` is a component that displays a list of actions or options.
1336
+ * The `<skf-tooltip>` is a component that displays a tooltip.
1182
1337
  * ---
1183
1338
  *
1184
1339
  *
1185
1340
  * ### **Events:**
1186
- * - **open** - Fired when the dropdown is opened
1187
- * - **close** - Fired when the dropdown is closed
1341
+ * - **skf-opened** - Fired when the dropdown is opened
1342
+ * - **skf-closed** - Fired when the dropdown is closed
1188
1343
  *
1189
1344
  * ### **Slots:**
1190
1345
  * - _default_ - The tooltip popover content