@skf-design-system/ui-components 1.0.1-beta.0 → 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 (206) 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 +14 -14
  6. package/dist/components/breadcrumb/breadcrumb.component.d.ts +1 -1
  7. package/dist/components/button/button.component.d.ts +3 -3
  8. package/dist/components/button/button.component.js +59 -55
  9. package/dist/components/card/card.component.js +18 -30
  10. package/dist/components/card/card.styles.js +25 -28
  11. package/dist/components/checkbox/checkbox.component.d.ts +9 -7
  12. package/dist/components/checkbox/checkbox.component.js +71 -58
  13. package/dist/components/collapse/collapse.component.js +1 -1
  14. package/dist/components/date-picker/datepicker.calendar.component.d.ts +77 -0
  15. package/dist/components/date-picker/datepicker.calendar.component.js +415 -0
  16. package/dist/components/date-picker/datepicker.calendar.styles.d.ts +1 -0
  17. package/dist/components/date-picker/datepicker.calendar.styles.js +202 -0
  18. package/dist/components/date-picker/datepicker.component.d.ts +79 -0
  19. package/dist/components/date-picker/datepicker.component.js +261 -0
  20. package/dist/components/date-picker/datepicker.d.ts +10 -0
  21. package/dist/components/date-picker/datepicker.helpers.d.ts +41 -0
  22. package/dist/components/date-picker/datepicker.helpers.js +76 -0
  23. package/dist/components/date-picker/datepicker.js +8 -0
  24. package/dist/components/date-picker/datepicker.styles.d.ts +1 -0
  25. package/dist/components/date-picker/datepicker.styles.js +87 -0
  26. package/dist/components/date-picker-input/datepicker-input.component.d.ts +115 -0
  27. package/dist/components/date-picker-input/datepicker-input.component.js +441 -0
  28. package/dist/components/date-picker-input/datepicker-input.d.ts +8 -0
  29. package/dist/components/date-picker-input/datepicker-input.helpers.d.ts +38 -0
  30. package/dist/components/date-picker-input/datepicker-input.helpers.js +31 -0
  31. package/dist/components/date-picker-input/datepicker-input.js +6 -0
  32. package/dist/components/date-picker-input/datepicker-input.styles.d.ts +1 -0
  33. package/dist/components/date-picker-input/datepicker-input.styles.js +18 -0
  34. package/dist/components/dialog/dialog.component.d.ts +18 -28
  35. package/dist/components/dialog/dialog.component.js +94 -84
  36. package/dist/components/divider/divider.component.d.ts +4 -8
  37. package/dist/components/divider/divider.component.js +24 -46
  38. package/dist/components/divider/divider.styles.js +34 -30
  39. package/dist/components/drawer/drawer.component.d.ts +57 -0
  40. package/dist/components/drawer/drawer.component.js +124 -0
  41. package/dist/components/drawer/drawer.d.ts +8 -0
  42. package/dist/components/drawer/drawer.js +6 -0
  43. package/dist/components/drawer/drawer.styles.d.ts +1 -0
  44. package/dist/components/drawer/drawer.styles.js +71 -0
  45. package/dist/components/header/header.component.d.ts +45 -0
  46. package/dist/components/header/header.component.js +110 -0
  47. package/dist/components/header/header.d.ts +8 -0
  48. package/dist/components/header/header.js +6 -0
  49. package/dist/components/header/header.styles.d.ts +1 -0
  50. package/dist/components/header/header.styles.js +68 -0
  51. package/dist/components/heading/heading.component.d.ts +6 -12
  52. package/dist/components/heading/heading.component.js +17 -17
  53. package/dist/components/heading/heading.styles.d.ts +1 -2
  54. package/dist/components/heading/heading.styles.js +1 -1
  55. package/dist/components/icon/icon.component.d.ts +1 -1
  56. package/dist/components/icon/icon.component.js +19 -19
  57. package/dist/components/input/input.component.d.ts +3 -2
  58. package/dist/components/input/input.component.js +89 -82
  59. package/dist/components/input/input.controllers.d.ts +20 -6
  60. package/dist/components/input/input.controllers.js +14 -10
  61. package/dist/components/link/link.component.js +29 -28
  62. package/dist/components/link/link.styles.js +24 -20
  63. package/dist/components/loader/loader.component.js +19 -19
  64. package/dist/components/logo/logo.component.js +6 -6
  65. package/dist/components/menu/menu.component.d.ts +4 -5
  66. package/dist/components/menu/menu.component.js +1 -1
  67. package/dist/components/nav/nav.component.d.ts +17 -0
  68. package/dist/components/nav/nav.component.js +34 -0
  69. package/dist/components/nav/nav.d.ts +8 -0
  70. package/dist/components/nav/nav.js +6 -0
  71. package/dist/components/nav/nav.styles.d.ts +1 -0
  72. package/dist/components/nav/nav.styles.js +17 -0
  73. package/dist/components/nav-item/nav-item.component.d.ts +20 -0
  74. package/dist/components/nav-item/nav-item.component.js +38 -0
  75. package/dist/components/nav-item/nav-item.d.ts +8 -0
  76. package/dist/components/nav-item/nav-item.js +6 -0
  77. package/dist/components/nav-item/nav-item.styles.d.ts +1 -0
  78. package/dist/components/nav-item/nav-item.styles.js +39 -0
  79. package/dist/components/popover/popover.component.d.ts +5 -6
  80. package/dist/components/popover/popover.component.js +24 -24
  81. package/dist/components/progress/progress.component.js +7 -7
  82. package/dist/components/radio/radio.component.d.ts +10 -6
  83. package/dist/components/radio/radio.component.js +14 -14
  84. package/dist/components/radio/radio.styles.d.ts +1 -2
  85. package/dist/components/radio/radio.styles.js +1 -1
  86. package/dist/components/segmented-button/segmented-button.component.d.ts +32 -0
  87. package/dist/components/segmented-button/segmented-button.d.ts +8 -0
  88. package/dist/components/segmented-button/segmented-button.styles.d.ts +1 -0
  89. package/dist/components/segmented-button-item/segmented-button-item.component.d.ts +36 -0
  90. package/dist/components/segmented-button-item/segmented-button-item.d.ts +8 -0
  91. package/dist/components/segmented-button-item/segmented-button-item.styles.d.ts +1 -0
  92. package/dist/components/select/select.component.js +2 -2
  93. package/dist/components/select/select.controllers.d.ts +20 -9
  94. package/dist/components/select/select.controllers.js +27 -22
  95. package/dist/components/select-option/select-option.controllers.d.ts +11 -5
  96. package/dist/components/select-option-group/select-option-group.component.js +9 -9
  97. package/dist/components/stepper/stepper.component.d.ts +2 -1
  98. package/dist/components/stepper/stepper.component.js +9 -9
  99. package/dist/components/stepper/stepper.helpers.js +5 -5
  100. package/dist/components/stepper-item/stepper-item.component.js +25 -25
  101. package/dist/components/switch/switch.component.d.ts +7 -6
  102. package/dist/components/switch/switch.component.js +7 -7
  103. package/dist/components/tab/tab.component.js +4 -4
  104. package/dist/components/tab-panel/tab-panel.component.js +12 -12
  105. package/dist/components/tag/tag.component.d.ts +4 -2
  106. package/dist/components/tag/tag.component.js +14 -14
  107. package/dist/components/textarea/textarea.component.js +10 -10
  108. package/dist/components/toast/toast.component.d.ts +1 -1
  109. package/dist/components/toast/toast.component.js +13 -13
  110. package/dist/components/toast-wrapper/toast-wrapper.component.js +10 -10
  111. package/dist/components/tooltip/tooltip.component.d.ts +5 -6
  112. package/dist/components/tooltip/tooltip.component.js +11 -11
  113. package/dist/custom-elements.json +3702 -2190
  114. package/dist/index.d.ts +6 -0
  115. package/dist/index.js +84 -66
  116. package/dist/internal/base-classes/popover/popover.base.d.ts +17 -7
  117. package/dist/internal/base-classes/popover/popover.base.js +119 -75
  118. package/dist/internal/base-classes/popover/popover.styles.js +14 -1
  119. package/dist/internal/components/hint/hint.component.js +13 -13
  120. package/dist/internal/controllers/elementOverflowController.d.ts +13 -0
  121. package/dist/internal/controllers/popover.controller.d.ts +12 -6
  122. package/dist/internal/controllers/popover.controller.js +9 -14
  123. package/dist/internal/helpers/dateFormatter.d.ts +2 -0
  124. package/dist/internal/helpers/utilityTypes.d.ts +22 -0
  125. package/dist/internal/helpers/uuid.d.ts +15 -0
  126. package/dist/internal/helpers/uuid.js +14 -0
  127. package/dist/internal/storybook/styles.d.ts +1 -0
  128. package/dist/styles/form-field.styles.js +11 -6
  129. package/dist/styles/global.css +1 -1
  130. package/dist/types/jsx/custom-element-jsx.d.ts +663 -1240
  131. package/dist/types/vue/index.d.ts +453 -255
  132. package/dist/vscode.html-custom-data.json +821 -503
  133. package/dist/web-types.json +1005 -633
  134. package/package.json +43 -52
  135. package/dist/react/index.d.ts +0 -35
  136. package/dist/react/index.js +0 -35
  137. package/dist/react/skf-accordion/index.d.ts +0 -3
  138. package/dist/react/skf-accordion/index.js +0 -13
  139. package/dist/react/skf-alert/index.d.ts +0 -9
  140. package/dist/react/skf-alert/index.js +0 -17
  141. package/dist/react/skf-breadcrumb/index.d.ts +0 -9
  142. package/dist/react/skf-breadcrumb/index.js +0 -17
  143. package/dist/react/skf-breadcrumb-item/index.d.ts +0 -3
  144. package/dist/react/skf-breadcrumb-item/index.js +0 -13
  145. package/dist/react/skf-button/index.d.ts +0 -9
  146. package/dist/react/skf-button/index.js +0 -17
  147. package/dist/react/skf-card/index.d.ts +0 -3
  148. package/dist/react/skf-card/index.js +0 -13
  149. package/dist/react/skf-checkbox/index.d.ts +0 -9
  150. package/dist/react/skf-checkbox/index.js +0 -17
  151. package/dist/react/skf-collapse/index.d.ts +0 -9
  152. package/dist/react/skf-collapse/index.js +0 -17
  153. package/dist/react/skf-dialog/index.d.ts +0 -15
  154. package/dist/react/skf-dialog/index.js +0 -19
  155. package/dist/react/skf-divider/index.d.ts +0 -3
  156. package/dist/react/skf-divider/index.js +0 -13
  157. package/dist/react/skf-heading/index.d.ts +0 -3
  158. package/dist/react/skf-heading/index.js +0 -13
  159. package/dist/react/skf-icon/index.d.ts +0 -3
  160. package/dist/react/skf-icon/index.js +0 -13
  161. package/dist/react/skf-input/index.d.ts +0 -12
  162. package/dist/react/skf-input/index.js +0 -18
  163. package/dist/react/skf-link/index.d.ts +0 -3
  164. package/dist/react/skf-link/index.js +0 -13
  165. package/dist/react/skf-loader/index.d.ts +0 -3
  166. package/dist/react/skf-loader/index.js +0 -13
  167. package/dist/react/skf-logo/index.d.ts +0 -3
  168. package/dist/react/skf-logo/index.js +0 -13
  169. package/dist/react/skf-menu/index.d.ts +0 -12
  170. package/dist/react/skf-menu/index.js +0 -18
  171. package/dist/react/skf-menu-item/index.d.ts +0 -27
  172. package/dist/react/skf-menu-item/index.js +0 -23
  173. package/dist/react/skf-popover/index.d.ts +0 -12
  174. package/dist/react/skf-popover/index.js +0 -18
  175. package/dist/react/skf-progress/index.d.ts +0 -3
  176. package/dist/react/skf-progress/index.js +0 -13
  177. package/dist/react/skf-radio/index.d.ts +0 -9
  178. package/dist/react/skf-radio/index.js +0 -17
  179. package/dist/react/skf-select/index.d.ts +0 -21
  180. package/dist/react/skf-select/index.js +0 -21
  181. package/dist/react/skf-select-option/index.d.ts +0 -9
  182. package/dist/react/skf-select-option/index.js +0 -17
  183. package/dist/react/skf-select-option-group/index.d.ts +0 -3
  184. package/dist/react/skf-select-option-group/index.js +0 -13
  185. package/dist/react/skf-stepper/index.d.ts +0 -9
  186. package/dist/react/skf-stepper/index.js +0 -17
  187. package/dist/react/skf-stepper-item/index.d.ts +0 -9
  188. package/dist/react/skf-stepper-item/index.js +0 -17
  189. package/dist/react/skf-switch/index.d.ts +0 -3
  190. package/dist/react/skf-switch/index.js +0 -13
  191. package/dist/react/skf-tab/index.d.ts +0 -12
  192. package/dist/react/skf-tab/index.js +0 -18
  193. package/dist/react/skf-tab-group/index.d.ts +0 -3
  194. package/dist/react/skf-tab-group/index.js +0 -13
  195. package/dist/react/skf-tab-panel/index.d.ts +0 -3
  196. package/dist/react/skf-tab-panel/index.js +0 -13
  197. package/dist/react/skf-tag/index.d.ts +0 -3
  198. package/dist/react/skf-tag/index.js +0 -13
  199. package/dist/react/skf-textarea/index.d.ts +0 -12
  200. package/dist/react/skf-textarea/index.js +0 -18
  201. package/dist/react/skf-toast/index.d.ts +0 -3
  202. package/dist/react/skf-toast/index.js +0 -13
  203. package/dist/react/skf-toast-wrapper/index.d.ts +0 -3
  204. package/dist/react/skf-toast-wrapper/index.js +0 -13
  205. package/dist/react/skf-tooltip/index.d.ts +0 -12
  206. package/dist/react/skf-tooltip/index.js +0 -18
