@skf-design-system/ui-components 1.0.2-beta.0 → 1.0.2-beta.10
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.
- package/README.md +37 -9
- package/dist/components/accordion/accordion-item.component.d.ts +36 -0
- package/dist/components/accordion/accordion-item.component.js +98 -0
- package/dist/components/accordion/accordion-item.d.ts +3 -3
- package/dist/components/accordion/accordion-item.js +4 -5
- package/dist/components/accordion/accordion-item.styles.js +77 -0
- package/dist/components/accordion/accordion.component.d.ts +6 -10
- package/dist/components/accordion/accordion.component.js +9 -10
- package/dist/components/accordion/accordion.d.ts +0 -1
- package/dist/components/accordion/accordion.js +0 -2
- package/dist/components/alert/alert.component.d.ts +12 -10
- package/dist/components/alert/alert.component.js +59 -51
- package/dist/components/alert/alert.styles.js +50 -51
- package/dist/components/breadcrumb/breadcrumb-item.component.js +59 -0
- package/dist/components/{breadcrumb-item → breadcrumb}/breadcrumb-item.d.ts +2 -2
- package/dist/components/breadcrumb/breadcrumb-item.js +6 -0
- package/dist/components/breadcrumb/breadcrumb-item.styles.js +63 -0
- package/dist/components/breadcrumb/breadcrumb.component.d.ts +6 -3
- package/dist/components/breadcrumb/breadcrumb.component.js +65 -0
- package/dist/components/breadcrumb/breadcrumb.d.ts +2 -2
- package/dist/components/breadcrumb/breadcrumb.js +6 -0
- package/dist/components/breadcrumb/breadcrumb.styles.js +25 -0
- package/dist/components/button/button.component.d.ts +13 -10
- package/dist/components/button/button.component.js +69 -66
- package/dist/components/button/button.styles.d.ts +1 -2
- package/dist/components/button/button.styles.js +6 -5
- package/dist/components/card/card.component.d.ts +6 -1
- package/dist/components/card/card.component.js +46 -24
- package/dist/components/card/card.styles.js +31 -14
- package/dist/components/checkbox/checkbox.component.d.ts +14 -11
- package/dist/components/checkbox/checkbox.component.js +67 -69
- package/dist/components/checkbox/checkbox.styles.d.ts +1 -2
- package/dist/components/checkbox/checkbox.styles.js +2 -6
- package/dist/components/{date-picker/datepicker.calendar.component.d.ts → datepicker/datepicker-calendar.component.d.ts} +8 -1
- package/dist/components/{date-picker/datepicker.calendar.component.js → datepicker/datepicker-calendar.component.js} +109 -115
- package/dist/components/datepicker/datepicker-calendar.d.ts +8 -0
- package/dist/components/datepicker/datepicker-calendar.js +6 -0
- package/dist/components/{date-picker/datepicker.component.d.ts → datepicker/datepicker-popup.component.d.ts} +9 -20
- package/dist/components/datepicker/datepicker-popup.component.js +272 -0
- package/dist/components/datepicker/datepicker-popup.d.ts +8 -0
- package/dist/components/{date-picker/datepicker.helpers.d.ts → datepicker/datepicker-popup.helpers.d.ts} +3 -3
- package/dist/components/datepicker/datepicker-popup.helpers.js +83 -0
- package/dist/components/datepicker/datepicker-popup.js +6 -0
- package/dist/components/{date-picker/datepicker.styles.js → datepicker/datepicker-popup.styles.js} +3 -3
- package/dist/components/{date-picker-input/datepicker-input.component.d.ts → datepicker/datepicker.component.d.ts} +22 -14
- package/dist/components/datepicker/datepicker.component.js +455 -0
- package/dist/components/datepicker/datepicker.d.ts +8 -0
- package/dist/components/datepicker/datepicker.js +6 -0
- package/dist/components/dialog/dialog.component.d.ts +8 -6
- package/dist/components/dialog/dialog.component.js +67 -67
- package/dist/components/dialog/dialog.d.ts +2 -2
- package/dist/components/dialog/dialog.styles.js +4 -4
- package/dist/components/divider/divider.component.d.ts +3 -0
- package/dist/components/divider/divider.component.js +43 -22
- package/dist/components/divider/divider.styles.js +9 -9
- package/dist/components/drawer/drawer.component.d.ts +24 -12
- package/dist/components/drawer/drawer.component.js +87 -63
- package/dist/components/drawer/drawer.d.ts +2 -2
- package/dist/components/drawer/drawer.styles.js +47 -40
- package/dist/components/header/header.component.d.ts +7 -4
- package/dist/components/header/header.component.js +68 -55
- package/dist/components/header/header.d.ts +2 -2
- package/dist/components/header/header.styles.js +2 -2
- package/dist/components/heading/heading.component.d.ts +8 -6
- package/dist/components/heading/heading.component.js +52 -24
- package/dist/components/heading/heading.styles.js +34 -36
- package/dist/components/icon/icon.component.d.ts +15 -17
- package/dist/components/icon/icon.component.js +62 -43
- package/dist/components/icon/icon.styles.d.ts +1 -2
- package/dist/components/icon/icon.styles.js +60 -60
- package/dist/components/input/input.component.d.ts +34 -39
- package/dist/components/input/input.component.js +159 -153
- package/dist/components/input/input.controllers.d.ts +0 -1
- package/dist/components/input/input.controllers.js +14 -19
- package/dist/components/link/link.component.d.ts +20 -25
- package/dist/components/link/link.component.js +104 -107
- package/dist/components/link/link.styles.d.ts +1 -2
- package/dist/components/link/link.styles.js +54 -46
- package/dist/components/loader/loader.component.d.ts +6 -4
- package/dist/components/loader/loader.component.js +49 -42
- package/dist/components/loader/loader.styles.d.ts +1 -2
- package/dist/components/loader/loader.styles.js +34 -30
- package/dist/components/logo/logo.component.d.ts +8 -6
- package/dist/components/logo/logo.component.js +55 -51
- package/dist/components/logo/logo.styles.js +26 -16
- package/dist/components/menu/menu-item.component.d.ts +13 -0
- package/dist/components/menu/menu-item.component.js +13 -0
- package/dist/components/{menu-item → menu}/menu-item.d.ts +2 -2
- package/dist/components/menu/menu-item.styles.js +23 -0
- package/dist/components/menu/menu.component.d.ts +14 -8
- package/dist/components/menu/menu.component.js +10 -12
- package/dist/components/menu/menu.d.ts +2 -2
- package/dist/components/{nav-item → nav}/nav-item.component.d.ts +6 -4
- package/dist/components/nav/nav-item.component.js +57 -0
- package/dist/components/nav/nav-item.styles.js +43 -0
- package/dist/components/nav/nav.component.d.ts +9 -0
- package/dist/components/nav/nav.component.js +47 -21
- package/dist/components/nav/nav.d.ts +2 -2
- package/dist/components/nav/nav.styles.js +15 -9
- package/dist/components/popover/popover.component.d.ts +17 -6
- package/dist/components/popover/popover.component.js +22 -16
- package/dist/components/popover/popover.d.ts +2 -2
- package/dist/components/progress/progress.component.d.ts +4 -2
- package/dist/components/progress/progress.component.js +38 -35
- package/dist/components/progress/progress.d.ts +2 -2
- package/dist/components/progress/progress.styles.js +42 -35
- package/dist/components/radio/radio.component.d.ts +13 -9
- package/dist/components/radio/radio.component.js +96 -91
- package/dist/components/radio/radio.styles.js +1 -1
- package/dist/components/{segmented-button-item → segmented-button}/segmented-button-item.component.d.ts +4 -4
- package/dist/components/segmented-button/segmented-button-item.component.js +56 -0
- package/dist/components/{segmented-button-item → segmented-button}/segmented-button-item.d.ts +2 -2
- package/dist/components/segmented-button/segmented-button-item.js +6 -0
- package/dist/components/segmented-button/segmented-button-item.styles.js +62 -0
- package/dist/components/segmented-button/segmented-button.component.d.ts +0 -2
- package/dist/components/segmented-button/segmented-button.component.js +71 -0
- package/dist/components/segmented-button/segmented-button.d.ts +2 -2
- package/dist/components/segmented-button/segmented-button.js +6 -0
- package/dist/components/segmented-button/segmented-button.styles.js +16 -0
- package/dist/components/{select-option-group → select}/select-option-group.component.d.ts +4 -0
- package/dist/components/select/select-option-group.component.js +50 -0
- package/dist/components/{select-option-group → select}/select-option-group.d.ts +2 -2
- package/dist/components/select/select-option-group.style.js +24 -0
- package/dist/components/{select-option → select}/select-option.component.d.ts +16 -12
- package/dist/components/select/select-option.component.js +135 -0
- package/dist/components/select/select-option.styles.js +65 -0
- package/dist/components/select/select.component.d.ts +35 -25
- package/dist/components/select/select.component.js +126 -88
- package/dist/components/select/select.controllers.d.ts +1 -1
- package/dist/components/select/select.controllers.js +16 -18
- package/dist/components/select/select.styles.js +8 -2
- package/dist/components/select/stories/select.stories.icons.d.ts +7 -0
- package/dist/components/{stepper-item → stepper}/stepper-item.component.d.ts +1 -1
- package/dist/components/stepper/stepper-item.component.js +116 -0
- package/dist/components/{stepper-item → stepper}/stepper-item.d.ts +2 -2
- package/dist/components/{stepper-item → stepper}/stepper-item.styles.js +4 -4
- package/dist/components/stepper/stepper.component.d.ts +2 -2
- package/dist/components/stepper/stepper.component.js +17 -18
- package/dist/components/stepper/stepper.d.ts +2 -2
- package/dist/components/stepper/stepper.helpers.d.ts +1 -1
- package/dist/components/stepper/stepper.helpers.js +6 -7
- package/dist/components/switch/switch.component.d.ts +4 -2
- package/dist/components/switch/switch.component.js +64 -58
- package/dist/components/switch/switch.d.ts +2 -2
- package/dist/components/switch/switch.styles.js +1 -1
- package/dist/components/{tab-panel → tabs}/tab-panel.component.d.ts +1 -1
- package/dist/components/tabs/tab-panel.component.js +39 -0
- package/dist/components/{tab-panel → tabs}/tab-panel.d.ts +2 -2
- package/dist/components/{tab → tabs}/tab.component.d.ts +3 -3
- package/dist/components/{tab → tabs}/tab.component.js +18 -15
- package/dist/components/{tab → tabs}/tab.d.ts +2 -2
- package/dist/components/{tab → tabs}/tab.styles.js +2 -2
- package/dist/components/{tab-group/tab-group.component.d.ts → tabs/tabs.component.d.ts} +3 -4
- package/dist/components/{tab-group/tab-group.component.js → tabs/tabs.component.js} +36 -37
- package/dist/components/tabs/tabs.d.ts +8 -0
- package/dist/components/tabs/tabs.js +6 -0
- package/dist/components/{tab-group/tab-group.styles.js → tabs/tabs.styles.js} +16 -16
- package/dist/components/tag/tag.component.d.ts +20 -16
- package/dist/components/tag/tag.component.js +74 -65
- package/dist/components/tag/tag.d.ts +2 -2
- package/dist/components/tag/tag.styles.js +63 -50
- package/dist/components/textarea/textarea.component.d.ts +14 -13
- package/dist/components/textarea/textarea.component.js +77 -72
- package/dist/components/{toast-item → toast}/toast-item.d.ts +2 -0
- package/dist/components/{toast-item → toast}/toast-item.js +4 -0
- package/dist/components/toast/toast-item.styles.js +21 -0
- package/dist/components/{toast-wrapper → toast}/toast-wrapper.component.js +1 -1
- package/dist/components/toast/toast-wrapper.styles.d.ts +1 -0
- package/dist/components/toast/toast.component.d.ts +5 -4
- package/dist/components/toast/toast.component.js +16 -16
- package/dist/components/toast/toast.singleton.d.ts +5 -5
- package/dist/components/toast/toast.singleton.js +28 -29
- package/dist/components/tooltip/tooltip.component.d.ts +11 -3
- package/dist/components/tooltip/tooltip.component.js +18 -9
- package/dist/components/tooltip/tooltip.d.ts +2 -2
- package/dist/custom-elements.json +2202 -1720
- package/dist/index.d.ts +19 -12
- package/dist/index.js +108 -89
- package/dist/internal/base-classes/popover/popover.base.d.ts +30 -6
- package/dist/internal/base-classes/popover/popover.base.js +83 -69
- package/dist/internal/base-classes/popover/popover.styles.js +4 -5
- package/dist/internal/components/formBase.d.ts +1 -0
- package/dist/internal/components/formBase.js +11 -19
- package/dist/internal/components/hint/hint.component.d.ts +6 -2
- package/dist/internal/components/hint/hint.component.js +47 -20
- package/dist/internal/components/hint/hint.styles.d.ts +1 -2
- package/dist/internal/components/hint/hint.styles.js +30 -26
- package/dist/internal/components/skf-element.d.ts +1 -3
- package/dist/internal/components/skf-element.js +4 -9
- package/dist/internal/constants/iconSeverity.d.ts +3 -2
- package/dist/internal/constants/iconSeverity.js +2 -3
- package/dist/internal/controllers/popover.controller.d.ts +2 -0
- package/dist/internal/controllers/popover.controller.js +11 -14
- package/dist/internal/helpers/hintSeverity.d.ts +2 -2
- package/dist/internal/helpers/hintSeverity.js +1 -1
- package/dist/internal/helpers/stateMap.d.ts +14 -0
- package/dist/internal/helpers/stateMap.js +68 -0
- package/dist/internal/helpers/uuid.d.ts +8 -10
- package/dist/internal/helpers/uuid.js +4 -11
- package/dist/internal/helpers/watch.d.ts +1 -1
- package/dist/internal/helpers/watch.js +12 -12
- package/dist/internal/templates/asterisk.d.ts +1 -1
- package/dist/internal/templates/asterisk.js +4 -4
- package/dist/internal/types/formField.d.ts +1 -1
- package/dist/internal/types.d.ts +22 -0
- package/dist/styles/component.styles.d.ts +1 -2
- package/dist/styles/component.styles.js +38 -37
- package/dist/styles/global-alt.css +1 -0
- package/dist/styles/global.css +1 -1
- package/dist/translations/en.d.ts +3 -0
- package/dist/translations/en.js +27 -0
- package/dist/translations/es.d.ts +3 -0
- package/dist/translations/es.js +27 -0
- package/dist/translations/index.d.ts +4 -0
- package/dist/translations/pt.d.ts +3 -0
- package/dist/translations/pt.js +27 -0
- package/dist/translations/sv.d.ts +3 -0
- package/dist/translations/sv.js +27 -0
- package/dist/types/jsx/custom-element-jsx.d.ts +2031 -927
- package/dist/types/vue/index.d.ts +357 -324
- package/dist/utilities/localize.d.ts +28 -0
- package/dist/utilities/localize.js +13 -0
- package/dist/vscode.html-custom-data.json +360 -1241
- package/dist/web-types.json +932 -805
- package/package.json +38 -52
- package/dist/components/accordion/accordion.test.d.ts +0 -1
- package/dist/components/checkbox/checkbox.test.d.ts +0 -1
- package/dist/components/collapse/collapse.component.d.ts +0 -40
- package/dist/components/collapse/collapse.component.js +0 -86
- package/dist/components/collapse/collapse.d.ts +0 -8
- package/dist/components/collapse/collapse.js +0 -6
- package/dist/components/collapse/collapse.styles.d.ts +0 -2
- package/dist/components/collapse/collapse.styles.js +0 -77
- package/dist/components/collapse/collapse.test.d.ts +0 -1
- package/dist/components/date-picker/datepicker.component.js +0 -261
- package/dist/components/date-picker/datepicker.d.ts +0 -10
- package/dist/components/date-picker/datepicker.helpers.js +0 -76
- package/dist/components/date-picker/datepicker.js +0 -8
- package/dist/components/date-picker-input/datepicker-input.component.js +0 -441
- package/dist/components/date-picker-input/datepicker-input.d.ts +0 -8
- package/dist/components/date-picker-input/datepicker-input.js +0 -6
- package/dist/components/input/input.test.d.ts +0 -1
- package/dist/components/menu-item/menu-item.component.d.ts +0 -25
- package/dist/components/menu-item/menu-item.component.js +0 -13
- package/dist/components/menu-item/menu-item.styles.js +0 -19
- package/dist/components/nav-item/nav-item.component.js +0 -38
- package/dist/components/nav-item/nav-item.styles.js +0 -39
- package/dist/components/radio/radio.test.d.ts +0 -1
- package/dist/components/select-option/select-option.component.js +0 -123
- package/dist/components/select-option/select-option.styles.js +0 -53
- package/dist/components/select-option-group/select-option-group.component.js +0 -31
- package/dist/components/select-option-group/select-option-group.style.js +0 -18
- package/dist/components/stepper-item/stepper-item.component.js +0 -113
- package/dist/components/switch/switch.test.d.ts +0 -1
- package/dist/components/tab-group/tab-group.d.ts +0 -8
- package/dist/components/tab-group/tab-group.js +0 -6
- package/dist/components/tab-panel/tab-panel.component.js +0 -36
- package/dist/components/toast-item/toast-item.styles.js +0 -18
- package/dist/internal/constants/heading.d.ts +0 -2
- package/dist/internal/playwright/index.d.ts +0 -1
- /package/dist/components/{breadcrumb-item/breadcrumb-item.styles.d.ts → accordion/accordion-item.styles.d.ts} +0 -0
- /package/dist/components/{breadcrumb-item → breadcrumb}/breadcrumb-item.component.d.ts +0 -0
- /package/dist/components/{date-picker/datepicker.calendar.styles.d.ts → breadcrumb/breadcrumb-item.styles.d.ts} +0 -0
- /package/dist/components/{date-picker/datepicker.styles.d.ts → datepicker/datepicker-calendar.styles.d.ts} +0 -0
- /package/dist/components/{date-picker/datepicker.calendar.styles.js → datepicker/datepicker-calendar.styles.js} +0 -0
- /package/dist/components/{menu-item/menu-item.styles.d.ts → datepicker/datepicker-popup.styles.d.ts} +0 -0
- /package/dist/components/{date-picker-input/datepicker-input.helpers.d.ts → datepicker/datepicker.helpers.d.ts} +0 -0
- /package/dist/components/{date-picker-input/datepicker-input.helpers.js → datepicker/datepicker.helpers.js} +0 -0
- /package/dist/components/{date-picker-input/datepicker-input.styles.d.ts → datepicker/datepicker.styles.d.ts} +0 -0
- /package/dist/components/{date-picker-input/datepicker-input.styles.js → datepicker/datepicker.styles.js} +0 -0
- /package/dist/components/{menu-item → menu}/menu-item.js +0 -0
- /package/dist/components/{nav-item/nav-item.styles.d.ts → menu/menu-item.styles.d.ts} +0 -0
- /package/dist/components/{nav-item → nav}/nav-item.d.ts +0 -0
- /package/dist/components/{nav-item → nav}/nav-item.js +0 -0
- /package/dist/components/{segmented-button-item/segmented-button-item.styles.d.ts → nav/nav-item.styles.d.ts} +0 -0
- /package/dist/components/{select-option-group/select-option-group.style.d.ts → segmented-button/segmented-button-item.styles.d.ts} +0 -0
- /package/dist/components/{select-option-group → select}/select-option-group.js +0 -0
- /package/dist/components/{select-option/select-option.styles.d.ts → select/select-option-group.style.d.ts} +0 -0
- /package/dist/components/{select-option → select}/select-option.controllers.d.ts +0 -0
- /package/dist/components/{select-option → select}/select-option.d.ts +0 -0
- /package/dist/components/{select-option → select}/select-option.js +0 -0
- /package/dist/components/{stepper-item/stepper-item.styles.d.ts → select/select-option.styles.d.ts} +0 -0
- /package/dist/components/{stepper-item → stepper}/stepper-item.js +0 -0
- /package/dist/components/{tab-group/tab-group.styles.d.ts → stepper/stepper-item.styles.d.ts} +0 -0
- /package/dist/components/{tab-panel → tabs}/tab-panel.js +0 -0
- /package/dist/components/{tab-panel → tabs}/tab-panel.styles.d.ts +0 -0
- /package/dist/components/{tab-panel → tabs}/tab-panel.styles.js +0 -0
- /package/dist/components/{tab → tabs}/tab.js +0 -0
- /package/dist/components/{tab → tabs}/tab.styles.d.ts +0 -0
- /package/dist/components/{toast-wrapper/toast-wrapper.styles.d.ts → tabs/tabs.styles.d.ts} +0 -0
- /package/dist/components/{toast-item → toast}/toast-item.component.d.ts +0 -0
- /package/dist/components/{toast-item → toast}/toast-item.component.js +0 -0
- /package/dist/components/{toast-item → toast}/toast-item.styles.d.ts +0 -0
- /package/dist/components/{toast-wrapper → toast}/toast-wrapper.component.d.ts +0 -0
- /package/dist/components/{toast-wrapper → toast}/toast-wrapper.d.ts +0 -0
- /package/dist/components/{toast-wrapper → toast}/toast-wrapper.js +0 -0
- /package/dist/components/{toast-wrapper → toast}/toast-wrapper.styles.js +0 -0
@@ -1,5 +1,6 @@
|
|
1
|
+
|
1
2
|
import type { SkfIcon } from "../../components/icon/icon.component.js";
|
2
|
-
import type {
|
3
|
+
import type { SkfAccordionItem } from "../../components/accordion-item/accordion-item.component.js";
|
3
4
|
import type { SkfAccordion } from "../../components/accordion/accordion.component.js";
|
4
5
|
import type { SkfAlert } from "../../components/alert/alert.component.js";
|
5
6
|
import type { SkfBreadcrumbItem } from "../../components/breadcrumb-item/breadcrumb-item.component.js";
|
@@ -8,37 +9,35 @@ import type { SkfLoader } from "../../components/loader/loader.component.js";
|
|
8
9
|
import type { SkfButton } from "../../components/button/button.component.js";
|
9
10
|
import type { SkfCard } from "../../components/card/card.component.js";
|
10
11
|
import type { SkfCheckbox } from "../../components/checkbox/checkbox.component.js";
|
11
|
-
import type {
|
12
|
+
import type { SkfDatepickerCalendar } from "../../components/datepicker-calendar/datepicker-calendar.component.js";
|
13
|
+
import type { SkfDatepicker } from "../../components/datepicker/datepicker.component.js";
|
12
14
|
import type { SkfHeading } from "../../components/heading/heading.component.js";
|
13
15
|
import type { SkfDialog } from "../../components/dialog/dialog.component.js";
|
14
16
|
import type { SkfDivider } from "../../components/divider/divider.component.js";
|
15
17
|
import type { SkfDrawer } from "../../components/drawer/drawer.component.js";
|
16
18
|
import type { SkfLogo } from "../../components/logo/logo.component.js";
|
19
|
+
import type { SkfLink } from "../../components/link/link.component.js";
|
20
|
+
import type { SkfNavItem } from "../../components/nav-item/nav-item.component.js";
|
17
21
|
import type { SkfNav } from "../../components/nav/nav.component.js";
|
18
22
|
import type { SkfHeader } from "../../components/header/header.component.js";
|
19
23
|
import type { SkfInput } from "../../components/input/input.component.js";
|
20
|
-
import type {
|
24
|
+
import type { SkfMenuItem } from "../../components/menu-item/menu-item.component.js";
|
21
25
|
import type { SkfMenu } from "../../components/menu/menu.component.js";
|
22
|
-
import type { SkfMenuItem, CustomEvent } from "../../components/menu-item/menu-item.component.js";
|
23
|
-
import type { SkfNavItem } from "../../components/nav-item/nav-item.component.js";
|
24
26
|
import type { SkfPopover } from "../../components/popover/popover.component.js";
|
25
27
|
import type { SkfProgress } from "../../components/progress/progress.component.js";
|
26
28
|
import type { SkfRadio } from "../../components/radio/radio.component.js";
|
27
|
-
import type {
|
28
|
-
SkfSegmentedButtonItem,
|
29
|
-
CustomEvent,
|
30
|
-
} from "../../components/segmented-button-item/segmented-button-item.component.js";
|
29
|
+
import type { SkfSegmentedButtonItem } from "../../components/segmented-button-item/segmented-button-item.component.js";
|
31
30
|
import type { SkfSegmentedButton } from "../../components/segmented-button/segmented-button.component.js";
|
32
|
-
import type {
|
31
|
+
import type { SkfSelectOptionGroup } from "../../components/select-option-group/select-option-group.component.js";
|
33
32
|
import type { SkfTag } from "../../components/tag/tag.component.js";
|
34
33
|
import type { SkfSelect } from "../../components/select/select.component.js";
|
35
|
-
import type {
|
34
|
+
import type { SkfSelectOption } from "../../components/select-option/select-option.component.js";
|
36
35
|
import type { SkfStepperItem } from "../../components/stepper-item/stepper-item.component.js";
|
37
36
|
import type { SkfStepper } from "../../components/stepper/stepper.component.js";
|
38
37
|
import type { SkfSwitch } from "../../components/switch/switch.component.js";
|
39
38
|
import type { SkfTabPanel } from "../../components/tab-panel/tab-panel.component.js";
|
40
|
-
import type {
|
41
|
-
import type { SkfTab
|
39
|
+
import type { SkfTabs } from "../../components/tabs/tabs.component.js";
|
40
|
+
import type { SkfTab } from "../../components/tab/tab.component.js";
|
42
41
|
import type { SkfTextArea } from "../../components/textarea/textarea.component.js";
|
43
42
|
import type { SkfToastWrapper } from "../../components/toast-wrapper/toast-wrapper.component.js";
|
44
43
|
import type { SkfToast } from "../../components/toast/toast.component.js";
|
@@ -46,12 +45,12 @@ import type { SkfTooltip } from "../../components/tooltip/tooltip.component.js";
|
|
46
45
|
|
47
46
|
/**
|
48
47
|
* This type can be used to create scoped tags for your components.
|
49
|
-
*
|
48
|
+
*
|
50
49
|
* Usage:
|
51
|
-
*
|
50
|
+
*
|
52
51
|
* ```ts
|
53
52
|
* import type { ScopedElements } from "path/to/library/jsx-integration";
|
54
|
-
*
|
53
|
+
*
|
55
54
|
* declare module "my-library" {
|
56
55
|
* namespace JSX {
|
57
56
|
* interface IntrinsicElements
|
@@ -59,13 +58,18 @@ import type { SkfTooltip } from "../../components/tooltip/tooltip.component.js";
|
|
59
58
|
* }
|
60
59
|
* }
|
61
60
|
* ```
|
62
|
-
*
|
61
|
+
*
|
62
|
+
* @deprecated Runtime scoped elements result in duplicate types and can confusing for developers. It is recommended to use the `prefix` and `suffix` options to generate new types instead.
|
63
63
|
*/
|
64
|
-
export type ScopedElements<
|
64
|
+
export type ScopedElements<
|
65
|
+
Prefix extends string = "",
|
66
|
+
Suffix extends string = ""
|
67
|
+
> = {
|
65
68
|
[Key in keyof CustomElements as `${Prefix}${Key}${Suffix}`]: CustomElements[Key];
|
66
69
|
};
|
67
70
|
|
68
|
-
type BaseProps = {
|
71
|
+
type BaseProps<T extends HTMLElement> = {
|
72
|
+
|
69
73
|
/** Content added between the opening and closing tags of the element */
|
70
74
|
children?: any;
|
71
75
|
/** Used for declaratively styling one or more elements using CSS (Cascading Stylesheets) */
|
@@ -91,7 +95,7 @@ type BaseProps = {
|
|
91
95
|
/** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
|
92
96
|
part?: string;
|
93
97
|
/** Use the ref attribute with a variable to assign a DOM element to the variable once the element is rendered. */
|
94
|
-
ref?:
|
98
|
+
ref?: T | ((e: T) => void);
|
95
99
|
/** Adds a reference for a custom element slot */
|
96
100
|
slot?: string;
|
97
101
|
/** Prop for setting inline styles */
|
@@ -102,1307 +106,2407 @@ type BaseProps = {
|
|
102
106
|
title?: string;
|
103
107
|
/** Passing 'no' excludes the element content from being translated. */
|
104
108
|
translate?: "yes" | "no";
|
109
|
+
/** The popover global attribute is used to designate an element as a popover element. */
|
110
|
+
popover?: "auto" | "hint" | "manual";
|
111
|
+
/** Turns an element element into a popover control button; takes the ID of the popover element to control as its value. */
|
112
|
+
popovertarget?: "top" | "bottom" | "left" | "right" | "auto";
|
113
|
+
/** Specifies the action to be performed on a popover element being controlled by a control element. */
|
114
|
+
popovertargetaction?: "show" | "hide" | "toggle";
|
115
|
+
|
116
|
+
} ;
|
117
|
+
|
118
|
+
type BaseEvents = {
|
119
|
+
|
120
|
+
// Mouse Events
|
121
|
+
|
122
|
+
/** Triggered when the element is clicked by the user by mouse or keyboard. */
|
123
|
+
onClick?: (event: MouseEvent) => void;
|
124
|
+
/** Fired when the context menu is triggered, often by right-clicking. */
|
125
|
+
onContextMenu?: (event: MouseEvent) => void;
|
126
|
+
/** Fired when the element is double-clicked. */
|
127
|
+
onDoubleClick?: (event: MouseEvent) => void;
|
128
|
+
/** Fired repeatedly as the draggable element is being dragged. */
|
129
|
+
onDrag?: (event: DragEvent) => void;
|
130
|
+
/** Fired when the dragging of a draggable element is finished. */
|
131
|
+
onDragEnd?: (event: DragEvent) => void;
|
132
|
+
/** Fired when a dragged element or text selection enters a valid drop target. */
|
133
|
+
onDragEnter?: (event: DragEvent) => void;
|
134
|
+
/** Fired when a dragged element or text selection leaves a valid drop target. */
|
135
|
+
onDragExit?: (event: DragEvent) => void;
|
136
|
+
/** Fired when a dragged element or text selection leaves a valid drop target. */
|
137
|
+
onDragLeave?: (event: DragEvent) => void;
|
138
|
+
/** Fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds). */
|
139
|
+
onDragOver?: (event: DragEvent) => void;
|
140
|
+
/** Fired when a draggable element starts being dragged. */
|
141
|
+
onDragStart?: (event: DragEvent) => void;
|
142
|
+
/** Fired when a dragged element is dropped onto a drop target. */
|
143
|
+
onDrop?: (event: DragEvent) => void;
|
144
|
+
/** Fired when a mouse button is pressed down on the element. */
|
145
|
+
onMouseDown?: (event: MouseEvent) => void;
|
146
|
+
/** Fired when the mouse cursor enters the element. */
|
147
|
+
onMouseEnter?: (event: MouseEvent) => void;
|
148
|
+
/** Triggered when the mouse cursor leaves the element. */
|
149
|
+
onMouseLeave?: (event: MouseEvent) => void;
|
150
|
+
/** Fired at an element when a pointing device (usually a mouse) is moved while the cursor's hotspot is inside it. */
|
151
|
+
onMouseMove?: (event: MouseEvent) => void;
|
152
|
+
/** Fired at an Element when a pointing device (usually a mouse) is used to move the cursor so that it is no longer contained within the element or one of its children. */
|
153
|
+
onMouseOut?: (event: MouseEvent) => void;
|
154
|
+
/** Fired at an Element when a pointing device (such as a mouse or trackpad) is used to move the cursor onto the element or one of its child elements. */
|
155
|
+
onMouseOver?: (event: MouseEvent) => void;
|
156
|
+
/** Fired when a mouse button is released on the element. */
|
157
|
+
onMouseUp?: (event: MouseEvent) => void;
|
158
|
+
|
159
|
+
// Keyboard Events
|
160
|
+
|
161
|
+
/** Fired when a key is pressed down. */
|
162
|
+
onKeyDown?: (event: KeyboardEvent) => void;
|
163
|
+
/** Fired when a key is released.. */
|
164
|
+
onKeyUp?: (event: KeyboardEvent) => void;
|
165
|
+
/** Fired when a key is pressed down. */
|
166
|
+
onKeyPressed?: (event: KeyboardEvent) => void;
|
167
|
+
|
168
|
+
// Focus Events
|
169
|
+
|
170
|
+
/** Fired when the element receives focus, often triggered by tab navigation. */
|
171
|
+
onFocus?: (event: FocusEvent) => void;
|
172
|
+
/** Fired when the element loses focus. */
|
173
|
+
onBlur?: (event: FocusEvent) => void;
|
174
|
+
|
175
|
+
// Form Events
|
176
|
+
|
177
|
+
/** Fired when the value of an input element changes, such as with text inputs or select elements. */
|
178
|
+
onChange?: (event: Event) => void;
|
179
|
+
/** Fires when the value of an <input>, <select>, or <textarea> element has been changed. */
|
180
|
+
onInput?: (event: Event) => void;
|
181
|
+
/** Fired when a form is submitted, usually on pressing Enter in a text input. */
|
182
|
+
onSubmit?: (event: Event) => void;
|
183
|
+
/** Fired when a form is reset. */
|
184
|
+
onReset?: (event: Event) => void;
|
185
|
+
|
186
|
+
// UI Events
|
187
|
+
|
188
|
+
/** Fired when the content of an element is scrolled. */
|
189
|
+
onScroll?: (event: UIEvent) => void;
|
190
|
+
|
191
|
+
// Wheel Events
|
192
|
+
|
193
|
+
/** Fired when the mouse wheel is scrolled while the element is focused. */
|
194
|
+
onWheel?: (event: WheelEvent) => void;
|
195
|
+
|
196
|
+
// Animation Events
|
197
|
+
|
198
|
+
/** Fired when a CSS animation starts. */
|
199
|
+
onAnimationStart?: (event: AnimationEvent) => void;
|
200
|
+
/** Fired when a CSS animation completes. */
|
201
|
+
onAnimationEnd?: (event: AnimationEvent) => void;
|
202
|
+
/** Fired when a CSS animation completes one iteration. */
|
203
|
+
onAnimationIteration?: (event: AnimationEvent) => void;
|
204
|
+
|
205
|
+
// Transition Events
|
206
|
+
|
207
|
+
/** Fired when a CSS transition has completed. */
|
208
|
+
onTransitionEnd?: (event: TransitionEvent) => void;
|
209
|
+
|
210
|
+
// Media Events
|
211
|
+
|
212
|
+
/** Fired when an element (usually an image) finishes loading */
|
213
|
+
onLoad?: (event: Event) => void;
|
214
|
+
/** Fired when an error occurs during the loading of an element, like an image not being found. */
|
215
|
+
onError?: (event: Event) => void;
|
216
|
+
|
217
|
+
// Clipboard Events
|
218
|
+
|
219
|
+
/** Fires when the user initiates a copy action through the browser's user interface. */
|
220
|
+
onCopy?: (event: ClipboardEvent) => void;
|
221
|
+
/** Fired when the user has initiated a "cut" action through the browser's user interface. */
|
222
|
+
onCut?: (event: ClipboardEvent) => void;
|
223
|
+
/** Fired when the user has initiated a "paste" action through the browser's user interface. */
|
224
|
+
onPaste?: (event: ClipboardEvent) => void;
|
225
|
+
|
226
|
+
true
|
105
227
|
};
|
106
228
|
|
107
|
-
|
229
|
+
|
108
230
|
|
109
231
|
export type SkfIconProps = {
|
110
232
|
/** Sets the color of the icon */
|
111
|
-
color?: SkfIcon[
|
233
|
+
"color"?: SkfIcon['color'];
|
112
234
|
/** If defined, adds an alternate description to use for assistive devices */
|
113
|
-
label?: SkfIcon[
|
235
|
+
"label"?: SkfIcon['label'];
|
114
236
|
/** Name of the icon to display */
|
115
|
-
name?: SkfIcon[
|
237
|
+
"name"?: SkfIcon['name'];
|
116
238
|
/** Size of the icon */
|
117
|
-
size?: SkfIcon[
|
118
|
-
};
|
239
|
+
"size"?: SkfIcon['size'];
|
119
240
|
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
/**
|
126
|
-
|
241
|
+
|
242
|
+
}
|
243
|
+
|
244
|
+
|
245
|
+
export type SkfAccordionItemProps = {
|
246
|
+
/** If true, will animate the expand/accordion-item state */
|
247
|
+
"animated"?: SkfAccordionItem['animated'];
|
248
|
+
/** If true, will set the accordion-item to be expanded by default */
|
249
|
+
"expanded"?: SkfAccordionItem['expanded'];
|
250
|
+
/** Heading for the accordion-item */
|
251
|
+
"heading"?: SkfAccordionItem['heading'];
|
252
|
+
/** Defines which heading element will be rendered */
|
253
|
+
"heading-as"?: SkfAccordionItem['headingAs'];
|
127
254
|
/** Defines which heading element will be rendered */
|
128
|
-
"
|
255
|
+
"headingAs"?: SkfAccordionItem['headingAs'];
|
129
256
|
/** If true, renders the small version */
|
130
|
-
small?:
|
131
|
-
/** If true, will truncate the heading in
|
132
|
-
truncate?:
|
257
|
+
"small"?: SkfAccordionItem['small'];
|
258
|
+
/** If true, will truncate the heading in accordion-item state */
|
259
|
+
"truncate"?: SkfAccordionItem['truncate'];
|
133
260
|
|
134
261
|
/** Event emitted when toggled */
|
135
|
-
"onskf-
|
136
|
-
}
|
262
|
+
"onskf-accordion-item-toggle"?: (e: CustomEvent<CustomEvent>) => void;
|
263
|
+
}
|
264
|
+
|
137
265
|
|
138
266
|
export type SkfAccordionProps = {
|
139
267
|
/** If true, will animate the expand/collapse state */
|
140
|
-
animated?: SkfAccordion[
|
268
|
+
"animated"?: SkfAccordion['animated'];
|
269
|
+
/** Defines which heading element will be rendered */
|
270
|
+
"heading-as"?: SkfAccordion['headingAs'];
|
141
271
|
/** Defines which heading element will be rendered */
|
142
|
-
"
|
272
|
+
"headingAs"?: SkfAccordion['headingAs'];
|
143
273
|
/** If true, adds a gap between each item */
|
144
|
-
gap?: SkfAccordion[
|
274
|
+
"gap"?: SkfAccordion['gap'];
|
145
275
|
/** If true, allowes multiple accordion items to open */
|
146
|
-
multiple?: SkfAccordion[
|
276
|
+
"multiple"?: SkfAccordion['multiple'];
|
147
277
|
/** If true, renders the small version */
|
148
|
-
small?: SkfAccordion[
|
278
|
+
"small"?: SkfAccordion['small'];
|
149
279
|
/** If true, will truncate all headings in collapsed state */
|
150
|
-
truncate?: SkfAccordion[
|
151
|
-
|
280
|
+
"truncate"?: SkfAccordion['truncate'];
|
281
|
+
|
282
|
+
|
283
|
+
}
|
284
|
+
|
152
285
|
|
153
286
|
export type SkfAlertProps = {
|
154
|
-
/** Close button aria-label */
|
155
|
-
"button-label"?: SkfAlert["buttonLabel"];
|
156
287
|
/** If defined, displays leading icon */
|
157
|
-
icon?: SkfAlert[
|
288
|
+
"icon"?: SkfAlert['icon'];
|
289
|
+
/** Sets the internal language of the component */
|
290
|
+
"lang"?: SkfAlert['lang'];
|
158
291
|
/** If true, renders with an close button and sets aria-role to `status` */
|
159
|
-
persistent?: SkfAlert[
|
292
|
+
"persistent"?: SkfAlert['persistent'];
|
160
293
|
/** If defined, gives the supplied appearance */
|
161
|
-
severity?: SkfAlert[
|
294
|
+
"severity"?: SkfAlert['severity'];
|
162
295
|
|
163
296
|
/** Fires when the close button is clicked */
|
164
|
-
"onskf-alert-close"?: (e: CustomEvent<
|
165
|
-
}
|
297
|
+
"onskf-alert-close"?: (e: CustomEvent<CustomEvent>) => void;
|
298
|
+
}
|
299
|
+
|
166
300
|
|
167
301
|
export type SkfBreadcrumbItemProps = {
|
168
302
|
/** If defined, loads url on click */
|
169
|
-
href?: SkfBreadcrumbItem[
|
303
|
+
"href"?: SkfBreadcrumbItem['href'];
|
170
304
|
/** If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. */
|
171
|
-
onClick?: SkfBreadcrumbItem[
|
172
|
-
|
305
|
+
"onClick"?: SkfBreadcrumbItem['onClick'];
|
306
|
+
|
307
|
+
|
308
|
+
}
|
309
|
+
|
173
310
|
|
174
311
|
export type SkfBreadcrumbProps = {
|
175
312
|
/** aria-label for the breadcrumb control */
|
176
|
-
label?: SkfBreadcrumb[
|
177
|
-
/**
|
178
|
-
|
313
|
+
"label"?: SkfBreadcrumb['label'];
|
314
|
+
/** If true, renders a smaller version */
|
315
|
+
"small"?: SkfBreadcrumb['small'];
|
179
316
|
|
180
317
|
/** Fired when the item is clicked */
|
181
|
-
onclick?: (e: CustomEvent<never>) => void;
|
182
|
-
}
|
318
|
+
"onclick"?: (e: CustomEvent<never>) => void;
|
319
|
+
}
|
320
|
+
|
183
321
|
|
184
322
|
export type SkfLoaderProps = {
|
185
|
-
/** Defines the aria-label */
|
186
|
-
"aria-label"?: SkfLoader["ariaLabel"];
|
187
323
|
/** If true, inverts the color (to be used on colored backgrounds) */
|
188
|
-
invert?: SkfLoader[
|
324
|
+
"invert"?: SkfLoader['invert'];
|
189
325
|
/** Defines the size of the loader */
|
190
|
-
size?: SkfLoader[
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
};
|
326
|
+
"size"?: SkfLoader['size'];
|
327
|
+
|
328
|
+
|
329
|
+
}
|
330
|
+
|
196
331
|
|
197
332
|
export type SkfButtonProps = {
|
198
333
|
/** If true, gives destructive appearance. **Notice!** Only applicable if `variant` is `primary`. */
|
199
|
-
destructive?: SkfButton[
|
334
|
+
"destructive"?: SkfButton['destructive'];
|
200
335
|
/** If true, removes border */
|
201
|
-
disabled?: SkfButton[
|
336
|
+
"disabled"?: SkfButton['disabled'];
|
202
337
|
/** If provided, renders an icon before or after the text */
|
203
|
-
icon?: SkfButton[
|
204
|
-
/** If true,
|
205
|
-
|
338
|
+
"icon"?: SkfButton['icon'];
|
339
|
+
/** If true, button will take a square shape */
|
340
|
+
"icon-only"?: SkfButton['iconOnly'];
|
341
|
+
/** If true, button will take a square shape */
|
342
|
+
"iconOnly"?: SkfButton['iconOnly'];
|
206
343
|
/** Determines the positioning of the icon in relation to the text */
|
207
|
-
"icon-position"?: SkfButton[
|
344
|
+
"icon-position"?: SkfButton['iconPosition'];
|
345
|
+
/** Determines the positioning of the icon in relation to the text */
|
346
|
+
"iconPosition"?: SkfButton['iconPosition'];
|
208
347
|
/** If true, hides text & icon and shows loading indicator. **Notice!** Only applicable if `variant` is `primary`. */
|
209
|
-
loading?: SkfButton[
|
348
|
+
"loading"?: SkfButton['loading'];
|
349
|
+
/** */
|
350
|
+
"no-validate"?: SkfButton['noValidate'];
|
210
351
|
/** */
|
211
|
-
"
|
352
|
+
"noValidate"?: SkfButton['noValidate'];
|
212
353
|
/** If provided, displays an alternative size */
|
213
|
-
size?: SkfButton[
|
354
|
+
"size"?: SkfButton['size'];
|
214
355
|
/** If provided, changes the button type */
|
215
|
-
type?: SkfButton[
|
356
|
+
"type"?: SkfButton['type'];
|
216
357
|
/** If provided, alters the appearance */
|
217
|
-
variant?: SkfButton[
|
358
|
+
"variant"?: SkfButton['variant'];
|
218
359
|
|
219
360
|
/** Fires when the button is clicked */
|
220
|
-
onclick?: (e: CustomEvent<
|
221
|
-
}
|
361
|
+
"onclick"?: (e: CustomEvent<CustomEvent>) => void;
|
362
|
+
}
|
363
|
+
|
222
364
|
|
223
365
|
export type SkfCardProps = {
|
224
366
|
/** If true, removes border */
|
225
|
-
"no-border"?: SkfCard[
|
367
|
+
"no-border"?: SkfCard['noBorder'];
|
368
|
+
/** If true, removes border */
|
369
|
+
"noBorder"?: SkfCard['noBorder'];
|
226
370
|
/** If true, removes padding */
|
227
|
-
"no-padding"?: SkfCard[
|
371
|
+
"no-padding"?: SkfCard['noPadding'];
|
372
|
+
/** If true, removes padding */
|
373
|
+
"noPadding"?: SkfCard['noPadding'];
|
228
374
|
/** If true, the Card fills the parent element height */
|
229
|
-
stretch?: SkfCard[
|
230
|
-
|
375
|
+
"stretch"?: SkfCard['stretch'];
|
376
|
+
|
377
|
+
|
378
|
+
}
|
379
|
+
|
231
380
|
|
232
381
|
export type SkfCheckboxProps = {
|
233
382
|
/** If true, sets disabled state */
|
234
|
-
disabled?:
|
383
|
+
"disabled"?: unknown;
|
384
|
+
/** If true, sets disabled state */
|
385
|
+
"undefined"?: unknown;
|
235
386
|
/** If true, value is required or must be checked for the form to be submittable */
|
236
|
-
required?:
|
387
|
+
"required"?: unknown;
|
237
388
|
/** If defined, outputs helping hints in console */
|
238
|
-
debug?: SkfCheckbox[
|
389
|
+
"debug"?: SkfCheckbox['debug'];
|
239
390
|
/** If true, outputs helping hints in console */
|
240
|
-
checked?: SkfCheckbox[
|
391
|
+
"checked"?: SkfCheckbox['checked'];
|
241
392
|
/** If true, forces component to invalid state until removed */
|
242
|
-
"custom-invalid"?: SkfCheckbox[
|
393
|
+
"custom-invalid"?: SkfCheckbox['customInvalid'];
|
394
|
+
/** If true, forces component to invalid state until removed */
|
395
|
+
"customInvalid"?: SkfCheckbox['customInvalid'];
|
243
396
|
/** If true and the checkbox is unchecked, the checkbox will appear indeterminate */
|
244
|
-
indeterminate?: SkfCheckbox[
|
397
|
+
"indeterminate"?: SkfCheckbox['indeterminate'];
|
245
398
|
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
246
|
-
label?: SkfCheckbox[
|
399
|
+
"label"?: SkfCheckbox['label'];
|
400
|
+
/** Sets the internal language of the component */
|
401
|
+
"lang"?: SkfCheckbox['lang'];
|
247
402
|
/** If defined, adds name to the input-element */
|
248
|
-
name?: SkfCheckbox[
|
249
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
250
|
-
"required-label"?: SkfCheckbox["requiredLabel"];
|
403
|
+
"name"?: SkfCheckbox['name'];
|
251
404
|
/** If defined, styles checkbox using provided severity */
|
252
|
-
severity?: SkfCheckbox[
|
405
|
+
"severity"?: SkfCheckbox['severity'];
|
406
|
+
/** If true, displays valid state after interaction */
|
407
|
+
"show-valid"?: SkfCheckbox['showValid'];
|
253
408
|
/** If true, displays valid state after interaction */
|
254
|
-
"
|
409
|
+
"showValid"?: SkfCheckbox['showValid'];
|
255
410
|
/** Size of the checkbox */
|
256
|
-
size?: SkfCheckbox[
|
411
|
+
"size"?: SkfCheckbox['size'];
|
257
412
|
/** The current value of the input field */
|
258
|
-
value?: SkfCheckbox[
|
413
|
+
"value"?: SkfCheckbox['value'];
|
259
414
|
|
260
|
-
/**
|
261
|
-
onchange?: (e: CustomEvent<
|
262
|
-
}
|
415
|
+
/** When the value of the input changes */
|
416
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
417
|
+
}
|
263
418
|
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
date?: SkfDatePicker["date"];
|
419
|
+
|
420
|
+
export type SkfDatepickerCalendarProps = {
|
421
|
+
/** */
|
422
|
+
"eventid"?: SkfDatepickerCalendar['eventid'];
|
269
423
|
/** */
|
270
|
-
|
424
|
+
"firstDayOfWeek"?: SkfDatepickerCalendar['firstDayOfWeek'];
|
271
425
|
/** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
|
272
|
-
"invalid-dates"?:
|
273
|
-
/**
|
274
|
-
|
426
|
+
"invalid-dates"?: SkfDatepickerCalendar['invalidDates'];
|
427
|
+
/** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
|
428
|
+
"invalidDates"?: SkfDatepickerCalendar['invalidDates'];
|
429
|
+
/** Sets the internal language of the component */
|
430
|
+
"lang"?: SkfDatepickerCalendar['lang'];
|
431
|
+
/** */
|
432
|
+
"locale"?: SkfDatepickerCalendar['locale'];
|
433
|
+
/** */
|
434
|
+
"range"?: SkfDatepickerCalendar['range'];
|
275
435
|
/** Earliest selectable date. (yyyy-mm-dd format) */
|
276
|
-
"selectable-from"?:
|
436
|
+
"selectable-from"?: SkfDatepickerCalendar['selectableFrom'];
|
437
|
+
/** Earliest selectable date. (yyyy-mm-dd format) */
|
438
|
+
"selectableFrom"?: SkfDatepickerCalendar['selectableFrom'];
|
439
|
+
/** Latest selectable date. (yyyy-mm-dd format) */
|
440
|
+
"selectable-to"?: SkfDatepickerCalendar['selectableTo'];
|
277
441
|
/** Latest selectable date. (yyyy-mm-dd format) */
|
278
|
-
"
|
442
|
+
"selectableTo"?: SkfDatepickerCalendar['selectableTo'];
|
279
443
|
/** */
|
280
|
-
|
444
|
+
"selected-date"?: SkfDatepickerCalendar['selectedDate'];
|
281
445
|
/** */
|
282
|
-
|
283
|
-
/**
|
284
|
-
"
|
285
|
-
/**
|
286
|
-
"
|
287
|
-
|
446
|
+
"selectedDate"?: SkfDatepickerCalendar['selectedDate'];
|
447
|
+
/** */
|
448
|
+
"selectedDateRange"?: SkfDatepickerCalendar['selectedDateRange'];
|
449
|
+
/** */
|
450
|
+
"_listenToKeyboard"?: SkfDatepickerCalendar['_listenToKeyboard'];
|
451
|
+
/** */
|
452
|
+
"_handleKeyDown"?: SkfDatepickerCalendar['_handleKeyDown'];
|
453
|
+
/** */
|
454
|
+
"dateSelectable"?: SkfDatepickerCalendar['dateSelectable'];
|
455
|
+
|
456
|
+
|
457
|
+
}
|
458
|
+
|
459
|
+
|
460
|
+
export type SkfDatepickerProps = {
|
461
|
+
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
462
|
+
"custom-invalid"?: SkfDatepicker['customInvalid'];
|
463
|
+
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
464
|
+
"customInvalid"?: SkfDatepicker['customInvalid'];
|
465
|
+
/** */
|
466
|
+
"id"?: SkfDatepicker['id'];
|
467
|
+
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
468
|
+
"label"?: SkfDatepicker['label'];
|
469
|
+
/** Sets the internal language of the component */
|
470
|
+
"lang"?: SkfDatepicker['lang'];
|
471
|
+
/** If true, hides the label visually */
|
472
|
+
"hide-label"?: SkfDatepicker['hideLabel'];
|
473
|
+
/** If true, hides the label visually */
|
474
|
+
"hideLabel"?: SkfDatepicker['hideLabel'];
|
475
|
+
/** If defined, displays informational text below the field */
|
476
|
+
"hint"?: SkfDatepicker['hint'];
|
477
|
+
/** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
|
478
|
+
"invalid-dates"?: SkfDatepicker['invalidDates'];
|
479
|
+
/** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
|
480
|
+
"invalidDates"?: SkfDatepicker['invalidDates'];
|
481
|
+
/** If defined, adds name to the input-element */
|
482
|
+
"name"?: SkfDatepicker['name'];
|
483
|
+
/** */
|
484
|
+
"placeholder"?: SkfDatepicker['placeholder'];
|
485
|
+
/** */
|
486
|
+
"range"?: SkfDatepicker['range'];
|
487
|
+
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
488
|
+
"readonly"?: SkfDatepicker['readonly'];
|
489
|
+
/** Earliest selectable date. (yyyy-mm-dd format) */
|
490
|
+
"selectable-from"?: SkfDatepicker['selectableFrom'];
|
491
|
+
/** Earliest selectable date. (yyyy-mm-dd format) */
|
492
|
+
"selectableFrom"?: SkfDatepicker['selectableFrom'];
|
493
|
+
/** Latest selectable date. (yyyy-mm-dd format) */
|
494
|
+
"selectable-to"?: SkfDatepicker['selectableTo'];
|
495
|
+
/** Latest selectable date. (yyyy-mm-dd format) */
|
496
|
+
"selectableTo"?: SkfDatepicker['selectableTo'];
|
497
|
+
/** If defined, displays provided severity state */
|
498
|
+
"severity"?: SkfDatepicker['severity'];
|
499
|
+
/** Size of the input */
|
500
|
+
"size"?: SkfDatepicker['size'];
|
501
|
+
/** Sets validation start */
|
502
|
+
"validate-on"?: SkfDatepicker['validateOn'];
|
503
|
+
/** Sets validation start */
|
504
|
+
"validateOn"?: SkfDatepicker['validateOn'];
|
505
|
+
/** The current value of the input field */
|
506
|
+
"value"?: SkfDatepicker['value'];
|
507
|
+
/** */
|
508
|
+
"focusTimeoutId"?: SkfDatepicker['focusTimeoutId'];
|
509
|
+
|
510
|
+
|
511
|
+
}
|
512
|
+
|
288
513
|
|
289
514
|
export type SkfHeadingProps = {
|
290
515
|
/** Controls which heading element will be rendered. Should not be used to affect appearance */
|
291
|
-
as?: SkfHeading[
|
516
|
+
"as"?: SkfHeading['as'];
|
292
517
|
/** If defined, changes the appearance of the heading */
|
293
|
-
"styled-as"?: SkfHeading[
|
294
|
-
|
518
|
+
"styled-as"?: SkfHeading['styledAs'];
|
519
|
+
/** If defined, changes the appearance of the heading */
|
520
|
+
"styledAs"?: SkfHeading['styledAs'];
|
521
|
+
|
522
|
+
|
523
|
+
}
|
524
|
+
|
295
525
|
|
296
526
|
export type SkfDialogProps = {
|
297
|
-
/** If defined, sets the aria-label for the close button */
|
298
|
-
"close-button-aria-label"?: SkfDialog["closeButtonAriaLabel"];
|
299
527
|
/** Title for the modal/dialog */
|
300
|
-
heading?: SkfDialog[
|
528
|
+
"heading"?: SkfDialog['heading'];
|
301
529
|
/** If true, makes the dialog stretch edge to edge on screen */
|
302
|
-
fullscreen?: SkfDialog[
|
530
|
+
"fullscreen"?: SkfDialog['fullscreen'];
|
531
|
+
/** Sets the internal language of the component */
|
532
|
+
"lang"?: SkfDialog['lang'];
|
533
|
+
/** If true, removes the close button */
|
534
|
+
"no-close-button"?: SkfDialog['noCloseButton'];
|
303
535
|
/** If true, removes the close button */
|
304
|
-
"
|
536
|
+
"noCloseButton"?: SkfDialog['noCloseButton'];
|
537
|
+
/** If defined, removes the inner padding */
|
538
|
+
"no-padding"?: SkfDialog['noPadding'];
|
305
539
|
/** If defined, removes the inner padding */
|
306
|
-
"
|
540
|
+
"noPadding"?: SkfDialog['noPadding'];
|
307
541
|
/** If true, indicates that the dialog is active and is available for interaction */
|
308
|
-
open?: SkfDialog[
|
542
|
+
"open"?: SkfDialog['open'];
|
309
543
|
|
310
544
|
/** Fires when the dialog is opened (after transitioned in) */
|
311
|
-
"onskf-dialog-opened"?: (e: CustomEvent<
|
312
|
-
/** Fires when the dialog is
|
313
|
-
"onskf-dialog-closing"?: (e: CustomEvent<
|
545
|
+
"onskf-dialog-opened"?: (e: CustomEvent<CustomEvent>) => void;
|
546
|
+
/** Fires when the dialog is closing (before transitioned out) */
|
547
|
+
"onskf-dialog-closing"?: (e: CustomEvent<CustomEvent>) => void;
|
314
548
|
/** Fires when the dialog is closed (after transitioned out) */
|
315
|
-
"onskf-dialog-closed"?: (e: CustomEvent<
|
316
|
-
}
|
549
|
+
"onskf-dialog-closed"?: (e: CustomEvent<CustomEvent>) => void;
|
550
|
+
}
|
551
|
+
|
317
552
|
|
318
553
|
export type SkfDividerProps = {
|
319
554
|
/** Defines the Divider color */
|
320
|
-
color?: SkfDivider[
|
555
|
+
"color"?: SkfDivider['color'];
|
321
556
|
/** If true, renders a div for presentational purpose instead of the semantic hr-element */
|
322
|
-
decorative?: SkfDivider[
|
557
|
+
"decorative"?: SkfDivider['decorative'];
|
323
558
|
/** If true, renders the divider vertically */
|
324
|
-
vertical?: SkfDivider[
|
325
|
-
|
559
|
+
"vertical"?: SkfDivider['vertical'];
|
560
|
+
|
561
|
+
|
562
|
+
}
|
563
|
+
|
326
564
|
|
327
565
|
export type SkfDrawerProps = {
|
328
|
-
/** If defined, sets the aria-label for the close button */
|
329
|
-
"close-button-aria-label"?: SkfDrawer["closeButtonAriaLabel"];
|
330
566
|
/** Heading for the Drawer */
|
331
|
-
heading?: SkfDrawer[
|
567
|
+
"heading"?: SkfDrawer['heading'];
|
568
|
+
/** Sets the internal language of the component */
|
569
|
+
"lang"?: SkfDrawer['lang'];
|
332
570
|
/** Sets the max-width */
|
333
|
-
size?: SkfDrawer[
|
571
|
+
"size"?: SkfDrawer['size'];
|
334
572
|
/** If true, Drawer is open */
|
335
|
-
open?: SkfDrawer[
|
573
|
+
"open"?: SkfDrawer['open'];
|
336
574
|
/** Placement of the Drawer */
|
337
|
-
placement?: SkfDrawer[
|
338
|
-
|
339
|
-
_clickstartInDialog?: SkfDrawer["_clickstartInDialog"];
|
340
|
-
/** */
|
341
|
-
_handleMouseDown?: SkfDrawer["_handleMouseDown"];
|
342
|
-
/** */
|
343
|
-
_handleMouseUp?: SkfDrawer["_handleMouseUp"];
|
575
|
+
"placement"?: SkfDrawer['placement'];
|
576
|
+
|
344
577
|
/** Fires when the drawer is opened (after transitioned in) */
|
345
|
-
"onskf-drawer-opened"?: (e: CustomEvent<
|
346
|
-
/** Fires when the drawer is
|
347
|
-
"onskf-drawer-closing"?: (e: CustomEvent<
|
578
|
+
"onskf-drawer-opened"?: (e: CustomEvent<CustomEvent>) => void;
|
579
|
+
/** Fires when the drawer is closing (before transitioned out) */
|
580
|
+
"onskf-drawer-closing"?: (e: CustomEvent<CustomEvent>) => void;
|
348
581
|
/** Fires when the drawer is closed (after transitioned out) */
|
349
|
-
"onskf-drawer-closed"?: (e: CustomEvent<
|
350
|
-
}
|
582
|
+
"onskf-drawer-closed"?: (e: CustomEvent<CustomEvent>) => void;
|
583
|
+
}
|
584
|
+
|
351
585
|
|
352
586
|
export type SkfLogoProps = {
|
353
587
|
/** Defines the title of the logo */
|
354
|
-
title?: SkfLogo[
|
588
|
+
"title"?: SkfLogo['title'];
|
355
589
|
/** Defines the color of the logo */
|
356
|
-
color?: SkfLogo[
|
357
|
-
};
|
590
|
+
"color"?: SkfLogo['color'];
|
358
591
|
|
359
|
-
|
592
|
+
|
593
|
+
}
|
594
|
+
|
595
|
+
|
596
|
+
export type SkfLinkProps = {
|
597
|
+
/** Defines the semantic element to render */
|
598
|
+
"as"?: SkfLink['as'];
|
599
|
+
/** Defines the text-color */
|
600
|
+
"color"?: SkfLink['color'];
|
601
|
+
/** If true, disables the link */
|
602
|
+
"disabled"?: SkfLink['disabled'];
|
603
|
+
/** If defined, downloads the url */
|
604
|
+
"download"?: SkfLink['download'];
|
605
|
+
/** If defined, loads url on click */
|
606
|
+
"href"?: SkfLink['href'];
|
607
|
+
/** If defined, renders an icon before or after the text */
|
608
|
+
"icon"?: SkfLink['icon'];
|
609
|
+
/** If true, the icon is placed to the right in relation to the text */
|
610
|
+
"icon-right"?: SkfLink['iconRight'];
|
611
|
+
/** If true, the icon is placed to the right in relation to the text */
|
612
|
+
"iconRight"?: SkfLink['iconRight'];
|
613
|
+
/** If defined, describes the relationship between a linked resource and the current document */
|
614
|
+
"rel"?: SkfLink['rel'];
|
615
|
+
/** If defined, used on conjunction with onClick property. **Notice!** Only applicable to as=button. */
|
616
|
+
"route"?: SkfLink['route'];
|
617
|
+
/** If true, fills the parents horizontal axis */
|
618
|
+
"stretch"?: SkfLink['stretch'];
|
619
|
+
/** If defined, specifies where to open the linked document */
|
620
|
+
"target"?: SkfLink['target'];
|
621
|
+
|
622
|
+
/** Fired when the link is clicked */
|
623
|
+
"onskf-link-click"?: (e: CustomEvent<CustomEvent>) => void;
|
624
|
+
}
|
625
|
+
|
626
|
+
|
627
|
+
export type SkfNavItemProps = {
|
360
628
|
/** */
|
361
|
-
|
362
|
-
|
629
|
+
"href"?: SkfNavItem['href'];
|
630
|
+
/** */
|
631
|
+
"icon"?: SkfNavItem['icon'];
|
632
|
+
/** */
|
633
|
+
"vertical"?: SkfNavItem['vertical'];
|
634
|
+
|
635
|
+
|
636
|
+
}
|
637
|
+
|
638
|
+
|
639
|
+
export type SkfNavProps = {
|
640
|
+
/** Sets the internal language of the component */
|
641
|
+
"lang"?: SkfNav['lang'];
|
642
|
+
/** If true, the navigation will be displayed vertically */
|
643
|
+
"vertical"?: SkfNav['vertical'];
|
644
|
+
|
645
|
+
|
646
|
+
}
|
647
|
+
|
363
648
|
|
364
649
|
export type SkfHeaderProps = {
|
365
650
|
/** If true, sets header to display in compact mode only (hanburger menu and drawer) */
|
366
|
-
compact?: SkfHeader[
|
367
|
-
/**
|
368
|
-
"
|
651
|
+
"compact"?: SkfHeader['compact'];
|
652
|
+
/** Sets the internal language of the component */
|
653
|
+
"lang"?: SkfHeader['lang'];
|
654
|
+
/** If defined, sets the app or site's name */
|
655
|
+
"site-name"?: SkfHeader['siteName'];
|
369
656
|
/** If defined, sets the app or site's name */
|
370
|
-
"
|
657
|
+
"siteName"?: SkfHeader['siteName'];
|
371
658
|
/** If defined, sets the site's base-url for the "logo-link" */
|
372
|
-
"site-url"?: SkfHeader[
|
373
|
-
|
659
|
+
"site-url"?: SkfHeader['siteUrl'];
|
660
|
+
/** If defined, sets the site's base-url for the "logo-link" */
|
661
|
+
"siteUrl"?: SkfHeader['siteUrl'];
|
662
|
+
|
663
|
+
|
664
|
+
}
|
665
|
+
|
374
666
|
|
375
667
|
export type SkfInputProps = {
|
376
668
|
/** If true, sets disabled state */
|
377
|
-
disabled?:
|
669
|
+
"disabled"?: unknown;
|
670
|
+
/** If true, sets disabled state */
|
671
|
+
"undefined"?: unknown;
|
378
672
|
/** If true, value is required or must be checked for the form to be submittable */
|
379
|
-
required?:
|
380
|
-
/**
|
381
|
-
[
|
382
|
-
autocomplete?: SkfInput[
|
383
|
-
/**
|
384
|
-
"
|
385
|
-
/** Custom aria-label for the visibility button. **Notice!** Only applicable to type=password. */
|
386
|
-
"button-aria-label-hide"?: SkfInput["buttonAriaLabelHide"];
|
387
|
-
/** Custom aria-label for the visibility button **Notice!** Only applicable to type=password. */
|
388
|
-
"button-aria-label-show"?: SkfInput["buttonAriaLabelShow"];
|
673
|
+
"required"?: unknown;
|
674
|
+
/** Indicates whether the value of the control can be automatically completed by the browser. See
|
675
|
+
[MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/autocomplete) for details. */
|
676
|
+
"autocomplete"?: SkfInput['autocomplete'];
|
677
|
+
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
678
|
+
"custom-invalid"?: SkfInput['customInvalid'];
|
389
679
|
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
390
|
-
"
|
680
|
+
"customInvalid"?: SkfInput['customInvalid'];
|
391
681
|
/** If true, outputs helping hints in console */
|
392
|
-
debug?: SkfInput[
|
682
|
+
"debug"?: SkfInput['debug'];
|
393
683
|
/** If true, hides the label visually */
|
394
|
-
"hide-label"?: SkfInput[
|
684
|
+
"hide-label"?: SkfInput['hideLabel'];
|
685
|
+
/** If true, hides the label visually */
|
686
|
+
"hideLabel"?: SkfInput['hideLabel'];
|
395
687
|
/** If defined, displays informational text below the field */
|
396
|
-
hint?: SkfInput[
|
397
|
-
/**
|
398
|
-
|
688
|
+
"hint"?: SkfInput['hint'];
|
689
|
+
/** Provides a hint about the type of data that might be entered by the user while editing the element or its contents. See
|
690
|
+
[MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inputMode) for details. */
|
691
|
+
"inputmode"?: SkfInput['inputmode'];
|
399
692
|
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
400
|
-
label?: SkfInput[
|
693
|
+
"label"?: SkfInput['label'];
|
694
|
+
/** Sets the internal language of the component */
|
695
|
+
"lang"?: SkfInput['lang'];
|
401
696
|
/** If defined, displays a prefix/adornment before the input-element */
|
402
|
-
leading?: SkfInput[
|
697
|
+
"leading"?: SkfInput['leading'];
|
403
698
|
/** If defined, sets the maximum value to accept for this input */
|
404
|
-
max?: SkfInput[
|
699
|
+
"max"?: SkfInput['max'];
|
700
|
+
/** If defined, sets the maximum character length to accept for this input */
|
701
|
+
"maxlength"?: SkfInput['maxLength'];
|
405
702
|
/** If defined, sets the maximum character length to accept for this input */
|
406
|
-
|
703
|
+
"maxLength"?: SkfInput['maxLength'];
|
407
704
|
/** If defined, sets the minimum value to accept for this input */
|
408
|
-
min?: SkfInput[
|
705
|
+
"min"?: SkfInput['min'];
|
409
706
|
/** If defined, sets the minimum character length to accept for this input */
|
410
|
-
minlength?: SkfInput[
|
707
|
+
"minlength"?: SkfInput['minLength'];
|
708
|
+
/** If defined, sets the minimum character length to accept for this input */
|
709
|
+
"minLength"?: SkfInput['minLength'];
|
411
710
|
/** If defined, adds name to the input-element */
|
412
|
-
name?: SkfInput[
|
711
|
+
"name"?: SkfInput['name'];
|
413
712
|
/** If defined, adds name to the input-element */
|
414
|
-
pattern?: SkfInput[
|
713
|
+
"pattern"?: SkfInput['pattern'];
|
415
714
|
/** If defined, displays placeholder text */
|
416
|
-
placeholder?: SkfInput[
|
715
|
+
"placeholder"?: SkfInput['placeholder'];
|
417
716
|
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
418
|
-
readonly?: SkfInput[
|
419
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
420
|
-
"required-label"?: SkfInput["requiredLabel"];
|
717
|
+
"readonly"?: SkfInput['readonly'];
|
421
718
|
/** If defined, displays provided severity state */
|
422
|
-
severity?: SkfInput[
|
719
|
+
"severity"?: SkfInput['severity'];
|
720
|
+
/** If true, displays valid state after interaction */
|
721
|
+
"show-valid"?: SkfInput['showValid'];
|
423
722
|
/** If true, displays valid state after interaction */
|
424
|
-
"
|
723
|
+
"showValid"?: SkfInput['showValid'];
|
425
724
|
/** Size of the input */
|
426
|
-
size?: SkfInput[
|
725
|
+
"size"?: SkfInput['size'];
|
427
726
|
/** If defined, displays a suffix/adornment after the input-element */
|
428
|
-
trailing?: SkfInput[
|
429
|
-
/** Type of input
|
430
|
-
type?: SkfInput[
|
727
|
+
"trailing"?: SkfInput['trailing'];
|
728
|
+
/** Type of input */
|
729
|
+
"type"?: SkfInput['type'];
|
730
|
+
/** Sets validation start */
|
731
|
+
"validate-on"?: SkfInput['validateOn'];
|
431
732
|
/** Sets validation start */
|
432
|
-
"
|
733
|
+
"validateOn"?: SkfInput['validateOn'];
|
433
734
|
/** The current value of the input field */
|
434
|
-
value?: SkfInput[
|
735
|
+
"value"?: SkfInput['value'];
|
435
736
|
|
436
737
|
/** Fires when the value of the input changes */
|
437
|
-
onchange?: (e: CustomEvent<
|
738
|
+
"onchange"?: (e: CustomEvent<CustomEvent>) => void;
|
438
739
|
/** Fires when the input is invalid */
|
439
|
-
oninvalid?: (e: CustomEvent<
|
440
|
-
}
|
740
|
+
"oninvalid"?: (e: CustomEvent<CustomEvent>) => void;
|
741
|
+
}
|
441
742
|
|
442
|
-
|
743
|
+
|
744
|
+
export type SkfMenuItemProps = {
|
443
745
|
/** Defines the semantic element to render */
|
444
|
-
as?:
|
746
|
+
"as"?: SkfMenuItem['as'];
|
445
747
|
/** Defines the text-color */
|
446
|
-
color?:
|
748
|
+
"color"?: SkfMenuItem['color'];
|
447
749
|
/** If true, disables the link */
|
448
|
-
disabled?:
|
750
|
+
"disabled"?: SkfMenuItem['disabled'];
|
449
751
|
/** If defined, downloads the url */
|
450
|
-
download?:
|
752
|
+
"download"?: SkfMenuItem['download'];
|
451
753
|
/** If defined, loads url on click */
|
452
|
-
href?:
|
754
|
+
"href"?: SkfMenuItem['href'];
|
453
755
|
/** If defined, renders an icon before or after the text */
|
454
|
-
icon?:
|
455
|
-
/**
|
456
|
-
"icon-
|
756
|
+
"icon"?: SkfMenuItem['icon'];
|
757
|
+
/** If true, the icon is placed to the right in relation to the text */
|
758
|
+
"icon-right"?: SkfMenuItem['iconRight'];
|
759
|
+
/** If true, the icon is placed to the right in relation to the text */
|
760
|
+
"iconRight"?: SkfMenuItem['iconRight'];
|
457
761
|
/** If defined, describes the relationship between a linked resource and the current document */
|
458
|
-
rel?:
|
459
|
-
/** If defined, used on conjunction with onClick property
|
460
|
-
route?:
|
762
|
+
"rel"?: SkfMenuItem['rel'];
|
763
|
+
/** If defined, used on conjunction with onClick property. **Notice!** Only applicable to as=button. */
|
764
|
+
"route"?: SkfMenuItem['route'];
|
461
765
|
/** If true, fills the parents horizontal axis */
|
462
|
-
stretch?:
|
766
|
+
"stretch"?: SkfMenuItem['stretch'];
|
463
767
|
/** If defined, specifies where to open the linked document */
|
464
|
-
target?:
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
768
|
+
"target"?: SkfMenuItem['target'];
|
769
|
+
|
770
|
+
/** Fired when the link is clicked */
|
771
|
+
"onskf-link-click"?: (e: CustomEvent<CustomEvent>) => void;
|
772
|
+
}
|
773
|
+
|
470
774
|
|
471
775
|
export type SkfMenuProps = {
|
472
776
|
/** The placement of the menu */
|
473
|
-
placement?:
|
777
|
+
"placement"?: unknown;
|
778
|
+
/** The placement of the menu */
|
779
|
+
"undefined"?: unknown;
|
474
780
|
/** The id of the element the menu will be anchored to */
|
475
|
-
anchor?:
|
476
|
-
/**
|
477
|
-
|
478
|
-
/**
|
479
|
-
|
781
|
+
"anchor"?: unknown;
|
782
|
+
/** Method that opens the menu */
|
783
|
+
"open()"?: SkfMenu['open()'];
|
784
|
+
/** Method that closes the menu */
|
785
|
+
"close()"?: SkfMenu['close()'];
|
786
|
+
|
480
787
|
/** Fired when the menu is opened */
|
481
|
-
"onskf-opened"?: (e: CustomEvent<
|
788
|
+
"onskf-opened"?: (e: CustomEvent<CustomEvent>) => void;
|
482
789
|
/** Fired when the menu is closed */
|
483
|
-
"onskf-closed"?: (e: CustomEvent<
|
484
|
-
}
|
790
|
+
"onskf-closed"?: (e: CustomEvent<CustomEvent>) => void;
|
791
|
+
}
|
485
792
|
|
486
|
-
export type SkfMenuItemProps = {
|
487
|
-
/** Defines the semantic element to render */
|
488
|
-
as?: SkfMenuItem["as"];
|
489
|
-
/** Defines the text-color */
|
490
|
-
color?: SkfMenuItem["color"];
|
491
|
-
/** If true, disables the link */
|
492
|
-
disabled?: SkfMenuItem["disabled"];
|
493
|
-
/** If defined, downloads the url */
|
494
|
-
download?: SkfMenuItem["download"];
|
495
|
-
/** If defined, loads url on click */
|
496
|
-
href?: SkfMenuItem["href"];
|
497
|
-
/** If defined, renders an icon before or after the text */
|
498
|
-
icon?: SkfMenuItem["icon"];
|
499
|
-
/** Defines the position of the icon in relation to the text */
|
500
|
-
"icon-placement"?: SkfMenuItem["iconPlacement"];
|
501
|
-
/** If defined, describes the relationship between a linked resource and the current document */
|
502
|
-
rel?: SkfMenuItem["rel"];
|
503
|
-
/** If defined, used on conjunction with onClick property, second argument */
|
504
|
-
route?: SkfMenuItem["route"];
|
505
|
-
/** If true, fills the parents horizontal axis */
|
506
|
-
stretch?: SkfMenuItem["stretch"];
|
507
|
-
/** If defined, specifies where to open the linked document */
|
508
|
-
target?: SkfMenuItem["target"];
|
509
|
-
/** Defines the type of button */
|
510
|
-
type?: SkfMenuItem["type"];
|
511
|
-
/** If provided, custom function triggered by click where the second return parameter enables custom routing. */
|
512
|
-
onClick?: SkfMenuItem["onClick"];
|
513
|
-
/** Fired when something happens */
|
514
|
-
"onmy-tag-my-event"?: (e: CustomEvent<CustomEvent>) => void;
|
515
|
-
/** Fired when the component is clicked */
|
516
|
-
onclick?: (e: CustomEvent<never>) => void;
|
517
|
-
/** Fired when the mouse is over the component */
|
518
|
-
onmouseover?: (e: CustomEvent<never>) => void;
|
519
|
-
/** Fired when the mouse is out of the component */
|
520
|
-
onmouseout?: (e: CustomEvent<never>) => void;
|
521
|
-
/** Fired when the component is focused */
|
522
|
-
onfocus?: (e: CustomEvent<never>) => void;
|
523
|
-
/** Fired when the component is blurred */
|
524
|
-
onblur?: (e: CustomEvent<never>) => void;
|
525
|
-
/** Fired when the component's value changes */
|
526
|
-
onchange?: (e: CustomEvent<never>) => void;
|
527
|
-
};
|
528
|
-
|
529
|
-
export type SkfNavItemProps = {
|
530
|
-
/** */
|
531
|
-
href?: SkfNavItem["href"];
|
532
|
-
/** */
|
533
|
-
icon?: SkfNavItem["icon"];
|
534
|
-
};
|
535
793
|
|
536
794
|
export type SkfPopoverProps = {
|
537
|
-
/** The placement of the
|
538
|
-
placement?:
|
539
|
-
/** The
|
540
|
-
|
795
|
+
/** The placement of the popover */
|
796
|
+
"placement"?: unknown;
|
797
|
+
/** The placement of the popover */
|
798
|
+
"undefined"?: unknown;
|
799
|
+
/** The id of the element the popover will be anchored to */
|
800
|
+
"anchor"?: unknown;
|
541
801
|
/** If defined, sets a custom offset for the popover */
|
542
|
-
offset?: SkfPopover[
|
802
|
+
"offset"?: SkfPopover['offset'];
|
543
803
|
/** If true, hides the arrow */
|
544
|
-
hideArrow?: SkfPopover[
|
545
|
-
/**
|
546
|
-
|
547
|
-
/**
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
804
|
+
"hideArrow"?: SkfPopover['hideArrow'];
|
805
|
+
/** Method that opens the popover */
|
806
|
+
"open()"?: SkfPopover['open()'];
|
807
|
+
/** Method that closes the popover */
|
808
|
+
"close()"?: SkfPopover['close()'];
|
809
|
+
|
810
|
+
/** Fired when the popover is opened */
|
811
|
+
"onskf-opened"?: (e: CustomEvent<CustomEvent>) => void;
|
812
|
+
/** Fired when the popover is closed */
|
813
|
+
"onskf-closed"?: (e: CustomEvent<CustomEvent>) => void;
|
814
|
+
}
|
815
|
+
|
556
816
|
|
557
817
|
export type SkfProgressProps = {
|
558
818
|
/** If true, the progress-bar's fill value is animated */
|
559
|
-
animated?: SkfProgress[
|
819
|
+
"animated"?: SkfProgress['animated'];
|
560
820
|
/** Describes how much work the task indicated by the progress element requires */
|
561
|
-
max?: SkfProgress[
|
821
|
+
"max"?: SkfProgress['max'];
|
562
822
|
/** Specifies how much of the task that has been completed */
|
563
|
-
value?: SkfProgress[
|
564
|
-
|
823
|
+
"value"?: SkfProgress['value'];
|
824
|
+
|
825
|
+
|
826
|
+
}
|
827
|
+
|
565
828
|
|
566
829
|
export type SkfRadioProps = {
|
567
830
|
/** If true, sets disabled state */
|
568
|
-
disabled?:
|
831
|
+
"disabled"?: unknown;
|
832
|
+
/** If true, sets disabled state */
|
833
|
+
"undefined"?: unknown;
|
569
834
|
/** If true, value is required or must be checked for the form to be submittable */
|
570
|
-
required?:
|
835
|
+
"required"?: unknown;
|
571
836
|
/** If true, outputs helping hints in console */
|
572
|
-
debug?: SkfRadio[
|
837
|
+
"debug"?: SkfRadio['debug'];
|
573
838
|
/** If true, outputs helping hints in console */
|
574
|
-
checked?: SkfRadio[
|
839
|
+
"checked"?: SkfRadio['checked'];
|
840
|
+
/** If true, forces component to invalid state until removed */
|
841
|
+
"custom-invalid"?: SkfRadio['customInvalid'];
|
575
842
|
/** If true, forces component to invalid state until removed */
|
576
|
-
"
|
843
|
+
"customInvalid"?: SkfRadio['customInvalid'];
|
577
844
|
/** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
|
578
|
-
label?: SkfRadio[
|
845
|
+
"label"?: SkfRadio['label'];
|
846
|
+
/** Sets the internal language of the component */
|
847
|
+
"lang"?: SkfRadio['lang'];
|
579
848
|
/** If defined, adds name to the input-element */
|
580
|
-
name?: SkfRadio[
|
581
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
582
|
-
"required-label"?: SkfRadio["requiredLabel"];
|
849
|
+
"name"?: SkfRadio['name'];
|
583
850
|
/** Size of the Radio */
|
584
|
-
size?: SkfRadio[
|
851
|
+
"size"?: SkfRadio['size'];
|
585
852
|
/** If defined, displays provided severity state */
|
586
|
-
severity?: SkfRadio[
|
853
|
+
"severity"?: SkfRadio['severity'];
|
854
|
+
/** If true, displays valid state after interaction */
|
855
|
+
"show-valid"?: SkfRadio['showValid'];
|
587
856
|
/** If true, displays valid state after interaction */
|
588
|
-
"
|
857
|
+
"showValid"?: SkfRadio['showValid'];
|
589
858
|
/** The current value of the input field */
|
590
|
-
value?: SkfRadio[
|
859
|
+
"value"?: SkfRadio['value'];
|
860
|
+
|
861
|
+
/** When the value of the input changes */
|
862
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
863
|
+
}
|
591
864
|
|
592
|
-
/** {object} - When the value of the input changes */
|
593
|
-
onchange?: (e: CustomEvent<never>) => void;
|
594
|
-
};
|
595
865
|
|
596
866
|
export type SkfSegmentedButtonItemProps = {
|
597
867
|
/** If true, items is marked as disabled */
|
598
|
-
disabled?: SkfSegmentedButtonItem[
|
868
|
+
"disabled"?: SkfSegmentedButtonItem['disabled'];
|
869
|
+
/** If true, items is marked as selected */
|
870
|
+
"selected"?: SkfSegmentedButtonItem['selected'];
|
599
871
|
/** Sets the item value */
|
600
|
-
value?: SkfSegmentedButtonItem[
|
872
|
+
"value"?: SkfSegmentedButtonItem['value'];
|
873
|
+
|
874
|
+
/** Fired when selected */
|
875
|
+
"onskf-segmented-button-item-select"?: (e: CustomEvent<CustomEvent>) => void;
|
876
|
+
}
|
601
877
|
|
602
|
-
/** Fired when something happens */
|
603
|
-
"onmy-tag-my-event"?: (e: CustomEvent<CustomEvent>) => void;
|
604
|
-
};
|
605
878
|
|
606
879
|
export type SkfSegmentedButtonProps = {
|
607
|
-
/** Sets the default selected control */
|
608
|
-
"default-selected"?: SkfSegmentedButton["defaultSelected"];
|
609
880
|
/** If true, allowes multiple items to be selected */
|
610
|
-
multiple?: SkfSegmentedButton[
|
611
|
-
};
|
881
|
+
"multiple"?: SkfSegmentedButton['multiple'];
|
612
882
|
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
/** If defined, sets provided color on the icon */
|
619
|
-
"icon-color"?: SkfSelectOption["iconColor"];
|
620
|
-
/** If true, sets the option as selected */
|
621
|
-
selected?: SkfSelectOption["selected"];
|
622
|
-
/** If defined, sets a short label */
|
623
|
-
"short-label"?: SkfSelectOption["shortLabel"];
|
624
|
-
/** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
|
625
|
-
value?: SkfSelectOption["value"];
|
626
|
-
/** The option's label text (equivalent to the tags textContent) */
|
627
|
-
text?: SkfSelectOption["text"];
|
628
|
-
/** */
|
629
|
-
role?: SkfSelectOption["role"];
|
883
|
+
|
884
|
+
}
|
885
|
+
|
886
|
+
|
887
|
+
export type SkfSelectOptionGroupProps = {
|
630
888
|
/** */
|
631
|
-
|
889
|
+
"label"?: SkfSelectOptionGroup['label'];
|
632
890
|
/** */
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
}
|
891
|
+
"small"?: SkfSelectOptionGroup['small'];
|
892
|
+
|
893
|
+
|
894
|
+
}
|
895
|
+
|
637
896
|
|
638
897
|
export type SkfTagProps = {
|
639
898
|
/** Specifies Tag size */
|
640
|
-
size?: SkfTag[
|
899
|
+
"size"?: SkfTag['size'];
|
641
900
|
/** If defined, displays leading/provided icon */
|
642
|
-
icon?: SkfTag[
|
901
|
+
"icon"?: SkfTag['icon'];
|
643
902
|
/** If defined, gives the supplied appearance */
|
644
|
-
color?: SkfTag[
|
903
|
+
"color"?: SkfTag['color'];
|
904
|
+
/** Sets the internal language of the component */
|
905
|
+
"lang"?: SkfTag['lang'];
|
645
906
|
/** If true, adds trailing button to remove tag */
|
646
|
-
removable?: SkfTag[
|
907
|
+
"removable"?: SkfTag['removable'];
|
647
908
|
/** If defined, accepts a function that runs on click */
|
648
|
-
onClick?: SkfTag[
|
909
|
+
"onClick"?: SkfTag['onClick'];
|
649
910
|
/** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
|
650
|
-
onRemove?: SkfTag[
|
651
|
-
|
911
|
+
"onRemove"?: SkfTag['onRemove'];
|
912
|
+
|
913
|
+
|
914
|
+
}
|
915
|
+
|
652
916
|
|
653
917
|
export type SkfSelectProps = {
|
654
|
-
/** If true, the select is disabled
|
655
|
-
disabled?:
|
918
|
+
/** If true, the select is disabled */
|
919
|
+
"disabled"?: unknown;
|
920
|
+
/** If true, the select is disabled */
|
921
|
+
"undefined"?: unknown;
|
922
|
+
/** If true, the select is required */
|
923
|
+
"required"?: unknown;
|
924
|
+
/** Sets the first visible text on the component */
|
925
|
+
"button-label"?: SkfSelect['buttonLabel'];
|
656
926
|
/** Sets the first visible text on the component */
|
657
|
-
"
|
927
|
+
"buttonLabel"?: SkfSelect['buttonLabel'];
|
658
928
|
/** If defined, forces component to invalid state until removed */
|
659
|
-
"custom-invalid"?: SkfSelect[
|
929
|
+
"custom-invalid"?: SkfSelect['customInvalid'];
|
930
|
+
/** If defined, forces component to invalid state until removed */
|
931
|
+
"customInvalid"?: SkfSelect['customInvalid'];
|
932
|
+
/** If true, hides the label visually */
|
933
|
+
"hide-label"?: SkfSelect['hideLabel'];
|
660
934
|
/** If true, hides the label visually */
|
661
|
-
"
|
935
|
+
"hideLabel"?: SkfSelect['hideLabel'];
|
936
|
+
/** If true and mulltiple is true, no tags are displayed under the select */
|
937
|
+
"hide-tags"?: SkfSelect['hideTags'];
|
662
938
|
/** If true and mulltiple is true, no tags are displayed under the select */
|
663
|
-
"
|
939
|
+
"hideTags"?: SkfSelect['hideTags'];
|
664
940
|
/** If defined, sets the hint text under the select component in the form */
|
665
|
-
hint?: SkfSelect[
|
941
|
+
"hint"?: SkfSelect['hint'];
|
666
942
|
/** If defined, displays provided label */
|
667
|
-
label?: SkfSelect[
|
943
|
+
"label"?: SkfSelect['label'];
|
944
|
+
/** Sets the internal language of the component */
|
945
|
+
"lang"?: SkfSelect['lang'];
|
668
946
|
/** If defined, limits the number of selectable options */
|
669
|
-
max?: SkfSelect[
|
947
|
+
"max"?: SkfSelect['max'];
|
670
948
|
/** If defined, sets the minimum number of required options */
|
671
|
-
min?: SkfSelect[
|
949
|
+
"min"?: SkfSelect['min'];
|
672
950
|
/** If true, allows for multiple options to be selected */
|
673
|
-
multiple?: SkfSelect[
|
951
|
+
"multiple"?: SkfSelect['multiple'];
|
674
952
|
/** If defined, set name of the component */
|
675
|
-
name?: SkfSelect[
|
676
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
677
|
-
"required-label"?: SkfSelect["requiredLabel"];
|
953
|
+
"name"?: SkfSelect['name'];
|
678
954
|
/** If defined, displays provided severity state */
|
679
|
-
severity?: SkfSelect[
|
955
|
+
"severity"?: SkfSelect['severity'];
|
680
956
|
/** If true, displays valid state after interaction */
|
681
|
-
"show-valid"?: SkfSelect[
|
957
|
+
"show-valid"?: SkfSelect['showValid'];
|
958
|
+
/** If true, displays valid state after interaction */
|
959
|
+
"showValid"?: SkfSelect['showValid'];
|
682
960
|
/** Size of the Select */
|
683
|
-
size?: SkfSelect[
|
961
|
+
"size"?: SkfSelect['size'];
|
684
962
|
/** A readonly property that returns the selected value(s) in a array */
|
685
|
-
selectedValues?: SkfSelect[
|
963
|
+
"selectedValues"?: SkfSelect['selectedValues'];
|
686
964
|
/** A readonly property that returns the selected slot(s) text content in a array */
|
687
|
-
selectedOptionsText?: SkfSelect[
|
688
|
-
/**
|
689
|
-
value?: SkfSelect[
|
965
|
+
"selectedOptionsText"?: SkfSelect['selectedOptionsText'];
|
966
|
+
/** Returns the selected value. (if multiple: in a comma separated string). If set will default set corresponding option. */
|
967
|
+
"value"?: SkfSelect['value'];
|
690
968
|
/** */
|
691
|
-
_selectedOptions?: SkfSelect[
|
969
|
+
"_selectedOptions"?: SkfSelect['_selectedOptions'];
|
970
|
+
|
692
971
|
/** Fired when the selected option(s) changes */
|
693
|
-
onchange?: (e: CustomEvent<
|
972
|
+
"onchange"?: (e: CustomEvent<Event>) => void;
|
694
973
|
/** Fired when the select is invalid */
|
695
|
-
oninvalid?: (e: CustomEvent<
|
974
|
+
"oninvalid"?: (e: CustomEvent<Event>) => void;
|
696
975
|
/** Fired when the form is reset */
|
697
|
-
onreset?: (e: CustomEvent<
|
976
|
+
"onreset"?: (e: CustomEvent<Event>) => void;
|
698
977
|
/** {detail: {expanded: boolean}} Fired when the select dropdown is toggled */
|
699
|
-
"onskf-select
|
978
|
+
"onskf-select-dropdown"?: (e: CustomEvent<CustomEvent>) => void;
|
700
979
|
/** {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled */
|
701
|
-
"onskf-select-option
|
702
|
-
|
980
|
+
"onskf-select-option-select"?: (e: CustomEvent<CustomEvent>) => void;
|
981
|
+
/** Fires when the select options are connected, useful for setting selected option(s) via value property. E.g mySkfSelect.value = 'option1,option2'; */
|
982
|
+
"onskf-select-connected"?: (e: CustomEvent<CustomEvent>) => void;
|
983
|
+
}
|
703
984
|
|
704
|
-
|
985
|
+
|
986
|
+
export type SkfSelectOptionProps = {
|
987
|
+
/** If true, prevents interaction with the option */
|
988
|
+
"disabled"?: SkfSelectOption['disabled'];
|
989
|
+
/** If defined, set an icon */
|
990
|
+
"icon"?: SkfSelectOption['icon'];
|
991
|
+
/** If defined, sets provided color on the icon */
|
992
|
+
"icon-color"?: SkfSelectOption['iconColor'];
|
993
|
+
/** If defined, sets provided color on the icon */
|
994
|
+
"iconColor"?: SkfSelectOption['iconColor'];
|
995
|
+
/** If true, sets the option as selected */
|
996
|
+
"selected"?: SkfSelectOption['selected'];
|
997
|
+
/** If defined, sets a short label */
|
998
|
+
"short-label"?: SkfSelectOption['shortLabel'];
|
999
|
+
/** If defined, sets a short label */
|
1000
|
+
"shortLabel"?: SkfSelectOption['shortLabel'];
|
1001
|
+
/** Returns or sets the option value. If value is omitted, defaults to the tags slotted text. */
|
1002
|
+
"value"?: SkfSelectOption['value'];
|
1003
|
+
/** The option's label text (equivalent to the tags textContent) */
|
1004
|
+
"text"?: SkfSelectOption['text'];
|
705
1005
|
/** */
|
706
|
-
|
707
|
-
|
1006
|
+
"small"?: SkfSelectOption['small'];
|
1007
|
+
/** */
|
1008
|
+
"_shortcutUpdate"?: SkfSelectOption['_shortcutUpdate'];
|
1009
|
+
|
1010
|
+
/** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
|
1011
|
+
"onskf-select-option-select"?: (e: CustomEvent<never>) => void;
|
1012
|
+
}
|
1013
|
+
|
708
1014
|
|
709
1015
|
export type SkfStepperItemProps = {
|
710
1016
|
/** If defined, gives the supplied appearance */
|
711
|
-
state?: SkfStepperItem[
|
1017
|
+
"state"?: SkfStepperItem['state'];
|
712
1018
|
/** If true, item marked as completed */
|
713
|
-
completed?: SkfStepperItem[
|
1019
|
+
"completed"?: SkfStepperItem['completed'];
|
714
1020
|
/** */
|
715
|
-
_setInternalState?: SkfStepperItem[
|
716
|
-
|
717
|
-
role?: SkfStepperItem["role"];
|
1021
|
+
"_setInternalState"?: SkfStepperItem['_setInternalState'];
|
1022
|
+
|
718
1023
|
/** Dispatched when the stepper item is selected */
|
719
1024
|
"onskf-stepper-item-select"?: (e: CustomEvent<never>) => void;
|
720
|
-
}
|
1025
|
+
}
|
1026
|
+
|
721
1027
|
|
722
1028
|
export type SkfStepperProps = {
|
723
1029
|
/** Sets the active item */
|
724
|
-
|
1030
|
+
"active-index"?: SkfStepper['activeIndex'];
|
1031
|
+
/** Sets the active item */
|
1032
|
+
"activeIndex"?: SkfStepper['activeIndex'];
|
725
1033
|
/** If true, sets linear mode (user can't go back to completed steps due to dependencies) */
|
726
|
-
linear?: SkfStepper[
|
1034
|
+
"linear"?: SkfStepper['linear'];
|
727
1035
|
|
728
1036
|
/** Dispatched when the stepper item is selected */
|
729
|
-
"onskf-stepper-item-select"?: (e: CustomEvent<
|
730
|
-
}
|
1037
|
+
"onskf-stepper-item-select"?: (e: CustomEvent<CustomEvent>) => void;
|
1038
|
+
}
|
1039
|
+
|
731
1040
|
|
732
1041
|
export type SkfSwitchProps = {
|
733
1042
|
/** If true, sets disabled state */
|
734
|
-
disabled?:
|
1043
|
+
"disabled"?: unknown;
|
1044
|
+
/** If true, sets disabled state */
|
1045
|
+
"undefined"?: unknown;
|
735
1046
|
/** If true, value is required or must be checked for the form to be submittable */
|
736
|
-
required?:
|
1047
|
+
"required"?: unknown;
|
737
1048
|
/** If true, outputs helping hints in console */
|
738
|
-
debug?: SkfSwitch[
|
1049
|
+
"debug"?: SkfSwitch['debug'];
|
739
1050
|
/** If true, outputs helping hints in console */
|
740
|
-
checked?: SkfSwitch[
|
1051
|
+
"checked"?: SkfSwitch['checked'];
|
1052
|
+
/** If true, hides the label visually */
|
1053
|
+
"hide-label"?: SkfSwitch['hideLabel'];
|
741
1054
|
/** If true, hides the label visually */
|
742
|
-
"
|
1055
|
+
"hideLabel"?: SkfSwitch['hideLabel'];
|
743
1056
|
/** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
|
744
|
-
label?: SkfSwitch[
|
1057
|
+
"label"?: SkfSwitch['label'];
|
1058
|
+
/** Sets the internal language of the component */
|
1059
|
+
"lang"?: SkfSwitch['lang'];
|
745
1060
|
/** If defined, adds name to the input-element */
|
746
|
-
name?: SkfSwitch[
|
747
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
748
|
-
"required-label"?: SkfSwitch["requiredLabel"];
|
1061
|
+
"name"?: SkfSwitch['name'];
|
749
1062
|
/** Size of the Switch */
|
750
|
-
size?: SkfSwitch[
|
1063
|
+
"size"?: SkfSwitch['size'];
|
751
1064
|
/** The current value of the input field */
|
752
|
-
value?: SkfSwitch[
|
753
|
-
|
1065
|
+
"value"?: SkfSwitch['value'];
|
1066
|
+
|
1067
|
+
|
1068
|
+
}
|
1069
|
+
|
754
1070
|
|
755
1071
|
export type SkfTabPanelProps = {
|
756
1072
|
/** The tab panel's name. */
|
757
|
-
name?: SkfTabPanel[
|
758
|
-
/** */
|
759
|
-
active?: SkfTabPanel["active"];
|
1073
|
+
"name"?: SkfTabPanel['name'];
|
760
1074
|
/** */
|
761
|
-
|
762
|
-
};
|
1075
|
+
"active"?: SkfTabPanel['active'];
|
763
1076
|
|
764
|
-
|
1077
|
+
|
1078
|
+
}
|
1079
|
+
|
1080
|
+
|
1081
|
+
export type SkfTabsProps = {
|
765
1082
|
/** Sets the default selected tab */
|
766
|
-
"default-selected"?:
|
1083
|
+
"default-selected"?: SkfTabs['defaultSelected'];
|
1084
|
+
/** Sets the default selected tab */
|
1085
|
+
"defaultSelected"?: SkfTabs['defaultSelected'];
|
1086
|
+
/** If true, removes border */
|
1087
|
+
"no-border"?: SkfTabs['noBorder'];
|
767
1088
|
/** If true, removes border */
|
768
|
-
"
|
1089
|
+
"noBorder"?: SkfTabs['noBorder'];
|
769
1090
|
/** If true, removes padding */
|
770
|
-
"no-padding"?:
|
1091
|
+
"no-padding"?: SkfTabs['noPadding'];
|
1092
|
+
/** If true, removes padding */
|
1093
|
+
"noPadding"?: SkfTabs['noPadding'];
|
771
1094
|
/** If true, component fills the parent element height */
|
772
|
-
stretch?:
|
1095
|
+
"stretch"?: SkfTabs['stretch'];
|
773
1096
|
/** Sets the appearance of the tabs */
|
774
|
-
variant?:
|
775
|
-
|
1097
|
+
"variant"?: SkfTabs['variant'];
|
1098
|
+
|
1099
|
+
|
1100
|
+
}
|
1101
|
+
|
776
1102
|
|
777
1103
|
export type SkfTabProps = {
|
778
1104
|
/** The name of the tab-panel this tab is associated with. The panel must be located in the same tab group. */
|
779
|
-
panel?: SkfTab[
|
780
|
-
/** */
|
781
|
-
selected?: SkfTab["selected"];
|
1105
|
+
"panel"?: SkfTab['panel'];
|
782
1106
|
/** */
|
783
|
-
|
1107
|
+
"selected"?: SkfTab['selected'];
|
784
1108
|
/** */
|
785
|
-
|
1109
|
+
"variant"?: SkfTab['variant'];
|
1110
|
+
|
786
1111
|
/** {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected */
|
787
1112
|
"onskf-tab-select"?: (e: CustomEvent<CustomEvent>) => void;
|
788
1113
|
/** Fired when the component is clicked */
|
789
|
-
onclick?: (e: CustomEvent<never>) => void;
|
790
|
-
}
|
1114
|
+
"onclick"?: (e: CustomEvent<never>) => void;
|
1115
|
+
}
|
1116
|
+
|
791
1117
|
|
792
1118
|
export type SkfTextAreaProps = {
|
793
1119
|
/** If true, sets disabled state */
|
794
|
-
disabled?:
|
1120
|
+
"disabled"?: unknown;
|
1121
|
+
/** If true, sets disabled state */
|
1122
|
+
"undefined"?: unknown;
|
795
1123
|
/** If true, value is required or must be checked for the form to be submittable */
|
796
|
-
required?:
|
1124
|
+
"required"?: unknown;
|
797
1125
|
/** If defined, sets the cols of the textarea */
|
798
|
-
cols?: SkfTextArea[
|
1126
|
+
"cols"?: SkfTextArea['cols'];
|
1127
|
+
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
1128
|
+
"custom-invalid"?: SkfTextArea['customInvalid'];
|
799
1129
|
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
800
|
-
"
|
1130
|
+
"customInvalid"?: SkfTextArea['customInvalid'];
|
801
1131
|
/** If true, outputs helping hints in console */
|
802
|
-
debug?: SkfTextArea[
|
1132
|
+
"debug"?: SkfTextArea['debug'];
|
803
1133
|
/** If true, hides the label visually */
|
804
|
-
"hide-label"?: SkfTextArea[
|
1134
|
+
"hide-label"?: SkfTextArea['hideLabel'];
|
1135
|
+
/** If true, hides the label visually */
|
1136
|
+
"hideLabel"?: SkfTextArea['hideLabel'];
|
805
1137
|
/** If defined, displays informational text below the field */
|
806
|
-
hint?: SkfTextArea[
|
1138
|
+
"hint"?: SkfTextArea['hint'];
|
807
1139
|
/** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
|
808
|
-
label?: SkfTextArea[
|
1140
|
+
"label"?: SkfTextArea['label'];
|
1141
|
+
/** Sets the internal language of the component */
|
1142
|
+
"lang"?: SkfTextArea['lang'];
|
809
1143
|
/** If defined, adds name to the input-element */
|
810
|
-
name?: SkfTextArea[
|
1144
|
+
"name"?: SkfTextArea['name'];
|
1145
|
+
/** If defined, sets the maximum character length to accept for this input */
|
1146
|
+
"maxlength"?: SkfTextArea['maxLength'];
|
811
1147
|
/** If defined, sets the maximum character length to accept for this input */
|
812
|
-
|
1148
|
+
"maxLength"?: SkfTextArea['maxLength'];
|
1149
|
+
/** If defined, sets the minimum character length to accept for this input */
|
1150
|
+
"minlength"?: SkfTextArea['minLength'];
|
813
1151
|
/** If defined, sets the minimum character length to accept for this input */
|
814
|
-
|
1152
|
+
"minLength"?: SkfTextArea['minLength'];
|
815
1153
|
/** If defined, displays placeholder text */
|
816
|
-
placeholder?: SkfTextArea[
|
1154
|
+
"placeholder"?: SkfTextArea['placeholder'];
|
817
1155
|
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
818
|
-
readonly?: SkfTextArea[
|
819
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
820
|
-
"required-label"?: SkfTextArea["requiredLabel"];
|
1156
|
+
"readonly"?: SkfTextArea['readonly'];
|
821
1157
|
/** If defined, sets the rows of the textarea */
|
822
|
-
rows?: SkfTextArea[
|
1158
|
+
"rows"?: SkfTextArea['rows'];
|
823
1159
|
/** If defined, displays provided severity state */
|
824
|
-
severity?: SkfTextArea[
|
1160
|
+
"severity"?: SkfTextArea['severity'];
|
825
1161
|
/** If true, displays valid state after interaction */
|
826
|
-
"show-valid"?: SkfTextArea[
|
1162
|
+
"show-valid"?: SkfTextArea['showValid'];
|
1163
|
+
/** If true, displays valid state after interaction */
|
1164
|
+
"showValid"?: SkfTextArea['showValid'];
|
827
1165
|
/** Size of the Textarea */
|
828
|
-
size?: SkfTextArea[
|
1166
|
+
"size"?: SkfTextArea['size'];
|
1167
|
+
/** Sets validation start */
|
1168
|
+
"validate-on"?: SkfTextArea['validateOn'];
|
829
1169
|
/** Sets validation start */
|
830
|
-
"
|
1170
|
+
"validateOn"?: SkfTextArea['validateOn'];
|
831
1171
|
/** The current value of the text area */
|
832
|
-
value?: SkfTextArea[
|
1172
|
+
"value"?: SkfTextArea['value'];
|
833
1173
|
|
834
1174
|
/** Fires when the value of the input changes */
|
835
|
-
onchange?: (e: CustomEvent<never>) => void;
|
1175
|
+
"onchange"?: (e: CustomEvent<never>) => void;
|
836
1176
|
/** Fires when the input is invalid */
|
837
|
-
oninvalid?: (e: CustomEvent<never>) => void;
|
838
|
-
}
|
1177
|
+
"oninvalid"?: (e: CustomEvent<never>) => void;
|
1178
|
+
}
|
1179
|
+
|
839
1180
|
|
840
1181
|
export type SkfToastWrapperProps = {
|
841
1182
|
/** */
|
842
|
-
debug?: SkfToastWrapper[
|
843
|
-
|
1183
|
+
"debug"?: SkfToastWrapper['debug'];
|
1184
|
+
|
1185
|
+
|
1186
|
+
}
|
1187
|
+
|
844
1188
|
|
845
1189
|
export type SkfToastProps = {
|
846
1190
|
/** */
|
847
|
-
debug?: SkfToast[
|
1191
|
+
"debug"?: SkfToast['debug'];
|
848
1192
|
/** If defined, displays leading icon */
|
849
|
-
icon?: SkfToast[
|
1193
|
+
"icon"?: SkfToast['icon'];
|
850
1194
|
/** If true, renders with an close button and sets aria-role to `status` */
|
851
|
-
persistent?: SkfToast[
|
1195
|
+
"persistent"?: SkfToast['persistent'];
|
852
1196
|
/** If defined, gives the supplied appearance */
|
853
|
-
severity?: SkfToast[
|
1197
|
+
"severity"?: SkfToast['severity'];
|
854
1198
|
/** Time in seconds before the toast disappears. */
|
855
|
-
timer?: SkfToast[
|
1199
|
+
"timer"?: SkfToast['timer'];
|
856
1200
|
/** offsets where toasts emerge vertically */
|
857
|
-
topOffset?: SkfToast[
|
858
|
-
|
1201
|
+
"topOffset"?: SkfToast['topOffset'];
|
1202
|
+
|
1203
|
+
|
1204
|
+
}
|
1205
|
+
|
859
1206
|
|
860
1207
|
export type SkfTooltipProps = {
|
861
1208
|
/** The placement of the dropdown */
|
862
|
-
placement?:
|
1209
|
+
"placement"?: unknown;
|
1210
|
+
/** The placement of the dropdown */
|
1211
|
+
"undefined"?: unknown;
|
863
1212
|
/** The id of the element the dropdown will be anchored to */
|
864
|
-
anchor?:
|
1213
|
+
"anchor"?: unknown;
|
865
1214
|
/** */
|
866
|
-
offset?: SkfTooltip[
|
1215
|
+
"offset"?: SkfTooltip['offset'];
|
867
1216
|
/** */
|
868
|
-
|
869
|
-
/**
|
870
|
-
"
|
871
|
-
/**
|
872
|
-
"
|
873
|
-
|
1217
|
+
"variant"?: SkfTooltip['variant'];
|
1218
|
+
/** Method that opens the tooltip */
|
1219
|
+
"open()"?: SkfTooltip['open()'];
|
1220
|
+
/** Method that closes the tooltip */
|
1221
|
+
"close()"?: SkfTooltip['close()'];
|
1222
|
+
|
1223
|
+
/** Fired when the tooltip is opened */
|
1224
|
+
"onskf-opened"?: (e: CustomEvent<CustomEvent>) => void;
|
1225
|
+
/** Fired when the tooltip is closed */
|
1226
|
+
"onskf-closed"?: (e: CustomEvent<CustomEvent>) => void;
|
1227
|
+
}
|
1228
|
+
|
1229
|
+
export type CustomElements = {
|
1230
|
+
|
874
1231
|
|
875
|
-
export type CustomElements = {
|
876
1232
|
/**
|
877
|
-
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
|
1233
|
+
* The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text.
|
1234
|
+
*
|
1235
|
+
* #### Attributes & Properties
|
1236
|
+
*
|
1237
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1238
|
+
*
|
1239
|
+
* - `color`: Sets the color of the icon
|
1240
|
+
* - `label`: If defined, adds an alternate description to use for assistive devices
|
1241
|
+
* - `name`: Name of the icon to display
|
1242
|
+
* - `size`: Size of the icon
|
1243
|
+
*/
|
1244
|
+
"skf-icon": Partial<SkfIconProps & BaseProps<SkfIcon> & BaseEvents>;
|
1245
|
+
|
882
1246
|
|
883
1247
|
/**
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
|
894
|
-
|
895
|
-
|
896
|
-
|
897
|
-
|
898
|
-
|
899
|
-
|
900
|
-
|
1248
|
+
* The `<skf-accordion-item>` is used in conjunction with the `<skf-accordion>` component
|
1249
|
+
*
|
1250
|
+
* #### Attributes & Properties
|
1251
|
+
*
|
1252
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1253
|
+
*
|
1254
|
+
* - `animated`: If true, will animate the expand/accordion-item state
|
1255
|
+
* - `expanded`: If true, will set the accordion-item to be expanded by default
|
1256
|
+
* - `heading`: Heading for the accordion-item
|
1257
|
+
* - `heading-as`/`headingAs`: Defines which heading element will be rendered
|
1258
|
+
* - `small`: If true, renders the small version
|
1259
|
+
* - `truncate`: If true, will truncate the heading in accordion-item state
|
1260
|
+
*
|
1261
|
+
* #### Events
|
1262
|
+
*
|
1263
|
+
* Events that will be emitted by the component.
|
1264
|
+
*
|
1265
|
+
* - `skf-accordion-item-toggle`: Event emitted when toggled
|
1266
|
+
*
|
1267
|
+
* #### Slots
|
1268
|
+
*
|
1269
|
+
* Areas where markup can be added to the component.
|
1270
|
+
*
|
1271
|
+
* - `(default)`: Main content
|
1272
|
+
*
|
1273
|
+
* #### Methods
|
1274
|
+
*
|
1275
|
+
* Methods that can be called to access component functionality.
|
1276
|
+
*
|
1277
|
+
* - `setClose() => void`: Class method as alternative to manipulate attribute
|
1278
|
+
* - `setOpen() => void`: Class method as alternative to manipulate attribute
|
1279
|
+
*/
|
1280
|
+
"skf-accordion-item": Partial<SkfAccordionItemProps & BaseProps<SkfAccordionItem> & BaseEvents>;
|
1281
|
+
|
901
1282
|
|
902
1283
|
/**
|
903
|
-
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
1284
|
+
* The `<skf-accordion>` component consists of one or more `<skf-accordion-item>` item(s) working together
|
1285
|
+
*
|
1286
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles
|
1287
|
+
*
|
1288
|
+
* #### Attributes & Properties
|
1289
|
+
*
|
1290
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1291
|
+
*
|
1292
|
+
* - `animated`: If true, will animate the expand/collapse state
|
1293
|
+
* - `heading-as`/`headingAs`: Defines which heading element will be rendered
|
1294
|
+
* - `gap`: If true, adds a gap between each item
|
1295
|
+
* - `multiple`: If true, allowes multiple accordion items to open
|
1296
|
+
* - `small`: If true, renders the small version
|
1297
|
+
* - `truncate`: If true, will truncate all headings in collapsed state
|
1298
|
+
*
|
1299
|
+
* #### Slots
|
1300
|
+
*
|
1301
|
+
* Areas where markup can be added to the component.
|
1302
|
+
*
|
1303
|
+
* - `(default)`: Expects one or more <skf-accordion-item> element(s)
|
1304
|
+
*/
|
1305
|
+
"skf-accordion": Partial<SkfAccordionProps & BaseProps<SkfAccordion> & BaseEvents>;
|
1306
|
+
|
913
1307
|
|
914
1308
|
/**
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
922
|
-
|
923
|
-
|
924
|
-
|
925
|
-
|
926
|
-
|
1309
|
+
* The `<skf-alert>` is a type of notification that appears in-line
|
1310
|
+
*
|
1311
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/990ec5-alert) for design principles
|
1312
|
+
*
|
1313
|
+
* #### Attributes & Properties
|
1314
|
+
*
|
1315
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1316
|
+
*
|
1317
|
+
* - `icon`: If defined, displays leading icon
|
1318
|
+
* - `lang`: Sets the internal language of the component
|
1319
|
+
* - `persistent`: If true, renders with an close button and sets aria-role to `status`
|
1320
|
+
* - `severity`: If defined, gives the supplied appearance
|
1321
|
+
*
|
1322
|
+
* #### Events
|
1323
|
+
*
|
1324
|
+
* Events that will be emitted by the component.
|
1325
|
+
*
|
1326
|
+
* - `skf-alert-close`: Fires when the close button is clicked
|
1327
|
+
*
|
1328
|
+
* #### Slots
|
1329
|
+
*
|
1330
|
+
* Areas where markup can be added to the component.
|
1331
|
+
*
|
1332
|
+
* - `(default)`: Alert message. **Notice!** See design principles for approved content
|
1333
|
+
* - `link`: Slot for the link
|
1334
|
+
*/
|
1335
|
+
"skf-alert": Partial<SkfAlertProps & BaseProps<SkfAlert> & BaseEvents>;
|
1336
|
+
|
927
1337
|
|
928
1338
|
/**
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
|
933
|
-
|
934
|
-
|
935
|
-
|
936
|
-
|
1339
|
+
* The `<skf-breadcrumb-item>` is used in conjunction with the `<skf-breadcrumb>` component
|
1340
|
+
*
|
1341
|
+
* #### Attributes & Properties
|
1342
|
+
*
|
1343
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1344
|
+
*
|
1345
|
+
* - `href`: If defined, loads url on click
|
1346
|
+
* - `onClick`: If defined, custom onClick where the second return parameter enables custom routing. **Notice!** Only applicable if `href` is defined. (property only)
|
1347
|
+
*
|
1348
|
+
* #### Slots
|
1349
|
+
*
|
1350
|
+
* Areas where markup can be added to the component.
|
1351
|
+
*
|
1352
|
+
* - `(default)`: Label of the breadcrumb item
|
1353
|
+
*/
|
1354
|
+
"skf-breadcrumb-item": Partial<SkfBreadcrumbItemProps & BaseProps<SkfBreadcrumbItem> & BaseEvents>;
|
1355
|
+
|
937
1356
|
|
938
1357
|
/**
|
939
|
-
|
940
|
-
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
|
1358
|
+
* The `<skf-breadcrumb>` component consists of multiple `<skf-breadcrumb-item>`, working together.
|
1359
|
+
*
|
1360
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/3338ef-breadcrumbs) for design principles.
|
1361
|
+
*
|
1362
|
+
* #### Attributes & Properties
|
1363
|
+
*
|
1364
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1365
|
+
*
|
1366
|
+
* - `label`: aria-label for the breadcrumb control
|
1367
|
+
* - `small`: If true, renders a smaller version
|
1368
|
+
*
|
1369
|
+
* #### Events
|
1370
|
+
*
|
1371
|
+
* Events that will be emitted by the component.
|
1372
|
+
*
|
1373
|
+
* - `click`: Fired when the item is clicked
|
1374
|
+
*
|
1375
|
+
* #### Slots
|
1376
|
+
*
|
1377
|
+
* Areas where markup can be added to the component.
|
1378
|
+
*
|
1379
|
+
* - `(default)`: One or more `<skf-breadcrumb-item>`
|
1380
|
+
*/
|
1381
|
+
"skf-breadcrumb": Partial<SkfBreadcrumbProps & BaseProps<SkfBreadcrumb> & BaseEvents>;
|
1382
|
+
|
952
1383
|
|
953
1384
|
/**
|
954
|
-
|
955
|
-
|
956
|
-
|
957
|
-
|
958
|
-
|
1385
|
+
* The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
|
1386
|
+
*
|
1387
|
+
* #### Attributes & Properties
|
1388
|
+
*
|
1389
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1390
|
+
*
|
1391
|
+
* - `invert`: If true, inverts the color (to be used on colored backgrounds)
|
1392
|
+
* - `size`: Defines the size of the loader
|
1393
|
+
*/
|
1394
|
+
"skf-loader": Partial<SkfLoaderProps & BaseProps<SkfLoader> & BaseEvents>;
|
1395
|
+
|
959
1396
|
|
960
1397
|
/**
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
967
|
-
|
968
|
-
|
969
|
-
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
|
1398
|
+
* Component to be used in forms or for interactivity
|
1399
|
+
*
|
1400
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/02493d-buttons) for design principles
|
1401
|
+
*
|
1402
|
+
* #### Attributes & Properties
|
1403
|
+
*
|
1404
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1405
|
+
*
|
1406
|
+
* - `destructive`: If true, gives destructive appearance. **Notice!** Only applicable if `variant` is `primary`.
|
1407
|
+
* - `disabled`: If true, removes border
|
1408
|
+
* - `icon`: If provided, renders an icon before or after the text
|
1409
|
+
* - `icon-only`/`iconOnly`: If true, button will take a square shape
|
1410
|
+
* - `icon-position`/`iconPosition`: Determines the positioning of the icon in relation to the text
|
1411
|
+
* - `loading`: If true, hides text & icon and shows loading indicator. **Notice!** Only applicable if `variant` is `primary`.
|
1412
|
+
* - `no-validate`/`noValidate`: undefined
|
1413
|
+
* - `size`: If provided, displays an alternative size
|
1414
|
+
* - `type`: If provided, changes the button type
|
1415
|
+
* - `variant`: If provided, alters the appearance
|
1416
|
+
*
|
1417
|
+
* #### Events
|
1418
|
+
*
|
1419
|
+
* Events that will be emitted by the component.
|
1420
|
+
*
|
1421
|
+
* - `click`: Fires when the button is clicked
|
1422
|
+
*
|
1423
|
+
* #### Slots
|
1424
|
+
*
|
1425
|
+
* Areas where markup can be added to the component.
|
1426
|
+
*
|
1427
|
+
* - `(default)`: The Primary content
|
1428
|
+
*
|
1429
|
+
* #### Methods
|
1430
|
+
*
|
1431
|
+
* Methods that can be called to access component functionality.
|
1432
|
+
*
|
1433
|
+
* - `click() => void`: Simulates a click on the button.
|
1434
|
+
*/
|
1435
|
+
"skf-button": Partial<SkfButtonProps & BaseProps<SkfButton> & BaseEvents>;
|
1436
|
+
|
975
1437
|
|
976
1438
|
/**
|
977
|
-
|
978
|
-
|
979
|
-
|
980
|
-
|
981
|
-
|
982
|
-
|
983
|
-
|
984
|
-
|
1439
|
+
* The `<skf-card>` can be used to group related subjects in a container
|
1440
|
+
*
|
1441
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/021eed-card) for design principles
|
1442
|
+
*
|
1443
|
+
* #### Attributes & Properties
|
1444
|
+
*
|
1445
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1446
|
+
*
|
1447
|
+
* - `no-border`/`noBorder`: If true, removes border
|
1448
|
+
* - `no-padding`/`noPadding`: If true, removes padding
|
1449
|
+
* - `stretch`: If true, the Card fills the parent element height
|
1450
|
+
*
|
1451
|
+
* #### Slots
|
1452
|
+
*
|
1453
|
+
* Areas where markup can be added to the component.
|
1454
|
+
*
|
1455
|
+
* - `(default)`: The card's main content
|
1456
|
+
*
|
1457
|
+
* #### CSS Custom Properties
|
1458
|
+
*
|
1459
|
+
* CSS variables available for styling the component.
|
1460
|
+
*
|
1461
|
+
* - `--mod-card-bg-color`: Ability to set a custom background color (default: `undefined`)
|
1462
|
+
*/
|
1463
|
+
"skf-card": Partial<SkfCardProps & BaseProps<SkfCard> & BaseEvents>;
|
1464
|
+
|
985
1465
|
|
986
1466
|
/**
|
987
|
-
|
988
|
-
|
989
|
-
|
990
|
-
|
991
|
-
|
992
|
-
|
993
|
-
|
994
|
-
|
995
|
-
|
996
|
-
|
997
|
-
|
1467
|
+
* The `<skf-checkbox>` component is used to create a checkbox input
|
1468
|
+
*
|
1469
|
+
* #### Attributes & Properties
|
1470
|
+
*
|
1471
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1472
|
+
*
|
1473
|
+
* - `disabled`/`undefined`: If true, sets disabled state
|
1474
|
+
* - `required`/`undefined`: If true, value is required or must be checked for the form to be submittable
|
1475
|
+
* - `debug`: If defined, outputs helping hints in console
|
1476
|
+
* - `checked`: If true, outputs helping hints in console
|
1477
|
+
* - `custom-invalid`/`customInvalid`: If true, forces component to invalid state until removed
|
1478
|
+
* - `indeterminate`: If true and the checkbox is unchecked, the checkbox will appear indeterminate
|
1479
|
+
* - `label`: If defined, sets the input's label. Alternatively, you can use the `label` attribute.
|
1480
|
+
* - `lang`: Sets the internal language of the component
|
1481
|
+
* - `name`: If defined, adds name to the input-element
|
1482
|
+
* - `severity`: If defined, styles checkbox using provided severity
|
1483
|
+
* - `show-valid`/`showValid`: If true, displays valid state after interaction
|
1484
|
+
* - `size`: Size of the checkbox
|
1485
|
+
* - `value`: The current value of the input field
|
1486
|
+
*
|
1487
|
+
* #### Events
|
1488
|
+
*
|
1489
|
+
* Events that will be emitted by the component.
|
1490
|
+
*
|
1491
|
+
* - `change`: When the value of the input changes
|
1492
|
+
*
|
1493
|
+
* #### Slots
|
1494
|
+
*
|
1495
|
+
* Areas where markup can be added to the component.
|
1496
|
+
*
|
1497
|
+
* - `(default)`: The Radios label. Alternatively, you can use the `label` attribute.
|
1498
|
+
*/
|
1499
|
+
"skf-checkbox": Partial<SkfCheckboxProps & BaseProps<SkfCheckbox> & BaseEvents>;
|
1500
|
+
|
998
1501
|
|
999
1502
|
/**
|
1000
|
-
|
1001
|
-
|
1002
|
-
|
1003
|
-
|
1004
|
-
|
1005
|
-
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1503
|
+
*
|
1504
|
+
*
|
1505
|
+
* #### Attributes & Properties
|
1506
|
+
*
|
1507
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1508
|
+
*
|
1509
|
+
* - `eventid`: undefined
|
1510
|
+
* - `firstDayOfWeek`: undefined
|
1511
|
+
* - `invalid-dates`/`invalidDates`: A comma-separated list of dates (yyyy-mm-dd format) that are not selectable.
|
1512
|
+
* - `lang`: Sets the internal language of the component
|
1513
|
+
* - `locale`: undefined
|
1514
|
+
* - `range`: undefined
|
1515
|
+
* - `selectable-from`/`selectableFrom`: Earliest selectable date. (yyyy-mm-dd format)
|
1516
|
+
* - `selectable-to`/`selectableTo`: Latest selectable date. (yyyy-mm-dd format)
|
1517
|
+
* - `selected-date`/`selectedDate`: undefined
|
1518
|
+
* - `selectedDateRange`: undefined
|
1519
|
+
* - `_listenToKeyboard`: undefined (property only)
|
1520
|
+
* - `_handleKeyDown`: undefined (property only)
|
1521
|
+
* - `dateSelectable`: undefined (property only)
|
1522
|
+
*
|
1523
|
+
* #### Methods
|
1524
|
+
*
|
1525
|
+
* Methods that can be called to access component functionality.
|
1526
|
+
*
|
1527
|
+
* - `_createDate({ year, month, day }: DateParts, useTemporalApi?: false) => Date`: undefined
|
1528
|
+
* - `_createDate({ year, month, day = 1 }: DateParts, useTemporalApi?: boolean) => Date | Temporal.PlainDate`: undefined
|
1529
|
+
*/
|
1530
|
+
"skf-datepicker-calendar": Partial<SkfDatepickerCalendarProps & BaseProps<SkfDatepickerCalendar> & BaseEvents>;
|
1531
|
+
|
1018
1532
|
|
1019
1533
|
/**
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1534
|
+
*
|
1535
|
+
*
|
1536
|
+
* #### Attributes & Properties
|
1537
|
+
*
|
1538
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1539
|
+
*
|
1540
|
+
* - `custom-invalid`/`customInvalid`: If defined, forces component to invalid state until removed. Its value is used as hint text.
|
1541
|
+
* - `id`: undefined
|
1542
|
+
* - `label`: If defined, sets the input's label. Alternatively, you can use the `label` attribute.
|
1543
|
+
* - `lang`: Sets the internal language of the component
|
1544
|
+
* - `hide-label`/`hideLabel`: If true, hides the label visually
|
1545
|
+
* - `hint`: If defined, displays informational text below the field
|
1546
|
+
* - `invalid-dates`/`invalidDates`: A comma-separated list of dates (yyyy-mm-dd format) that are not selectable.
|
1547
|
+
* - `name`: If defined, adds name to the input-element
|
1548
|
+
* - `placeholder`: undefined
|
1549
|
+
* - `range`: undefined
|
1550
|
+
* - `readonly`: If true, makes the element not mutable, meaning the user can not edit the control
|
1551
|
+
* - `selectable-from`/`selectableFrom`: Earliest selectable date. (yyyy-mm-dd format)
|
1552
|
+
* - `selectable-to`/`selectableTo`: Latest selectable date. (yyyy-mm-dd format)
|
1553
|
+
* - `severity`: If defined, displays provided severity state
|
1554
|
+
* - `size`: Size of the input
|
1555
|
+
* - `validate-on`/`validateOn`: Sets validation start
|
1556
|
+
* - `value`: The current value of the input field
|
1557
|
+
* - `focusTimeoutId`: undefined (property only)
|
1558
|
+
*
|
1559
|
+
* #### Methods
|
1560
|
+
*
|
1561
|
+
* Methods that can be called to access component functionality.
|
1562
|
+
*
|
1563
|
+
* - `_handleValueChange() => void`: undefined
|
1564
|
+
* - `showPopover() => void`: undefined
|
1565
|
+
* - `hidePopover() => void`: undefined
|
1566
|
+
* - `clear() => void`: Clears the input field
|
1567
|
+
*/
|
1568
|
+
"skf-datepicker": Partial<SkfDatepickerProps & BaseProps<SkfDatepicker> & BaseEvents>;
|
1569
|
+
|
1029
1570
|
|
1030
1571
|
/**
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1039
|
-
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
|
1044
|
-
|
1045
|
-
|
1046
|
-
|
1047
|
-
|
1048
|
-
|
1049
|
-
* - **--skf-dialog-height** - A custom height for the Dialog. Pass valid CSS **block-size** values _(default: undefined)_
|
1050
|
-
* - **--skf-dialog-width** - A custom width for the Dialog Pass valid CSS **inline-size** values _(default: undefined)_
|
1051
|
-
*/
|
1052
|
-
"skf-dialog": Partial<SkfDialogProps & BaseProps & BaseEvents>;
|
1572
|
+
* The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
|
1573
|
+
* It extends the interface of native html `<h1>` to `<h4>` elements.
|
1574
|
+
*
|
1575
|
+
* #### Attributes & Properties
|
1576
|
+
*
|
1577
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1578
|
+
*
|
1579
|
+
* - `as`: Controls which heading element will be rendered. Should not be used to affect appearance
|
1580
|
+
* - `styled-as`/`styledAs`: If defined, changes the appearance of the heading
|
1581
|
+
*
|
1582
|
+
* #### Slots
|
1583
|
+
*
|
1584
|
+
* Areas where markup can be added to the component.
|
1585
|
+
*
|
1586
|
+
* - `(default)`: The headings content
|
1587
|
+
*/
|
1588
|
+
"skf-heading": Partial<SkfHeadingProps & BaseProps<SkfHeading> & BaseEvents>;
|
1589
|
+
|
1053
1590
|
|
1054
1591
|
/**
|
1055
|
-
|
1056
|
-
|
1057
|
-
|
1058
|
-
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
1592
|
+
* 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)
|
1593
|
+
*
|
1594
|
+
* #### Attributes & Properties
|
1595
|
+
*
|
1596
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1597
|
+
*
|
1598
|
+
* - `heading`: Title for the modal/dialog
|
1599
|
+
* - `fullscreen`: If true, makes the dialog stretch edge to edge on screen
|
1600
|
+
* - `lang`: Sets the internal language of the component
|
1601
|
+
* - `no-close-button`/`noCloseButton`: If true, removes the close button
|
1602
|
+
* - `no-padding`/`noPadding`: If defined, removes the inner padding
|
1603
|
+
* - `open`: If true, indicates that the dialog is active and is available for interaction
|
1604
|
+
*
|
1605
|
+
* #### Events
|
1606
|
+
*
|
1607
|
+
* Events that will be emitted by the component.
|
1608
|
+
*
|
1609
|
+
* - `skf-dialog-opened`: Fires when the dialog is opened (after transitioned in)
|
1610
|
+
* - `skf-dialog-closing`: Fires when the dialog is closing (before transitioned out)
|
1611
|
+
* - `skf-dialog-closed`: Fires when the dialog is closed (after transitioned out)
|
1612
|
+
*
|
1613
|
+
* #### Slots
|
1614
|
+
*
|
1615
|
+
* Areas where markup can be added to the component.
|
1616
|
+
*
|
1617
|
+
* - `(default)`: The dialog component's content
|
1618
|
+
* - `footer`: The dialog component's buttons goes here
|
1619
|
+
*
|
1620
|
+
* #### Methods
|
1621
|
+
*
|
1622
|
+
* Methods that can be called to access component functionality.
|
1623
|
+
*
|
1624
|
+
* - `showModal() => void`: Method that opens the dialog in modal state
|
1625
|
+
* - `close() => void`: Method that closes the dialog
|
1626
|
+
*
|
1627
|
+
* #### CSS Custom Properties
|
1628
|
+
*
|
1629
|
+
* CSS variables available for styling the component.
|
1630
|
+
*
|
1631
|
+
* - `--skf-dialog-height`: A custom height for the Dialog. Pass valid CSS **block-size** values (default: `undefined`)
|
1632
|
+
* - `--skf-dialog-width`: A custom width for the Dialog Pass valid CSS **inline-size** values (default: `undefined`)
|
1633
|
+
*/
|
1634
|
+
"skf-dialog": Partial<SkfDialogProps & BaseProps<SkfDialog> & BaseEvents>;
|
1635
|
+
|
1064
1636
|
|
1065
1637
|
/**
|
1066
|
-
|
1067
|
-
|
1068
|
-
|
1069
|
-
|
1070
|
-
|
1071
|
-
|
1072
|
-
|
1073
|
-
|
1074
|
-
|
1075
|
-
|
1076
|
-
|
1077
|
-
|
1078
|
-
|
1638
|
+
* The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
|
1639
|
+
*
|
1640
|
+
* #### Attributes & Properties
|
1641
|
+
*
|
1642
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1643
|
+
*
|
1644
|
+
* - `color`: Defines the Divider color
|
1645
|
+
* - `decorative`: If true, renders a div for presentational purpose instead of the semantic hr-element
|
1646
|
+
* - `vertical`: If true, renders the divider vertically
|
1647
|
+
*
|
1648
|
+
* #### CSS Custom Properties
|
1649
|
+
*
|
1650
|
+
* CSS variables available for styling the component.
|
1651
|
+
*
|
1652
|
+
* - `--skf-divider-spacing`: The amount of space the divider occupies. Pass valid CSS **margin-block** values when horizontal and **margin-inline** when vertical (default: `undefined`)
|
1653
|
+
* - `--skf-divider-inset`: The amount of space the divider should be indented. Pass valid CSS **margin-inline** values when horizontal and **margin-block** when vertical (default: `undefined`)
|
1654
|
+
*/
|
1655
|
+
"skf-divider": Partial<SkfDividerProps & BaseProps<SkfDivider> & BaseEvents>;
|
1656
|
+
|
1079
1657
|
|
1080
1658
|
/**
|
1081
|
-
|
1082
|
-
|
1083
|
-
|
1084
|
-
|
1085
|
-
|
1086
|
-
|
1087
|
-
|
1088
|
-
|
1659
|
+
* The `<skf-drawer>` is a modal component that displays content and toggle by sliding from left/right viewport edge
|
1660
|
+
*
|
1661
|
+
* #### Attributes & Properties
|
1662
|
+
*
|
1663
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1664
|
+
*
|
1665
|
+
* - `heading`: Heading for the Drawer
|
1666
|
+
* - `lang`: Sets the internal language of the component
|
1667
|
+
* - `size`: Sets the max-width
|
1668
|
+
* - `open`: If true, Drawer is open
|
1669
|
+
* - `placement`: Placement of the Drawer
|
1670
|
+
*
|
1671
|
+
* #### Events
|
1672
|
+
*
|
1673
|
+
* Events that will be emitted by the component.
|
1674
|
+
*
|
1675
|
+
* - `skf-drawer-opened`: Fires when the drawer is opened (after transitioned in)
|
1676
|
+
* - `skf-drawer-closing`: Fires when the drawer is closing (before transitioned out)
|
1677
|
+
* - `skf-drawer-closed`: Fires when the drawer is closed (after transitioned out)
|
1678
|
+
*
|
1679
|
+
* #### Slots
|
1680
|
+
*
|
1681
|
+
* Areas where markup can be added to the component.
|
1682
|
+
*
|
1683
|
+
* - `(default)`: The Drawer's main content
|
1684
|
+
*
|
1685
|
+
* #### Methods
|
1686
|
+
*
|
1687
|
+
* Methods that can be called to access component functionality.
|
1688
|
+
*
|
1689
|
+
* - `close() => void`: undefined
|
1690
|
+
*/
|
1691
|
+
"skf-drawer": Partial<SkfDrawerProps & BaseProps<SkfDrawer> & BaseEvents>;
|
1692
|
+
|
1089
1693
|
|
1090
1694
|
/**
|
1091
|
-
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1695
|
+
* The `<skf-logo>` component is used to display the SKF logo.
|
1696
|
+
*
|
1697
|
+
* #### Attributes & Properties
|
1698
|
+
*
|
1699
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1700
|
+
*
|
1701
|
+
* - `title`: Defines the title of the logo
|
1702
|
+
* - `color`: Defines the color of the logo
|
1703
|
+
*
|
1704
|
+
* #### CSS Custom Properties
|
1705
|
+
*
|
1706
|
+
* CSS variables available for styling the component.
|
1707
|
+
*
|
1708
|
+
* - `--mod-logo-height`: The height of the logo (default: `undefined`)
|
1709
|
+
*/
|
1710
|
+
"skf-logo": Partial<SkfLogoProps & BaseProps<SkfLogo> & BaseEvents>;
|
1711
|
+
|
1099
1712
|
|
1100
1713
|
/**
|
1101
|
-
|
1102
|
-
|
1103
|
-
|
1104
|
-
|
1105
|
-
|
1106
|
-
|
1107
|
-
|
1108
|
-
|
1714
|
+
* The `<skf-link>` can be used as either a regular link or a semantic button. The button variant is
|
1715
|
+
* intended to be used for triggering javascript functions, not handling forms.
|
1716
|
+
*
|
1717
|
+
* #### Attributes & Properties
|
1718
|
+
*
|
1719
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1720
|
+
*
|
1721
|
+
* - `as`: Defines the semantic element to render
|
1722
|
+
* - `color`: Defines the text-color
|
1723
|
+
* - `disabled`: If true, disables the link
|
1724
|
+
* - `download`: If defined, downloads the url
|
1725
|
+
* - `href`: If defined, loads url on click
|
1726
|
+
* - `icon`: If defined, renders an icon before or after the text
|
1727
|
+
* - `icon-right`/`iconRight`: If true, the icon is placed to the right in relation to the text
|
1728
|
+
* - `rel`: If defined, describes the relationship between a linked resource and the current document
|
1729
|
+
* - `route`: If defined, used on conjunction with onClick property. **Notice!** Only applicable to as=button.
|
1730
|
+
* - `stretch`: If true, fills the parents horizontal axis
|
1731
|
+
* - `target`: If defined, specifies where to open the linked document
|
1732
|
+
*
|
1733
|
+
* #### Events
|
1734
|
+
*
|
1735
|
+
* Events that will be emitted by the component.
|
1736
|
+
*
|
1737
|
+
* - `skf-link-click`: Fired when the link is clicked
|
1738
|
+
*
|
1739
|
+
* #### Slots
|
1740
|
+
*
|
1741
|
+
* Areas where markup can be added to the component.
|
1742
|
+
*
|
1743
|
+
* - `(default)`: The links' main content
|
1744
|
+
*
|
1745
|
+
* #### Methods
|
1746
|
+
*
|
1747
|
+
* Methods that can be called to access component functionality.
|
1748
|
+
*
|
1749
|
+
* - `_handleAsChange() => void`: undefined
|
1750
|
+
*/
|
1751
|
+
"skf-link": Partial<SkfLinkProps & BaseProps<SkfLink> & BaseEvents>;
|
1752
|
+
|
1109
1753
|
|
1110
1754
|
/**
|
1111
|
-
|
1112
|
-
|
1113
|
-
|
1114
|
-
|
1115
|
-
|
1116
|
-
|
1117
|
-
|
1118
|
-
|
1119
|
-
|
1120
|
-
|
1121
|
-
|
1122
|
-
|
1755
|
+
* The `<skf-nav>` is a component that displays a list of <nav-items>.
|
1756
|
+
*
|
1757
|
+
* #### Attributes & Properties
|
1758
|
+
*
|
1759
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1760
|
+
*
|
1761
|
+
* - `href`: undefined
|
1762
|
+
* - `icon`: undefined
|
1763
|
+
* - `vertical`: undefined (property only)
|
1764
|
+
*
|
1765
|
+
* #### Slots
|
1766
|
+
*
|
1767
|
+
* Areas where markup can be added to the component.
|
1768
|
+
*
|
1769
|
+
* - `(default)`: The component's main content
|
1770
|
+
*/
|
1771
|
+
"skf-nav-item": Partial<SkfNavItemProps & BaseProps<SkfNavItem> & BaseEvents>;
|
1772
|
+
|
1123
1773
|
|
1124
1774
|
/**
|
1125
|
-
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1130
|
-
|
1131
|
-
|
1132
|
-
|
1775
|
+
* The `<skf-nav>` is a component that displays a list of <nav-items>.
|
1776
|
+
*
|
1777
|
+
* #### Attributes & Properties
|
1778
|
+
*
|
1779
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1780
|
+
*
|
1781
|
+
* - `lang`: Sets the internal language of the component
|
1782
|
+
* - `vertical`: If true, the navigation will be displayed vertically
|
1783
|
+
*
|
1784
|
+
* #### Slots
|
1785
|
+
*
|
1786
|
+
* Areas where markup can be added to the component.
|
1787
|
+
*
|
1788
|
+
* - `(default)`: The component's main content
|
1789
|
+
*/
|
1790
|
+
"skf-nav": Partial<SkfNavProps & BaseProps<SkfNav> & BaseEvents>;
|
1791
|
+
|
1133
1792
|
|
1134
1793
|
/**
|
1135
|
-
|
1136
|
-
|
1137
|
-
|
1138
|
-
|
1139
|
-
|
1140
|
-
|
1141
|
-
|
1142
|
-
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1146
|
-
|
1794
|
+
* 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.
|
1795
|
+
*
|
1796
|
+
* #### Attributes & Properties
|
1797
|
+
*
|
1798
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1799
|
+
*
|
1800
|
+
* - `compact`: If true, sets header to display in compact mode only (hanburger menu and drawer)
|
1801
|
+
* - `lang`: Sets the internal language of the component
|
1802
|
+
* - `site-name`/`siteName`: If defined, sets the app or site's name
|
1803
|
+
* - `site-url`/`siteUrl`: If defined, sets the site's base-url for the "logo-link"
|
1804
|
+
*
|
1805
|
+
* #### Slots
|
1806
|
+
*
|
1807
|
+
* Areas where markup can be added to the component.
|
1808
|
+
*
|
1809
|
+
* - `(default)`: Navigation items
|
1810
|
+
*/
|
1811
|
+
"skf-header": Partial<SkfHeaderProps & BaseProps<SkfHeader> & BaseEvents>;
|
1812
|
+
|
1147
1813
|
|
1148
1814
|
/**
|
1149
|
-
|
1150
|
-
|
1151
|
-
|
1152
|
-
|
1153
|
-
|
1154
|
-
|
1155
|
-
|
1156
|
-
|
1157
|
-
|
1158
|
-
|
1159
|
-
|
1160
|
-
|
1161
|
-
|
1162
|
-
|
1163
|
-
|
1164
|
-
|
1165
|
-
|
1166
|
-
|
1815
|
+
* The skf-text-field is used to create a text input field. It can be used inside a form element or standalone
|
1816
|
+
*
|
1817
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/9481fa-input-field) for design principles
|
1818
|
+
*
|
1819
|
+
* #### Attributes & Properties
|
1820
|
+
*
|
1821
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1822
|
+
*
|
1823
|
+
* - `disabled`/`undefined`: If true, sets disabled state
|
1824
|
+
* - `required`/`undefined`: If true, value is required or must be checked for the form to be submittable
|
1825
|
+
* - `autocomplete`: Indicates whether the value of the control can be automatically completed by the browser. See
|
1826
|
+
* [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/autocomplete) for details.
|
1827
|
+
* - `custom-invalid`/`customInvalid`: If defined, forces component to invalid state until removed. Its value is used as hint text.
|
1828
|
+
* - `debug`: If true, outputs helping hints in console
|
1829
|
+
* - `hide-label`/`hideLabel`: If true, hides the label visually
|
1830
|
+
* - `hint`: If defined, displays informational text below the field
|
1831
|
+
* - `inputmode`: Provides a hint about the type of data that might be entered by the user while editing the element or its contents. See
|
1832
|
+
* [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inputMode) for details.
|
1833
|
+
* - `label`: If defined, sets the input's label. Alternatively, you can use the `label` attribute.
|
1834
|
+
* - `lang`: Sets the internal language of the component
|
1835
|
+
* - `leading`: If defined, displays a prefix/adornment before the input-element
|
1836
|
+
* - `max`: If defined, sets the maximum value to accept for this input
|
1837
|
+
* - `maxlength`/`maxLength`: If defined, sets the maximum character length to accept for this input
|
1838
|
+
* - `min`: If defined, sets the minimum value to accept for this input
|
1839
|
+
* - `minlength`/`minLength`: If defined, sets the minimum character length to accept for this input
|
1840
|
+
* - `name`: If defined, adds name to the input-element
|
1841
|
+
* - `pattern`: If defined, adds name to the input-element
|
1842
|
+
* - `placeholder`: If defined, displays placeholder text
|
1843
|
+
* - `readonly`: If true, makes the element not mutable, meaning the user can not edit the control
|
1844
|
+
* - `severity`: If defined, displays provided severity state
|
1845
|
+
* - `show-valid`/`showValid`: If true, displays valid state after interaction
|
1846
|
+
* - `size`: Size of the input
|
1847
|
+
* - `trailing`: If defined, displays a suffix/adornment after the input-element
|
1848
|
+
* - `type`: Type of input
|
1849
|
+
* - `validate-on`/`validateOn`: Sets validation start
|
1850
|
+
* - `value`: The current value of the input field
|
1851
|
+
*
|
1852
|
+
* #### Events
|
1853
|
+
*
|
1854
|
+
* Events that will be emitted by the component.
|
1855
|
+
*
|
1856
|
+
* - `change`: Fires when the value of the input changes
|
1857
|
+
* - `invalid`: Fires when the input is invalid
|
1858
|
+
*
|
1859
|
+
* #### Slots
|
1860
|
+
*
|
1861
|
+
* Areas where markup can be added to the component.
|
1862
|
+
*
|
1863
|
+
* - `(default)`: The Inputs label. Alternatively, you can use the `label` attribute.
|
1864
|
+
*/
|
1865
|
+
"skf-input": Partial<SkfInputProps & BaseProps<SkfInput> & BaseEvents>;
|
1866
|
+
|
1167
1867
|
|
1168
1868
|
/**
|
1169
|
-
|
1170
|
-
|
1171
|
-
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1869
|
+
* The `<skf-menu-item>` is used in conjunction with the `<skf-menu>` component
|
1870
|
+
*
|
1871
|
+
* #### Attributes & Properties
|
1872
|
+
*
|
1873
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1874
|
+
*
|
1875
|
+
* - `as`: Defines the semantic element to render
|
1876
|
+
* - `color`: Defines the text-color
|
1877
|
+
* - `disabled`: If true, disables the link
|
1878
|
+
* - `download`: If defined, downloads the url
|
1879
|
+
* - `href`: If defined, loads url on click
|
1880
|
+
* - `icon`: If defined, renders an icon before or after the text
|
1881
|
+
* - `icon-right`/`iconRight`: If true, the icon is placed to the right in relation to the text
|
1882
|
+
* - `rel`: If defined, describes the relationship between a linked resource and the current document
|
1883
|
+
* - `route`: If defined, used on conjunction with onClick property. **Notice!** Only applicable to as=button.
|
1884
|
+
* - `stretch`: If true, fills the parents horizontal axis
|
1885
|
+
* - `target`: If defined, specifies where to open the linked document
|
1886
|
+
*
|
1887
|
+
* #### Events
|
1888
|
+
*
|
1889
|
+
* Events that will be emitted by the component.
|
1890
|
+
*
|
1891
|
+
* - `skf-link-click`: Fired when the link is clicked
|
1892
|
+
*
|
1893
|
+
* #### Slots
|
1894
|
+
*
|
1895
|
+
* Areas where markup can be added to the component.
|
1896
|
+
*
|
1897
|
+
* - `(default)`: The component's main content
|
1898
|
+
*
|
1899
|
+
* #### Methods
|
1900
|
+
*
|
1901
|
+
* Methods that can be called to access component functionality.
|
1902
|
+
*
|
1903
|
+
* - `_handleAsChange() => void`: undefined
|
1904
|
+
*/
|
1905
|
+
"skf-menu-item": Partial<SkfMenuItemProps & BaseProps<SkfMenuItem> & BaseEvents>;
|
1906
|
+
|
1177
1907
|
|
1178
1908
|
/**
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
1184
|
-
|
1185
|
-
|
1186
|
-
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1909
|
+
* The `<skf-menu>` is a component that displays a list of actions or options
|
1910
|
+
*
|
1911
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/983e5d-popover) for design principles
|
1912
|
+
*
|
1913
|
+
* #### Attributes & Properties
|
1914
|
+
*
|
1915
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1916
|
+
*
|
1917
|
+
* - `placement`/`undefined`: The placement of the menu
|
1918
|
+
* - `anchor`/`undefined`: The id of the element the menu will be anchored to
|
1919
|
+
* - `open()`: Method that opens the menu (property only)
|
1920
|
+
* - `close()`: Method that closes the menu (property only)
|
1921
|
+
*
|
1922
|
+
* #### Events
|
1923
|
+
*
|
1924
|
+
* Events that will be emitted by the component.
|
1925
|
+
*
|
1926
|
+
* - `skf-opened`: Fired when the menu is opened
|
1927
|
+
* - `skf-closed`: Fired when the menu is closed
|
1928
|
+
*
|
1929
|
+
* #### Slots
|
1930
|
+
*
|
1931
|
+
* Areas where markup can be added to the component.
|
1932
|
+
*
|
1933
|
+
* - `(default)`: The menu content
|
1934
|
+
*/
|
1935
|
+
"skf-menu": Partial<SkfMenuProps & BaseProps<SkfMenu> & BaseEvents>;
|
1936
|
+
|
1191
1937
|
|
1192
1938
|
/**
|
1193
|
-
|
1194
|
-
|
1195
|
-
|
1196
|
-
|
1197
|
-
|
1939
|
+
* The `<skf-popover>` is a general purpose component that displays the slot content in a popover.
|
1940
|
+
*
|
1941
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/983e5d-popover) for design principles
|
1942
|
+
*
|
1943
|
+
* #### Attributes & Properties
|
1944
|
+
*
|
1945
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1946
|
+
*
|
1947
|
+
* - `placement`/`undefined`: The placement of the popover
|
1948
|
+
* - `anchor`/`undefined`: The id of the element the popover will be anchored to
|
1949
|
+
* - `offset`: If defined, sets a custom offset for the popover
|
1950
|
+
* - `hideArrow`: If true, hides the arrow
|
1951
|
+
* - `open()`: Method that opens the popover (property only)
|
1952
|
+
* - `close()`: Method that closes the popover (property only)
|
1953
|
+
*
|
1954
|
+
* #### Events
|
1955
|
+
*
|
1956
|
+
* Events that will be emitted by the component.
|
1957
|
+
*
|
1958
|
+
* - `skf-opened`: Fired when the popover is opened
|
1959
|
+
* - `skf-closed`: Fired when the popover is closed
|
1960
|
+
*
|
1961
|
+
* #### Slots
|
1962
|
+
*
|
1963
|
+
* Areas where markup can be added to the component.
|
1964
|
+
*
|
1965
|
+
* - `(default)`: The popover content
|
1966
|
+
*/
|
1967
|
+
"skf-popover": Partial<SkfPopoverProps & BaseProps<SkfPopover> & BaseEvents>;
|
1968
|
+
|
1198
1969
|
|
1199
1970
|
/**
|
1200
|
-
|
1201
|
-
|
1202
|
-
|
1203
|
-
|
1204
|
-
|
1205
|
-
|
1206
|
-
|
1207
|
-
|
1208
|
-
|
1209
|
-
|
1210
|
-
|
1971
|
+
* The `<skf-progress>` element displays an indicator showing the completion progress of a task, typically displayed as a progress bar
|
1972
|
+
*
|
1973
|
+
* #### Attributes & Properties
|
1974
|
+
*
|
1975
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1976
|
+
*
|
1977
|
+
* - `animated`: If true, the progress-bar's fill value is animated
|
1978
|
+
* - `max`: Describes how much work the task indicated by the progress element requires
|
1979
|
+
* - `value`: Specifies how much of the task that has been completed
|
1980
|
+
*/
|
1981
|
+
"skf-progress": Partial<SkfProgressProps & BaseProps<SkfProgress> & BaseEvents>;
|
1982
|
+
|
1211
1983
|
|
1212
1984
|
/**
|
1213
|
-
|
1214
|
-
|
1215
|
-
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1985
|
+
* The `<skf-radio>` component is used to create a radio input
|
1986
|
+
*
|
1987
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/78d5dd-radio-button) for design principles
|
1988
|
+
*
|
1989
|
+
* #### Attributes & Properties
|
1990
|
+
*
|
1991
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
1992
|
+
*
|
1993
|
+
* - `disabled`/`undefined`: If true, sets disabled state
|
1994
|
+
* - `required`/`undefined`: If true, value is required or must be checked for the form to be submittable
|
1995
|
+
* - `debug`: If true, outputs helping hints in console
|
1996
|
+
* - `checked`: If true, outputs helping hints in console
|
1997
|
+
* - `custom-invalid`/`customInvalid`: If true, forces component to invalid state until removed
|
1998
|
+
* - `label`: If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute.
|
1999
|
+
* - `lang`: Sets the internal language of the component
|
2000
|
+
* - `name`: If defined, adds name to the input-element
|
2001
|
+
* - `size`: Size of the Radio
|
2002
|
+
* - `severity`: If defined, displays provided severity state
|
2003
|
+
* - `show-valid`/`showValid`: If true, displays valid state after interaction
|
2004
|
+
* - `value`: The current value of the input field
|
2005
|
+
*
|
2006
|
+
* #### Events
|
2007
|
+
*
|
2008
|
+
* Events that will be emitted by the component.
|
2009
|
+
*
|
2010
|
+
* - `change`: When the value of the input changes
|
2011
|
+
*
|
2012
|
+
* #### Slots
|
2013
|
+
*
|
2014
|
+
* Areas where markup can be added to the component.
|
2015
|
+
*
|
2016
|
+
* - `(default)`: The radios label. Alternatively, you can use the `label` attribute.
|
2017
|
+
*/
|
2018
|
+
"skf-radio": Partial<SkfRadioProps & BaseProps<SkfRadio> & BaseEvents>;
|
2019
|
+
|
1224
2020
|
|
1225
2021
|
/**
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
2022
|
+
* The `<skf-segmented-button-item>` is used in conjunction with the `<skf-segmented-button>` component
|
2023
|
+
*
|
2024
|
+
* #### Attributes & Properties
|
2025
|
+
*
|
2026
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2027
|
+
*
|
2028
|
+
* - `disabled`: If true, items is marked as disabled
|
2029
|
+
* - `selected`: If true, items is marked as selected
|
2030
|
+
* - `value`: Sets the item value
|
2031
|
+
*
|
2032
|
+
* #### Events
|
2033
|
+
*
|
2034
|
+
* Events that will be emitted by the component.
|
2035
|
+
*
|
2036
|
+
* - `skf-segmented-button-item-select`: Fired when selected
|
2037
|
+
*
|
2038
|
+
* #### Slots
|
2039
|
+
*
|
2040
|
+
* Areas where markup can be added to the component.
|
2041
|
+
*
|
2042
|
+
* - `(default)`: Label for the button
|
2043
|
+
*/
|
2044
|
+
"skf-segmented-button-item": Partial<SkfSegmentedButtonItemProps & BaseProps<SkfSegmentedButtonItem> & BaseEvents>;
|
2045
|
+
|
1236
2046
|
|
1237
2047
|
/**
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1244
|
-
|
1245
|
-
|
1246
|
-
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
2048
|
+
* The `<skf-segmented-button>` component consists of multiple `<skf-segmented-button-item>`, working together.
|
2049
|
+
*
|
2050
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/68ff54-segmented-buttons) for design principles
|
2051
|
+
*
|
2052
|
+
* #### Attributes & Properties
|
2053
|
+
*
|
2054
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2055
|
+
*
|
2056
|
+
* - `multiple`: If true, allowes multiple items to be selected
|
2057
|
+
*
|
2058
|
+
* #### Slots
|
2059
|
+
*
|
2060
|
+
* Areas where markup can be added to the component.
|
2061
|
+
*
|
2062
|
+
* - `(default)`: One or more `<skf-segmented-button-item>`
|
2063
|
+
*/
|
2064
|
+
"skf-segmented-button": Partial<SkfSegmentedButtonProps & BaseProps<SkfSegmentedButton> & BaseEvents>;
|
2065
|
+
|
1250
2066
|
|
1251
2067
|
/**
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1256
|
-
|
1257
|
-
|
1258
|
-
|
1259
|
-
|
2068
|
+
* The `<skf-select-option-group>` is a component that groups select-options
|
2069
|
+
*
|
2070
|
+
* #### Attributes & Properties
|
2071
|
+
*
|
2072
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2073
|
+
*
|
2074
|
+
* - `label`: undefined
|
2075
|
+
* - `small`: undefined (property only)
|
2076
|
+
*
|
2077
|
+
* #### Slots
|
2078
|
+
*
|
2079
|
+
* Areas where markup can be added to the component.
|
2080
|
+
*
|
2081
|
+
* - `(default)`: The component's placeholder content
|
2082
|
+
*/
|
2083
|
+
"skf-select-option-group": Partial<SkfSelectOptionGroupProps & BaseProps<SkfSelectOptionGroup> & BaseEvents>;
|
2084
|
+
|
1260
2085
|
|
1261
2086
|
/**
|
1262
|
-
|
1263
|
-
|
1264
|
-
|
1265
|
-
|
1266
|
-
|
1267
|
-
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1271
|
-
|
1272
|
-
|
1273
|
-
|
1274
|
-
|
1275
|
-
|
1276
|
-
|
2087
|
+
* The `<skf-tag>` is a component that displays a list of actions or options
|
2088
|
+
*
|
2089
|
+
* #### Attributes & Properties
|
2090
|
+
*
|
2091
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2092
|
+
*
|
2093
|
+
* - `size`: Specifies Tag size
|
2094
|
+
* - `icon`: If defined, displays leading/provided icon
|
2095
|
+
* - `color`: If defined, gives the supplied appearance
|
2096
|
+
* - `lang`: Sets the internal language of the component
|
2097
|
+
* - `removable`: If true, adds trailing button to remove tag
|
2098
|
+
* - `onClick`: If defined, accepts a function that runs on click (property only)
|
2099
|
+
* - `onRemove`: If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. (property only)
|
2100
|
+
*
|
2101
|
+
* #### Slots
|
2102
|
+
*
|
2103
|
+
* Areas where markup can be added to the component.
|
2104
|
+
*
|
2105
|
+
* - `(default)`: The component's placeholder content
|
2106
|
+
*/
|
2107
|
+
"skf-tag": Partial<SkfTagProps & BaseProps<SkfTag> & BaseEvents>;
|
2108
|
+
|
1277
2109
|
|
1278
2110
|
/**
|
1279
|
-
|
1280
|
-
|
1281
|
-
|
1282
|
-
|
1283
|
-
|
1284
|
-
|
1285
|
-
|
1286
|
-
|
2111
|
+
* 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.
|
2112
|
+
*
|
2113
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/91c9f0-select-and-combobox) for design principles
|
2114
|
+
*
|
2115
|
+
* #### Attributes & Properties
|
2116
|
+
*
|
2117
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2118
|
+
*
|
2119
|
+
* - `disabled`/`undefined`: If true, the select is disabled
|
2120
|
+
* - `required`/`undefined`: If true, the select is required
|
2121
|
+
* - `button-label`/`buttonLabel`: Sets the first visible text on the component
|
2122
|
+
* - `custom-invalid`/`customInvalid`: If defined, forces component to invalid state until removed
|
2123
|
+
* - `hide-label`/`hideLabel`: If true, hides the label visually
|
2124
|
+
* - `hide-tags`/`hideTags`: If true and mulltiple is true, no tags are displayed under the select
|
2125
|
+
* - `hint`: If defined, sets the hint text under the select component in the form
|
2126
|
+
* - `label`: If defined, displays provided label
|
2127
|
+
* - `lang`: Sets the internal language of the component
|
2128
|
+
* - `max`: If defined, limits the number of selectable options
|
2129
|
+
* - `min`: If defined, sets the minimum number of required options
|
2130
|
+
* - `multiple`: If true, allows for multiple options to be selected
|
2131
|
+
* - `name`: If defined, set name of the component
|
2132
|
+
* - `severity`: If defined, displays provided severity state
|
2133
|
+
* - `show-valid`/`showValid`: If true, displays valid state after interaction
|
2134
|
+
* - `size`: Size of the Select
|
2135
|
+
* - `selectedValues`: A readonly property that returns the selected value(s) in a array (property only)
|
2136
|
+
* - `selectedOptionsText`: A readonly property that returns the selected slot(s) text content in a array (property only)
|
2137
|
+
* - `value`: Returns the selected value. (if multiple: in a comma separated string). If set will default set corresponding option. (property only)
|
2138
|
+
* - `_selectedOptions`: undefined (property only)
|
2139
|
+
*
|
2140
|
+
* #### Events
|
2141
|
+
*
|
2142
|
+
* Events that will be emitted by the component.
|
2143
|
+
*
|
2144
|
+
* - `change`: Fired when the selected option(s) changes
|
2145
|
+
* - `invalid`: Fired when the select is invalid
|
2146
|
+
* - `reset`: Fired when the form is reset
|
2147
|
+
* - `skf-select-dropdown`: {detail: {expanded: boolean}} Fired when the select dropdown is toggled
|
2148
|
+
* - `skf-select-option-select`: {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
|
2149
|
+
* - `skf-select-connected`: Fires when the select options are connected, useful for setting selected option(s) via value property. E.g mySkfSelect.value = 'option1,option2';
|
2150
|
+
*
|
2151
|
+
* #### Slots
|
2152
|
+
*
|
2153
|
+
* Areas where markup can be added to the component.
|
2154
|
+
*
|
2155
|
+
* - `(default)`: The select's placeholder content
|
2156
|
+
*
|
2157
|
+
* #### Methods
|
2158
|
+
*
|
2159
|
+
* Methods that can be called to access component functionality.
|
2160
|
+
*
|
2161
|
+
* - `_handleSizeUpdate() => void`: undefined
|
2162
|
+
* - `handleExpandedChange() => void`: undefined
|
2163
|
+
*/
|
2164
|
+
"skf-select": Partial<SkfSelectProps & BaseProps<SkfSelect> & BaseEvents>;
|
2165
|
+
|
1287
2166
|
|
1288
2167
|
/**
|
1289
|
-
|
1290
|
-
|
1291
|
-
|
1292
|
-
|
1293
|
-
|
1294
|
-
|
1295
|
-
|
1296
|
-
|
1297
|
-
|
1298
|
-
|
1299
|
-
|
2168
|
+
* The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
|
2169
|
+
* It represents an individual option in a select dropdown.
|
2170
|
+
*
|
2171
|
+
* #### Attributes & Properties
|
2172
|
+
*
|
2173
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2174
|
+
*
|
2175
|
+
* - `disabled`: If true, prevents interaction with the option
|
2176
|
+
* - `icon`: If defined, set an icon
|
2177
|
+
* - `icon-color`/`iconColor`: If defined, sets provided color on the icon
|
2178
|
+
* - `selected`: If true, sets the option as selected
|
2179
|
+
* - `short-label`/`shortLabel`: If defined, sets a short label
|
2180
|
+
* - `value`: Returns or sets the option value. If value is omitted, defaults to the tags slotted text.
|
2181
|
+
* - `text`: The option's label text (equivalent to the tags textContent) (property only)
|
2182
|
+
* - `small`: undefined (property only)
|
2183
|
+
* - `_shortcutUpdate`: undefined (property only)
|
2184
|
+
*
|
2185
|
+
* #### Events
|
2186
|
+
*
|
2187
|
+
* Events that will be emitted by the component.
|
2188
|
+
*
|
2189
|
+
* - `skf-select-option-select`: {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected.
|
2190
|
+
*
|
2191
|
+
* #### Slots
|
2192
|
+
*
|
2193
|
+
* Areas where markup can be added to the component.
|
2194
|
+
*
|
2195
|
+
* - `(default)`: The option's text content
|
2196
|
+
* - `icon`: The option's slot for icon or custom meta information (svg).
|
2197
|
+
*/
|
2198
|
+
"skf-select-option": Partial<SkfSelectOptionProps & BaseProps<SkfSelectOption> & BaseEvents>;
|
2199
|
+
|
1300
2200
|
|
1301
2201
|
/**
|
1302
|
-
|
1303
|
-
|
1304
|
-
|
1305
|
-
|
1306
|
-
|
1307
|
-
|
1308
|
-
|
1309
|
-
|
1310
|
-
|
1311
|
-
|
1312
|
-
|
2202
|
+
* The `<skf-stepper-item>` is used in conjunction with the `<skf-stepper>` component
|
2203
|
+
*
|
2204
|
+
* #### Attributes & Properties
|
2205
|
+
*
|
2206
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2207
|
+
*
|
2208
|
+
* - `state`: If defined, gives the supplied appearance
|
2209
|
+
* - `completed`: If true, item marked as completed
|
2210
|
+
* - `_setInternalState`: undefined (property only)
|
2211
|
+
*
|
2212
|
+
* #### Events
|
2213
|
+
*
|
2214
|
+
* Events that will be emitted by the component.
|
2215
|
+
*
|
2216
|
+
* - `skf-stepper-item-select`: Dispatched when the stepper item is selected
|
2217
|
+
*
|
2218
|
+
* #### Slots
|
2219
|
+
*
|
2220
|
+
* Areas where markup can be added to the component.
|
2221
|
+
*
|
2222
|
+
* - `(default)`: Label of the stepper item
|
2223
|
+
*/
|
2224
|
+
"skf-stepper-item": Partial<SkfStepperItemProps & BaseProps<SkfStepperItem> & BaseEvents>;
|
2225
|
+
|
1313
2226
|
|
1314
2227
|
/**
|
1315
|
-
|
1316
|
-
|
1317
|
-
|
1318
|
-
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1324
|
-
|
2228
|
+
* The `<skf-stepper>` is a component that displays a list of actions or options.
|
2229
|
+
*
|
2230
|
+
* #### Attributes & Properties
|
2231
|
+
*
|
2232
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2233
|
+
*
|
2234
|
+
* - `active-index`/`activeIndex`: Sets the active item
|
2235
|
+
* - `linear`: If true, sets linear mode (user can't go back to completed steps due to dependencies)
|
2236
|
+
*
|
2237
|
+
* #### Events
|
2238
|
+
*
|
2239
|
+
* Events that will be emitted by the component.
|
2240
|
+
*
|
2241
|
+
* - `skf-stepper-item-select`: Dispatched when the stepper item is selected
|
2242
|
+
*
|
2243
|
+
* #### Slots
|
2244
|
+
*
|
2245
|
+
* Areas where markup can be added to the component.
|
2246
|
+
*
|
2247
|
+
* - `(default)`: One or more `<skf-stepper-item>`
|
2248
|
+
*/
|
2249
|
+
"skf-stepper": Partial<SkfStepperProps & BaseProps<SkfStepper> & BaseEvents>;
|
2250
|
+
|
1325
2251
|
|
1326
2252
|
/**
|
1327
|
-
|
1328
|
-
|
1329
|
-
|
1330
|
-
|
1331
|
-
|
1332
|
-
|
1333
|
-
|
1334
|
-
|
2253
|
+
* The `<skf-switch>` is a component that displays a list of actions or options
|
2254
|
+
*
|
2255
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/7282a2-switch) for design principle
|
2256
|
+
*
|
2257
|
+
* #### Attributes & Properties
|
2258
|
+
*
|
2259
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2260
|
+
*
|
2261
|
+
* - `disabled`/`undefined`: If true, sets disabled state
|
2262
|
+
* - `required`/`undefined`: If true, value is required or must be checked for the form to be submittable
|
2263
|
+
* - `debug`: If true, outputs helping hints in console
|
2264
|
+
* - `checked`: If true, outputs helping hints in console
|
2265
|
+
* - `hide-label`/`hideLabel`: If true, hides the label visually
|
2266
|
+
* - `label`: If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute.
|
2267
|
+
* - `lang`: Sets the internal language of the component
|
2268
|
+
* - `name`: If defined, adds name to the input-element
|
2269
|
+
* - `size`: Size of the Switch
|
2270
|
+
* - `value`: The current value of the input field
|
2271
|
+
*
|
2272
|
+
* #### Slots
|
2273
|
+
*
|
2274
|
+
* Areas where markup can be added to the component.
|
2275
|
+
*
|
2276
|
+
* - `(default)`: The Switchs label. Alternatively, you can use the `label` attribute.
|
2277
|
+
*
|
2278
|
+
* #### Methods
|
2279
|
+
*
|
2280
|
+
* Methods that can be called to access component functionality.
|
2281
|
+
*
|
2282
|
+
* - `debugOutput() => void`: undefined
|
2283
|
+
*/
|
2284
|
+
"skf-switch": Partial<SkfSwitchProps & BaseProps<SkfSwitch> & BaseEvents>;
|
2285
|
+
|
1335
2286
|
|
1336
2287
|
/**
|
1337
|
-
|
1338
|
-
|
1339
|
-
|
1340
|
-
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1344
|
-
|
1345
|
-
|
2288
|
+
* The `<skf-tab-panel>` is a component that displays a list of actions or options.
|
2289
|
+
*
|
2290
|
+
* #### Attributes & Properties
|
2291
|
+
*
|
2292
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2293
|
+
*
|
2294
|
+
* - `name`: The tab panel's name.
|
2295
|
+
* - `active`: undefined (property only)
|
2296
|
+
*
|
2297
|
+
* #### Slots
|
2298
|
+
*
|
2299
|
+
* Areas where markup can be added to the component.
|
2300
|
+
*
|
2301
|
+
* - `(default)`: The tab panel's content
|
2302
|
+
*/
|
2303
|
+
"skf-tab-panel": Partial<SkfTabPanelProps & BaseProps<SkfTabPanel> & BaseEvents>;
|
2304
|
+
|
2305
|
+
|
2306
|
+
/**
|
2307
|
+
* The `<skf-tabs>` is a component that displays a list of actions or options
|
2308
|
+
*
|
2309
|
+
* #### Attributes & Properties
|
2310
|
+
*
|
2311
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2312
|
+
*
|
2313
|
+
* - `default-selected`/`defaultSelected`: Sets the default selected tab
|
2314
|
+
* - `no-border`/`noBorder`: If true, removes border
|
2315
|
+
* - `no-padding`/`noPadding`: If true, removes padding
|
2316
|
+
* - `stretch`: If true, component fills the parent element height
|
2317
|
+
* - `variant`: Sets the appearance of the tabs
|
2318
|
+
*
|
2319
|
+
* #### Slots
|
2320
|
+
*
|
2321
|
+
* Areas where markup can be added to the component.
|
2322
|
+
*
|
2323
|
+
* - `(default)`: Used for grouping tab panels in the tab group. Must be <skf-tab-panel> elements
|
2324
|
+
* - `tabs`: Used for grouping tabs in the tab group. Must be <skf-tab> elements
|
2325
|
+
*/
|
2326
|
+
"skf-tabs": Partial<SkfTabsProps & BaseProps<SkfTabs> & BaseEvents>;
|
2327
|
+
|
1346
2328
|
|
1347
2329
|
/**
|
1348
|
-
|
1349
|
-
|
1350
|
-
|
1351
|
-
|
1352
|
-
|
1353
|
-
|
1354
|
-
|
1355
|
-
|
1356
|
-
|
1357
|
-
|
1358
|
-
|
1359
|
-
|
2330
|
+
* The `<skf-tab>` is a component that displays a list of actions or options
|
2331
|
+
*
|
2332
|
+
* #### Attributes & Properties
|
2333
|
+
*
|
2334
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2335
|
+
*
|
2336
|
+
* - `panel`: The name of the tab-panel this tab is associated with. The panel must be located in the same tab group.
|
2337
|
+
* - `selected`: undefined (property only)
|
2338
|
+
* - `variant`: undefined (property only)
|
2339
|
+
*
|
2340
|
+
* #### Events
|
2341
|
+
*
|
2342
|
+
* Events that will be emitted by the component.
|
2343
|
+
*
|
2344
|
+
* - `skf-tab-select`: {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
|
2345
|
+
* - `click`: Fired when the component is clicked
|
2346
|
+
*
|
2347
|
+
* #### Slots
|
2348
|
+
*
|
2349
|
+
* Areas where markup can be added to the component.
|
2350
|
+
*
|
2351
|
+
* - `(default)`: The tab's label
|
2352
|
+
*/
|
2353
|
+
"skf-tab": Partial<SkfTabProps & BaseProps<SkfTab> & BaseEvents>;
|
2354
|
+
|
1360
2355
|
|
1361
2356
|
/**
|
1362
|
-
|
1363
|
-
|
1364
|
-
|
1365
|
-
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1371
|
-
|
1372
|
-
|
1373
|
-
|
2357
|
+
* The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
|
2358
|
+
*
|
2359
|
+
* #### Attributes & Properties
|
2360
|
+
*
|
2361
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2362
|
+
*
|
2363
|
+
* - `disabled`/`undefined`: If true, sets disabled state
|
2364
|
+
* - `required`/`undefined`: If true, value is required or must be checked for the form to be submittable
|
2365
|
+
* - `cols`: If defined, sets the cols of the textarea
|
2366
|
+
* - `custom-invalid`/`customInvalid`: If defined, forces component to invalid state until removed. Its value is used as hint text.
|
2367
|
+
* - `debug`: If true, outputs helping hints in console
|
2368
|
+
* - `hide-label`/`hideLabel`: If true, hides the label visually
|
2369
|
+
* - `hint`: If defined, displays informational text below the field
|
2370
|
+
* - `label`: If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute.
|
2371
|
+
* - `lang`: Sets the internal language of the component
|
2372
|
+
* - `name`: If defined, adds name to the input-element
|
2373
|
+
* - `maxlength`/`maxLength`: If defined, sets the maximum character length to accept for this input
|
2374
|
+
* - `minlength`/`minLength`: If defined, sets the minimum character length to accept for this input
|
2375
|
+
* - `placeholder`: If defined, displays placeholder text
|
2376
|
+
* - `readonly`: If true, makes the element not mutable, meaning the user can not edit the control
|
2377
|
+
* - `rows`: If defined, sets the rows of the textarea
|
2378
|
+
* - `severity`: If defined, displays provided severity state
|
2379
|
+
* - `show-valid`/`showValid`: If true, displays valid state after interaction
|
2380
|
+
* - `size`: Size of the Textarea
|
2381
|
+
* - `validate-on`/`validateOn`: Sets validation start
|
2382
|
+
* - `value`: The current value of the text area
|
2383
|
+
*
|
2384
|
+
* #### Events
|
2385
|
+
*
|
2386
|
+
* Events that will be emitted by the component.
|
2387
|
+
*
|
2388
|
+
* - `change`: Fires when the value of the input changes
|
2389
|
+
* - `invalid`: Fires when the input is invalid
|
2390
|
+
*
|
2391
|
+
* #### Slots
|
2392
|
+
*
|
2393
|
+
* Areas where markup can be added to the component.
|
2394
|
+
*
|
2395
|
+
* - `(default)`: The textareas label. Alternatively, you can use the `label` attribute.
|
2396
|
+
*/
|
2397
|
+
"skf-textarea": Partial<SkfTextAreaProps & BaseProps<SkfTextArea> & BaseEvents>;
|
2398
|
+
|
1374
2399
|
|
1375
2400
|
/**
|
1376
|
-
|
1377
|
-
|
1378
|
-
|
1379
|
-
|
1380
|
-
|
1381
|
-
|
1382
|
-
|
1383
|
-
|
2401
|
+
* 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.
|
2402
|
+
*
|
2403
|
+
* #### Attributes & Properties
|
2404
|
+
*
|
2405
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2406
|
+
*
|
2407
|
+
* - `debug`: undefined
|
2408
|
+
*
|
2409
|
+
* #### Slots
|
2410
|
+
*
|
2411
|
+
* Areas where markup can be added to the component.
|
2412
|
+
*
|
2413
|
+
* - `(default)`: The alert components that the toast creates will render here.
|
2414
|
+
*/
|
2415
|
+
"skf-toast-wrapper": Partial<SkfToastWrapperProps & BaseProps<SkfToastWrapper> & BaseEvents>;
|
2416
|
+
|
1384
2417
|
|
1385
2418
|
/**
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
2419
|
+
* A simple toast component that displays a message to the user. Invoke a toast message by appending a <skf-toast> 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.
|
2420
|
+
*
|
2421
|
+
* #### Attributes & Properties
|
2422
|
+
*
|
2423
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2424
|
+
*
|
2425
|
+
* - `debug`: undefined
|
2426
|
+
* - `icon`: If defined, displays leading icon
|
2427
|
+
* - `persistent`: If true, renders with an close button and sets aria-role to `status`
|
2428
|
+
* - `severity`: If defined, gives the supplied appearance
|
2429
|
+
* - `timer`: Time in seconds before the toast disappears.
|
2430
|
+
* - `topOffset`: offsets where toasts emerge vertically
|
2431
|
+
*
|
2432
|
+
* #### Slots
|
2433
|
+
*
|
2434
|
+
* Areas where markup can be added to the component.
|
2435
|
+
*
|
2436
|
+
* - `(default)`: The component's placeholder content
|
2437
|
+
*/
|
2438
|
+
"skf-toast": Partial<SkfToastProps & BaseProps<SkfToast> & BaseEvents>;
|
2439
|
+
|
1394
2440
|
|
1395
2441
|
/**
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
|
2442
|
+
* The `<skf-tooltip>` is a component that displays a tooltip.
|
2443
|
+
*
|
2444
|
+
* #### Attributes & Properties
|
2445
|
+
*
|
2446
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
2447
|
+
*
|
2448
|
+
* - `placement`/`undefined`: The placement of the dropdown
|
2449
|
+
* - `anchor`/`undefined`: The id of the element the dropdown will be anchored to
|
2450
|
+
* - `offset`: undefined (property only)
|
2451
|
+
* - `placement`: undefined (property only)
|
2452
|
+
* - `variant`: undefined (property only)
|
2453
|
+
* - `open()`: Method that opens the tooltip (property only)
|
2454
|
+
* - `close()`: Method that closes the tooltip (property only)
|
2455
|
+
*
|
2456
|
+
* #### Events
|
2457
|
+
*
|
2458
|
+
* Events that will be emitted by the component.
|
2459
|
+
*
|
2460
|
+
* - `skf-opened`: Fired when the tooltip is opened
|
2461
|
+
* - `skf-closed`: Fired when the tooltip is closed
|
2462
|
+
*
|
2463
|
+
* #### Slots
|
2464
|
+
*
|
2465
|
+
* Areas where markup can be added to the component.
|
2466
|
+
*
|
2467
|
+
* - `(default)`: The tooltip popover content
|
2468
|
+
*/
|
2469
|
+
"skf-tooltip": Partial<SkfTooltipProps & BaseProps<SkfTooltip> & BaseEvents>;
|
2470
|
+
}
|
2471
|
+
|
2472
|
+
declare module 'react' {
|
2473
|
+
namespace JSX {
|
2474
|
+
interface IntrinsicElements extends CustomElements {}
|
2475
|
+
}
|
2476
|
+
}
|
2477
|
+
|
2478
|
+
declare module 'preact' {
|
2479
|
+
namespace JSX {
|
2480
|
+
interface IntrinsicElements extends CustomElements {}
|
2481
|
+
}
|
2482
|
+
}
|
2483
|
+
|
2484
|
+
declare module '@builder.io/qwik' {
|
2485
|
+
namespace JSX {
|
2486
|
+
interface IntrinsicElements extends CustomElements {}
|
2487
|
+
}
|
2488
|
+
}
|
2489
|
+
|
2490
|
+
declare module '@stencil/core' {
|
2491
|
+
namespace JSX {
|
2492
|
+
interface IntrinsicElements extends CustomElements {}
|
2493
|
+
}
|
2494
|
+
}
|
2495
|
+
|
2496
|
+
declare module 'hono' {
|
2497
|
+
namespace JSX {
|
2498
|
+
interface IntrinsicElements extends CustomElements {}
|
2499
|
+
}
|
2500
|
+
}
|
2501
|
+
|
2502
|
+
declare module 'react-native' {
|
2503
|
+
namespace JSX {
|
2504
|
+
interface IntrinsicElements extends CustomElements {}
|
2505
|
+
}
|
2506
|
+
}
|
2507
|
+
|
2508
|
+
declare global {
|
2509
|
+
namespace JSX {
|
2510
|
+
interface IntrinsicElements extends CustomElements {}
|
2511
|
+
}
|
2512
|
+
}
|