@skf-design-system/ui-components 0.0.1-beta.4 → 1.0.0-alpha.28
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 +26 -6
- package/custom-elements.json +18265 -0
- package/dist/components/accordion/accordion.component.d.ts +9 -5
- package/dist/components/accordion/accordion.component.js +22 -19
- package/dist/components/accordion/accordion.d.ts +1 -1
- package/dist/components/accordion/accordion.styles.js +3 -3
- package/dist/components/alert/alert.component.d.ts +7 -4
- package/dist/components/alert/alert.component.js +21 -19
- package/dist/components/alert/alert.styles.js +50 -47
- package/dist/components/button/button.component.d.ts +24 -0
- package/dist/components/button/button.component.js +80 -56
- package/dist/components/button/button.styles.js +2 -1
- package/dist/components/card/card.component.d.ts +3 -3
- package/dist/components/card/card.component.js +16 -19
- package/dist/components/card/card.styles.js +11 -3
- package/dist/components/checkbox/checkbox.component.d.ts +17 -15
- package/dist/components/checkbox/checkbox.component.js +95 -89
- package/dist/components/checkbox/checkbox.styles.js +7 -2
- package/dist/components/checkbox/checkbox.test.d.ts +1 -0
- package/dist/components/collapse/collapse.component.d.ts +9 -6
- package/dist/components/collapse/collapse.component.js +39 -36
- package/dist/components/collapse/collapse.styles.js +3 -3
- package/dist/components/collapse/collapse.test.d.ts +1 -0
- package/dist/components/divider/divider.component.d.ts +13 -10
- package/dist/components/divider/divider.component.js +34 -29
- package/dist/components/divider/divider.styles.js +1 -5
- package/dist/components/heading/heading.component.d.ts +12 -2
- package/dist/components/heading/heading.component.js +14 -14
- package/dist/components/heading/heading.styles.js +1 -1
- package/dist/components/icon/icon.component.d.ts +14 -8
- package/dist/components/icon/icon.component.js +6 -6
- package/dist/components/icon/icon.styles.js +56 -54
- package/dist/components/input/input.component.d.ts +44 -29
- package/dist/components/input/input.component.js +118 -111
- package/dist/components/link/link.component.d.ts +15 -12
- package/dist/components/link/link.component.js +7 -7
- package/dist/components/link/link.styles.js +1 -1
- package/dist/components/loader/loader.component.d.ts +7 -7
- package/dist/components/loader/loader.component.js +35 -61
- package/dist/components/loader/loader.styles.js +42 -10
- package/dist/components/logo/logo.component.d.ts +5 -3
- package/dist/components/logo/logo.component.js +8 -8
- package/dist/components/logo/logo.styles.js +2 -2
- package/dist/components/progress/progress.component.d.ts +22 -0
- package/dist/components/progress/progress.component.js +40 -0
- package/dist/components/progress/progress.d.ts +8 -0
- package/dist/components/progress/progress.js +6 -0
- package/dist/components/progress/progress.styles.d.ts +1 -0
- package/dist/components/progress/progress.styles.js +47 -0
- package/dist/components/radio/radio.component.d.ts +18 -18
- package/dist/components/radio/radio.component.js +94 -78
- package/dist/components/radio/radio.styles.js +6 -1
- package/dist/components/select/select.component.d.ts +140 -0
- package/dist/components/select/select.component.js +327 -0
- package/dist/components/select/select.controllers.d.ts +59 -0
- package/dist/components/select/select.controllers.js +172 -0
- package/dist/components/select/select.d.ts +8 -0
- package/dist/components/select/select.js +6 -0
- package/dist/components/select/select.styles.d.ts +1 -0
- package/dist/components/select/select.styles.js +131 -0
- package/dist/components/select-option/select-option.component.d.ts +77 -0
- package/dist/components/select-option/select-option.component.js +123 -0
- package/dist/components/select-option/select-option.controllers.d.ts +9 -0
- package/dist/components/select-option/select-option.d.ts +8 -0
- package/dist/components/select-option/select-option.js +6 -0
- package/dist/components/select-option/select-option.styles.d.ts +1 -0
- package/dist/components/select-option/select-option.styles.js +53 -0
- package/dist/components/select-option-group/select-option-group.component.d.ts +16 -0
- package/dist/components/select-option-group/select-option-group.component.js +31 -0
- package/dist/components/select-option-group/select-option-group.d.ts +8 -0
- package/dist/components/select-option-group/select-option-group.js +6 -0
- package/dist/components/select-option-group/select-option-group.style.d.ts +1 -0
- package/dist/components/select-option-group/select-option-group.style.js +18 -0
- package/dist/components/switch/switch.component.d.ts +2 -3
- package/dist/components/switch/switch.component.js +5 -2
- package/dist/components/switch/switch.styles.js +6 -1
- package/dist/components/switch/switch.test.d.ts +1 -0
- package/dist/components/tab/tab.component.d.ts +29 -0
- package/dist/components/tab/tab.component.js +57 -0
- package/dist/components/tab/tab.d.ts +8 -0
- package/dist/components/tab/tab.js +6 -0
- package/dist/components/tab/tab.styles.d.ts +1 -0
- package/dist/components/tab/tab.styles.js +123 -0
- package/dist/components/tab-group/tab-group.component.d.ts +43 -0
- package/dist/components/tab-group/tab-group.component.js +98 -0
- package/dist/components/tab-group/tab-group.d.ts +8 -0
- package/dist/components/tab-group/tab-group.js +6 -0
- package/dist/components/tab-group/tab-group.styles.d.ts +1 -0
- package/dist/components/tab-group/tab-group.styles.js +75 -0
- package/dist/components/tab-panel/tab-panel.component.d.ts +19 -0
- package/dist/components/tab-panel/tab-panel.component.js +36 -0
- package/dist/components/tab-panel/tab-panel.d.ts +8 -0
- package/dist/components/tab-panel/tab-panel.js +6 -0
- package/dist/components/tab-panel/tab-panel.styles.d.ts +1 -0
- package/dist/components/tab-panel/tab-panel.styles.js +13 -0
- package/dist/components/tag/tag.component.d.ts +25 -4
- package/dist/components/tag/tag.component.js +66 -29
- package/dist/components/tag/tag.styles.js +6 -5
- package/dist/components/textarea/textarea.component.d.ts +26 -23
- package/dist/components/textarea/textarea.component.js +20 -17
- package/dist/components/toast/toast.component.d.ts +35 -0
- package/dist/components/toast/toast.component.js +52 -0
- package/dist/components/toast/toast.d.ts +8 -0
- package/dist/components/toast/toast.js +6 -0
- package/dist/components/toast/toast.singleton.d.ts +26 -0
- package/dist/components/toast/toast.singleton.js +53 -0
- package/dist/components/toast/toast.styles.d.ts +1 -0
- package/dist/components/toast/toast.styles.js +9 -0
- package/dist/components/toast-item/toast-item.component.d.ts +21 -0
- package/dist/components/toast-item/toast-item.component.js +65 -0
- package/dist/components/toast-item/toast-item.d.ts +6 -0
- package/dist/components/toast-item/toast-item.js +2 -0
- package/dist/components/toast-item/toast-item.styles.d.ts +2 -0
- package/dist/components/toast-item/toast-item.styles.js +16 -0
- package/dist/components/toast-wrapper/toast-wrapper.component.d.ts +24 -0
- package/dist/components/toast-wrapper/toast-wrapper.component.js +37 -0
- package/dist/components/toast-wrapper/toast-wrapper.d.ts +8 -0
- package/dist/components/toast-wrapper/toast-wrapper.js +6 -0
- package/dist/components/toast-wrapper/toast-wrapper.styles.d.ts +1 -0
- package/dist/components/toast-wrapper/toast-wrapper.styles.js +20 -0
- package/dist/custom-elements.json +2146 -616
- package/dist/index.d.ts +8 -0
- package/dist/index.js +60 -36
- package/dist/internal/components/formBase.d.ts +19 -1
- package/dist/internal/components/formBase.js +29 -17
- package/dist/internal/components/hint/hint.component.js +12 -10
- package/dist/internal/components/hint/hint.styles.js +26 -10
- package/dist/internal/components/skf-element.d.ts +4 -4
- package/dist/internal/components/skf-element.js +15 -19
- package/dist/internal/helpers/array.d.ts +4 -0
- package/dist/internal/helpers/findMatchingTags.d.ts +2 -0
- package/dist/internal/helpers/findMatchingTags.js +12 -0
- package/dist/internal/helpers/hintSeverity.d.ts +2 -0
- package/dist/internal/helpers/hintSeverity.js +6 -0
- package/dist/internal/helpers/raiseError.d.ts +28 -0
- package/dist/internal/helpers/raiseError.js +29 -0
- package/dist/internal/helpers/watch.d.ts +27 -0
- package/dist/internal/helpers/watch.js +28 -0
- package/dist/internal/storybook/shadowRootTraverser.d.ts +16 -6
- package/dist/react/index.d.ts +9 -0
- package/dist/react/index.js +9 -0
- package/dist/react/skf-button/index.d.ts +7 -1
- package/dist/react/skf-button/index.js +5 -1
- package/dist/react/skf-progress/index.d.ts +3 -0
- package/dist/react/skf-progress/index.js +13 -0
- package/dist/react/skf-select/index.d.ts +21 -0
- package/dist/react/skf-select/index.js +21 -0
- package/dist/react/skf-select-option/index.d.ts +9 -0
- package/dist/react/skf-select-option/index.js +17 -0
- package/dist/react/skf-select-option-group/index.d.ts +3 -0
- package/dist/react/skf-select-option-group/index.js +13 -0
- package/dist/react/skf-tab/index.d.ts +12 -0
- package/dist/react/skf-tab/index.js +18 -0
- package/dist/react/skf-tab-group/index.d.ts +3 -0
- package/dist/react/skf-tab-group/index.js +13 -0
- package/dist/react/skf-tab-panel/index.d.ts +3 -0
- package/dist/react/skf-tab-panel/index.js +13 -0
- package/dist/react/skf-toast/index.d.ts +3 -0
- package/dist/react/skf-toast/index.js +13 -0
- package/dist/react/skf-toast-wrapper/index.d.ts +3 -0
- package/dist/react/skf-toast-wrapper/index.js +13 -0
- package/dist/styles/form-field.styles.js +11 -7
- package/dist/types/jsx/custom-element-jsx.d.ts +166 -995
- package/dist/types/vue/index.d.ts +368 -94
- package/dist/vscode.html-custom-data.json +408 -106
- package/dist/web-types.json +932 -281
- package/package.json +39 -35
@@ -1,3 +1,30 @@
|
|
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
|
+
|
1
28
|
/**
|
2
29
|
* This type can be used to create scoped tags for your components.
|
3
30
|
*
|
@@ -58,986 +85,18 @@ type BaseProps = {
|
|
58
85
|
translate?: "yes" | "no";
|
59
86
|
};
|
60
87
|
|
61
|
-
type BaseEvents = {};
|
62
|
-
|
63
|
-
export type SkfAccordionProps = {
|
64
|
-
/** If true, will animate the expand/collapse state */
|
65
|
-
animated?: boolean | undefined;
|
66
|
-
/** Controls which heading element will be rendered */
|
67
|
-
"heading-as"?: Exclude<HeadingType, "h1">;
|
68
|
-
/** If provided, adds a gap between each item */
|
69
|
-
gap?: boolean | undefined;
|
70
|
-
/** If true, allowes multiple accordion items to open */
|
71
|
-
multiple?: boolean | undefined;
|
72
|
-
/** If true, renders the small version */
|
73
|
-
small?: boolean | undefined;
|
74
|
-
/** If true, will truncate all headings in collapsed state */
|
75
|
-
truncate?: boolean | undefined;
|
76
|
-
};
|
77
|
-
|
78
|
-
export type SkfAlertProps = {
|
79
|
-
/** If true, alert is being used as a toast with an close button */
|
80
|
-
closeable?: boolean | undefined;
|
81
|
-
/** Close button aria-label */
|
82
|
-
"button-label"?: string;
|
83
|
-
/** If defined, displays leading icon */
|
84
|
-
icon?: SkfIcon["name"] | undefined;
|
85
|
-
/** If defined, gives the supplied appearance */
|
86
|
-
severity?: SeverityFgColor | undefined;
|
87
|
-
|
88
|
-
/** Fires when the close button is clicked */
|
89
|
-
"onskf-alert-close"?: (e: CustomEvent<never>) => void;
|
90
|
-
};
|
91
|
-
|
92
|
-
export type SkfButtonProps = {
|
93
|
-
/** If true, gives destructive appearance. **Notice!** Only applicable if `variant` is `primary`. */
|
94
|
-
destructive?: boolean;
|
95
|
-
/** If true, removes border */
|
96
|
-
disabled?: boolean;
|
97
|
-
/** If provided, renders an icon before or after the text */
|
98
|
-
icon?:
|
99
|
-
| "arrowDown"
|
100
|
-
| "arrowDownUp"
|
101
|
-
| "arrowLeft"
|
102
|
-
| "arrowRight"
|
103
|
-
| "arrowUp"
|
104
|
-
| "article"
|
105
|
-
| "artificialIntelligence"
|
106
|
-
| "asset"
|
107
|
-
| "attachment"
|
108
|
-
| "bandCursor"
|
109
|
-
| "bands"
|
110
|
-
| "batteryEmpty"
|
111
|
-
| "batteryFull"
|
112
|
-
| "batteryLow"
|
113
|
-
| "bearingFault"
|
114
|
-
| "book"
|
115
|
-
| "bulb"
|
116
|
-
| "burger"
|
117
|
-
| "cPM"
|
118
|
-
| "calendar"
|
119
|
-
| "calendarBooked"
|
120
|
-
| "calendarEmpty"
|
121
|
-
| "calendarNotBooked"
|
122
|
-
| "calendarRecurring"
|
123
|
-
| "caretDown"
|
124
|
-
| "caretUp"
|
125
|
-
| "caretUpDown"
|
126
|
-
| "chat"
|
127
|
-
| "check"
|
128
|
-
| "checkCircle"
|
129
|
-
| "checkSmall"
|
130
|
-
| "chevronDown"
|
131
|
-
| "chevronLeft"
|
132
|
-
| "chevronRight"
|
133
|
-
| "chevronUp"
|
134
|
-
| "chevronUpDown"
|
135
|
-
| "close"
|
136
|
-
| "closeAllFaults"
|
137
|
-
| "closeFault"
|
138
|
-
| "closeSmall"
|
139
|
-
| "columnGraph"
|
140
|
-
| "comment"
|
141
|
-
| "connection1"
|
142
|
-
| "connection2"
|
143
|
-
| "connection3"
|
144
|
-
| "connection4"
|
145
|
-
| "danger"
|
146
|
-
| "defectFrequencies"
|
147
|
-
| "defectFrequenciesAlternative"
|
148
|
-
| "doubleChevronLeft"
|
149
|
-
| "doubleChevronRight"
|
150
|
-
| "download"
|
151
|
-
| "draft"
|
152
|
-
| "draftFilled"
|
153
|
-
| "draftOutlined"
|
154
|
-
| "dragNDrop"
|
155
|
-
| "drop"
|
156
|
-
| "duplicate"
|
157
|
-
| "edit"
|
158
|
-
| "emailFilled"
|
159
|
-
| "emailOutlined"
|
160
|
-
| "exclamation"
|
161
|
-
| "eye"
|
162
|
-
| "eyeHidden"
|
163
|
-
| "eyeVisible"
|
164
|
-
| "filter"
|
165
|
-
| "forbidden"
|
166
|
-
| "fullScreen"
|
167
|
-
| "fullScreenExit"
|
168
|
-
| "functionalLocation"
|
169
|
-
| "harmonicCursor"
|
170
|
-
| "heatmap"
|
171
|
-
| "hierarchy"
|
172
|
-
| "history"
|
173
|
-
| "historyAlt"
|
174
|
-
| "hourglassFramedFilled"
|
175
|
-
| "hourglassFramedOutlined"
|
176
|
-
| "hourglassOutlined"
|
177
|
-
| "hz"
|
178
|
-
| "iMX"
|
179
|
-
| "image"
|
180
|
-
| "infoCircleFilled"
|
181
|
-
| "infoCircleOutlined"
|
182
|
-
| "integration"
|
183
|
-
| "kebab"
|
184
|
-
| "link"
|
185
|
-
| "listGroup"
|
186
|
-
| "listItem"
|
187
|
-
| "locationPin"
|
188
|
-
| "lock"
|
189
|
-
| "logOut"
|
190
|
-
| "meatballs"
|
191
|
-
| "microphone"
|
192
|
-
| "minus"
|
193
|
-
| "minusSmall"
|
194
|
-
| "noData"
|
195
|
-
| "o"
|
196
|
-
| "openInNew"
|
197
|
-
| "overlayBaseline"
|
198
|
-
| "pDF"
|
199
|
-
| "paper"
|
200
|
-
| "pause"
|
201
|
-
| "pieChart"
|
202
|
-
| "pin"
|
203
|
-
| "play"
|
204
|
-
| "plus"
|
205
|
-
| "powerOff"
|
206
|
-
| "printer"
|
207
|
-
| "proCollect"
|
208
|
-
| "recAction"
|
209
|
-
| "received"
|
210
|
-
| "refresh"
|
211
|
-
| "reorder"
|
212
|
-
| "replace"
|
213
|
-
| "reply"
|
214
|
-
| "rewalkableRoute"
|
215
|
-
| "routes"
|
216
|
-
| "search"
|
217
|
-
| "send"
|
218
|
-
| "sensorA"
|
219
|
-
| "sensorB"
|
220
|
-
| "settings"
|
221
|
-
| "sidebandCursor"
|
222
|
-
| "singleCursor"
|
223
|
-
| "spectrum"
|
224
|
-
| "starFilled"
|
225
|
-
| "starOutlined"
|
226
|
-
| "statusCircle"
|
227
|
-
| "stop"
|
228
|
-
| "structuralVibration"
|
229
|
-
| "sync"
|
230
|
-
| "timewave"
|
231
|
-
| "trash"
|
232
|
-
| "trend"
|
233
|
-
| "trendingUp"
|
234
|
-
| "undo"
|
235
|
-
| "unknownCircle"
|
236
|
-
| "unknownDiamond"
|
237
|
-
| "unlink"
|
238
|
-
| "unlock"
|
239
|
-
| "unscheduledAction"
|
240
|
-
| "upload"
|
241
|
-
| "user"
|
242
|
-
| "viewFull"
|
243
|
-
| "viewHorizontal"
|
244
|
-
| "viewVertical"
|
245
|
-
| "warning"
|
246
|
-
| "warningCircle"
|
247
|
-
| "warningDiamond"
|
248
|
-
| "zoomIn"
|
249
|
-
| "zoomOut";
|
250
|
-
/** If provided, determines the positioning of the icon in relation to the text */
|
251
|
-
"icon-position"?: "left" | "right" | undefined;
|
252
|
-
/** If true, hides text & icon and shows loading indicator. **Notice!** Only applicable if `variant` is `primary`. */
|
253
|
-
loading?: boolean;
|
254
|
-
/** If provided, displays an alternative size */
|
255
|
-
size?: "sm" | "md" | "lg";
|
256
|
-
/** If provided, changes the button type */
|
257
|
-
type?: "button" | "submit" | "reset";
|
258
|
-
/** If provided, alters the appearance */
|
259
|
-
variant?: "primary" | "secondary";
|
260
|
-
};
|
261
|
-
|
262
|
-
export type SkfCardProps = {
|
263
|
-
/** If true, removes border */
|
264
|
-
"no-border"?: boolean;
|
265
|
-
/** If true, removes padding */
|
266
|
-
"no-padding"?: boolean;
|
267
|
-
/** If true, the Card fills the parent element height */
|
268
|
-
stretch?: boolean;
|
269
|
-
};
|
270
|
-
|
271
|
-
export type SkfCheckboxProps = {
|
272
|
-
/** If true, sets disabled state */
|
273
|
-
disabled?: boolean;
|
274
|
-
/** If true, value is required or must be checked for the form to be submittable */
|
275
|
-
required?: boolean;
|
276
|
-
/** If defined, outputs helping hints in console */
|
277
|
-
debug?: boolean | undefined;
|
278
|
-
/** If true, outputs helping hints in console */
|
279
|
-
checked?: boolean | undefined;
|
280
|
-
/** If true, forces component to invalid state until removed */
|
281
|
-
"custom-invalid"?: boolean | undefined;
|
282
|
-
/** If true, hides the label visually */
|
283
|
-
"hide-label"?: boolean | undefined;
|
284
|
-
/** If true and the checkbox is unchecked, the checkbox will appear indeterminate */
|
285
|
-
indeterminate?: boolean | undefined;
|
286
|
-
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
287
|
-
label?: string | undefined;
|
288
|
-
/** If defined, adds name to the input-element */
|
289
|
-
name?: string | undefined;
|
290
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
291
|
-
"required-label"?: string | undefined;
|
292
|
-
/** Size of the checkbox */
|
293
|
-
size?: "sm" | "md";
|
294
|
-
/** If defined, styles checkbox using provided severity */
|
295
|
-
severity?: FormFieldBaseProps["severity"] | undefined;
|
296
|
-
/** If defined, displays valid state after interaction */
|
297
|
-
"show-valid"?: boolean | undefined;
|
298
|
-
/** The current value of the input field */
|
299
|
-
value?: string;
|
300
|
-
|
301
|
-
/** {object} - When the value of the input changes */
|
302
|
-
onchange?: (e: CustomEvent<never>) => void;
|
303
|
-
};
|
304
|
-
|
305
|
-
export type SkfCollapseProps = {
|
306
|
-
/** If true, will animate the expand/collapse state */
|
307
|
-
animated?: boolean;
|
308
|
-
/** If true, will set the collapse to be expanded by default */
|
309
|
-
expanded?: boolean;
|
310
|
-
/** Heading for the collapse */
|
311
|
-
heading?: string | undefined;
|
312
|
-
/** Controls which heading element will be rendered */
|
313
|
-
"heading-as"?: Exclude<HeadingType, "h1">;
|
314
|
-
/** If true, renders the small version */
|
315
|
-
small?: boolean;
|
316
|
-
/** If true, will truncate the heading in collapsed state */
|
317
|
-
truncate?: boolean;
|
318
|
-
|
319
|
-
/** Event emitted when toggled */
|
320
|
-
"onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
|
321
|
-
};
|
322
|
-
|
323
|
-
export type SkfDividerProps = {
|
324
|
-
/** If provided, alters the Divider color */
|
325
|
-
color?: "emphasised" | "primary" | "secondary" | "tertiary" | "inverse";
|
326
|
-
/** If true, renders a div for presentational purpose instead of the semantic hr-element */
|
327
|
-
decorative?: boolean;
|
328
|
-
/** If true, renders the divider vertically */
|
329
|
-
vertical?: boolean;
|
330
|
-
};
|
331
|
-
|
332
|
-
export type SkfHeadingProps = {
|
333
|
-
/** Controls which heading element will be rendered. Should not be used to affect appearance. */
|
334
|
-
as?: HeadingType;
|
335
|
-
/** If provided, changes the appearance of the heading */
|
336
|
-
"styled-as"?: HeadingType | undefined;
|
337
|
-
};
|
338
|
-
|
339
|
-
export type SkfIconProps = {
|
340
|
-
/** */
|
341
|
-
color?: "primary" | "inverse" | "emphasised" | "secondary" | "success" | "info" | "warning" | "error" | "alert";
|
342
|
-
/** If provided, adds an alternate description to use for assistive devices */
|
343
|
-
label?: string | undefined;
|
344
|
-
/** */
|
345
|
-
name?:
|
346
|
-
| "arrowDown"
|
347
|
-
| "arrowDownUp"
|
348
|
-
| "arrowLeft"
|
349
|
-
| "arrowRight"
|
350
|
-
| "arrowUp"
|
351
|
-
| "article"
|
352
|
-
| "artificialIntelligence"
|
353
|
-
| "asset"
|
354
|
-
| "attachment"
|
355
|
-
| "bandCursor"
|
356
|
-
| "bands"
|
357
|
-
| "batteryEmpty"
|
358
|
-
| "batteryFull"
|
359
|
-
| "batteryLow"
|
360
|
-
| "bearingFault"
|
361
|
-
| "book"
|
362
|
-
| "bulb"
|
363
|
-
| "burger"
|
364
|
-
| "cPM"
|
365
|
-
| "calendar"
|
366
|
-
| "calendarBooked"
|
367
|
-
| "calendarEmpty"
|
368
|
-
| "calendarNotBooked"
|
369
|
-
| "calendarRecurring"
|
370
|
-
| "caretDown"
|
371
|
-
| "caretUp"
|
372
|
-
| "caretUpDown"
|
373
|
-
| "chat"
|
374
|
-
| "check"
|
375
|
-
| "checkCircle"
|
376
|
-
| "checkSmall"
|
377
|
-
| "chevronDown"
|
378
|
-
| "chevronLeft"
|
379
|
-
| "chevronRight"
|
380
|
-
| "chevronUp"
|
381
|
-
| "chevronUpDown"
|
382
|
-
| "close"
|
383
|
-
| "closeAllFaults"
|
384
|
-
| "closeFault"
|
385
|
-
| "closeSmall"
|
386
|
-
| "columnGraph"
|
387
|
-
| "comment"
|
388
|
-
| "connection1"
|
389
|
-
| "connection2"
|
390
|
-
| "connection3"
|
391
|
-
| "connection4"
|
392
|
-
| "danger"
|
393
|
-
| "defectFrequencies"
|
394
|
-
| "defectFrequenciesAlternative"
|
395
|
-
| "doubleChevronLeft"
|
396
|
-
| "doubleChevronRight"
|
397
|
-
| "download"
|
398
|
-
| "draft"
|
399
|
-
| "draftFilled"
|
400
|
-
| "draftOutlined"
|
401
|
-
| "dragNDrop"
|
402
|
-
| "drop"
|
403
|
-
| "duplicate"
|
404
|
-
| "edit"
|
405
|
-
| "emailFilled"
|
406
|
-
| "emailOutlined"
|
407
|
-
| "exclamation"
|
408
|
-
| "eye"
|
409
|
-
| "eyeHidden"
|
410
|
-
| "eyeVisible"
|
411
|
-
| "filter"
|
412
|
-
| "forbidden"
|
413
|
-
| "fullScreen"
|
414
|
-
| "fullScreenExit"
|
415
|
-
| "functionalLocation"
|
416
|
-
| "harmonicCursor"
|
417
|
-
| "heatmap"
|
418
|
-
| "hierarchy"
|
419
|
-
| "history"
|
420
|
-
| "historyAlt"
|
421
|
-
| "hourglassFramedFilled"
|
422
|
-
| "hourglassFramedOutlined"
|
423
|
-
| "hourglassOutlined"
|
424
|
-
| "hz"
|
425
|
-
| "iMX"
|
426
|
-
| "image"
|
427
|
-
| "infoCircleFilled"
|
428
|
-
| "infoCircleOutlined"
|
429
|
-
| "integration"
|
430
|
-
| "kebab"
|
431
|
-
| "link"
|
432
|
-
| "listGroup"
|
433
|
-
| "listItem"
|
434
|
-
| "locationPin"
|
435
|
-
| "lock"
|
436
|
-
| "logOut"
|
437
|
-
| "meatballs"
|
438
|
-
| "microphone"
|
439
|
-
| "minus"
|
440
|
-
| "minusSmall"
|
441
|
-
| "noData"
|
442
|
-
| "o"
|
443
|
-
| "openInNew"
|
444
|
-
| "overlayBaseline"
|
445
|
-
| "pDF"
|
446
|
-
| "paper"
|
447
|
-
| "pause"
|
448
|
-
| "pieChart"
|
449
|
-
| "pin"
|
450
|
-
| "play"
|
451
|
-
| "plus"
|
452
|
-
| "powerOff"
|
453
|
-
| "printer"
|
454
|
-
| "proCollect"
|
455
|
-
| "recAction"
|
456
|
-
| "received"
|
457
|
-
| "refresh"
|
458
|
-
| "reorder"
|
459
|
-
| "replace"
|
460
|
-
| "reply"
|
461
|
-
| "rewalkableRoute"
|
462
|
-
| "routes"
|
463
|
-
| "search"
|
464
|
-
| "send"
|
465
|
-
| "sensorA"
|
466
|
-
| "sensorB"
|
467
|
-
| "settings"
|
468
|
-
| "sidebandCursor"
|
469
|
-
| "singleCursor"
|
470
|
-
| "spectrum"
|
471
|
-
| "starFilled"
|
472
|
-
| "starOutlined"
|
473
|
-
| "statusCircle"
|
474
|
-
| "stop"
|
475
|
-
| "structuralVibration"
|
476
|
-
| "sync"
|
477
|
-
| "timewave"
|
478
|
-
| "trash"
|
479
|
-
| "trend"
|
480
|
-
| "trendingUp"
|
481
|
-
| "undo"
|
482
|
-
| "unknownCircle"
|
483
|
-
| "unknownDiamond"
|
484
|
-
| "unlink"
|
485
|
-
| "unlock"
|
486
|
-
| "unscheduledAction"
|
487
|
-
| "upload"
|
488
|
-
| "user"
|
489
|
-
| "viewFull"
|
490
|
-
| "viewHorizontal"
|
491
|
-
| "viewVertical"
|
492
|
-
| "warning"
|
493
|
-
| "warningCircle"
|
494
|
-
| "warningDiamond"
|
495
|
-
| "zoomIn"
|
496
|
-
| "zoomOut";
|
497
|
-
/** */
|
498
|
-
size?: "xs" | "sm" | "md" | "lg";
|
499
|
-
};
|
500
|
-
|
501
|
-
export type SkfInputProps = {
|
502
|
-
/** If true, sets disabled state */
|
503
|
-
disabled?: boolean;
|
504
|
-
/** If true, value is required or must be checked for the form to be submittable */
|
505
|
-
required?: boolean;
|
506
|
-
/** If provided, renders a custom aria-label for the clear button **Notice!** Only applicable to type=search. */
|
507
|
-
"button-aria-label-clear"?: string;
|
508
|
-
/** If provided, renders a custom aria-label for the visibility button. **Notice!** Only applicable to type=password. */
|
509
|
-
"button-aria-label-hide"?: string;
|
510
|
-
/** If provided, renders a custom aria-label for the visibility button **Notice!** Only applicable to type=password. */
|
511
|
-
"button-aria-label-show"?: string;
|
512
|
-
/** If provided, forces component to invalid state until removed. Its value is used as hint text. */
|
513
|
-
"custom-invalid"?: string;
|
514
|
-
/** If provided, outputs helping hints in console */
|
515
|
-
debug?: boolean;
|
516
|
-
/** If true, hides the label visually */
|
517
|
-
"hide-label"?: boolean;
|
518
|
-
/** If provided, displays informational text below the field */
|
519
|
-
hint?: string | undefined;
|
520
|
-
/** If provided, tells what keyboard to use if applicable */
|
521
|
-
inputmode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search";
|
522
|
-
/** The input's label. Alternatively, you can use the `label` attribute. */
|
523
|
-
label?: string | undefined;
|
524
|
-
/** If provided, displays a prefix/adornment before the input-element */
|
525
|
-
leading?: string | undefined;
|
526
|
-
/** If provided, sets the maximum value to accept for this input */
|
527
|
-
max?: number | string | undefined;
|
528
|
-
/** If provided, sets the maximum character length to accept for this input */
|
529
|
-
maxlength?: number | undefined;
|
530
|
-
/** If provided, sets the minimum value to accept for this input */
|
531
|
-
min?: number | string | undefined;
|
532
|
-
/** If provided, sets the minimum character length to accept for this input */
|
533
|
-
minlength?: number | undefined;
|
534
|
-
/** If provided, adds name to the input-element */
|
535
|
-
name?: string | undefined;
|
536
|
-
/** If provided, adds name to the input-element */
|
537
|
-
pattern?: string | undefined;
|
538
|
-
/** If provided, displays placeholder text */
|
539
|
-
placeholder?: string | undefined;
|
540
|
-
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
541
|
-
readonly?: boolean | undefined;
|
542
|
-
/** If provided, renders an alternative A11y text for the asterisk */
|
543
|
-
"required-label"?: string | undefined;
|
544
|
-
/** If provided, displays provided severity state */
|
545
|
-
severity?: FormFieldBaseProps["severity"] | undefined;
|
546
|
-
/** If provided, displays provided severity state */
|
547
|
-
"show-valid"?: boolean | undefined;
|
548
|
-
/** If provided, displays an alternative size */
|
549
|
-
size?: "sm" | "md" | undefined;
|
550
|
-
/** If provided, displays a suffix/adornment after the input-element */
|
551
|
-
trailing?: string | undefined;
|
552
|
-
/** If provided, changes the type of form control */
|
553
|
-
type?: Exclude<FormFieldBaseProps["type"], "checkbox" | "radio"> | undefined;
|
554
|
-
/** If provided, sets validation start, "input", "change" or "submit" */
|
555
|
-
"validate-on"?: "input" | "change" | "submit" | undefined;
|
556
|
-
/** The current value of the input field */
|
557
|
-
value?: string;
|
558
|
-
/** */
|
559
|
-
_numberController?: string;
|
560
|
-
/** */
|
561
|
-
_passwordController?: string;
|
562
|
-
/** Fires when the value of the input changes */
|
563
|
-
onchange?: (e: CustomEvent<never>) => void;
|
564
|
-
/** Fires when the input is invalid */
|
565
|
-
oninvalid?: (e: CustomEvent<never>) => void;
|
566
|
-
};
|
567
|
-
|
568
|
-
export type SkfLinkProps = {
|
569
|
-
/** Specifies semantic element to render - */
|
570
|
-
as?: "button" | "a";
|
571
|
-
/** */
|
572
|
-
color?: "primary" | "inverse";
|
573
|
-
/** If true, disables the link */
|
574
|
-
disabled?: boolean | undefined;
|
575
|
-
/** If provided, downloads the url */
|
576
|
-
download?: string | undefined;
|
577
|
-
/** If provided, loads url on click */
|
578
|
-
href?: string | undefined;
|
579
|
-
/** If provided, renders an icon before or after the text */
|
580
|
-
icon?:
|
581
|
-
| "arrowDown"
|
582
|
-
| "arrowDownUp"
|
583
|
-
| "arrowLeft"
|
584
|
-
| "arrowRight"
|
585
|
-
| "arrowUp"
|
586
|
-
| "article"
|
587
|
-
| "artificialIntelligence"
|
588
|
-
| "asset"
|
589
|
-
| "attachment"
|
590
|
-
| "bandCursor"
|
591
|
-
| "bands"
|
592
|
-
| "batteryEmpty"
|
593
|
-
| "batteryFull"
|
594
|
-
| "batteryLow"
|
595
|
-
| "bearingFault"
|
596
|
-
| "book"
|
597
|
-
| "bulb"
|
598
|
-
| "burger"
|
599
|
-
| "cPM"
|
600
|
-
| "calendar"
|
601
|
-
| "calendarBooked"
|
602
|
-
| "calendarEmpty"
|
603
|
-
| "calendarNotBooked"
|
604
|
-
| "calendarRecurring"
|
605
|
-
| "caretDown"
|
606
|
-
| "caretUp"
|
607
|
-
| "caretUpDown"
|
608
|
-
| "chat"
|
609
|
-
| "check"
|
610
|
-
| "checkCircle"
|
611
|
-
| "checkSmall"
|
612
|
-
| "chevronDown"
|
613
|
-
| "chevronLeft"
|
614
|
-
| "chevronRight"
|
615
|
-
| "chevronUp"
|
616
|
-
| "chevronUpDown"
|
617
|
-
| "close"
|
618
|
-
| "closeAllFaults"
|
619
|
-
| "closeFault"
|
620
|
-
| "closeSmall"
|
621
|
-
| "columnGraph"
|
622
|
-
| "comment"
|
623
|
-
| "connection1"
|
624
|
-
| "connection2"
|
625
|
-
| "connection3"
|
626
|
-
| "connection4"
|
627
|
-
| "danger"
|
628
|
-
| "defectFrequencies"
|
629
|
-
| "defectFrequenciesAlternative"
|
630
|
-
| "doubleChevronLeft"
|
631
|
-
| "doubleChevronRight"
|
632
|
-
| "download"
|
633
|
-
| "draft"
|
634
|
-
| "draftFilled"
|
635
|
-
| "draftOutlined"
|
636
|
-
| "dragNDrop"
|
637
|
-
| "drop"
|
638
|
-
| "duplicate"
|
639
|
-
| "edit"
|
640
|
-
| "emailFilled"
|
641
|
-
| "emailOutlined"
|
642
|
-
| "exclamation"
|
643
|
-
| "eye"
|
644
|
-
| "eyeHidden"
|
645
|
-
| "eyeVisible"
|
646
|
-
| "filter"
|
647
|
-
| "forbidden"
|
648
|
-
| "fullScreen"
|
649
|
-
| "fullScreenExit"
|
650
|
-
| "functionalLocation"
|
651
|
-
| "harmonicCursor"
|
652
|
-
| "heatmap"
|
653
|
-
| "hierarchy"
|
654
|
-
| "history"
|
655
|
-
| "historyAlt"
|
656
|
-
| "hourglassFramedFilled"
|
657
|
-
| "hourglassFramedOutlined"
|
658
|
-
| "hourglassOutlined"
|
659
|
-
| "hz"
|
660
|
-
| "iMX"
|
661
|
-
| "image"
|
662
|
-
| "infoCircleFilled"
|
663
|
-
| "infoCircleOutlined"
|
664
|
-
| "integration"
|
665
|
-
| "kebab"
|
666
|
-
| "link"
|
667
|
-
| "listGroup"
|
668
|
-
| "listItem"
|
669
|
-
| "locationPin"
|
670
|
-
| "lock"
|
671
|
-
| "logOut"
|
672
|
-
| "meatballs"
|
673
|
-
| "microphone"
|
674
|
-
| "minus"
|
675
|
-
| "minusSmall"
|
676
|
-
| "noData"
|
677
|
-
| "o"
|
678
|
-
| "openInNew"
|
679
|
-
| "overlayBaseline"
|
680
|
-
| "pDF"
|
681
|
-
| "paper"
|
682
|
-
| "pause"
|
683
|
-
| "pieChart"
|
684
|
-
| "pin"
|
685
|
-
| "play"
|
686
|
-
| "plus"
|
687
|
-
| "powerOff"
|
688
|
-
| "printer"
|
689
|
-
| "proCollect"
|
690
|
-
| "recAction"
|
691
|
-
| "received"
|
692
|
-
| "refresh"
|
693
|
-
| "reorder"
|
694
|
-
| "replace"
|
695
|
-
| "reply"
|
696
|
-
| "rewalkableRoute"
|
697
|
-
| "routes"
|
698
|
-
| "search"
|
699
|
-
| "send"
|
700
|
-
| "sensorA"
|
701
|
-
| "sensorB"
|
702
|
-
| "settings"
|
703
|
-
| "sidebandCursor"
|
704
|
-
| "singleCursor"
|
705
|
-
| "spectrum"
|
706
|
-
| "starFilled"
|
707
|
-
| "starOutlined"
|
708
|
-
| "statusCircle"
|
709
|
-
| "stop"
|
710
|
-
| "structuralVibration"
|
711
|
-
| "sync"
|
712
|
-
| "timewave"
|
713
|
-
| "trash"
|
714
|
-
| "trend"
|
715
|
-
| "trendingUp"
|
716
|
-
| "undo"
|
717
|
-
| "unknownCircle"
|
718
|
-
| "unknownDiamond"
|
719
|
-
| "unlink"
|
720
|
-
| "unlock"
|
721
|
-
| "unscheduledAction"
|
722
|
-
| "upload"
|
723
|
-
| "user"
|
724
|
-
| "viewFull"
|
725
|
-
| "viewHorizontal"
|
726
|
-
| "viewVertical"
|
727
|
-
| "warning"
|
728
|
-
| "warningCircle"
|
729
|
-
| "warningDiamond"
|
730
|
-
| "zoomIn"
|
731
|
-
| "zoomOut";
|
732
|
-
/** Position of the icon in relation to the text - */
|
733
|
-
"icon-placement"?: "left" | "right";
|
734
|
-
/** Specifies the relationship of the target object to the link object - */
|
735
|
-
rel?: string;
|
736
|
-
/** If provided, used on conjunction with onClick property, second argument */
|
737
|
-
route?: string | undefined;
|
738
|
-
/** If true, fills the parents horizontal axis */
|
739
|
-
stretch?: boolean | undefined;
|
740
|
-
/** If provided, specifies where to open the linked document */
|
741
|
-
target?: "_blank" | "_parent" | "_self" | "_top" | undefined;
|
742
|
-
/** Type of button - */
|
743
|
-
type?: "button" | "submit" | "reset";
|
744
|
-
/** If provided, custom function triggered by click where the second return parameter enables custom routing. */
|
745
|
-
onClick?: function;
|
746
|
-
};
|
747
|
-
|
748
|
-
export type SkfLoaderProps = {
|
749
|
-
/** */
|
750
|
-
"aria-label"?: string;
|
751
|
-
/** If true, inverts the color (to be used on colored backgrounds) */
|
752
|
-
invert?: boolean;
|
753
|
-
/** If provided, displays an alternative size */
|
754
|
-
size?: "md" | "sm" | undefined;
|
755
|
-
};
|
756
|
-
|
757
|
-
export type SkfLogoProps = {
|
758
|
-
/** The title of the logo */
|
759
|
-
title?: string;
|
760
|
-
/** If provided, sets color of the logo */
|
761
|
-
color?: "primary" | "secondary" | "inverse";
|
762
|
-
};
|
763
|
-
|
764
|
-
export type SkfRadioProps = {
|
765
|
-
/** If true, sets disabled state */
|
766
|
-
disabled?: boolean;
|
767
|
-
/** If true, value is required or must be checked for the form to be submittable */
|
768
|
-
required?: boolean;
|
769
|
-
/** If provided, outputs helping hints in console */
|
770
|
-
debug?: boolean;
|
771
|
-
/** If true, outputs helping hints in console */
|
772
|
-
checked?: boolean | undefined;
|
773
|
-
/** If true, forces component to invalid state until removed */
|
774
|
-
"custom-invalid"?: boolean | undefined;
|
775
|
-
/** If true, hides the label visually */
|
776
|
-
"hide-label"?: boolean;
|
777
|
-
/** The input's label. Alternatively, you can use the `label` attribute. */
|
778
|
-
label?: string | undefined;
|
779
|
-
/** If provided, adds name to the input-element */
|
780
|
-
name?: string | undefined;
|
781
|
-
/** If provided, renders an alternative A11y text for the asterisk */
|
782
|
-
"required-label"?: string | undefined;
|
783
|
-
/** If provided, displays an alternative size */
|
784
|
-
size?: "sm" | "md" | undefined;
|
785
|
-
/** If provided, displays provided severity state */
|
786
|
-
severity?: FormFieldBaseProps["severity"] | undefined;
|
787
|
-
/** If provided, displays valid state after interaction */
|
788
|
-
"show-valid"?: boolean | undefined;
|
789
|
-
/** The current value of the input field */
|
790
|
-
value?: string;
|
791
|
-
|
792
|
-
/** {object} - When the value of the input changes */
|
793
|
-
onchange?: (e: CustomEvent<never>) => void;
|
794
|
-
};
|
795
|
-
|
796
|
-
export type SkfSwitchProps = {
|
797
|
-
/** If true, sets disabled state */
|
798
|
-
disabled?: boolean;
|
799
|
-
/** If true, value is required or must be checked for the form to be submittable */
|
800
|
-
required?: boolean;
|
801
|
-
/** If true, outputs helping hints in console */
|
802
|
-
debug?: boolean | undefined;
|
803
|
-
/** If true, outputs helping hints in console */
|
804
|
-
checked?: boolean | undefined;
|
805
|
-
/** If true, hides the label visually */
|
806
|
-
"hide-label"?: boolean | undefined;
|
807
|
-
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
808
|
-
label?: string | undefined;
|
809
|
-
/** If defined, adds name to the input-element */
|
810
|
-
name?: string | undefined;
|
811
|
-
/** If defined, renders an alternative A11y text for the asterisk */
|
812
|
-
"required-label"?: string | undefined;
|
813
|
-
/** Size of the Switch */
|
814
|
-
size?: "sm" | "md";
|
815
|
-
/** The current value of the input field */
|
816
|
-
value?: string;
|
817
|
-
};
|
818
|
-
|
819
|
-
export type SkfTagProps = {
|
820
|
-
/** Specifies Tag size - */
|
821
|
-
size?: "sm" | "md" | "lg";
|
822
|
-
/** If defined, displays leading/provided icon - */
|
823
|
-
icon?:
|
824
|
-
| "arrowDown"
|
825
|
-
| "arrowDownUp"
|
826
|
-
| "arrowLeft"
|
827
|
-
| "arrowRight"
|
828
|
-
| "arrowUp"
|
829
|
-
| "article"
|
830
|
-
| "artificialIntelligence"
|
831
|
-
| "asset"
|
832
|
-
| "attachment"
|
833
|
-
| "bandCursor"
|
834
|
-
| "bands"
|
835
|
-
| "batteryEmpty"
|
836
|
-
| "batteryFull"
|
837
|
-
| "batteryLow"
|
838
|
-
| "bearingFault"
|
839
|
-
| "book"
|
840
|
-
| "bulb"
|
841
|
-
| "burger"
|
842
|
-
| "cPM"
|
843
|
-
| "calendar"
|
844
|
-
| "calendarBooked"
|
845
|
-
| "calendarEmpty"
|
846
|
-
| "calendarNotBooked"
|
847
|
-
| "calendarRecurring"
|
848
|
-
| "caretDown"
|
849
|
-
| "caretUp"
|
850
|
-
| "caretUpDown"
|
851
|
-
| "chat"
|
852
|
-
| "check"
|
853
|
-
| "checkCircle"
|
854
|
-
| "checkSmall"
|
855
|
-
| "chevronDown"
|
856
|
-
| "chevronLeft"
|
857
|
-
| "chevronRight"
|
858
|
-
| "chevronUp"
|
859
|
-
| "chevronUpDown"
|
860
|
-
| "close"
|
861
|
-
| "closeAllFaults"
|
862
|
-
| "closeFault"
|
863
|
-
| "closeSmall"
|
864
|
-
| "columnGraph"
|
865
|
-
| "comment"
|
866
|
-
| "connection1"
|
867
|
-
| "connection2"
|
868
|
-
| "connection3"
|
869
|
-
| "connection4"
|
870
|
-
| "danger"
|
871
|
-
| "defectFrequencies"
|
872
|
-
| "defectFrequenciesAlternative"
|
873
|
-
| "doubleChevronLeft"
|
874
|
-
| "doubleChevronRight"
|
875
|
-
| "download"
|
876
|
-
| "draft"
|
877
|
-
| "draftFilled"
|
878
|
-
| "draftOutlined"
|
879
|
-
| "dragNDrop"
|
880
|
-
| "drop"
|
881
|
-
| "duplicate"
|
882
|
-
| "edit"
|
883
|
-
| "emailFilled"
|
884
|
-
| "emailOutlined"
|
885
|
-
| "exclamation"
|
886
|
-
| "eye"
|
887
|
-
| "eyeHidden"
|
888
|
-
| "eyeVisible"
|
889
|
-
| "filter"
|
890
|
-
| "forbidden"
|
891
|
-
| "fullScreen"
|
892
|
-
| "fullScreenExit"
|
893
|
-
| "functionalLocation"
|
894
|
-
| "harmonicCursor"
|
895
|
-
| "heatmap"
|
896
|
-
| "hierarchy"
|
897
|
-
| "history"
|
898
|
-
| "historyAlt"
|
899
|
-
| "hourglassFramedFilled"
|
900
|
-
| "hourglassFramedOutlined"
|
901
|
-
| "hourglassOutlined"
|
902
|
-
| "hz"
|
903
|
-
| "iMX"
|
904
|
-
| "image"
|
905
|
-
| "infoCircleFilled"
|
906
|
-
| "infoCircleOutlined"
|
907
|
-
| "integration"
|
908
|
-
| "kebab"
|
909
|
-
| "link"
|
910
|
-
| "listGroup"
|
911
|
-
| "listItem"
|
912
|
-
| "locationPin"
|
913
|
-
| "lock"
|
914
|
-
| "logOut"
|
915
|
-
| "meatballs"
|
916
|
-
| "microphone"
|
917
|
-
| "minus"
|
918
|
-
| "minusSmall"
|
919
|
-
| "noData"
|
920
|
-
| "o"
|
921
|
-
| "openInNew"
|
922
|
-
| "overlayBaseline"
|
923
|
-
| "pDF"
|
924
|
-
| "paper"
|
925
|
-
| "pause"
|
926
|
-
| "pieChart"
|
927
|
-
| "pin"
|
928
|
-
| "play"
|
929
|
-
| "plus"
|
930
|
-
| "powerOff"
|
931
|
-
| "printer"
|
932
|
-
| "proCollect"
|
933
|
-
| "recAction"
|
934
|
-
| "received"
|
935
|
-
| "refresh"
|
936
|
-
| "reorder"
|
937
|
-
| "replace"
|
938
|
-
| "reply"
|
939
|
-
| "rewalkableRoute"
|
940
|
-
| "routes"
|
941
|
-
| "search"
|
942
|
-
| "send"
|
943
|
-
| "sensorA"
|
944
|
-
| "sensorB"
|
945
|
-
| "settings"
|
946
|
-
| "sidebandCursor"
|
947
|
-
| "singleCursor"
|
948
|
-
| "spectrum"
|
949
|
-
| "starFilled"
|
950
|
-
| "starOutlined"
|
951
|
-
| "statusCircle"
|
952
|
-
| "stop"
|
953
|
-
| "structuralVibration"
|
954
|
-
| "sync"
|
955
|
-
| "timewave"
|
956
|
-
| "trash"
|
957
|
-
| "trend"
|
958
|
-
| "trendingUp"
|
959
|
-
| "undo"
|
960
|
-
| "unknownCircle"
|
961
|
-
| "unknownDiamond"
|
962
|
-
| "unlink"
|
963
|
-
| "unlock"
|
964
|
-
| "unscheduledAction"
|
965
|
-
| "upload"
|
966
|
-
| "user"
|
967
|
-
| "viewFull"
|
968
|
-
| "viewHorizontal"
|
969
|
-
| "viewVertical"
|
970
|
-
| "warning"
|
971
|
-
| "warningCircle"
|
972
|
-
| "warningDiamond"
|
973
|
-
| "zoomIn"
|
974
|
-
| "zoomOut";
|
975
|
-
/** If defined, gives the supplied appearance - */
|
976
|
-
color?: "warning" | "success" | "info" | "error" | "alert";
|
977
|
-
/** If true, adds trailing button to remove tag */
|
978
|
-
removable?: boolean | undefined;
|
979
|
-
};
|
980
|
-
|
981
|
-
export type SkfTextAreaProps = {
|
982
|
-
/** If true, sets disabled state */
|
983
|
-
disabled?: boolean;
|
984
|
-
/** If true, value is required or must be checked for the form to be submittable */
|
985
|
-
required?: boolean;
|
986
|
-
/** If provided, sets the cols of the textarea */
|
987
|
-
cols?: number;
|
988
|
-
/** If provided, forces component to invalid state until removed. Its value is used as hint text. */
|
989
|
-
"custom-invalid"?: string;
|
990
|
-
/** If provided, outputs helping hints in console */
|
991
|
-
debug?: boolean;
|
992
|
-
/** hide-label - If true, hides the label visually */
|
993
|
-
"hide-label"?: boolean;
|
994
|
-
/** If provided, displays informational text below the field */
|
995
|
-
hint?: string | undefined;
|
996
|
-
/** The input's label. Alternatively, you can use the component slot. */
|
997
|
-
label?: string;
|
998
|
-
/** If provided, adds name to the input-element */
|
999
|
-
name?: string | undefined;
|
1000
|
-
/** If provided, sets the maximum character length to accept for this input */
|
1001
|
-
maxlength?: number | undefined;
|
1002
|
-
/** If provided, sets the minimum character length to accept for this input */
|
1003
|
-
minlength?: number | undefined;
|
1004
|
-
/** If provided, displays placeholder text */
|
1005
|
-
placeholder?: string | undefined;
|
1006
|
-
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
1007
|
-
readonly?: boolean | undefined;
|
1008
|
-
/** If provided, renders an alternative A11y text for the asterisk */
|
1009
|
-
"required-label"?: string | undefined;
|
1010
|
-
/** If provided, sets the rows of the textarea */
|
1011
|
-
rows?: number;
|
1012
|
-
/** If provided, displays provided severity state */
|
1013
|
-
severity?: "success" | "error";
|
1014
|
-
/** If true, displays valid state after interaction */
|
1015
|
-
"show-valid"?: boolean | undefined;
|
1016
|
-
/** If provided, displays an alternative size */
|
1017
|
-
size?: "sm" | "md" | undefined;
|
1018
|
-
/** If provided, sets validation start, "input", "change" or "submit" */
|
1019
|
-
"validate-on"?: "input" | "change" | "submit" | undefined;
|
1020
|
-
/** The current value of the text area */
|
1021
|
-
value?: string;
|
1022
|
-
|
1023
|
-
/** Fires when the value of the input changes */
|
1024
|
-
onchange?: (e: CustomEvent<never>) => void;
|
1025
|
-
/** Fires when the input is invalid */
|
1026
|
-
oninvalid?: (e: CustomEvent<never>) => void;
|
1027
|
-
};
|
1028
|
-
|
1029
88
|
export type CustomElements = {
|
1030
89
|
/**
|
1031
90
|
* The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
|
1032
91
|
*
|
1033
|
-
* See [
|
92
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
|
1034
93
|
* ---
|
1035
94
|
*
|
1036
95
|
*
|
1037
96
|
* ### **Slots:**
|
1038
97
|
* - _default_ - Expects one or more <skf-accordion-item> element(s)
|
1039
98
|
*/
|
1040
|
-
"skf-accordion": Partial<
|
99
|
+
"skf-accordion": Partial<SkfAccordion & BaseProps & BaseEvents>;
|
1041
100
|
|
1042
101
|
/**
|
1043
102
|
* The `<skf-alert>` is a type of notification that appears in-line
|
@@ -1049,19 +108,25 @@ export type CustomElements = {
|
|
1049
108
|
*
|
1050
109
|
* ### **Slots:**
|
1051
110
|
* - _default_ - Alert message. **Notice!** See design principles for approved content
|
1052
|
-
* - **link** -
|
111
|
+
* - **link** - Slot for the link
|
1053
112
|
*/
|
1054
|
-
"skf-alert": Partial<
|
113
|
+
"skf-alert": Partial<SkfAlert & BaseProps & BaseEvents>;
|
1055
114
|
|
1056
115
|
/**
|
1057
116
|
* Component to be used in forms or for interactivity
|
1058
117
|
* ---
|
1059
118
|
*
|
1060
119
|
*
|
120
|
+
* ### **Events:**
|
121
|
+
* - **click** - Fires when the button is clicked
|
122
|
+
*
|
123
|
+
* ### **Methods:**
|
124
|
+
* - **click()** - Simulates a click on the button.
|
125
|
+
*
|
1061
126
|
* ### **Slots:**
|
1062
127
|
* - _default_ - The Primary content
|
1063
128
|
*/
|
1064
|
-
"skf-button": Partial<
|
129
|
+
"skf-button": Partial<SkfButton & BaseProps & BaseEvents>;
|
1065
130
|
|
1066
131
|
/**
|
1067
132
|
* The `<skf-card>` can be used to group related subjects in a container
|
@@ -1071,7 +136,7 @@ export type CustomElements = {
|
|
1071
136
|
* ### **Slots:**
|
1072
137
|
* - _default_ - The card's main content
|
1073
138
|
*/
|
1074
|
-
"skf-card": Partial<
|
139
|
+
"skf-card": Partial<SkfCard & BaseProps & BaseEvents>;
|
1075
140
|
|
1076
141
|
/**
|
1077
142
|
* The `<skf-checkbox>` component is used to create a checkbox input
|
@@ -1082,14 +147,14 @@ export type CustomElements = {
|
|
1082
147
|
* - **change** - {object} - When the value of the input changes
|
1083
148
|
*
|
1084
149
|
* ### **Slots:**
|
1085
|
-
* -
|
150
|
+
* - _default_ - The Radios label. Alternatively, you can use the `label` attribute.
|
1086
151
|
*/
|
1087
|
-
"skf-checkbox": Partial<
|
152
|
+
"skf-checkbox": Partial<SkfCheckbox & BaseProps & BaseEvents>;
|
1088
153
|
|
1089
154
|
/**
|
1090
155
|
* The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
|
1091
156
|
*
|
1092
|
-
* See [
|
157
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
|
1093
158
|
* ---
|
1094
159
|
*
|
1095
160
|
*
|
@@ -1103,10 +168,10 @@ export type CustomElements = {
|
|
1103
168
|
* ### **Slots:**
|
1104
169
|
* - _default_ - Main content
|
1105
170
|
*/
|
1106
|
-
"skf-collapse": Partial<
|
171
|
+
"skf-collapse": Partial<SkfCollapse & BaseProps & BaseEvents>;
|
1107
172
|
|
1108
173
|
/**
|
1109
|
-
* The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
|
174
|
+
* The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
|
1110
175
|
* ---
|
1111
176
|
*
|
1112
177
|
*
|
@@ -1114,22 +179,25 @@ export type CustomElements = {
|
|
1114
179
|
* - **--skf-divider-spacing** - The amount of space the divider occupies. Pass valid CSS **margin-block** values when horizontal and **margin-inline** when vertical _(default: undefined)_
|
1115
180
|
* - **--skf-divider-inset** - The amount of space the divider should be indented. Pass valid CSS **margin-inline** values when horizontal and **margin-block** when vertical _(default: undefined)_
|
1116
181
|
*/
|
1117
|
-
"skf-divider": Partial<
|
182
|
+
"skf-divider": Partial<SkfDivider & BaseProps & BaseEvents>;
|
1118
183
|
|
1119
184
|
/**
|
1120
185
|
* The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
|
1121
186
|
* It extends the interface of native html `<h1>` to `<h4>` elements.
|
1122
187
|
* ---
|
1123
188
|
*
|
189
|
+
*
|
190
|
+
* ### **Slots:**
|
191
|
+
* - _default_ - The headings content
|
1124
192
|
*/
|
1125
|
-
"skf-heading": Partial<
|
193
|
+
"skf-heading": Partial<SkfHeading & BaseProps & BaseEvents>;
|
1126
194
|
|
1127
195
|
/**
|
1128
196
|
* The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text
|
1129
197
|
* ---
|
1130
198
|
*
|
1131
199
|
*/
|
1132
|
-
"skf-icon": Partial<
|
200
|
+
"skf-icon": Partial<SkfIcon & BaseProps & BaseEvents>;
|
1133
201
|
|
1134
202
|
/**
|
1135
203
|
* The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.
|
@@ -1141,9 +209,9 @@ export type CustomElements = {
|
|
1141
209
|
* - **invalid** - Fires when the input is invalid
|
1142
210
|
*
|
1143
211
|
* ### **Slots:**
|
1144
|
-
* -
|
212
|
+
* - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
|
1145
213
|
*/
|
1146
|
-
"skf-input": Partial<
|
214
|
+
"skf-input": Partial<SkfInput & BaseProps & BaseEvents>;
|
1147
215
|
|
1148
216
|
/**
|
1149
217
|
* The `<skf-link>` can be used as either a regular link or a link styled semantic button
|
@@ -1153,14 +221,14 @@ export type CustomElements = {
|
|
1153
221
|
* ### **Slots:**
|
1154
222
|
* - _default_ - The links' main content
|
1155
223
|
*/
|
1156
|
-
"skf-link": Partial<
|
224
|
+
"skf-link": Partial<SkfLink & BaseProps & BaseEvents>;
|
1157
225
|
|
1158
226
|
/**
|
1159
|
-
* The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
|
227
|
+
* The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
|
1160
228
|
* ---
|
1161
229
|
*
|
1162
230
|
*/
|
1163
|
-
"skf-loader": Partial<
|
231
|
+
"skf-loader": Partial<SkfLoader & BaseProps & BaseEvents>;
|
1164
232
|
|
1165
233
|
/**
|
1166
234
|
* The `<skf-logo>` component is used to display the SKF logo.
|
@@ -1170,7 +238,14 @@ export type CustomElements = {
|
|
1170
238
|
* ### **CSS Properties:**
|
1171
239
|
* - **--skf-logo-height** - The height of the logo _(default: undefined)_
|
1172
240
|
*/
|
1173
|
-
"skf-logo": Partial<
|
241
|
+
"skf-logo": Partial<SkfLogo & BaseProps & BaseEvents>;
|
242
|
+
|
243
|
+
/**
|
244
|
+
* The `<skf-progress>` element displays an indicator showing the completion progress of a task, typically displayed as a progress bar
|
245
|
+
* ---
|
246
|
+
*
|
247
|
+
*/
|
248
|
+
"skf-progress": Partial<SkfProgress & BaseProps & BaseEvents>;
|
1174
249
|
|
1175
250
|
/**
|
1176
251
|
* The `<skf-radio>` component is used to create a radio input
|
@@ -1181,19 +256,95 @@ export type CustomElements = {
|
|
1181
256
|
* - **change** - {object} - When the value of the input changes
|
1182
257
|
*
|
1183
258
|
* ### **Slots:**
|
1184
|
-
* -
|
259
|
+
* - _default_ - The radios label. Alternatively, you can use the `label` attribute.
|
1185
260
|
*/
|
1186
|
-
"skf-radio": Partial<
|
261
|
+
"skf-radio": Partial<SkfRadio & BaseProps & BaseEvents>;
|
1187
262
|
|
1188
263
|
/**
|
1189
|
-
* The `<skf-
|
264
|
+
* 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.
|
265
|
+
* ---
|
266
|
+
*
|
267
|
+
*
|
268
|
+
* ### **Events:**
|
269
|
+
* - **change** - Fired when the selected option(s) changes
|
270
|
+
* - **invalid** - Fired when the select is invalid
|
271
|
+
* - **reset** - Fired when the form is reset
|
272
|
+
* - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
|
273
|
+
* - **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
|
274
|
+
*
|
275
|
+
* ### **Slots:**
|
276
|
+
* - _default_ - The select's placeholder content
|
277
|
+
*/
|
278
|
+
"skf-select": Partial<SkfSelect & BaseProps & BaseEvents>;
|
279
|
+
|
280
|
+
/**
|
281
|
+
* The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
|
282
|
+
* ---
|
283
|
+
*
|
284
|
+
*
|
285
|
+
* ### **Events:**
|
286
|
+
* - **skf-select-option:select** - {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected.
|
287
|
+
*
|
288
|
+
* ### **Slots:**
|
289
|
+
* - _default_ - The option's text content
|
290
|
+
* - **icon** - The option's slot for icon or custom meta information (svg).
|
291
|
+
*/
|
292
|
+
"skf-select-option": Partial<SkfSelectOption & BaseProps & BaseEvents>;
|
293
|
+
|
294
|
+
/**
|
295
|
+
* The `<skf-select-option-group>` is a component that groups select-options
|
1190
296
|
* ---
|
1191
297
|
*
|
1192
298
|
*
|
1193
299
|
* ### **Slots:**
|
1194
300
|
* - _default_ - The component's placeholder content
|
1195
301
|
*/
|
1196
|
-
"skf-
|
302
|
+
"skf-select-option-group": Partial<SkfSelectOptionGroup & BaseProps & BaseEvents>;
|
303
|
+
|
304
|
+
/**
|
305
|
+
* The `<skf-switch>` is a component that displays a list of actions or options
|
306
|
+
* ---
|
307
|
+
*
|
308
|
+
*
|
309
|
+
* ### **Slots:**
|
310
|
+
* - _default_ - The Switchs label. Alternatively, you can use the `label` attribute.
|
311
|
+
*/
|
312
|
+
"skf-switch": Partial<SkfSwitch & BaseProps & BaseEvents>;
|
313
|
+
|
314
|
+
/**
|
315
|
+
* The `<skf-tab>` is a component that displays a list of actions or options
|
316
|
+
* ---
|
317
|
+
*
|
318
|
+
*
|
319
|
+
* ### **Events:**
|
320
|
+
* - **skf-tab-select** - {detail: { selected: true, tab: SkfTab }} Fires when the tab is selected
|
321
|
+
* - **click** - Fired when the component is clicked
|
322
|
+
*
|
323
|
+
* ### **Slots:**
|
324
|
+
* - _default_ - The tab's label
|
325
|
+
*/
|
326
|
+
"skf-tab": Partial<SkfTab & BaseProps & BaseEvents>;
|
327
|
+
|
328
|
+
/**
|
329
|
+
* The `<skf-tab-group>` is a component that displays a list of actions or options.
|
330
|
+
* ---
|
331
|
+
*
|
332
|
+
*
|
333
|
+
* ### **Slots:**
|
334
|
+
* - _default_ - Used for grouping tab panels in the tab group. Must be <skf-tab-panel> elements
|
335
|
+
* - **tabs** - Used for grouping tabs in the tab group. Must be <skf-tab> elements
|
336
|
+
*/
|
337
|
+
"skf-tab-group": Partial<SkfTabGroup & BaseProps & BaseEvents>;
|
338
|
+
|
339
|
+
/**
|
340
|
+
* The `<skf-tab-panel>` is a component that displays a list of actions or options.
|
341
|
+
* ---
|
342
|
+
*
|
343
|
+
*
|
344
|
+
* ### **Slots:**
|
345
|
+
* - _default_ - The tab panel's content
|
346
|
+
*/
|
347
|
+
"skf-tab-panel": Partial<SkfTabPanel & BaseProps & BaseEvents>;
|
1197
348
|
|
1198
349
|
/**
|
1199
350
|
* The `<skf-tag>` is a component that displays a list of actions or options
|
@@ -1203,7 +354,7 @@ export type CustomElements = {
|
|
1203
354
|
* ### **Slots:**
|
1204
355
|
* - _default_ - The component's placeholder content
|
1205
356
|
*/
|
1206
|
-
"skf-tag": Partial<
|
357
|
+
"skf-tag": Partial<SkfTag & BaseProps & BaseEvents>;
|
1207
358
|
|
1208
359
|
/**
|
1209
360
|
* The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
|
@@ -1215,7 +366,27 @@ export type CustomElements = {
|
|
1215
366
|
* - **invalid** - Fires when the input is invalid
|
1216
367
|
*
|
1217
368
|
* ### **Slots:**
|
1218
|
-
* -
|
369
|
+
* - _default_ - The textareas label. Alternatively, you can use the `label` attribute.
|
370
|
+
*/
|
371
|
+
"skf-textarea": Partial<SkfTextArea & BaseProps & BaseEvents>;
|
372
|
+
|
373
|
+
/**
|
374
|
+
* A simple toast component that displays a message to the user. Use by appending a <skf-toast> tag to the DOM. Position in DOM is irrelevant.
|
375
|
+
* ---
|
376
|
+
*
|
377
|
+
*
|
378
|
+
* ### **Slots:**
|
379
|
+
* - _default_ - The component's placeholder content
|
380
|
+
*/
|
381
|
+
"skf-toast": Partial<SkfToast & BaseProps & BaseEvents>;
|
382
|
+
|
383
|
+
/**
|
384
|
+
* 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.
|
385
|
+
* ---
|
386
|
+
*
|
387
|
+
*
|
388
|
+
* ### **Slots:**
|
389
|
+
* - _default_ - The alert components that the toast creates will render here.
|
1219
390
|
*/
|
1220
|
-
"skf-
|
391
|
+
"skf-toast-wrapper": Partial<SkfToastWrapper & BaseProps & BaseEvents>;
|
1221
392
|
};
|