@@ -1,41 +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";
13
+ import type { SkfDatePicker } from "../../components/datepicker/datepicker.component.js";
14
+ import type { SkfHeading } from "../../components/heading/heading.component.js";
11
15
  import type { SkfDialog } from "../../components/dialog/dialog.component.js";
12
16
  import type { SkfDivider } from "../../components/divider/divider.component.js";
13
- import type { SkfHeading } from "../../components/heading/heading.component.js";
14
- 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";
15
21
  import type { SkfInput } from "../../components/input/input.component.js";
16
22
  import type { SkfLink } from "../../components/link/link.component.js";
17
- import type { SkfLoader } from "../../components/loader/loader.component.js";
18
- import type { SkfLogo } from "../../components/logo/logo.component.js";
19
23
  import type { SkfMenu } from "../../components/menu/menu.component.js";
20
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";
21
26
  import type { SkfPopover } from "../../components/popover/popover.component.js";
22
27
  import type { SkfProgress } from "../../components/progress/progress.component.js";
23
28
  import type { SkfRadio } from "../../components/radio/radio.component.js";
24
- 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";
25
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";
26
37
  import type { SkfSelectOptionGroup } from "../../components/select-option-group/select-option-group.component.js";
27
- import type { SkfStepper } from "../../components/stepper/stepper.component.js";
28
38
  import type { SkfStepperItem } from "../../components/stepper-item/stepper-item.component.js";
