@skf-design-system/ui-components 1.0.1-beta.1 → 1.0.2-beta.0

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