@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,3 +1,49 @@
1
+ import type { SkfIcon } from "../../components/icon/icon.component.js";
2
+ import type { SkfCollapse, CustomEvent } from "../../components/collapse/collapse.component.js";
3
+ import type { SkfAccordion } from "../../components/accordion/accordion.component.js";
4
+ import type { SkfAlert } from "../../components/alert/alert.component.js";
5
+ import type { SkfBreadcrumbItem } from "../../components/breadcrumb-item/breadcrumb-item.component.js";
6
+ import type { SkfBreadcrumb } from "../../components/breadcrumb/breadcrumb.component.js";
7
+ import type { SkfLoader } from "../../components/loader/loader.component.js";
8
+ import type { SkfButton } from "../../components/button/button.component.js";
9
+ import type { SkfCard } from "../../components/card/card.component.js";
10
+ import type { SkfCheckbox } from "../../components/checkbox/checkbox.component.js";
11
+ import type { SkfDatePicker } from "../../components/datepicker/datepicker.component.js";
12
+ import type { SkfHeading } from "../../components/heading/heading.component.js";
13
+ import type { SkfDialog } from "../../components/dialog/dialog.component.js";
14
+ import type { SkfDivider } from "../../components/divider/divider.component.js";
15
+ import type { SkfDrawer } from "../../components/drawer/drawer.component.js";
16
+ import type { SkfLogo } from "../../components/logo/logo.component.js";
17
+ import type { SkfNav } from "../../components/nav/nav.component.js";
18
+ import type { SkfHeader } from "../../components/header/header.component.js";
19
+ import type { SkfInput } from "../../components/input/input.component.js";
20
+ import type { SkfLink } from "../../components/link/link.component.js";
21
+ import type { SkfMenu } from "../../components/menu/menu.component.js";
22
+ import type { SkfMenuItem, CustomEvent } from "../../components/menu-item/menu-item.component.js";
23
+ import type { SkfNavItem } from "../../components/nav-item/nav-item.component.js";
24
+ import type { SkfPopover } from "../../components/popover/popover.component.js";
25
+ import type { SkfProgress } from "../../components/progress/progress.component.js";
26
+ import type { SkfRadio } from "../../components/radio/radio.component.js";
27
+ import type {
28
+ SkfSegmentedButtonItem,
29
+ CustomEvent,
30
+ } from "../../components/segmented-button-item/segmented-button-item.component.js";
31
+ import type { SkfSegmentedButton } from "../../components/segmented-button/segmented-button.component.js";
32
+ import type { SkfSelectOption } from "../../components/select-option/select-option.component.js";
33
+ import type { SkfTag } from "../../components/tag/tag.component.js";
34
+ import type { SkfSelect } from "../../components/select/select.component.js";
35
+ import type { SkfSelectOptionGroup } from "../../components/select-option-group/select-option-group.component.js";
36
+ import type { SkfStepperItem } from "../../components/stepper-item/stepper-item.component.js";
37
+ import type { SkfStepper } from "../../components/stepper/stepper.component.js";
38
+ import type { SkfSwitch } from "../../components/switch/switch.component.js";
39
+ import type { SkfTabPanel } from "../../components/tab-panel/tab-panel.component.js";
40
+ import type { SkfTabGroup } from "../../components/tab-group/tab-group.component.js";
41
+ import type { SkfTab, CustomEvent } from "../../components/tab/tab.component.js";
42
+ import type { SkfTextArea } from "../../components/textarea/textarea.component.js";
43
+ import type { SkfToastWrapper } from "../../components/toast-wrapper/toast-wrapper.component.js";
44
+ import type { SkfToast } from "../../components/toast/toast.component.js";
45
+ import type { SkfTooltip } from "../../components/tooltip/tooltip.component.js";
46
+
1
47
  /**
2
48
  * This type can be used to create scoped tags for your components.
3
49
  *
@@ -60,224 +106,115 @@ type BaseProps = {
60
106
 
61
107
  type BaseEvents = {};
62
108
 
109
+ export type SkfIconProps = {
110
+ /** Sets the color of the icon */
111
+ color?: SkfIcon["color"];
112
+ /** If defined, adds an alternate description to use for assistive devices */
113
+ label?: SkfIcon["label"];
114
+ /** Name of the icon to display */
115
+ name?: SkfIcon["name"];
116
+ /** Size of the icon */
117
+ size?: SkfIcon["size"];
118
+ };
119
+
120
+ export type SkfCollapseProps = {
121
+ /** If true, will animate the expand/collapse state */
122
+ animated?: SkfCollapse["animated"];
123
+ /** If true, will set the collapse to be expanded by default */
124
+ expanded?: SkfCollapse["expanded"];
125
+ /** Heading for the collapse */
126
+ heading?: SkfCollapse["heading"];
127
+ /** Defines which heading element will be rendered */
128
+ "heading-as"?: SkfCollapse["headingAs"];
129
+ /** If true, renders the small version */
130
+ small?: SkfCollapse["small"];
131
+ /** If true, will truncate the heading in collapsed state */
132
+ truncate?: SkfCollapse["truncate"];
133
+
134
+ /** Event emitted when toggled */
135
+ "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
136
+ };
137
+
63
138
  export type SkfAccordionProps = {
64
139
  /** If true, will animate the expand/collapse state */
65
- animated?: boolean | undefined;
140
+ animated?: SkfAccordion["animated"];
66
141
  /** Defines which heading element will be rendered */
67
- "heading-as"?: "h1" | "h2" | "h3" | "h4";
142
+ "heading-as"?: SkfAccordion["headingAs"];
68
143
  /** If true, adds a gap between each item */
69
- gap?: boolean;
144
+ gap?: SkfAccordion["gap"];
70
145
  /** If true, allowes multiple accordion items to open */
71
- multiple?: boolean | undefined;
146
+ multiple?: SkfAccordion["multiple"];
72
147
  /** If true, renders the small version */
73
- small?: boolean | undefined;
148
+ small?: SkfAccordion["small"];
74
149
  /** If true, will truncate all headings in collapsed state */
75
- truncate?: boolean | undefined;
150
+ truncate?: SkfAccordion["truncate"];
76
151
  };
77
152
 
78
153
  export type SkfAlertProps = {
79
154
  /** Close button aria-label */
80
- "button-label"?: string;
155
+ "button-label"?: SkfAlert["buttonLabel"];
81
156
  /** If defined, displays leading icon */
82
- icon?: SkfIcon["name"] | undefined;
157
+ icon?: SkfAlert["icon"];
83
158
  /** If true, renders with an close button and sets aria-role to `status` */
84
- persistent?: boolean | undefined;
159
+ persistent?: SkfAlert["persistent"];
85
160
  /** If defined, gives the supplied appearance */
86
- severity?: "error" | "info" | "warning" | "success" | "alert";
161
+ severity?: SkfAlert["severity"];
87
162
 
88
163
  /** Fires when the close button is clicked */
89
164
  "onskf-alert-close"?: (e: CustomEvent<never>) => void;
90
165
  };
91
166
 
167
+ export type SkfBreadcrumbItemProps = {
168
+ /** If defined, loads url on click */
169
+ href?: SkfBreadcrumbItem["href"];
170
+ /** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
171
+ onClick?: SkfBreadcrumbItem["onClick"];
172
+ };
173
+
92
174
  export type SkfBreadcrumbProps = {
93
175
  /** aria-label for the breadcrumb control */
94
- label?: string;
176
+ label?: SkfBreadcrumb["label"];
95
177
  /** Displays an alternative size */
96
- size?: "md" | "sm";
178
+ size?: SkfBreadcrumb["size"];
97
179
 
98
180
  /** Fired when the item is clicked */
99
181
  onclick?: (e: CustomEvent<never>) => void;
100
182
  };
101
183
 
102
- export type SkfBreadcrumbItemProps = {
103
- /** If defined, loads url on click */
104
- href?: string | undefined;
105
- /** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
106
- onClick?: string;
184
+ export type SkfLoaderProps = {
185
+ /** Defines the aria-label */
186
+ "aria-label"?: SkfLoader["ariaLabel"];
187
+ /** If true, inverts the color (to be used on colored backgrounds) */
188
+ invert?: SkfLoader["invert"];
189
+ /** Defines the size of the loader */
190
+ size?: SkfLoader["size"];
191
+ /** */
192
+ role?: SkfLoader["role"];
193
+ /** */
194
+ ariaLive?: SkfLoader["ariaLive"];
107
195
  };
108
196
 