39
+ import type { SkfStepper } from "../../components/stepper/stepper.component.js";
29
40
  import type { SkfSwitch } from "../../components/switch/switch.component.js";
30
- import type { SkfTab, CustomEvent } from "../../components/tab/tab.component.js";
31
- import type { SkfTabGroup } from "../../components/tab-group/tab-group.component.js";
32
41
  import type { SkfTabPanel } from "../../components/tab-panel/tab-panel.component.js";
33
- 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";
34
44
  import type { SkfTextArea } from "../../components/textarea/textarea.component.js";
35
- import type { SkfToast } from "../../components/toast/toast.component.js";
36
45
  import type { SkfToastWrapper } from "../../components/toast-wrapper/toast-wrapper.component.js";
46
+ import type { SkfToast } from "../../components/toast/toast.component.js";
37
47
  import type { SkfTooltip } from "../../components/tooltip/tooltip.component.js";
38
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
+
39
78
  type SkfAccordionProps = {
40
79
  /** If true, will animate the expand/collapse state */
41
80
  animated?: SkfAccordion["animated"];
@@ -65,6 +104,13 @@ type SkfAlertProps = {
65
104
  "onskf-alert-close"?: (e: CustomEvent<never>) => void;
66
105
  };
67
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
+
68
114
  type SkfBreadcrumbProps = {
69
115
  /** aria-label for the breadcrumb control */
70
116
  label?: SkfBreadcrumb["label"];
@@ -75,11 +121,17 @@ type SkfBreadcrumbProps = {
75
121
  onclick?: (e: CustomEvent<never>) => void;
76
122
  };
77
123
 
78
- type SkfBreadcrumbItemProps = {
79
- /** If defined, loads url on click */
80
- href?: SkfBreadcrumbItem["href"];
81
- /** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
82
- 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"];
83
135
  };
84
136
 
85
137
  type SkfButtonProps = {
@@ -91,7 +143,7 @@ type SkfButtonProps = {
91
143
  icon?: SkfButton["icon"];
92
144
  /** If true, removes border */
93
145
  iconOnly?: SkfButton["iconOnly"];
94
- /** If provided, determines the positioning of the icon in relation to the text */
146
+ /** Determines the positioning of the icon in relation to the text */
95
147
  "icon-position"?: SkfButton["iconPosition"];
96
148
  /** If true, hides text & icon and shows loading indicator. **Notice!** Only applicable if `variant` is `primary`. */
97
149
  loading?: SkfButton["loading"];
@@ -149,22 +201,36 @@ type SkfCheckboxProps = {
149
201
  onchange?: (e: CustomEvent<never>) => void;
150
202
  };
151
203
 
152
- type SkfCollapseProps = {
153
- /** If true, will animate the expand/collapse state */
154
- animated?: SkfCollapse["animated"];
155
- /** If true, will set the collapse to be expanded by default */
156
- expanded?: SkfCollapse["expanded"];
157
- /** Heading for the collapse */
158
- heading?: SkfCollapse["heading"];
159
- /** Defines which heading element will be rendered */
160
- "heading-as"?: SkfCollapse["headingAs"];
161
- /** If true, renders the small version */
162
- small?: SkfCollapse["small"];
163
- /** If true, will truncate the heading in collapsed state */
164
- truncate?: SkfCollapse["truncate"];
204
+ type SkfDatePickerProps = {
205
+ /** The locale to use for formatting the date */
206
+ locale?: SkfDatePicker["locale"];
207
+ /** The date to display in the date picker */
208
+ date?: SkfDatePicker["date"];
209
+ /** */
210
+ id?: SkfDatePicker["id"];
211
+ /** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
212
+ "invalid-dates"?: SkfDatePicker["invalidDates"];
213
+ /** If true, the date picker will allow the selection of a range of dates */
214
+ range?: SkfDatePicker["range"];
215
+ /** Earliest selectable date. (yyyy-mm-dd format) */
216
+ "selectable-from"?: SkfDatePicker["selectableFrom"];
217
+ /** Latest selectable date. (yyyy-mm-dd format) */
218
+ "selectable-to"?: SkfDatePicker["selectableTo"];
219
+ /** */
220
+ selectedDate?: SkfDatePicker["selectedDate"];
221
+ /** */
222
+ selectedDateRange?: SkfDatePicker["selectedDateRange"];
223
+ /** When a date is selected */
224
+ "onselected-date-changed"?: (e: CustomEvent<never>) => void;
225
+ /** When a range of dates is selected */
226
+ "onselected-date-range-changed"?: (e: CustomEvent<never>) => void;
227
+ };
165
228
 
166
- /** Event emitted when toggled */
167
- "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
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"];
168
234
  };
169
235
 
170
236
  type SkfDialogProps = {
@@ -178,20 +244,15 @@ type SkfDialogProps = {
178
244
  "no-close-button"?: SkfDialog["noCloseButton"];
179
245
  /** If defined, removes the inner padding */
180
246
  "no-padding"?: SkfDialog["noPadding"];
181
- /** */
247
+ /** If true, indicates that the dialog is active and is available for interaction */
182
248
  open?: SkfDialog["open"];
183
- /** If provided, will run function on dialog close */
184
- onClose?: SkfDialog["onClose"];
185
- /** Method that opens the dialog in modal state */
186
- showModal?: SkfDialog["showModal"];
187
- /** Method that closes the dialog */
188
- close?: SkfDialog["close"];
249
+
189
250
  /** Fires when the dialog is opened (after transitioned in) */
190
- "onskf-dialog-open"?: (e: CustomEvent<never>) => void;
251
+ "onskf-dialog-opened"?: (e: CustomEvent<never>) => void;
191
252
  /** Fires when the dialog is closed (before transitioned out) */
192
- "onskf-dialog-close"?: (e: CustomEvent<never>) => void;
253
+ "onskf-dialog-closing"?: (e: CustomEvent<never>) => void;
193
254
  /** Fires when the dialog is closed (after transitioned out) */
194
- onclose?: (e: CustomEvent<never>) => void;
255
+ "onskf-dialog-closed"?: (e: CustomEvent<never>) => void;
195
256
  };
196
257
 
197
258
  type SkfDividerProps = {
@@ -203,22 +264,52 @@ type SkfDividerProps = {
203
264
  vertical?: SkfDivider["vertical"];
204
265
  };
205
266
 
206
- type SkfHeadingProps = {
207
- /** Controls which heading element will be rendered. Should not be used to affect appearance */
208
- as?: SkfHeading["as"];
209
- /** If provided, changes the appearance of the heading */
210
- "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;
211
290
  };
212
291
 
213
- type SkfIconProps = {
214
- /** Sets the color of the icon */
215
- color?: SkfIcon["color"];
216
- /** If defined, adds an alternate description to use for assistive devices */
217
- label?: SkfIcon["label"];
218
- /** Name of the icon to display */
219
- name?: SkfIcon["name"];
220
- /** Size of the icon */
221
- 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"];
222
313
  };
223
314
 
224
315
  type SkfInputProps = {
@@ -226,7 +317,8 @@ type SkfInputProps = {
226
317
  disabled?: SkfInput["undefined"];
227
318
  /** If true, value is required or must be checked for the form to be submittable */
228
319
  required?: SkfInput["undefined"];
229
- /** -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. */
230
322
  autocomplete?: SkfInput["autocomplete"];
231
323
  /** Custom aria-label for the clear button. **Notice!** Only applicable to type=search. */
232
324
  "button-aria-label-clear"?: SkfInput["buttonAriaLabelClear"];
@@ -316,37 +408,19 @@ type SkfLinkProps = {
316
408
  onClick?: SkfLink["onClick"];
317
409
  };
318
410
 
319
- type SkfLoaderProps = {
320
- /** Defines the aria-label */
321
- "aria-label"?: SkfLoader["ariaLabel"];
322
- /** If true, inverts the color (to be used on colored backgrounds) */
323
- invert?: SkfLoader["invert"];
324
- /** Defines the size of the loader */
325
- size?: SkfLoader["size"];
326
- /** */
327
- role?: SkfLoader["role"];
328
- /** */
329
- ariaLive?: SkfLoader["ariaLive"];
330
- };
331
-
332
- type SkfLogoProps = {
333
- /** Defines the title of the logo */
334
- title?: SkfLogo["title"];
335
- /** Defines the color of the logo */
336
- color?: SkfLogo["color"];
337
- };
338
-
339
411
  type SkfMenuProps = {
340
412
  /** The placement of the menu */
341
- placement?: SkfMenu["placement"];
342
- /** Whether the menu is open */
343
- isOpen?: SkfMenu["isOpen"];
413
+ placement?: SkfMenu["undefined"];
344
414
  /** The id of the element the menu will be anchored to */
345
- anchor?: SkfMenu["anchor"];
415
+ anchor?: SkfMenu["undefined"];
416
+ /** */
417
+ placement?: SkfMenu["placement"];
418
+ /** */
419
+ triggerEvent?: SkfMenu["triggerEvent"];
346
420
  /** Fired when the menu is opened */
347
- onopen?: (e: CustomEvent<never>) => void;
421
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
348
422
  /** Fired when the menu is closed */
349
- onclose?: (e: CustomEvent<never>) => void;
423
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
350
424
  };
351
425
 
352
426
  type SkfMenuItemProps = {
@@ -392,23 +466,32 @@ type SkfMenuItemProps = {
392
466
  onchange?: (e: CustomEvent<never>) => void;
393
467
  };
394
468
 
469
+ type SkfNavItemProps = {
470
+ /** */
471
+ href?: SkfNavItem["href"];
472
+ /** */
473
+ icon?: SkfNavItem["icon"];
474
+ };
475
+
395
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"];
396
481
  /** If defined, sets a custom offset for the popover */
397
482
  offset?: SkfPopover["offset"];
398
483
  /** If true, hides the arrow */
399
484
  hideArrow?: SkfPopover["hideArrow"];
400
485
  /** */
401
486
  arrow?: SkfPopover["arrow"];
402
- /** The placement of the menu */
487
+ /** */
403
488
  placement?: SkfPopover["placement"];
404
- /** Whether the menu is open */
405
- isOpen?: SkfPopover["isOpen"];
406
- /** The id of the element the menu will be anchored to */
407
- anchor?: SkfPopover["anchor"];
489
+ /** */
490
+ triggerEvent?: SkfPopover["triggerEvent"];
408
491
  /** Fired when the menu is opened */
409
- onopen?: (e: CustomEvent<never>) => void;
492
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
410
493
  /** Fired when the menu is closed */
411
- onclose?: (e: CustomEvent<never>) => void;
494
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
412
495
  };
413
496
 
414
497
  type SkfProgressProps = {
@@ -450,6 +533,63 @@ type SkfRadioProps = {
450
533
  onchange?: (e: CustomEvent<never>) => void;
451
534
  };
452
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
+
453
593
  type SkfSelectProps = {
454
594
  /** If true, the select is disabled `default: false` */
455
595
  disabled?: SkfSelect["undefined"];
@@ -501,46 +641,11 @@ type SkfSelectProps = {
501
641
  "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
502
642
  };
503
643
 
504
- type SkfSelectOptionProps = {
505
- /** If true, prevents interaction with the option */
506
- disabled?: SkfSelectOption["disabled"];
507
- /** If defined, set an icon */
508
- icon?: SkfSelectOption["icon"];
509
- /** If defined, sets provided color on the icon */
510
- "icon-color"?: SkfSelectOption["iconColor"];
511
- /** If true, sets the option as selected */
512
- selected?: SkfSelectOption["selected"];
513
- /** If defined, sets a short label */
514
- "short-label"?: SkfSelectOption["shortLabel"];
515
- /** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
516
- value?: SkfSelectOption["value"];
517
- /** The option's label text (equivalent to the tags textContent) */
518
- text?: SkfSelectOption["text"];
519
- /** */
520
- role?: SkfSelectOption["role"];
521
- /** */
522
- _parent?: SkfSelectOption["_parent"];
523
- /** */
524
- _shortcutUpdate?: SkfSelectOption["_shortcutUpdate"];
525
- /** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
526
- "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
527
- };
528
-
529
644
  type SkfSelectOptionGroupProps = {
530
645
  /** */
531
646
  label?: SkfSelectOptionGroup["label"];
532
647
  };
533
648
 
534
- type SkfStepperProps = {
535
- /** Sets the active item */
536
- activeIndex?: SkfStepper["activeIndex"];
537
- /** If true, sets linear mode (user can't go back to completed steps due to dependencies) */
538
- linear?: SkfStepper["linear"];
539
-
540
- /** Dispatched when the stepper item is selected */
541
- "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
542
- };
543
-
544
649
  type SkfStepperItemProps = {
545
650
  /** If defined, gives the supplied appearance */
546
651
  state?: SkfStepperItem["state"];
@@ -554,6 +659,16 @@ type SkfStepperItemProps = {
554
659
  "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
555
660
  };
556
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
+
557
672
  type SkfSwitchProps = {
558
673
  /** If true, sets disabled state */
559
674
  disabled?: SkfSwitch["undefined"];
@@ -577,19 +692,13 @@ type SkfSwitchProps = {
577
692
  value?: SkfSwitch["value"];
578
693
  };
579
694
 
580
- type SkfTabProps = {
581
- /** The name of the tab-panel this tab is associated with. The panel must be located in the same tab group. */
582
- panel?: SkfTab["panel"];
583
- /** */
584
- selected?: SkfTab["selected"];
695
+ type SkfTabPanelProps = {
696
+ /** The tab panel's name. */
697
+ name?: SkfTabPanel["name"];
585
698
  /** */
586
- variant?: SkfTab["variant"];
699
+ active?: SkfTabPanel["active"];
587
700
  /** */
588
- role?: SkfTab["role"];
589
- /** {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected */
590
- "onskf-tab-select"?: (e: CustomEvent<CustomEvent>) => void;
591
- /** Fired when the component is clicked */
592
- onclick?: (e: CustomEvent<never>) => void;
701
+ role?: SkfTabPanel["role"];
593
702
  };
594
703
 
595
704
  type SkfTabGroupProps = {
@@ -605,28 +714,19 @@ type SkfTabGroupProps = {
605
714
  variant?: SkfTabGroup["variant"];
606
715
  };
607
716
 
608
- type SkfTabPanelProps = {
609
- /** The tab panel's name. */
610
- 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"];
611
720
  /** */
612
- active?: SkfTabPanel["active"];
721
+ selected?: SkfTab["selected"];
613
722
  /** */
614
- role?: SkfTabPanel["role"];
615
- };
616
-
617
- type SkfTagProps = {
618
- /** Specifies Tag size */
619
- size?: SkfTag["size"];
620
- /** If defined, displays leading/provided icon */
621
- icon?: SkfTag["icon"];
622
- /** If defined, gives the supplied appearance */
623
- color?: SkfTag["color"];
624
- /** If true, adds trailing button to remove tag */
625
- removable?: SkfTag["removable"];
626
- /** If defined, accepts a function that runs on click */
627
- onClick?: SkfTag["onClick"];
628
- /** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
629
- 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;
630
730
  };
631
731
 
632
732
  type SkfTextAreaProps = {
@@ -677,6 +777,11 @@ type SkfTextAreaProps = {
677
777
  oninvalid?: (e: CustomEvent<never>) => void;
678
778
  };
679
779
 
780
+ type SkfToastWrapperProps = {
781
+ /** */
782
+ debug?: SkfToastWrapper["debug"];
783
+ };
784
+
680
785
  type SkfToastProps = {
681
786
  /** */
682
787
  debug?: SkfToast["debug"];
@@ -692,27 +797,48 @@ type SkfToastProps = {
692
797
  topOffset?: SkfToast["topOffset"];
693
798
  };
694
799
 
695
- type SkfToastWrapperProps = {
696
- /** */
697
- debug?: SkfToastWrapper["debug"];
698
- };
699
-
700
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"];
701
805
  /** */
702
806
  offset?: SkfTooltip["offset"];
703
- /** The placement of the dropdown */
807
+ /** */
704
808
  placement?: SkfTooltip["placement"];
705
- /** Whether the dropdown is open */
706
- isOpen?: SkfTooltip["isOpen"];
707
- /** The id of the element the dropdown will be anchored to */
708
- anchor?: SkfTooltip["anchor"];
709
809
  /** Fired when the dropdown is opened */
710
- onopen?: (e: CustomEvent<never>) => void;
810
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
711
811
  /** Fired when the dropdown is closed */
712
- onclose?: (e: CustomEvent<never>) => void;
812
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
713
813
  };
714
814
 
715
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
+
716
842
  /**
717
843
  * The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
718
844
  *
@@ -739,8 +865,20 @@ export type CustomElements = {
739
865
  */
740
866
  "skf-alert": DefineComponent<SkfAlertProps>;
741
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
+
742
878
  /**
743
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.
744
882
  * ---
745
883
  *
746
884
  *
@@ -753,14 +891,11 @@ export type CustomElements = {
753
891
  "skf-breadcrumb": DefineComponent<SkfBreadcrumbProps>;
754
892
 
755
893
  /**
756
- * 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
757
895
  * ---
758
896
  *
759
- *
760
- * ### **Slots:**
761
- * - _default_ - Label of the breadcrumb item
762
897
  */
763
- "skf-breadcrumb-item": DefineComponent<SkfBreadcrumbItemProps>;
898
+ "skf-loader": DefineComponent<SkfLoaderProps>;
764
899
 
765
900
  /**
766
901
  * Component to be used in forms or for interactivity
@@ -802,33 +937,49 @@ export type CustomElements = {
802
937
  "skf-checkbox": DefineComponent<SkfCheckboxProps>;
803
938
 
804
939
  /**
805
- * The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
806
- *
807
- * 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.
808
941
  * ---
809
942
  *
810
943
  *
811
944
  * ### **Events:**
812
- * - **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
813
947
  *
814
948
  * ### **Methods:**
815
- * - **setClose()** - Class method as alternative to manipulate attribute
816
- * - **setOpen()** - Class method as alternative to manipulate attribute
949
+ * - **gotoDate(date: _Date | string_)** - Navigates to the given date.
817
950
  *
818
951
  * ### **Slots:**
819
- * - _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)_
820
956
  */
821
- "skf-collapse": DefineComponent<SkfCollapseProps>;
957
+ "skf-datepicker": DefineComponent<SkfDatePickerProps>;
958
+
959
+ /**
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.
962
+ * ---
963
+ *
964
+ *
965
+ * ### **Slots:**
966
+ * - _default_ - The headings content
967
+ */
968
+ "skf-heading": DefineComponent<SkfHeadingProps>;
822
969
 
823
970
  /**
824
- * 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)
825
972
  * ---
826
973
  *
827
974
  *
828
975
  * ### **Events:**
829
- * - **skf-dialog-open** - Fires when the dialog is opened (after transitioned in)
830
- * - **skf-dialog-close** - Fires when the dialog is closed (before transitioned out)
831
- * - **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
832
983
  *
833
984
  * ### **Slots:**
834
985
  * - _default_ - The dialog component's content
@@ -852,63 +1003,73 @@ export type CustomElements = {
852
1003
  "skf-divider": DefineComponent<SkfDividerProps>;
853
1004
 
854
1005
  /**
855
- * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
856
- * 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.
857
1007
  * ---
858
1008
  *
859
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
+ *
860
1015
  * ### **Slots:**
861
- * - _default_ - The headings content
1016
+ * - _default_ - The Drawer's main content
862
1017
  */
863
- "skf-heading": DefineComponent<SkfHeadingProps>;
1018
+ "skf-drawer": DefineComponent<SkfDrawerProps>;
864
1019
 
865
1020
  /**
866
- * 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.
867
1022
  * ---
868
1023
  *
1024
+ *
1025
+ * ### **CSS Properties:**
1026
+ * - **--skf-logo-height** - The height of the logo _(default: undefined)_
869
1027
  */
870
- "skf-icon": DefineComponent<SkfIconProps>;
1028
+ "skf-logo": DefineComponent<SkfLogoProps>;
871
1029
 
872
1030
  /**
873
- * 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>.
874
1032
  * ---
875
1033
  *
876
1034
  *
877
- * ### **Events:**
878
- * - **change** - Fires when the value of the input changes
879
- * - **invalid** - Fires when the input is invalid
880
- *
881
1035
  * ### **Slots:**
882
- * - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
1036
+ * - _default_ - The component's main content
883
1037
  */
884
- "skf-input": DefineComponent<SkfInputProps>;
1038
+ "skf-nav": DefineComponent<SkfNavProps>;
885
1039
 
886
1040
  /**
887
- * 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
888
1042
  * ---
889
1043
  *
890
1044
  *
891
1045
  * ### **Slots:**
892
- * - _default_ - The links' main content
1046
+ * - _default_ - Navigation items
893
1047
  */
894
- "skf-link": DefineComponent<SkfLinkProps>;
1048
+ "skf-header": DefineComponent<SkfHeaderProps>;
895
1049
 
896
1050
  /**
897
- * 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.
898
1052
  * ---
899
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.
900
1061
  */
901
- "skf-loader": DefineComponent<SkfLoaderProps>;
1062
+ "skf-input": DefineComponent<SkfInputProps>;
902
1063
 
903
1064
  /**
904
- * 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
905
1066
  * ---
906
1067
  *
907
1068
  *
908
- * ### **CSS Properties:**
909
- * - **--skf-logo-height** - The height of the logo _(default: undefined)_
1069
+ * ### **Slots:**
1070
+ * - _default_ - The links' main content
910
1071
  */
911
- "skf-logo": DefineComponent<SkfLogoProps>;
1072
+ "skf-link": DefineComponent<SkfLinkProps>;
912
1073
 
913
1074
  /**
914
1075
  * The `<skf-menu>` is a component that displays a list of actions or options.
@@ -916,8 +1077,8 @@ export type CustomElements = {
916
1077
  *
917
1078
  *
918
1079
  * ### **Events:**
919
- * - **open** - Fired when the menu is opened
920
- * - **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
921
1082
  *
922
1083
  * ### **Slots:**
923
1084
  * - _default_ - The menu popover content
@@ -945,13 +1106,23 @@ export type CustomElements = {
945
1106
  "skf-menu-item": DefineComponent<SkfMenuItemProps>;
946
1107
 
947
1108
  /**
948
- * 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.
949
1120
  * ---
950
1121
  *
951
1122
  *
952
1123
  * ### **Events:**
953
- * - **open** - Fired when the menu is opened
954
- * - **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
955
1126
  *
956
1127
  * ### **Slots:**
957
1128
  * - _default_ - The popover content
@@ -979,21 +1150,29 @@ export type CustomElements = {
979
1150
  "skf-radio": DefineComponent<SkfRadioProps>;
980
1151
 
981
1152
  /**
982
- * 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
983
1154
  * ---
984
1155
  *
985
1156
  *
986
1157
  * ### **Events:**
987
- * - **change** - Fired when the selected option(s) changes
988
- * - **invalid** - Fired when the select is invalid
989
- * - **reset** - Fired when the form is reset
990
- * - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
991
- * - **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
992
1159
  *
993
1160
  * ### **Slots:**
994
- * - _default_ - The select's placeholder content
1161
+ * - _default_ - The items label
995
1162
  */
996
- "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>;
997
1176
 
998
1177
  /**
999
1178
  * The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
@@ -1010,27 +1189,41 @@ export type CustomElements = {
1010
1189
  "skf-select-option": DefineComponent<SkfSelectOptionProps>;
1011
1190
 
1012
1191
  /**
1013
- * 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
1014
1193
  * ---
1015
1194
  *
1016
1195
  *
1017
1196
  * ### **Slots:**
1018
1197
  * - _default_ - The component's placeholder content
1019
1198
  */
1020
- "skf-select-option-group": DefineComponent<SkfSelectOptionGroupProps>;
1199
+ "skf-tag": DefineComponent<SkfTagProps>;
1021
1200
 
1022
1201
  /**
1023
- * 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.
1024
1203
  * ---
1025
1204
  *
1026
1205
  *
1027
1206
  * ### **Events:**
1028
- * - **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
1029
1212
  *
1030
1213
  * ### **Slots:**
1031
- * - _default_ - One or more `<skf-stepper-item>`
1214
+ * - _default_ - The select's placeholder content
1032
1215
  */
1033
- "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>;
1034
1227
 
1035
1228
  /**
1036
1229
  * The `<skf-stepper-item>` is used in conjunction with the `<skf-stepper>` component
@@ -1045,8 +1238,23 @@ export type CustomElements = {
1045
1238
  */
1046
1239
  "skf-stepper-item": DefineComponent<SkfStepperItemProps>;
1047
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
+
1048
1254
  /**
1049
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
1050
1258
  * ---
1051
1259
  *
1052
1260
  *
@@ -1056,18 +1264,14 @@ export type CustomElements = {
1056
1264
  "skf-switch": DefineComponent<SkfSwitchProps>;
1057
1265
 
1058
1266
  /**
1059
- * 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.
1060
1268
  * ---
1061
1269
  *
1062
1270
  *
1063
- * ### **Events:**
1064
- * - **skf-tab-select** - {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
1065
- * - **click** - Fired when the component is clicked
1066
- *
1067
1271
  * ### **Slots:**
1068
- * - _default_ - The tab's label
1272
+ * - _default_ - The tab panel's content
1069
1273
  */
1070
- "skf-tab": DefineComponent<SkfTabProps>;
1274
+ "skf-tab-panel": DefineComponent<SkfTabPanelProps>;
1071
1275
 
1072
1276
  /**
1073
1277
  * The `<skf-tab-group>` is a component that displays a list of actions or options.
@@ -1081,24 +1285,18 @@ export type CustomElements = {
1081
1285
  "skf-tab-group": DefineComponent<SkfTabGroupProps>;
1082
1286
 
1083
1287
  /**
1084
- * 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
1085
1289
  * ---
1086
1290
  *
1087
1291
  *
1088
- * ### **Slots:**
1089
- * - _default_ - The tab panel's content
1090
- */
1091
- "skf-tab-panel": DefineComponent<SkfTabPanelProps>;
1092
-
1093
- /**
1094
- * The `<skf-tag>` is a component that displays a list of actions or options
1095
- * ---
1096
- *
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
1097
1295
  *
1098
1296
  * ### **Slots:**
1099
- * - _default_ - The component's placeholder content
1297
+ * - _default_ - The tab's label
1100
1298
  */
1101
- "skf-tag": DefineComponent<SkfTagProps>;
1299
+ "skf-tab": DefineComponent<SkfTabProps>;
1102
1300
 
1103
1301
  /**
1104
1302
  * The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
@@ -1115,33 +1313,33 @@ export type CustomElements = {
1115
1313
  "skf-textarea": DefineComponent<SkfTextAreaProps>;
1116
1314
 
1117
1315
  /**
1118
- * 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.
1119
1317
  * ---
1120
1318
  *
1121
1319
  *
1122
1320
  * ### **Slots:**
1123
- * - _default_ - The component's placeholder content
1321
+ * - _default_ - The alert components that the toast creates will render here.
1124
1322
  */
1125
- "skf-toast": DefineComponent<SkfToastProps>;
1323
+ "skf-toast-wrapper": DefineComponent<SkfToastWrapperProps>;
1126
1324
 
1127
1325
  /**
1128
- * 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.
1129
1327
  * ---
1130
1328
  *
1131
1329
  *
1132
1330
  * ### **Slots:**
1133
- * - _default_ - The alert components that the toast creates will render here.
1331
+ * - _default_ - The component's placeholder content
1134
1332
  */
1135
- "skf-toast-wrapper": DefineComponent<SkfToastWrapperProps>;
1333
+ "skf-toast": DefineComponent<SkfToastProps>;
1136
1334
 
1137
1335
  /**
1138
- * 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.
1139
1337
  * ---
1140
1338
  *
1141
1339
  *
1142
1340
  * ### **Events:**
1143
- * - **open** - Fired when the dropdown is opened
1144
- * - **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
1145
1343
  *
1146
1344
  * ### **Slots:**
1147
1345
  * - _default_ - The tooltip popover content