@skf-design-system/ui-components 1.0.0-alpha.33 → 1.0.0-alpha.35

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