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