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