109
197
  export type SkfButtonProps = {
110
198
  /** If true, gives destructive appearance. **Notice!** Only applicable if `variant` is `primary`. */
111
- destructive?: boolean;
199
+ destructive?: SkfButton["destructive"];
112
200
  /** If true, removes border */
113
- disabled?: boolean;
201
+ disabled?: SkfButton["disabled"];
114
202
  /** If provided, renders an icon before or after the text */
115
- icon?:
116
- | "arrowDown"
117
- | "arrowDownUp"
118
- | "arrowLeft"
119
- | "arrowRight"
120
- | "arrowUp"
121
- | "article"
122
- | "artificialIntelligence"
123
- | "asset"
124
- | "attachment"
125
- | "bandCursor"
126
- | "bands"
127
- | "batteryEmpty"
128
- | "batteryFull"
129
- | "batteryLow"
130
- | "bearingFault"
131
- | "book"
132
- | "bulb"
133
- | "burger"
134
- | "cPM"
135
- | "calendar"
136
- | "calendarBooked"
137
- | "calendarEmpty"
138
- | "calendarNotBooked"
139
- | "calendarRecurring"
140
- | "caretDown"
141
- | "caretUp"
142
- | "caretUpDown"
143
- | "chat"
144
- | "check"
145
- | "checkCircle"
146
- | "checkSmall"
147
- | "chevronDown"
148
- | "chevronLeft"
149
- | "chevronRight"
150
- | "chevronUp"
151
- | "chevronUpDown"
152
- | "close"
153
- | "closeAllFaults"
154
- | "closeFault"
155
- | "closeSmall"
156
- | "columnGraph"
157
- | "comment"
158
- | "connection1"
159
- | "connection2"
160
- | "connection3"
161
- | "connection4"
162
- | "danger"
163
- | "defectFrequencies"
164
- | "defectFrequenciesAlternative"
165
- | "doubleChevronLeft"
166
- | "doubleChevronRight"
167
- | "download"
168
- | "draft"
169
- | "draftFilled"
170
- | "draftOutlined"
171
- | "dragNDrop"
172
- | "drop"
173
- | "duplicate"
174
- | "edit"
175
- | "emailFilled"
176
- | "emailOutlined"
177
- | "exclamation"
178
- | "eye"
179
- | "eyeHidden"
180
- | "eyeVisible"
181
- | "filter"
182
- | "forbidden"
183
- | "fullScreen"
184
- | "fullScreenExit"
185
- | "functionalLocation"
186
- | "harmonicCursor"
187
- | "heatmap"
188
- | "hierarchy"
189
- | "history"
190
- | "historyAlt"
191
- | "hourglassFramedFilled"
192
- | "hourglassFramedOutlined"
193
- | "hourglassOutlined"
194
- | "hz"
195
- | "iMX"
196
- | "image"
197
- | "infoCircleFilled"
198
- | "infoCircleOutlined"
199
- | "integration"
200
- | "kebab"
201
- | "link"
202
- | "listGroup"
203
- | "listItem"
204
- | "locationPin"
205
- | "lock"
206
- | "logOut"
207
- | "meatballs"
208
- | "microphone"
209
- | "minus"
210
- | "minusSmall"
211
- | "noData"
212
- | "o"
213
- | "openInNew"
214
- | "overlayBaseline"
215
- | "pDF"
216
- | "paper"
217
- | "pause"
218
- | "pieChart"
219
- | "pin"
220
- | "play"
221
- | "plus"
222
- | "powerOff"
223
- | "printer"
224
- | "proCollect"
225
- | "recAction"
226
- | "received"
227
- | "refresh"
228
- | "reorder"
229
- | "replace"
230
- | "reply"
231
- | "rewalkableRoute"
232
- | "routes"
233
- | "search"
234
- | "send"
235
- | "sensorA"
236
- | "sensorB"
237
- | "settings"
238
- | "sidebandCursor"
239
- | "singleCursor"
240
- | "spectrum"
241
- | "starFilled"
242
- | "starOutlined"
243
- | "statusCircle"
244
- | "stop"
245
- | "structuralVibration"
246
- | "sync"
247
- | "timewave"
248
- | "trash"
249
- | "trend"
250
- | "trendingUp"
251
- | "undo"
252
- | "unknownCircle"
253
- | "unknownDiamond"
254
- | "unlink"
255
- | "unlock"
256
- | "unscheduledAction"
257
- | "upload"
258
- | "user"
259
- | "viewFull"
260
- | "viewHorizontal"
261
- | "viewVertical"
262
- | "warning"
263
- | "warningCircle"
264
- | "warningDiamond"
265
- | "zoomIn"
266
- | "zoomOut";
203
+ icon?: SkfButton["icon"];
267
204
  /** If true, removes border */
268
- iconOnly?: boolean;
269
- /** If provided, determines the positioning of the icon in relation to the text */
270
- "icon-position"?: "left" | "right" | undefined;
205
+ iconOnly?: SkfButton["iconOnly"];
206
+ /** Determines the positioning of the icon in relation to the text */
207
+ "icon-position"?: SkfButton["iconPosition"];
271
208
  /** If true, hides text & icon and shows loading indicator. **Notice!** Only applicable if `variant` is `primary`. */
272
- loading?: boolean;
209
+ loading?: SkfButton["loading"];
273
210
  /** */
274
- "no-validate"?: boolean;
211
+ "no-validate"?: SkfButton["noValidate"];
275
212
  /** If provided, displays an alternative size */
276
- size?: "sm" | "md" | "lg";
213
+ size?: SkfButton["size"];
277
214
  /** If provided, changes the button type */
278
- type?: "button" | "submit" | "reset";
215
+ type?: SkfButton["type"];
279
216
  /** If provided, alters the appearance */
280
- variant?: "primary" | "secondary" | "tertiary";
217
+ variant?: SkfButton["variant"];
281
218
 
282
219
  /** Fires when the button is clicked */
283
220
  onclick?: (e: CustomEvent<never>) => void;
@@ -285,347 +222,216 @@ export type SkfButtonProps = {
285
222
 
286
223
  export type SkfCardProps = {
287
224
  /** If true, removes border */
288
- "no-border"?: boolean;
225
+ "no-border"?: SkfCard["noBorder"];
289
226
  /** If true, removes padding */
290
- "no-padding"?: boolean;
227
+ "no-padding"?: SkfCard["noPadding"];
291
228
  /** If true, the Card fills the parent element height */
292
- stretch?: boolean;
229
+ stretch?: SkfCard["stretch"];
293
230
  };
294
231
 
295
232
  export type SkfCheckboxProps = {
296
233
  /** If true, sets disabled state */
297
- disabled?: boolean;
234
+ disabled?: SkfCheckbox["undefined"];
298
235
  /** If true, value is required or must be checked for the form to be submittable */
299
- required?: boolean;
236
+ required?: SkfCheckbox["undefined"];
300
237
  /** If defined, outputs helping hints in console */
301
- debug?: boolean | undefined;
238
+ debug?: SkfCheckbox["debug"];
302
239
  /** If true, outputs helping hints in console */
303
- checked?: boolean | undefined;
240
+ checked?: SkfCheckbox["checked"];
304
241
  /** If true, forces component to invalid state until removed */
305
- "custom-invalid"?: boolean | undefined;
242
+ "custom-invalid"?: SkfCheckbox["customInvalid"];
306
243
  /** If true and the checkbox is unchecked, the checkbox will appear indeterminate */
307
- indeterminate?: boolean | undefined;
244
+ indeterminate?: SkfCheckbox["indeterminate"];
308
245
  /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
309
- label?: string | undefined;
246
+ label?: SkfCheckbox["label"];
310
247
  /** If defined, adds name to the input-element */
311
- name?: string | undefined;
248
+ name?: SkfCheckbox["name"];
312
249
  /** If defined, renders an alternative A11y text for the asterisk */
313
- "required-label"?: string | undefined;
250
+ "required-label"?: SkfCheckbox["requiredLabel"];
314
251
  /** If defined, styles checkbox using provided severity */
315
- severity?: "alert" | "success" | "info" | "warning";
252
+ severity?: SkfCheckbox["severity"];
316
253
  /** If true, displays valid state after interaction */
317
- "show-valid"?: boolean | undefined;
254
+ "show-valid"?: SkfCheckbox["showValid"];
318
255
  /** Size of the checkbox */
319
- size?: "sm" | "md";
256
+ size?: SkfCheckbox["size"];
320
257
  /** The current value of the input field */
321
- value?: string;
258
+ value?: SkfCheckbox["value"];
322
259
 
323
260
  /** {object} - When the value of the input changes */
324
261
  onchange?: (e: CustomEvent<never>) => void;
325
262
  };
326
263
 
327
- export type SkfCollapseProps = {
328
- /** If true, will animate the expand/collapse state */
329
- animated?: boolean;
330
- /** If true, will set the collapse to be expanded by default */
331
- expanded?: boolean;
332
- /** Heading for the collapse */
333
- heading?: string | undefined;
334
- /** Defines which heading element will be rendered */
335
- "heading-as"?: "h2" | "h3" | "h4";
336
- /** If true, renders the small version */
337
- small?: boolean;
338
- /** If true, will truncate the heading in collapsed state */
339
- truncate?: boolean;
264
+ export type SkfDatePickerProps = {
265
+ /** The locale to use for formatting the date */
266
+ locale?: SkfDatePicker["locale"];
267
+ /** The date to display in the date picker */
268
+ date?: SkfDatePicker["date"];
269
+ /** */
270
+ id?: SkfDatePicker["id"];
271
+ /** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
272
+ "invalid-dates"?: SkfDatePicker["invalidDates"];
273
+ /** If true, the date picker will allow the selection of a range of dates */
274
+ range?: SkfDatePicker["range"];
275
+ /** Earliest selectable date. (yyyy-mm-dd format) */
276
+ "selectable-from"?: SkfDatePicker["selectableFrom"];
277
+ /** Latest selectable date. (yyyy-mm-dd format) */
278
+ "selectable-to"?: SkfDatePicker["selectableTo"];
279
+ /** */
280
+ selectedDate?: SkfDatePicker["selectedDate"];
281
+ /** */
282
+ selectedDateRange?: SkfDatePicker["selectedDateRange"];
283
+ /** When a date is selected */
284
+ "onselected-date-changed"?: (e: CustomEvent<never>) => void;
285
+ /** When a range of dates is selected */
286
+ "onselected-date-range-changed"?: (e: CustomEvent<never>) => void;
287
+ };
340
288
 
341
- /** Event emitted when toggled */
342
- "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
289
+ export type SkfHeadingProps = {
290
+ /** Controls which heading element will be rendered. Should not be used to affect appearance */
291
+ as?: SkfHeading["as"];
292
+ /** If defined, changes the appearance of the heading */
293
+ "styled-as"?: SkfHeading["styledAs"];
343
294
  };
344
295
 
345
296
  export type SkfDialogProps = {
346
297
  /** If defined, sets the aria-label for the close button */
347
- "close-button-aria-label"?: string | undefined;
298
+ "close-button-aria-label"?: SkfDialog["closeButtonAriaLabel"];
348
299
  /** Title for the modal/dialog */
349
- heading?: string | undefined;
300
+ heading?: SkfDialog["heading"];
350
301
  /** If true, makes the dialog stretch edge to edge on screen */
351
- fullscreen?: boolean;
302
+ fullscreen?: SkfDialog["fullscreen"];
352
303
  /** If true, removes the close button */
353
- "no-close-button"?: boolean;
304
+ "no-close-button"?: SkfDialog["noCloseButton"];
354
305
  /** If defined, removes the inner padding */
355
- "no-padding"?: boolean;
356
- /** */
357
- open?: boolean | null | undefined;
358
- /** If provided, will run function on dialog close */
359
- onClose?: ((event: Event) => void) | null | undefined;
360
- /** Method that opens the dialog in modal state */
361
- showModal?: string;
362
- /** Method that closes the dialog */
363
- close?: string;
306
+ "no-padding"?: SkfDialog["noPadding"];
307
+ /** If true, indicates that the dialog is active and is available for interaction */
308
+ open?: SkfDialog["open"];
309
+
364
310
  /** Fires when the dialog is opened (after transitioned in) */
365
- "onskf-dialog-open"?: (e: CustomEvent<never>) => void;
311
+ "onskf-dialog-opened"?: (e: CustomEvent<never>) => void;
366
312
  /** Fires when the dialog is closed (before transitioned out) */
367
- "onskf-dialog-close"?: (e: CustomEvent<never>) => void;
313
+ "onskf-dialog-closing"?: (e: CustomEvent<never>) => void;
368
314
  /** Fires when the dialog is closed (after transitioned out) */
369
- onclose?: (e: CustomEvent<never>) => void;
315
+ "onskf-dialog-closed"?: (e: CustomEvent<never>) => void;
370
316
  };
371
317
 
372
318
  export type SkfDividerProps = {
373
319
  /** Defines the Divider color */
374
- color?: "emphasised" | "primary" | "secondary" | "tertiary" | "inverse";
320
+ color?: SkfDivider["color"];
375
321
  /** If true, renders a div for presentational purpose instead of the semantic hr-element */
376
- decorative?: boolean;
322
+ decorative?: SkfDivider["decorative"];
377
323
  /** If true, renders the divider vertically */
378
- vertical?: boolean;
324
+ vertical?: SkfDivider["vertical"];
379
325
  };
380
326
 
381
- export type SkfHeadingProps = {
382
- /** Controls which heading element will be rendered. Should not be used to affect appearance */
383
- as?: "h1" | "h2" | "h3" | "h4";
384
- /** If provided, changes the appearance of the heading */
385
- "styled-as"?: "h1" | "h2" | "h3" | "h4";
327
+ export type SkfDrawerProps = {
328
+ /** If defined, sets the aria-label for the close button */
329
+ "close-button-aria-label"?: SkfDrawer["closeButtonAriaLabel"];
330
+ /** Heading for the Drawer */
331
+ heading?: SkfDrawer["heading"];
332
+ /** Sets the max-width */
333
+ size?: SkfDrawer["size"];
334
+ /** If true, Drawer is open */
335
+ open?: SkfDrawer["open"];
336
+ /** Placement of the Drawer */
337
+ placement?: SkfDrawer["placement"];
338
+ /** */
339
+ _clickstartInDialog?: SkfDrawer["_clickstartInDialog"];
340
+ /** */
341
+ _handleMouseDown?: SkfDrawer["_handleMouseDown"];
342
+ /** */
343
+ _handleMouseUp?: SkfDrawer["_handleMouseUp"];
344
+ /** Fires when the drawer is opened (after transitioned in) */
345
+ "onskf-drawer-opened"?: (e: CustomEvent<never>) => void;
346
+ /** Fires when the drawer is closed (before transitioned out) */
347
+ "onskf-drawer-closing"?: (e: CustomEvent<never>) => void;
348
+ /** Fires when the drawer is closed (after transitioned out) */
349
+ "onskf-drawer-closed"?: (e: CustomEvent<never>) => void;
386
350
  };
387
351
 
388
- export type SkfIconProps = {
389
- /** Sets the color of the icon */
390
- color?: "primary" | "inverse" | "emphasised" | "secondary" | "success" | "info" | "warning" | "error" | "alert";
391
- /** If defined, adds an alternate description to use for assistive devices */
392
- label?: string | undefined;
393
- /** Name of the icon to display */
394
- name?:
395
- | "arrowDown"
396
- | "arrowDownUp"
397
- | "arrowLeft"
398
- | "arrowRight"
399
- | "arrowUp"
400
- | "article"
401
- | "artificialIntelligence"
402
- | "asset"
403
- | "attachment"
404
- | "bandCursor"
405
- | "bands"
406
- | "batteryEmpty"
407
- | "batteryFull"
408
- | "batteryLow"
409
- | "bearingFault"
410
- | "book"
411
- | "bulb"
412
- | "burger"
413
- | "cPM"
414
- | "calendar"
415
- | "calendarBooked"
416
- | "calendarEmpty"
417
- | "calendarNotBooked"
418
- | "calendarRecurring"
419
- | "caretDown"
420
- | "caretUp"
421
- | "caretUpDown"
422
- | "chat"
423
- | "check"
424
- | "checkCircle"
425
- | "checkSmall"
426
- | "chevronDown"
427
- | "chevronLeft"
428
- | "chevronRight"
429
- | "chevronUp"
430
- | "chevronUpDown"
431
- | "close"
432
- | "closeAllFaults"
433
- | "closeFault"
434
- | "closeSmall"
435
- | "columnGraph"
436
- | "comment"
437
- | "connection1"
438
- | "connection2"
439
- | "connection3"
440
- | "connection4"
441
- | "danger"
442
- | "defectFrequencies"
443
- | "defectFrequenciesAlternative"
444
- | "doubleChevronLeft"
445
- | "doubleChevronRight"
446
- | "download"
447
- | "draft"
448
- | "draftFilled"
449
- | "draftOutlined"
450
- | "dragNDrop"
451
- | "drop"
452
- | "duplicate"
453
- | "edit"
454
- | "emailFilled"
455
- | "emailOutlined"
456
- | "exclamation"
457
- | "eye"
458
- | "eyeHidden"
459
- | "eyeVisible"
460
- | "filter"
461
- | "forbidden"
462
- | "fullScreen"
463
- | "fullScreenExit"
464
- | "functionalLocation"
465
- | "harmonicCursor"
466
- | "heatmap"
467
- | "hierarchy"
468
- | "history"
469
- | "historyAlt"
470
- | "hourglassFramedFilled"
471
- | "hourglassFramedOutlined"
472
- | "hourglassOutlined"
473
- | "hz"
474
- | "iMX"
475
- | "image"
476
- | "infoCircleFilled"
477
- | "infoCircleOutlined"
478
- | "integration"
479
- | "kebab"
480
- | "link"
481
- | "listGroup"
482
- | "listItem"
483
- | "locationPin"
484
- | "lock"
485
- | "logOut"
486
- | "meatballs"
487
- | "microphone"
488
- | "minus"
489
- | "minusSmall"
490
- | "noData"
491
- | "o"
492
- | "openInNew"
493
- | "overlayBaseline"
494
- | "pDF"
495
- | "paper"
496
- | "pause"
497
- | "pieChart"
498
- | "pin"
499
- | "play"
500
- | "plus"
501
- | "powerOff"
502
- | "printer"
503
- | "proCollect"
504
- | "recAction"
505
- | "received"
506
- | "refresh"
507
- | "reorder"
508
- | "replace"
509
- | "reply"
510
- | "rewalkableRoute"
511
- | "routes"
512
- | "search"
513
- | "send"
514
- | "sensorA"
515
- | "sensorB"
516
- | "settings"
517
- | "sidebandCursor"
518
- | "singleCursor"
519
- | "spectrum"
520
- | "starFilled"
521
- | "starOutlined"
522
- | "statusCircle"
523
- | "stop"
524
- | "structuralVibration"
525
- | "sync"
526
- | "timewave"
527
- | "trash"
528
- | "trend"
529
- | "trendingUp"
530
- | "undo"
531
- | "unknownCircle"
532
- | "unknownDiamond"
533
- | "unlink"
534
- | "unlock"
535
- | "unscheduledAction"
536
- | "upload"
537
- | "user"
538
- | "viewFull"
539
- | "viewHorizontal"
540
- | "viewVertical"
541
- | "warning"
542
- | "warningCircle"
543
- | "warningDiamond"
544
- | "zoomIn"
545
- | "zoomOut";
546
- /** Size of the icon */
547
- size?: "xs" | "sm" | "md" | "lg";
352
+ export type SkfLogoProps = {
353
+ /** Defines the title of the logo */
354
+ title?: SkfLogo["title"];
355
+ /** Defines the color of the logo */
356
+ color?: SkfLogo["color"];
357
+ };
358
+
359
+ export type SkfNavProps = {
360
+ /** */
361
+ vertical?: SkfNav["vertical"];
362
+ };
363
+
364
+ export type SkfHeaderProps = {
365
+ /** If true, sets header to display in compact mode only (hanburger menu and drawer) */
366
+ compact?: SkfHeader["compact"];
367
+ /** If defined, sets the aria-label for the hamburger button */
368
+ "hamburger-aria-label"?: SkfHeader["hamburgerAriaLabel"];
369
+ /** If defined, sets the app or site's name */
370
+ "site-name"?: SkfHeader["siteName"];
371
+ /** If defined, sets the site's base-url for the "logo-link" */
372
+ "site-url"?: SkfHeader["siteUrl"];
548
373
  };
549
374
 
550
375
  export type SkfInputProps = {
551
376
  /** If true, sets disabled state */
552
- disabled?: boolean;
377
+ disabled?: SkfInput["undefined"];
553
378
  /** If true, value is required or must be checked for the form to be submittable */
554
- required?: boolean;
555
- /** -m } */
556
- autocomplete?: string;
379
+ required?: SkfInput["undefined"];
380
+ /** Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
381
+ [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values. */
382
+ autocomplete?: SkfInput["autocomplete"];
557
383
  /** Custom aria-label for the clear button. **Notice!** Only applicable to type=search. */
558
- "button-aria-label-clear"?: string;
384
+ "button-aria-label-clear"?: SkfInput["buttonAriaLabelClear"];
559
385
  /** Custom aria-label for the visibility button. **Notice!** Only applicable to type=password. */
560
- "button-aria-label-hide"?: string;
386
+ "button-aria-label-hide"?: SkfInput["buttonAriaLabelHide"];
561
387
  /** Custom aria-label for the visibility button **Notice!** Only applicable to type=password. */
562
- "button-aria-label-show"?: string;
388
+ "button-aria-label-show"?: SkfInput["buttonAriaLabelShow"];
563
389
  /** If defined, forces component to invalid state until removed. Its value is used as hint text. */
564
- "custom-invalid"?: string;
390
+ "custom-invalid"?: SkfInput["customInvalid"];
565
391
  /** If true, outputs helping hints in console */
566
- debug?: boolean | undefined;
392
+ debug?: SkfInput["debug"];
567
393
  /** If true, hides the label visually */
568
- "hide-label"?: boolean | undefined;
394
+ "hide-label"?: SkfInput["hideLabel"];
569
395
  /** If defined, displays informational text below the field */
570
- hint?: string | undefined;
396
+ hint?: SkfInput["hint"];
571
397
  /** Tells what keyboard to use if applicable */
572
- inputmode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search";
398
+ inputmode?: SkfInput["inputmode"];
573
399
  /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
574
- label?: string | undefined;
400
+ label?: SkfInput["label"];
575
401
  /** If defined, displays a prefix/adornment before the input-element */
576
- leading?: string | undefined;
402
+ leading?: SkfInput["leading"];
577
403
  /** If defined, sets the maximum value to accept for this input */
578
- max?: number | string | undefined;
404
+ max?: SkfInput["max"];
579
405
  /** If defined, sets the maximum character length to accept for this input */
580
- maxlength?: number | undefined;
406
+ maxlength?: SkfInput["maxLength"];
581
407
  /** If defined, sets the minimum value to accept for this input */
582
- min?: number | string | undefined;
408
+ min?: SkfInput["min"];
583
409
  /** If defined, sets the minimum character length to accept for this input */
584
- minlength?: number | undefined;
410
+ minlength?: SkfInput["minLength"];
585
411
  /** If defined, adds name to the input-element */
586
- name?: string | undefined;
412
+ name?: SkfInput["name"];
587
413
  /** If defined, adds name to the input-element */
588
- pattern?: string | undefined;
414
+ pattern?: SkfInput["pattern"];
589
415
  /** If defined, displays placeholder text */
590
- placeholder?: string | undefined;
416
+ placeholder?: SkfInput["placeholder"];
591
417
  /** If true, makes the element not mutable, meaning the user can not edit the control */
592
- readonly?: boolean | undefined;
418
+ readonly?: SkfInput["readonly"];
593
419
  /** If defined, renders an alternative A11y text for the asterisk */
594
- "required-label"?: string | undefined;
420
+ "required-label"?: SkfInput["requiredLabel"];
595
421
  /** If defined, displays provided severity state */
596
- severity?: "alert" | "success" | "info" | "warning";
422
+ severity?: SkfInput["severity"];
597
423
  /** If true, displays valid state after interaction */
598
- "show-valid"?: boolean | undefined;
424
+ "show-valid"?: SkfInput["showValid"];
599
425
  /** Size of the input */
600
- size?: "sm" | "md";
426
+ size?: SkfInput["size"];
601
427
  /** If defined, displays a suffix/adornment after the input-element */
602
- trailing?: string | undefined;
428
+ trailing?: SkfInput["trailing"];
603
429
  /** Type of input control */
604
- type?:
605
- | "button"
606
- | "color"
607
- | "date"
608
- | "datetime-local"
609
- | "email"
610
- | "file"
611
- | "hidden"
612
- | "image"
613
- | "month"
614
- | "number"
615
- | "password"
616
- | "range"
617
- | "reset"
618
- | "search"
619
- | "submit"
620
- | "tel"
621
- | "text"
622
- | "time"
623
- | "url"
624
- | "week";
430
+ type?: SkfInput["type"];
625
431
  /** Sets validation start */
626
- "validate-on"?: "input" | "change" | "submit";
432
+ "validate-on"?: SkfInput["validateOn"];
627
433
  /** The current value of the input field */
628
- value?: string;
434
+ value?: SkfInput["value"];
629
435
 
630
436
  /** Fires when the value of the input changes */
631
437
  onchange?: (e: CustomEvent<never>) => void;
@@ -635,407 +441,75 @@ export type SkfInputProps = {
635
441
 
636
442
  export type SkfLinkProps = {
637
443
  /** Defines the semantic element to render */
638
- as?: "button" | "a";
444
+ as?: SkfLink["as"];
639
445
  /** Defines the text-color */
640
- color?: "primary" | "inverse";
446
+ color?: SkfLink["color"];
641
447
  /** If true, disables the link */
642
- disabled?: boolean | undefined;
448
+ disabled?: SkfLink["disabled"];
643
449
  /** If defined, downloads the url */
644
- download?: string | undefined;
450
+ download?: SkfLink["download"];
645
451
  /** If defined, loads url on click */
646
- href?: string | undefined;
452
+ href?: SkfLink["href"];
647
453
  /** If defined, renders an icon before or after the text */
648
- icon?:
649
- | "arrowDown"
650
- | "arrowDownUp"
651
- | "arrowLeft"
652
- | "arrowRight"
653
- | "arrowUp"
654
- | "article"
655
- | "artificialIntelligence"
656
- | "asset"
657
- | "attachment"
658
- | "bandCursor"
659
- | "bands"
660
- | "batteryEmpty"
661
- | "batteryFull"
662
- | "batteryLow"
663
- | "bearingFault"
664
- | "book"
665
- | "bulb"
666
- | "burger"
667
- | "cPM"
668
- | "calendar"
669
- | "calendarBooked"
670
- | "calendarEmpty"
671
- | "calendarNotBooked"
672
- | "calendarRecurring"
673
- | "caretDown"
674
- | "caretUp"
675
- | "caretUpDown"
676
- | "chat"
677
- | "check"
678
- | "checkCircle"
679
- | "checkSmall"
680
- | "chevronDown"
681
- | "chevronLeft"
682
- | "chevronRight"
683
- | "chevronUp"
684
- | "chevronUpDown"
685
- | "close"
686
- | "closeAllFaults"
687
- | "closeFault"
688
- | "closeSmall"
689
- | "columnGraph"
690
- | "comment"
691
- | "connection1"
692
- | "connection2"
693
- | "connection3"
694
- | "connection4"
695
- | "danger"
696
- | "defectFrequencies"
697
- | "defectFrequenciesAlternative"
698
- | "doubleChevronLeft"
699
- | "doubleChevronRight"
700
- | "download"
701
- | "draft"
702
- | "draftFilled"
703
- | "draftOutlined"
704
- | "dragNDrop"
705
- | "drop"
706
- | "duplicate"
707
- | "edit"
708
- | "emailFilled"
709
- | "emailOutlined"
710
- | "exclamation"
711
- | "eye"
712
- | "eyeHidden"
713
- | "eyeVisible"
714
- | "filter"
715
- | "forbidden"
716
- | "fullScreen"
717
- | "fullScreenExit"
718
- | "functionalLocation"
719
- | "harmonicCursor"
720
- | "heatmap"
721
- | "hierarchy"
722
- | "history"
723
- | "historyAlt"
724
- | "hourglassFramedFilled"
725
- | "hourglassFramedOutlined"
726
- | "hourglassOutlined"
727
- | "hz"
728
- | "iMX"
729
- | "image"
730
- | "infoCircleFilled"
731
- | "infoCircleOutlined"
732
- | "integration"
733
- | "kebab"
734
- | "link"
735
- | "listGroup"
736
- | "listItem"
737
- | "locationPin"
738
- | "lock"
739
- | "logOut"
740
- | "meatballs"
741
- | "microphone"
742
- | "minus"
743
- | "minusSmall"
744
- | "noData"
745
- | "o"
746
- | "openInNew"
747
- | "overlayBaseline"
748
- | "pDF"
749
- | "paper"
750
- | "pause"
751
- | "pieChart"
752
- | "pin"
753
- | "play"
754
- | "plus"
755
- | "powerOff"
756
- | "printer"
757
- | "proCollect"
758
- | "recAction"
759
- | "received"
760
- | "refresh"
761
- | "reorder"
762
- | "replace"
763
- | "reply"
764
- | "rewalkableRoute"
765
- | "routes"
766
- | "search"
767
- | "send"
768
- | "sensorA"
769
- | "sensorB"
770
- | "settings"
771
- | "sidebandCursor"
772
- | "singleCursor"
773
- | "spectrum"
774
- | "starFilled"
775
- | "starOutlined"
776
- | "statusCircle"
777
- | "stop"
778
- | "structuralVibration"
779
- | "sync"
780
- | "timewave"
781
- | "trash"
782
- | "trend"
783
- | "trendingUp"
784
- | "undo"
785
- | "unknownCircle"
786
- | "unknownDiamond"
787
- | "unlink"
788
- | "unlock"
789
- | "unscheduledAction"
790
- | "upload"
791
- | "user"
792
- | "viewFull"
793
- | "viewHorizontal"
794
- | "viewVertical"
795
- | "warning"
796
- | "warningCircle"
797
- | "warningDiamond"
798
- | "zoomIn"
799
- | "zoomOut";
454
+ icon?: SkfLink["icon"];
800
455
  /** Defines the position of the icon in relation to the text */
801
- "icon-placement"?: "left" | "right";
456
+ "icon-placement"?: SkfLink["iconPlacement"];
802
457
  /** If defined, describes the relationship between a linked resource and the current document */
803
- rel?: string | undefined;
458
+ rel?: SkfLink["rel"];
804
459
  /** If defined, used on conjunction with onClick property, second argument */
805
- route?: string | undefined;
460
+ route?: SkfLink["route"];
806
461
  /** If true, fills the parents horizontal axis */
807
- stretch?: boolean;
462
+ stretch?: SkfLink["stretch"];
808
463
  /** If defined, specifies where to open the linked document */
809
- target?: "_blank" | "_parent" | "_self" | "_top" | undefined;
464
+ target?: SkfLink["target"];
810
465
  /** Defines the type of button */
811
- type?: "button" | "submit" | "reset";
466
+ type?: SkfLink["type"];
812
467
  /** If provided, custom function triggered by click where the second return parameter enables custom routing. */
813
- onClick?: function;
814
- };
815
-
816
- export type SkfLoaderProps = {
817
- /** Defines the aria-label */
818
- "aria-label"?: string;
819
- /** If true, inverts the color (to be used on colored backgrounds) */
820
- invert?: boolean;
821
- /** Defines the size of the loader */
822
- size?: "md" | "sm" | undefined;
823
- /** */
824
- role?: string;
825
- /** */
826
- ariaLive?: string;
827
- };
828
-
829
- export type SkfLogoProps = {
830
- /** Defines the title of the logo */
831
- title?: string;
832
- /** Defines the color of the logo */
833
- color?: "primary" | "secondary" | "inverse";
468
+ onClick?: SkfLink["onClick"];
834
469
  };
835
470
 
836
471
  export type SkfMenuProps = {
837
472
  /** The placement of the menu */
838
- placement?:
839
- | "top"
840
- | "right"
841
- | "bottom"
842
- | "left"
843
- | "top-start"
844
- | "top-end"
845
- | "right-start"
846
- | "right-end"
847
- | "bottom-start"
848
- | "bottom-end"
849
- | "left-start"
850
- | "left-end";
851
- /** Whether the menu is open */
852
- isOpen?: boolean;
473
+ placement?: SkfMenu["undefined"];
853
474
  /** The id of the element the menu will be anchored to */
854
- anchor?: string;
475
+ anchor?: SkfMenu["undefined"];
476
+ /** */
477
+ placement?: SkfMenu["placement"];
478
+ /** */
479
+ triggerEvent?: SkfMenu["triggerEvent"];
855
480
  /** Fired when the menu is opened */
856
- onopen?: (e: CustomEvent<never>) => void;
481
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
857
482
  /** Fired when the menu is closed */
858
- onclose?: (e: CustomEvent<never>) => void;
483
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
859
484
  };
860
485
 
861
486
  export type SkfMenuItemProps = {
862
487
  /** Defines the semantic element to render */
863
- as?: "button" | "a";
488
+ as?: SkfMenuItem["as"];
864
489
  /** Defines the text-color */
865
- color?: "primary" | "inverse";
490
+ color?: SkfMenuItem["color"];
866
491
  /** If true, disables the link */
867
- disabled?: boolean | undefined;
492
+ disabled?: SkfMenuItem["disabled"];
868
493
  /** If defined, downloads the url */
869
- download?: string | undefined;
494
+ download?: SkfMenuItem["download"];
870
495
  /** If defined, loads url on click */
871
- href?: string | undefined;
496
+ href?: SkfMenuItem["href"];
872
497
  /** If defined, renders an icon before or after the text */
873
- icon?:
874
- | "arrowDown"
875
- | "arrowDownUp"
876
- | "arrowLeft"
877
- | "arrowRight"
878
- | "arrowUp"
879
- | "article"
880
- | "artificialIntelligence"
881
- | "asset"
882
- | "attachment"
883
- | "bandCursor"
884
- | "bands"
885
- | "batteryEmpty"
886
- | "batteryFull"
887
- | "batteryLow"
888
- | "bearingFault"
889
- | "book"
890
- | "bulb"
891
- | "burger"
892
- | "cPM"
893
- | "calendar"
894
- | "calendarBooked"
895
- | "calendarEmpty"
896
- | "calendarNotBooked"
897
- | "calendarRecurring"
898
- | "caretDown"
899
- | "caretUp"
900
- | "caretUpDown"
901
- | "chat"
902
- | "check"
903
- | "checkCircle"
904
- | "checkSmall"
905
- | "chevronDown"
906
- | "chevronLeft"
907
- | "chevronRight"
908
- | "chevronUp"
909
- | "chevronUpDown"
910
- | "close"
911
- | "closeAllFaults"
912
- | "closeFault"
913
- | "closeSmall"
914
- | "columnGraph"
915
- | "comment"
916
- | "connection1"
917
- | "connection2"
918
- | "connection3"
919
- | "connection4"
920
- | "danger"
921
- | "defectFrequencies"
922
- | "defectFrequenciesAlternative"
923
- | "doubleChevronLeft"
924
- | "doubleChevronRight"
925
- | "download"
926
- | "draft"
927
- | "draftFilled"
928
- | "draftOutlined"
929
- | "dragNDrop"
930
- | "drop"
931
- | "duplicate"
932
- | "edit"
933
- | "emailFilled"
934
- | "emailOutlined"
935
- | "exclamation"
936
- | "eye"
937
- | "eyeHidden"
938
- | "eyeVisible"
939
- | "filter"
940
- | "forbidden"
941
- | "fullScreen"
942
- | "fullScreenExit"
943
- | "functionalLocation"
944
- | "harmonicCursor"
945
- | "heatmap"
946
- | "hierarchy"
947
- | "history"
948
- | "historyAlt"
949
- | "hourglassFramedFilled"
950
- | "hourglassFramedOutlined"
951
- | "hourglassOutlined"
952
- | "hz"
953
- | "iMX"
954
- | "image"
955
- | "infoCircleFilled"
956
- | "infoCircleOutlined"
957
- | "integration"
958
- | "kebab"
959
- | "link"
960
- | "listGroup"
961
- | "listItem"
962
- | "locationPin"
963
- | "lock"
964
- | "logOut"
965
- | "meatballs"
966
- | "microphone"
967
- | "minus"
968
- | "minusSmall"
969
- | "noData"
970
- | "o"
971
- | "openInNew"
972
- | "overlayBaseline"
973
- | "pDF"
974
- | "paper"
975
- | "pause"
976
- | "pieChart"
977
- | "pin"
978
- | "play"
979
- | "plus"
980
- | "powerOff"
981
- | "printer"
982
- | "proCollect"
983
- | "recAction"
984
- | "received"
985
- | "refresh"
986
- | "reorder"
987
- | "replace"
988
- | "reply"
989
- | "rewalkableRoute"
990
- | "routes"
991
- | "search"
992
- | "send"
993
- | "sensorA"
994
- | "sensorB"
995
- | "settings"
996
- | "sidebandCursor"
997
- | "singleCursor"
998
- | "spectrum"
999
- | "starFilled"
1000
- | "starOutlined"
1001
- | "statusCircle"
1002
- | "stop"
1003
- | "structuralVibration"
1004
- | "sync"
1005
- | "timewave"
1006
- | "trash"
1007
- | "trend"
1008
- | "trendingUp"
1009
- | "undo"
1010
- | "unknownCircle"
1011
- | "unknownDiamond"
1012
- | "unlink"
1013
- | "unlock"
1014
- | "unscheduledAction"
1015
- | "upload"
1016
- | "user"
1017
- | "viewFull"
1018
- | "viewHorizontal"
1019
- | "viewVertical"
1020
- | "warning"
1021
- | "warningCircle"
1022
- | "warningDiamond"
1023
- | "zoomIn"
1024
- | "zoomOut";
498
+ icon?: SkfMenuItem["icon"];
1025
499
  /** Defines the position of the icon in relation to the text */
1026
- "icon-placement"?: "left" | "right";
500
+ "icon-placement"?: SkfMenuItem["iconPlacement"];
1027
501
  /** If defined, describes the relationship between a linked resource and the current document */
1028
- rel?: string | undefined;
502
+ rel?: SkfMenuItem["rel"];
1029
503
  /** If defined, used on conjunction with onClick property, second argument */
1030
- route?: string | undefined;
504
+ route?: SkfMenuItem["route"];
1031
505
  /** If true, fills the parents horizontal axis */
1032
- stretch?: boolean;
506
+ stretch?: SkfMenuItem["stretch"];
1033
507
  /** If defined, specifies where to open the linked document */
1034
- target?: "_blank" | "_parent" | "_self" | "_top" | undefined;
508
+ target?: SkfMenuItem["target"];
1035
509
  /** Defines the type of button */
1036
- type?: "button" | "submit" | "reset";
510
+ type?: SkfMenuItem["type"];
1037
511
  /** If provided, custom function triggered by click where the second return parameter enables custom routing. */
1038
- onClick?: function;
512
+ onClick?: SkfMenuItem["onClick"];
1039
513
  /** Fired when something happens */
1040
514
  "onmy-tag-my-event"?: (e: CustomEvent<CustomEvent>) => void;
1041
515
  /** Fired when the component is clicked */
@@ -1052,115 +526,169 @@ export type SkfMenuItemProps = {
1052
526
  onchange?: (e: CustomEvent<never>) => void;
1053
527
  };
1054
528
 
529
+ export type SkfNavItemProps = {
530
+ /** */
531
+ href?: SkfNavItem["href"];
532
+ /** */
533
+ icon?: SkfNavItem["icon"];
534
+ };
535
+
1055
536
  export type SkfPopoverProps = {
537
+ /** The placement of the menu */
538
+ placement?: SkfPopover["undefined"];
539
+ /** The id of the element the menu will be anchored to */
540
+ anchor?: SkfPopover["undefined"];
1056
541
  /** If defined, sets a custom offset for the popover */
1057
- offset?: number;
542
+ offset?: SkfPopover["offset"];
1058
543
  /** If true, hides the arrow */
1059
- hideArrow?: boolean;
544
+ hideArrow?: SkfPopover["hideArrow"];
1060
545
  /** */
1061
- arrow?: boolean;
1062
- /** The placement of the menu */
1063
- placement?:
1064
- | "top"
1065
- | "right"
1066
- | "bottom"
1067
- | "left"
1068
- | "top-start"
1069
- | "top-end"
1070
- | "right-start"
1071
- | "right-end"
1072
- | "bottom-start"
1073
- | "bottom-end"
1074
- | "left-start"
1075
- | "left-end";
1076
- /** Whether the menu is open */
1077
- isOpen?: boolean;
1078
- /** The id of the element the menu will be anchored to */
1079
- anchor?: string;
546
+ arrow?: SkfPopover["arrow"];
547
+ /** */
548
+ placement?: SkfPopover["placement"];
549
+ /** */
550
+ triggerEvent?: SkfPopover["triggerEvent"];
1080
551
  /** Fired when the menu is opened */
1081
- onopen?: (e: CustomEvent<never>) => void;
552
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
1082
553
  /** Fired when the menu is closed */
1083
- onclose?: (e: CustomEvent<never>) => void;
554
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
1084
555
  };
1085
556
 
1086
557
  export type SkfProgressProps = {
1087
558
  /** If true, the progress-bar's fill value is animated */
1088
- animated?: boolean;
559
+ animated?: SkfProgress["animated"];
1089
560
  /** Describes how much work the task indicated by the progress element requires */
1090
- max?: number;
561
+ max?: SkfProgress["max"];
1091
562
  /** Specifies how much of the task that has been completed */
1092
- value?: number;
563
+ value?: SkfProgress["value"];
1093
564
  };
1094
565
 
1095
566
  export type SkfRadioProps = {
1096
567
  /** If true, sets disabled state */
1097
- disabled?: boolean;
568
+ disabled?: SkfRadio["undefined"];
1098
569
  /** If true, value is required or must be checked for the form to be submittable */
1099
- required?: boolean;
570
+ required?: SkfRadio["undefined"];
1100
571
  /** If true, outputs helping hints in console */
1101
- debug?: boolean | undefined;
572
+ debug?: SkfRadio["debug"];
1102
573
  /** If true, outputs helping hints in console */
1103
- checked?: boolean | undefined;
574
+ checked?: SkfRadio["checked"];
1104
575
  /** If true, forces component to invalid state until removed */
1105
- "custom-invalid"?: boolean | undefined;
576
+ "custom-invalid"?: SkfRadio["customInvalid"];
1106
577
  /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
1107
- label?: string | undefined;
578
+ label?: SkfRadio["label"];
1108
579
  /** If defined, adds name to the input-element */
1109
- name?: string | undefined;
580
+ name?: SkfRadio["name"];
1110
581
  /** If defined, renders an alternative A11y text for the asterisk */
1111
- "required-label"?: string | undefined;
582
+ "required-label"?: SkfRadio["requiredLabel"];
1112
583
  /** Size of the Radio */
1113
- size?: "sm" | "md";
584
+ size?: SkfRadio["size"];
1114
585
  /** If defined, displays provided severity state */
1115
- severity?: "success" | "info" | "warning" | "alert";
586
+ severity?: SkfRadio["severity"];
1116
587
  /** If true, displays valid state after interaction */
1117
- "show-valid"?: boolean | undefined;
588
+ "show-valid"?: SkfRadio["showValid"];
1118
589
  /** The current value of the input field */
1119
- value?: string;
590
+ value?: SkfRadio["value"];
1120
591
 
1121
592
  /** {object} - When the value of the input changes */
1122
593
  onchange?: (e: CustomEvent<never>) => void;
1123
594
  };
1124
595
 
596
+ export type SkfSegmentedButtonItemProps = {
597
+ /** If true, items is marked as disabled */
598
+ disabled?: SkfSegmentedButtonItem["disabled"];
599
+ /** Sets the item value */
600
+ value?: SkfSegmentedButtonItem["value"];
601
+
602
+ /** Fired when something happens */
603
+ "onmy-tag-my-event"?: (e: CustomEvent<CustomEvent>) => void;
604
+ };
605
+
606
+ export type SkfSegmentedButtonProps = {
607
+ /** Sets the default selected control */
608
+ "default-selected"?: SkfSegmentedButton["defaultSelected"];
609
+ /** If true, allowes multiple items to be selected */
610
+ multiple?: SkfSegmentedButton["multiple"];
611
+ };
612
+
613
+ export type SkfSelectOptionProps = {
614
+ /** If true, prevents interaction with the option */
615
+ disabled?: SkfSelectOption["disabled"];
616
+ /** If defined, set an icon */
617
+ icon?: SkfSelectOption["icon"];
618
+ /** If defined, sets provided color on the icon */
619
+ "icon-color"?: SkfSelectOption["iconColor"];
620
+ /** If true, sets the option as selected */
621
+ selected?: SkfSelectOption["selected"];
622
+ /** If defined, sets a short label */
623
+ "short-label"?: SkfSelectOption["shortLabel"];
624
+ /** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
625
+ value?: SkfSelectOption["value"];
626
+ /** The option's label text (equivalent to the tags textContent) */
627
+ text?: SkfSelectOption["text"];
628
+ /** */
629
+ role?: SkfSelectOption["role"];
630
+ /** */
631
+ _parent?: SkfSelectOption["_parent"];
632
+ /** */
633
+ _shortcutUpdate?: SkfSelectOption["_shortcutUpdate"];
634
+ /** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
635
+ "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
636
+ };
637
+
638
+ export type SkfTagProps = {
639
+ /** Specifies Tag size */
640
+ size?: SkfTag["size"];
641
+ /** If defined, displays leading/provided icon */
642
+ icon?: SkfTag["icon"];
643
+ /** If defined, gives the supplied appearance */
644
+ color?: SkfTag["color"];
645
+ /** If true, adds trailing button to remove tag */
646
+ removable?: SkfTag["removable"];
647
+ /** If defined, accepts a function that runs on click */
648
+ onClick?: SkfTag["onClick"];
649
+ /** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
650
+ onRemove?: SkfTag["onRemove"];
651
+ };
652
+
1125
653
  export type SkfSelectProps = {
1126
654
  /** If true, the select is disabled `default: false` */
1127
- disabled?: boolean;
655
+ disabled?: SkfSelect["undefined"];
1128
656
  /** Sets the first visible text on the component */
1129
- "button-label"?: string;
657
+ "button-label"?: SkfSelect["buttonLabel"];
1130
658
  /** If defined, forces component to invalid state until removed */
1131
- "custom-invalid"?: string | undefined;
659
+ "custom-invalid"?: SkfSelect["customInvalid"];
1132
660
  /** If true, hides the label visually */
1133
- "hide-label"?: boolean | undefined;
661
+ "hide-label"?: SkfSelect["hideLabel"];
1134
662
  /** If true and mulltiple is true, no tags are displayed under the select */
1135
- "hide-tags"?: boolean | undefined;
663
+ "hide-tags"?: SkfSelect["hideTags"];
1136
664
  /** If defined, sets the hint text under the select component in the form */
1137
- hint?: string | undefined;
665
+ hint?: SkfSelect["hint"];
1138
666
  /** If defined, displays provided label */
1139
- label?: string | undefined;
667
+ label?: SkfSelect["label"];
1140
668
  /** If defined, limits the number of selectable options */
1141
- max?: number | undefined;
669
+ max?: SkfSelect["max"];
1142
670
  /** If defined, sets the minimum number of required options */
1143
- min?: number | undefined;
671
+ min?: SkfSelect["min"];
1144
672
  /** If true, allows for multiple options to be selected */
1145
- multiple?: boolean | undefined;
673
+ multiple?: SkfSelect["multiple"];
1146
674
  /** If defined, set name of the component */
1147
- name?: string | undefined;
675
+ name?: SkfSelect["name"];
1148
676
  /** If defined, renders an alternative A11y text for the asterisk */
1149
- "required-label"?: string | undefined;
677
+ "required-label"?: SkfSelect["requiredLabel"];
1150
678
  /** If defined, displays provided severity state */
1151
- severity?: FormFieldBaseProps["severity"] | undefined;
679
+ severity?: SkfSelect["severity"];
1152
680
  /** If true, displays valid state after interaction */
1153
- "show-valid"?: boolean | undefined;
681
+ "show-valid"?: SkfSelect["showValid"];
1154
682
  /** Size of the Select */
1155
- size?: "sm" | "md";
683
+ size?: SkfSelect["size"];
1156
684
  /** A readonly property that returns the selected value(s) in a array */
1157
- selectedValues?: string;
685
+ selectedValues?: SkfSelect["selectedValues"];
1158
686
  /** A readonly property that returns the selected slot(s) text content in a array */
1159
- selectedOptionsText?: string;
687
+ selectedOptionsText?: SkfSelect["selectedOptionsText"];
1160
688
  /** Read only, returns the selected value. (if multiple: in a comma separated string) */
1161
- value?: string;
689
+ value?: SkfSelect["value"];
1162
690
  /** */
1163
- _selectedOptions?: array;
691
+ _selectedOptions?: SkfSelect["_selectedOptions"];
1164
692
  /** Fired when the selected option(s) changes */
1165
693
  onchange?: (e: CustomEvent<never>) => void;
1166
694
  /** Fired when the select is invalid */
@@ -1173,326 +701,135 @@ export type SkfSelectProps = {
1173
701
  "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
1174
702
  };
1175
703
 
1176
- export type SkfSelectOptionProps = {
1177
- /** If true, prevents interaction with the option */
1178
- disabled?: boolean | undefined;
1179
- /** If defined, set an icon */
1180
- icon?: SkfIcon["name"] | undefined;
1181
- /** If defined, sets provided color on the icon */
1182
- "icon-color"?: SeverityFgColor | undefined;
1183
- /** If true, sets the option as selected */
1184
- selected?: boolean | undefined;
1185
- /** If defined, sets a short label */
1186
- "short-label"?: string | undefined;
1187
- /** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
1188
- value?: string;
1189
- /** The option's label text (equivalent to the tags textContent) */
1190
- text?: string;
1191
- /** */
1192
- role?: string;
1193
- /** */
1194
- _parent?: string;
704
+ export type SkfSelectOptionGroupProps = {
1195
705
  /** */
1196
- _shortcutUpdate?: boolean;
1197
- /** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
1198
- "onskf-select-option:select"?: (e: CustomEvent<never>) => void;
706
+ label?: SkfSelectOptionGroup["label"];
1199
707
  };
1200
708
 
1201
- export type SkfSelectOptionGroupProps = {
709
+ export type SkfStepperItemProps = {
710
+ /** If defined, gives the supplied appearance */
711
+ state?: SkfStepperItem["state"];
712
+ /** If true, item marked as completed */
713
+ completed?: SkfStepperItem["completed"];
714
+ /** */
715
+ _setInternalState?: SkfStepperItem["_setInternalState"];
1202
716
  /** */
1203
- label?: string;
717
+ role?: SkfStepperItem["role"];
718
+ /** Dispatched when the stepper item is selected */
719
+ "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
1204
720
  };
1205
721
 
1206
722
  export type SkfStepperProps = {
1207
723
  /** Sets the active item */
1208
- activeIndex?: number;
724
+ activeIndex?: SkfStepper["activeIndex"];
1209
725
  /** If true, sets linear mode (user can't go back to completed steps due to dependencies) */
1210
- linear?: boolean;
726
+ linear?: SkfStepper["linear"];
1211
727
 
1212
728
  /** Dispatched when the stepper item is selected */
1213
729
  "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
1214
730
  };
1215
731
 
1216
- export type SkfStepperItemProps = {
1217
- /** If defined, gives the supplied appearance */
1218
- state?: Extract<SkfStepperItemState, "active" | "completed"> | undefined;
1219
- /** If true, item marked as completed */
1220
- completed?: boolean;
1221
- /** */
1222
- _setInternalState?: string;
1223
- /** */
1224
- role?: string;
1225
- /** Dispatched when the stepper item is selected */
1226
- "onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
1227
- };
1228
-
1229
732
  export type SkfSwitchProps = {
1230
733
  /** If true, sets disabled state */
1231
- disabled?: boolean;
734
+ disabled?: SkfSwitch["undefined"];
1232
735
  /** If true, value is required or must be checked for the form to be submittable */
1233
- required?: boolean;
736
+ required?: SkfSwitch["undefined"];
1234
737
  /** If true, outputs helping hints in console */
1235
- debug?: boolean | undefined;
738
+ debug?: SkfSwitch["debug"];
1236
739
  /** If true, outputs helping hints in console */
1237
- checked?: boolean | undefined;
740
+ checked?: SkfSwitch["checked"];
1238
741
  /** If true, hides the label visually */
1239
- "hide-label"?: boolean | undefined;
742
+ "hide-label"?: SkfSwitch["hideLabel"];
1240
743
  /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
1241
- label?: string | undefined;
744
+ label?: SkfSwitch["label"];
1242
745
  /** If defined, adds name to the input-element */
1243
- name?: string | undefined;
746
+ name?: SkfSwitch["name"];
1244
747
  /** If defined, renders an alternative A11y text for the asterisk */
1245
- "required-label"?: string | undefined;
748
+ "required-label"?: SkfSwitch["requiredLabel"];
1246
749
  /** Size of the Switch */
1247
- size?: "sm" | "md";
750
+ size?: SkfSwitch["size"];
1248
751
  /** The current value of the input field */
1249
- value?: string;
752
+ value?: SkfSwitch["value"];
1250
753
  };
1251
754
 
1252
- export type SkfTabProps = {
1253
- /** The name of the tab-panel this tab is associated with. The panel must be located in the same tab group. */
1254
- panel?: string;
755
+ export type SkfTabPanelProps = {
756
+ /** The tab panel's name. */
757
+ name?: SkfTabPanel["name"];
1255
758
  /** */
1256
- selected?: boolean;
759
+ active?: SkfTabPanel["active"];
1257
760
  /** */
1258
- variant?: SkfTabGroup["variant"];
1259
- /** */
1260
- role?: string;
1261
- /** {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected */
1262
- "onskf-tab-select"?: (e: CustomEvent<CustomEvent>) => void;
1263
- /** Fired when the component is clicked */
1264
- onclick?: (e: CustomEvent<never>) => void;
761
+ role?: SkfTabPanel["role"];
1265
762
  };
1266
763
 
1267
764
  export type SkfTabGroupProps = {
1268
765
  /** Sets the default selected tab */
1269
- "default-selected"?: number;
766
+ "default-selected"?: SkfTabGroup["defaultSelected"];
1270
767
  /** If true, removes border */
1271
- "no-border"?: boolean;
768
+ "no-border"?: SkfTabGroup["noBorder"];
1272
769
  /** If true, removes padding */
1273
- "no-padding"?: boolean;
770
+ "no-padding"?: SkfTabGroup["noPadding"];
1274
771
  /** If true, component fills the parent element height */
1275
- stretch?: boolean;
772
+ stretch?: SkfTabGroup["stretch"];
1276
773
  /** Sets the appearance of the tabs */
1277
- variant?: "compressed" | "expanded";
774
+ variant?: SkfTabGroup["variant"];
1278
775
  };
1279
776
 
1280
- export type SkfTabPanelProps = {
1281
- /** The tab panel's name. */
1282
- name?: string;
777
+ export type SkfTabProps = {
778
+ /** The name of the tab-panel this tab is associated with. The panel must be located in the same tab group. */
779
+ panel?: SkfTab["panel"];
1283
780
  /** */
1284
- active?: boolean;
781
+ selected?: SkfTab["selected"];
1285
782
  /** */
1286
- role?: string;
1287
- };
1288
-
1289
- export type SkfTagProps = {
1290
- /** Specifies Tag size */
1291
- size?: "sm" | "md" | "lg";
1292
- /** If defined, displays leading/provided icon */
1293
- icon?:
1294
- | "arrowDown"
1295
- | "arrowDownUp"
1296
- | "arrowLeft"
1297
- | "arrowRight"
1298
- | "arrowUp"
1299
- | "article"
1300
- | "artificialIntelligence"
1301
- | "asset"
1302
- | "attachment"
1303
- | "bandCursor"
1304
- | "bands"
1305
- | "batteryEmpty"
1306
- | "batteryFull"
1307
- | "batteryLow"
1308
- | "bearingFault"
1309
- | "book"
1310
- | "bulb"
1311
- | "burger"
1312
- | "cPM"
1313
- | "calendar"
1314
- | "calendarBooked"
1315
- | "calendarEmpty"
1316
- | "calendarNotBooked"
1317
- | "calendarRecurring"
1318
- | "caretDown"
1319
- | "caretUp"
1320
- | "caretUpDown"
1321
- | "chat"
1322
- | "check"
1323
- | "checkCircle"
1324
- | "checkSmall"
1325
- | "chevronDown"
1326
- | "chevronLeft"
1327
- | "chevronRight"
1328
- | "chevronUp"
1329
- | "chevronUpDown"
1330
- | "close"
1331
- | "closeAllFaults"
1332
- | "closeFault"
1333
- | "closeSmall"
1334
- | "columnGraph"
1335
- | "comment"
1336
- | "connection1"
1337
- | "connection2"
1338
- | "connection3"
1339
- | "connection4"
1340
- | "danger"
1341
- | "defectFrequencies"
1342
- | "defectFrequenciesAlternative"
1343
- | "doubleChevronLeft"
1344
- | "doubleChevronRight"
1345
- | "download"
1346
- | "draft"
1347
- | "draftFilled"
1348
- | "draftOutlined"
1349
- | "dragNDrop"
1350
- | "drop"
1351
- | "duplicate"
1352
- | "edit"
1353
- | "emailFilled"
1354
- | "emailOutlined"
1355
- | "exclamation"
1356
- | "eye"
1357
- | "eyeHidden"
1358
- | "eyeVisible"
1359
- | "filter"
1360
- | "forbidden"
1361
- | "fullScreen"
1362
- | "fullScreenExit"
1363
- | "functionalLocation"
1364
- | "harmonicCursor"
1365
- | "heatmap"
1366
- | "hierarchy"
1367
- | "history"
1368
- | "historyAlt"
1369
- | "hourglassFramedFilled"
1370
- | "hourglassFramedOutlined"
1371
- | "hourglassOutlined"
1372
- | "hz"
1373
- | "iMX"
1374
- | "image"
1375
- | "infoCircleFilled"
1376
- | "infoCircleOutlined"
1377
- | "integration"
1378
- | "kebab"
1379
- | "link"
1380
- | "listGroup"
1381
- | "listItem"
1382
- | "locationPin"
1383
- | "lock"
1384
- | "logOut"
1385
- | "meatballs"
1386
- | "microphone"
1387
- | "minus"
1388
- | "minusSmall"
1389
- | "noData"
1390
- | "o"
1391
- | "openInNew"
1392
- | "overlayBaseline"
1393
- | "pDF"
1394
- | "paper"
1395
- | "pause"
1396
- | "pieChart"
1397
- | "pin"
1398
- | "play"
1399
- | "plus"
1400
- | "powerOff"
1401
- | "printer"
1402
- | "proCollect"
1403
- | "recAction"
1404
- | "received"
1405
- | "refresh"
1406
- | "reorder"
1407
- | "replace"
1408
- | "reply"
1409
- | "rewalkableRoute"
1410
- | "routes"
1411
- | "search"
1412
- | "send"
1413
- | "sensorA"
1414
- | "sensorB"
1415
- | "settings"
1416
- | "sidebandCursor"
1417
- | "singleCursor"
1418
- | "spectrum"
1419
- | "starFilled"
1420
- | "starOutlined"
1421
- | "statusCircle"
1422
- | "stop"
1423
- | "structuralVibration"
1424
- | "sync"
1425
- | "timewave"
1426
- | "trash"
1427
- | "trend"
1428
- | "trendingUp"
1429
- | "undo"
1430
- | "unknownCircle"
1431
- | "unknownDiamond"
1432
- | "unlink"
1433
- | "unlock"
1434
- | "unscheduledAction"
1435
- | "upload"
1436
- | "user"
1437
- | "viewFull"
1438
- | "viewHorizontal"
1439
- | "viewVertical"
1440
- | "warning"
1441
- | "warningCircle"
1442
- | "warningDiamond"
1443
- | "zoomIn"
1444
- | "zoomOut";
1445
- /** If defined, gives the supplied appearance */
1446
- color?: "warning" | "success" | "info" | "error" | "alert";
1447
- /** If true, adds trailing button to remove tag */
1448
- removable?: boolean | undefined;
1449
- /** If defined, accepts a function that runs on click */
1450
- onClick?: string;
1451
- /** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
1452
- onRemove?: string;
783
+ variant?: SkfTab["variant"];
784
+ /** */
785
+ role?: SkfTab["role"];
786
+ /** {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected */
787
+ "onskf-tab-select"?: (e: CustomEvent<CustomEvent>) => void;
788
+ /** Fired when the component is clicked */
789
+ onclick?: (e: CustomEvent<never>) => void;
1453
790
  };
1454
791
 
1455
792
  export type SkfTextAreaProps = {
1456
793
  /** If true, sets disabled state */
1457
- disabled?: boolean;
794
+ disabled?: SkfTextArea["undefined"];
1458
795
  /** If true, value is required or must be checked for the form to be submittable */
1459
- required?: boolean;
796
+ required?: SkfTextArea["undefined"];
1460
797
  /** If defined, sets the cols of the textarea */
1461
- cols?: number | undefined;
798
+ cols?: SkfTextArea["cols"];
1462
799
  /** If defined, forces component to invalid state until removed. Its value is used as hint text. */
1463
- "custom-invalid"?: string;
800
+ "custom-invalid"?: SkfTextArea["customInvalid"];
1464
801
  /** If true, outputs helping hints in console */
1465
- debug?: boolean | undefined;
802
+ debug?: SkfTextArea["debug"];
1466
803
  /** If true, hides the label visually */
1467
- "hide-label"?: boolean | undefined;
804
+ "hide-label"?: SkfTextArea["hideLabel"];
1468
805
  /** If defined, displays informational text below the field */
1469
- hint?: string | undefined;
806
+ hint?: SkfTextArea["hint"];
1470
807
  /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
1471
- label?: string | undefined;
808
+ label?: SkfTextArea["label"];
1472
809
  /** If defined, adds name to the input-element */
1473
- name?: string | undefined;
810
+ name?: SkfTextArea["name"];
1474
811
  /** If defined, sets the maximum character length to accept for this input */
1475
- maxlength?: number | undefined;
812
+ maxlength?: SkfTextArea["maxLength"];
1476
813
  /** If defined, sets the minimum character length to accept for this input */
1477
- minlength?: number | undefined;
814
+ minlength?: SkfTextArea["minLength"];
1478
815
  /** If defined, displays placeholder text */
1479
- placeholder?: string | undefined;
816
+ placeholder?: SkfTextArea["placeholder"];
1480
817
  /** If true, makes the element not mutable, meaning the user can not edit the control */
1481
- readonly?: boolean | undefined;
818
+ readonly?: SkfTextArea["readonly"];
1482
819
  /** If defined, renders an alternative A11y text for the asterisk */
1483
- "required-label"?: string | undefined;
820
+ "required-label"?: SkfTextArea["requiredLabel"];
1484
821
  /** If defined, sets the rows of the textarea */
1485
- rows?: number | undefined;
822
+ rows?: SkfTextArea["rows"];
1486
823
  /** If defined, displays provided severity state */
1487
- severity?: "success" | "info" | "warning" | "alert";
824
+ severity?: SkfTextArea["severity"];
1488
825
  /** If true, displays valid state after interaction */
1489
- "show-valid"?: boolean | undefined;
826
+ "show-valid"?: SkfTextArea["showValid"];
1490
827
  /** Size of the Textarea */
1491
- size?: "sm" | "md" | undefined;
828
+ size?: SkfTextArea["size"];
1492
829
  /** Sets validation start */
1493
- "validate-on"?: "input" | "change" | "submit";
830
+ "validate-on"?: SkfTextArea["validateOn"];
1494
831
  /** The current value of the text area */
1495
- value?: string;
832
+ value?: SkfTextArea["value"];
1496
833
 
1497
834
  /** Fires when the value of the input changes */
1498
835
  onchange?: (e: CustomEvent<never>) => void;
@@ -1500,54 +837,68 @@ export type SkfTextAreaProps = {
1500
837
  oninvalid?: (e: CustomEvent<never>) => void;
1501
838
  };
1502
839
 
840
+ export type SkfToastWrapperProps = {
841
+ /** */
842
+ debug?: SkfToastWrapper["debug"];
843
+ };
844
+
1503
845
  export type SkfToastProps = {
1504
846
  /** */
1505
- debug?: boolean;
847
+ debug?: SkfToast["debug"];
1506
848
  /** If defined, displays leading icon */
1507
- icon?: SkfAlert["icon"] | undefined;
849
+ icon?: SkfToast["icon"];
1508
850
  /** If true, renders with an close button and sets aria-role to `status` */
1509
- persistent?: SkfAlert["persistent"];
851
+ persistent?: SkfToast["persistent"];
1510
852
  /** If defined, gives the supplied appearance */
1511
- severity?: SkfAlert["severity"];
853
+ severity?: SkfToast["severity"];
1512
854
  /** Time in seconds before the toast disappears. */
1513
- timer?: number;
855
+ timer?: SkfToast["timer"];
1514
856
  /** offsets where toasts emerge vertically */
1515
- topOffset?: number | undefined;
1516
- };
1517
-
1518
- export type SkfToastWrapperProps = {
1519
- /** */
1520
- debug?: boolean;
857
+ topOffset?: SkfToast["topOffset"];
1521
858
  };
1522
859
 
1523
860
  export type SkfTooltipProps = {
1524
- /** */
1525
- offset?: number;
1526
861
  /** The placement of the dropdown */
1527
- placement?:
1528
- | "top"
1529
- | "right"
1530
- | "bottom"
1531
- | "left"
1532
- | "top-start"
1533
- | "top-end"
1534
- | "right-start"
1535
- | "right-end"
1536
- | "bottom-start"
1537
- | "bottom-end"
1538
- | "left-start"
1539
- | "left-end";
1540
- /** Whether the dropdown is open */
1541
- isOpen?: boolean;
862
+ placement?: SkfTooltip["undefined"];
1542
863
  /** The id of the element the dropdown will be anchored to */
1543
- anchor?: string;
864
+ anchor?: SkfTooltip["undefined"];
865
+ /** */
866
+ offset?: SkfTooltip["offset"];
867
+ /** */
868
+ placement?: SkfTooltip["placement"];
1544
869
  /** Fired when the dropdown is opened */
1545
- onopen?: (e: CustomEvent<never>) => void;
870
+ "onskf-opened"?: (e: CustomEvent<never>) => void;
1546
871
  /** Fired when the dropdown is closed */
1547
- onclose?: (e: CustomEvent<never>) => void;
872
+ "onskf-closed"?: (e: CustomEvent<never>) => void;
1548
873
  };
1549
874
 
1550
875
  export type CustomElements = {
876
+ /**
877
+ * The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text
878
+ * ---
879
+ *
880
+ */
881
+ "skf-icon": Partial<SkfIconProps & BaseProps & BaseEvents>;
882
+
883
+ /**
884
+ * The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
885
+ *
886
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
887
+ * ---
888
+ *
889
+ *
890
+ * ### **Events:**
891
+ * - **skf-collapse-toggle** - Event emitted when toggled
892
+ *
893
+ * ### **Methods:**
894
+ * - **setClose()** - Class method as alternative to manipulate attribute
895
+ * - **setOpen()** - Class method as alternative to manipulate attribute
896
+ *
897
+ * ### **Slots:**
898
+ * - _default_ - Main content
899
+ */
900
+ "skf-collapse": Partial<SkfCollapseProps & BaseProps & BaseEvents>;
901
+
1551
902
  /**
1552
903
  * The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
1553
904
  *
@@ -1574,8 +925,20 @@ export type CustomElements = {
1574
925
  */
1575
926
  "skf-alert": Partial<SkfAlertProps & BaseProps & BaseEvents>;
1576
927
 
928
+ /**
929
+ * The `<skf-breadcrumb-item>` is used in conjunction with the `<skf-breadcrumb>` component
930
+ * ---
931
+ *
932
+ *
933
+ * ### **Slots:**
934
+ * - _default_ - Label of the breadcrumb item
935
+ */
936
+ "skf-breadcrumb-item": Partial<SkfBreadcrumbItemProps & BaseProps & BaseEvents>;
937
+
1577
938
  /**
1578
939
  * The `<skf-breadcrumb>` component consists of multiple `<skf-breadcrumb-item>`, working together.
940
+ *
941
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/3338ef-breadcrumbs) for design principles.
1579
942
  * ---
1580
943
  *
1581
944
  *
@@ -1588,14 +951,11 @@ export type CustomElements = {
1588
951
  "skf-breadcrumb": Partial<SkfBreadcrumbProps & BaseProps & BaseEvents>;
1589
952
 
1590
953
  /**
1591
- * The `<skf-breadcrumb-item>` is used in conjunction with the `<skf-breadcrumb>` component
954
+ * The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
1592
955
  * ---
1593
956
  *
1594
- *
1595
- * ### **Slots:**
1596
- * - _default_ - Label of the breadcrumb item
1597
957
  */
1598
- "skf-breadcrumb-item": Partial<SkfBreadcrumbItemProps & BaseProps & BaseEvents>;
958
+ "skf-loader": Partial<SkfLoaderProps & BaseProps & BaseEvents>;
1599
959
 
1600
960
  /**
1601
961
  * Component to be used in forms or for interactivity
@@ -1637,33 +997,49 @@ export type CustomElements = {
1637
997
  "skf-checkbox": Partial<SkfCheckboxProps & BaseProps & BaseEvents>;
1638
998
 
1639
999
  /**
1640
- * The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
1641
- *
1642
- * See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
1000
+ * A date picker component that allows users to select a date or a range of dates.
1643
1001
  * ---
1644
1002
  *
1645
1003
  *
1646
1004
  * ### **Events:**
1647
- * - **skf-collapse-toggle** - Event emitted when toggled
1005
+ * - **selected-date-changed** - When a date is selected
1006
+ * - **selected-date-range-changed** - When a range of dates is selected
1648
1007
  *
1649
1008
  * ### **Methods:**
1650
- * - **setClose()** - Class method as alternative to manipulate attribute
1651
- * - **setOpen()** - Class method as alternative to manipulate attribute
1009
+ * - **gotoDate(date: _Date | string_)** - Navigates to the given date.
1652
1010
  *
1653
1011
  * ### **Slots:**
1654
- * - _default_ - Main content
1012
+ * - _default_ - Default hint content placed inside the date picker
1013
+ *
1014
+ * ### **CSS Properties:**
1015
+ * - **--max-width** - The maximum width of the date picker _(default: undefined)_
1655
1016
  */
1656
- "skf-collapse": Partial<SkfCollapseProps & BaseProps & BaseEvents>;
1017
+ "skf-datepicker": Partial<SkfDatePickerProps & BaseProps & BaseEvents>;
1657
1018
 
1658
1019
  /**
1659
- * The `<skf-dialog>` is a component that open up a dialog with the content provided
1020
+ * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
1021
+ * It extends the interface of native html `<h1>` to `<h4>` elements.
1022
+ * ---
1023
+ *
1024
+ *
1025
+ * ### **Slots:**
1026
+ * - _default_ - The headings content
1027
+ */
1028
+ "skf-heading": Partial<SkfHeadingProps & BaseProps & BaseEvents>;
1029
+
1030
+ /**
1031
+ * 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)
1660
1032
  * ---
1661
1033
  *
1662
1034
  *
1663
1035
  * ### **Events:**
1664
- * - **skf-dialog-open** - Fires when the dialog is opened (after transitioned in)
1665
- * - **skf-dialog-close** - Fires when the dialog is closed (before transitioned out)
1666
- * - **close** - Fires when the dialog is closed (after transitioned out)
1036
+ * - **skf-dialog-opened** - Fires when the dialog is opened (after transitioned in)
1037
+ * - **skf-dialog-closing** - Fires when the dialog is closed (before transitioned out)
1038
+ * - **skf-dialog-closed** - Fires when the dialog is closed (after transitioned out)
1039
+ *
1040
+ * ### **Methods:**
1041
+ * - **showModal()** - Method that opens the dialog in modal state
1042
+ * - **close()** - Method that closes the dialog
1667
1043
  *
1668
1044
  * ### **Slots:**
1669
1045
  * - _default_ - The dialog component's content
@@ -1687,63 +1063,73 @@ export type CustomElements = {
1687
1063
  "skf-divider": Partial<SkfDividerProps & BaseProps & BaseEvents>;
1688
1064
 
1689
1065
  /**
1690
- * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
1691
- * It extends the interface of native html `<h1>` to `<h4>` elements.
1066
+ * The `<skf-drawer>` is a modal component that displays content and toggle by sliding from left/right viewport edge.
1692
1067
  * ---
1693
1068
  *
1694
1069
  *
1070
+ * ### **Events:**
1071
+ * - **skf-drawer-opened** - Fires when the drawer is opened (after transitioned in)
1072
+ * - **skf-drawer-closing** - Fires when the drawer is closed (before transitioned out)
1073
+ * - **skf-drawer-closed** - Fires when the drawer is closed (after transitioned out)
1074
+ *
1695
1075
  * ### **Slots:**
1696
- * - _default_ - The headings content
1076
+ * - _default_ - The Drawer's main content
1697
1077
  */
1698
- "skf-heading": Partial<SkfHeadingProps & BaseProps & BaseEvents>;
1078
+ "skf-drawer": Partial<SkfDrawerProps & BaseProps & BaseEvents>;
1699
1079
 
1700
1080
  /**
1701
- * The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text
1081
+ * The `<skf-logo>` component is used to display the SKF logo.
1702
1082
  * ---
1703
1083
  *
1084
+ *
1085
+ * ### **CSS Properties:**
1086
+ * - **--skf-logo-height** - The height of the logo _(default: undefined)_
1704
1087
  */
1705
- "skf-icon": Partial<SkfIconProps & BaseProps & BaseEvents>;
1088
+ "skf-logo": Partial<SkfLogoProps & BaseProps & BaseEvents>;
1706
1089
 
1707
1090
  /**
1708
- * The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.
1091
+ * The `<skf-nav>` is a component that displays a list of <nav-items>.
1709
1092
  * ---
1710
1093
  *
1711
1094
  *
1712
- * ### **Events:**
1713
- * - **change** - Fires when the value of the input changes
1714
- * - **invalid** - Fires when the input is invalid
1715
- *
1716
1095
  * ### **Slots:**
1717
- * - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
1096
+ * - _default_ - The component's main content
1718
1097
  */
1719
- "skf-input": Partial<SkfInputProps & BaseProps & BaseEvents>;
1098
+ "skf-nav": Partial<SkfNavProps & BaseProps & BaseEvents>;
1720
1099
 
1721
1100
  /**
1722
- * The `<skf-link>` can be used as either a regular link or a link styled semantic button
1101
+ * The `<skf-header>` component is to be used as the site-header in the app
1723
1102
  * ---
1724
1103
  *
1725
1104
  *
1726
1105
  * ### **Slots:**
1727
- * - _default_ - The links' main content
1106
+ * - _default_ - Navigation items
1728
1107
  */
1729
- "skf-link": Partial<SkfLinkProps & BaseProps & BaseEvents>;
1108
+ "skf-header": Partial<SkfHeaderProps & BaseProps & BaseEvents>;
1730
1109
 
1731
1110
  /**
1732
- * The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
1111
+ * The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.
1733
1112
  * ---
1734
1113
  *
1114
+ *
1115
+ * ### **Events:**
1116
+ * - **change** - Fires when the value of the input changes
1117
+ * - **invalid** - Fires when the input is invalid
1118
+ *
1119
+ * ### **Slots:**
1120
+ * - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
1735
1121
  */
1736
- "skf-loader": Partial<SkfLoaderProps & BaseProps & BaseEvents>;
1122
+ "skf-input": Partial<SkfInputProps & BaseProps & BaseEvents>;
1737
1123
 
1738
1124
  /**
1739
- * The `<skf-logo>` component is used to display the SKF logo.
1125
+ * The `<skf-link>` can be used as either a regular link or a link styled semantic button
1740
1126
  * ---
1741
1127
  *
1742
1128
  *
1743
- * ### **CSS Properties:**
1744
- * - **--skf-logo-height** - The height of the logo _(default: undefined)_
1129
+ * ### **Slots:**
1130
+ * - _default_ - The links' main content
1745
1131
  */
1746
- "skf-logo": Partial<SkfLogoProps & BaseProps & BaseEvents>;
1132
+ "skf-link": Partial<SkfLinkProps & BaseProps & BaseEvents>;
1747
1133
 
1748
1134
  /**
1749
1135
  * The `<skf-menu>` is a component that displays a list of actions or options.
@@ -1751,8 +1137,8 @@ export type CustomElements = {
1751
1137
  *
1752
1138
  *
1753
1139
  * ### **Events:**
1754
- * - **open** - Fired when the menu is opened
1755
- * - **close** - Fired when the menu is closed
1140
+ * - **skf-opened** - Fired when the menu is opened
1141
+ * - **skf-closed** - Fired when the menu is closed
1756
1142
  *
1757
1143
  * ### **Slots:**
1758
1144
  * - _default_ - The menu popover content
@@ -1780,13 +1166,23 @@ export type CustomElements = {
1780
1166
  "skf-menu-item": Partial<SkfMenuItemProps & BaseProps & BaseEvents>;
1781
1167
 
1782
1168
  /**
1783
- * The `<skf-popover>` is a general purpose component that displays the slot content.
1169
+ * The `<skf-nav>` is a component that displays a list of <nav-items>.
1170
+ * ---
1171
+ *
1172
+ *
1173
+ * ### **Slots:**
1174
+ * - _default_ - The component's main content
1175
+ */
1176
+ "skf-nav-item": Partial<SkfNavItemProps & BaseProps & BaseEvents>;
1177
+
1178
+ /**
1179
+ * The `<skf-popover>` is a general purpose component that displays the slot content in a popover.
1784
1180
  * ---
1785
1181
  *
1786
1182
  *
1787
1183
  * ### **Events:**
1788
- * - **open** - Fired when the menu is opened
1789
- * - **close** - Fired when the menu is closed
1184
+ * - **skf-opened** - Fired when the menu is opened
1185
+ * - **skf-closed** - Fired when the menu is closed
1790
1186
  *
1791
1187
  * ### **Slots:**
1792
1188
  * - _default_ - The popover content
@@ -1814,21 +1210,29 @@ export type CustomElements = {
1814
1210
  "skf-radio": Partial<SkfRadioProps & BaseProps & BaseEvents>;
1815
1211
 
1816
1212
  /**
1817
- * 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.
1213
+ * The `<skf-segmented-button-item>` is used in conjunction with the `<skf-segmented-button>` component
1818
1214
  * ---
1819
1215
  *
1820
1216
  *
1821
1217
  * ### **Events:**
1822
- * - **change** - Fired when the selected option(s) changes
1823
- * - **invalid** - Fired when the select is invalid
1824
- * - **reset** - Fired when the form is reset
1825
- * - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
1826
- * - **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
1218
+ * - **my-tag-my-event** - Fired when something happens
1827
1219
  *
1828
1220
  * ### **Slots:**
1829
- * - _default_ - The select's placeholder content
1221
+ * - _default_ - The items label
1830
1222
  */
1831
- "skf-select": Partial<SkfSelectProps & BaseProps & BaseEvents>;
1223
+ "skf-segmented-button-item": Partial<SkfSegmentedButtonItemProps & BaseProps & BaseEvents>;
1224
+
1225
+ /**
1226
+ * The `<skf-segmented-button>` component consists of multiple `<skf-segmented-button-item>`, working together.
1227
+ *
1228
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/68ff54-segmented-buttons) for design principles
1229
+ * ---
1230
+ *
1231
+ *
1232
+ * ### **Slots:**
1233
+ * - _default_ - One or more `<skf-segmented-button-item>`
1234
+ */
1235
+ "skf-segmented-button": Partial<SkfSegmentedButtonProps & BaseProps & BaseEvents>;
1832
1236
 
1833
1237
  /**
1834
1238
  * The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
@@ -1845,27 +1249,41 @@ export type CustomElements = {
1845
1249
  "skf-select-option": Partial<SkfSelectOptionProps & BaseProps & BaseEvents>;
1846
1250
 
1847
1251
  /**
1848
- * The `<skf-select-option-group>` is a component that groups select-options
1252
+ * The `<skf-tag>` is a component that displays a list of actions or options
1849
1253
  * ---
1850
1254
  *
1851
1255
  *
1852
1256
  * ### **Slots:**
1853
1257
  * - _default_ - The component's placeholder content
1854
1258
  */
1855
- "skf-select-option-group": Partial<SkfSelectOptionGroupProps & BaseProps & BaseEvents>;
1259
+ "skf-tag": Partial<SkfTagProps & BaseProps & BaseEvents>;
1856
1260
 
1857
1261
  /**
1858
- * The `<skf-stepper>` is a component that displays a list of actions or options.
1262
+ * 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.
1859
1263
  * ---
1860
1264
  *
1861
1265
  *
1862
1266
  * ### **Events:**
1863
- * - **skf-stepper-item-select** - Dispatched when the stepper item is selected
1267
+ * - **change** - Fired when the selected option(s) changes
1268
+ * - **invalid** - Fired when the select is invalid
1269
+ * - **reset** - Fired when the form is reset
1270
+ * - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
1271
+ * - **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
1864
1272
  *
1865
1273
  * ### **Slots:**
1866
- * - _default_ - One or more `<skf-stepper-item>`
1274
+ * - _default_ - The select's placeholder content
1867
1275
  */
1868
- "skf-stepper": Partial<SkfStepperProps & BaseProps & BaseEvents>;
1276
+ "skf-select": Partial<SkfSelectProps & BaseProps & BaseEvents>;
1277
+
1278
+ /**
1279
+ * The `<skf-select-option-group>` is a component that groups select-options
1280
+ * ---
1281
+ *
1282
+ *
1283
+ * ### **Slots:**
1284
+ * - _default_ - The component's placeholder content
1285
+ */
1286
+ "skf-select-option-group": Partial<SkfSelectOptionGroupProps & BaseProps & BaseEvents>;
1869
1287
 
1870
1288
  /**
1871
1289
  * The `<skf-stepper-item>` is used in conjunction with the `<skf-stepper>` component
@@ -1880,8 +1298,23 @@ export type CustomElements = {
1880
1298
  */
1881
1299
  "skf-stepper-item": Partial<SkfStepperItemProps & BaseProps & BaseEvents>;
1882
1300
 
1301
+ /**
1302
+ * The `<skf-stepper>` is a component that displays a list of actions or options.
1303
+ * ---
1304
+ *
1305
+ *
1306
+ * ### **Events:**
1307
+ * - **skf-stepper-item-select** - Dispatched when the stepper item is selected
1308
+ *
1309
+ * ### **Slots:**
1310
+ * - _default_ - One or more `<skf-stepper-item>`
1311
+ */
1312
+ "skf-stepper": Partial<SkfStepperProps & BaseProps & BaseEvents>;
1313
+
1883
1314
  /**
1884
1315
  * The `<skf-switch>` is a component that displays a list of actions or options
1316
+ *
1317
+ * See [zeroheight](https://zeroheight.com/853e936c9/p/7282a2-switch) for design principle
1885
1318
  * ---
1886
1319
  *
1887
1320
  *
@@ -1891,18 +1324,14 @@ export type CustomElements = {
1891
1324
  "skf-switch": Partial<SkfSwitchProps & BaseProps & BaseEvents>;
1892
1325
 
1893
1326
  /**
1894
- * The `<skf-tab>` is a component that displays a list of actions or options
1327
+ * The `<skf-tab-panel>` is a component that displays a list of actions or options.
1895
1328
  * ---
1896
1329
  *
1897
1330
  *
1898
- * ### **Events:**
1899
- * - **skf-tab-select** - {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
1900
- * - **click** - Fired when the component is clicked
1901
- *
1902
1331
  * ### **Slots:**
1903
- * - _default_ - The tab's label
1332
+ * - _default_ - The tab panel's content
1904
1333
  */
1905
- "skf-tab": Partial<SkfTabProps & BaseProps & BaseEvents>;
1334
+ "skf-tab-panel": Partial<SkfTabPanelProps & BaseProps & BaseEvents>;
1906
1335
 
1907
1336
  /**
1908
1337
  * The `<skf-tab-group>` is a component that displays a list of actions or options.
@@ -1916,24 +1345,18 @@ export type CustomElements = {
1916
1345
  "skf-tab-group": Partial<SkfTabGroupProps & BaseProps & BaseEvents>;
1917
1346
 
1918
1347
  /**
1919
- * The `<skf-tab-panel>` is a component that displays a list of actions or options.
1348
+ * The `<skf-tab>` is a component that displays a list of actions or options
1920
1349
  * ---
1921
1350
  *
1922
1351
  *
1923
- * ### **Slots:**
1924
- * - _default_ - The tab panel's content
1925
- */
1926
- "skf-tab-panel": Partial<SkfTabPanelProps & BaseProps & BaseEvents>;
1927
-
1928
- /**
1929
- * The `<skf-tag>` is a component that displays a list of actions or options
1930
- * ---
1931
- *
1352
+ * ### **Events:**
1353
+ * - **skf-tab-select** - {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
1354
+ * - **click** - Fired when the component is clicked
1932
1355
  *
1933
1356
  * ### **Slots:**
1934
- * - _default_ - The component's placeholder content
1357
+ * - _default_ - The tab's label
1935
1358
  */
1936
- "skf-tag": Partial<SkfTagProps & BaseProps & BaseEvents>;
1359
+ "skf-tab": Partial<SkfTabProps & BaseProps & BaseEvents>;
1937
1360
 
1938
1361
  /**
1939
1362
  * The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
@@ -1950,33 +1373,33 @@ export type CustomElements = {
1950
1373
  "skf-textarea": Partial<SkfTextAreaProps & BaseProps & BaseEvents>;
1951
1374
 
1952
1375
  /**
1953
- * 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.
1376
+ * 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.
1954
1377
  * ---
1955
1378
  *
1956
1379
  *
1957
1380
  * ### **Slots:**
1958
- * - _default_ - The component's placeholder content
1381
+ * - _default_ - The alert components that the toast creates will render here.
1959
1382
  */
1960
- "skf-toast": Partial<SkfToastProps & BaseProps & BaseEvents>;
1383
+ "skf-toast-wrapper": Partial<SkfToastWrapperProps & BaseProps & BaseEvents>;
1961
1384
 
1962
1385
  /**
1963
- * 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.
1386
+ * 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.
1964
1387
  * ---
1965
1388
  *
1966
1389
  *
1967
1390
  * ### **Slots:**
1968
- * - _default_ - The alert components that the toast creates will render here.
1391
+ * - _default_ - The component's placeholder content
1969
1392
  */
1970
- "skf-toast-wrapper": Partial<SkfToastWrapperProps & BaseProps & BaseEvents>;
1393
+ "skf-toast": Partial<SkfToastProps & BaseProps & BaseEvents>;
1971
1394
 
1972
1395
  /**
1973
- * The `<skf-tooltip>` is a component that displays a list of actions or options.
1396
+ * The `<skf-tooltip>` is a component that displays a tooltip.
1974
1397
  * ---
1975
1398
  *
1976
1399
  *
1977
1400
  * ### **Events:**
1978
- * - **open** - Fired when the dropdown is opened
1979
- * - **close** - Fired when the dropdown is closed
1401
+ * - **skf-opened** - Fired when the dropdown is opened
1402
+ * - **skf-closed** - Fired when the dropdown is closed
1980
1403
  *
1981
1404
  * ### **Slots:**
1982
1405
  * - _default_ - The tooltip popover content