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