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