@skf-design-system/ui-components 0.0.1-beta.4 → 1.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/checkbox/checkbox.component.js +1 -1
- package/dist/components/input/input.component.js +24 -26
- package/dist/components/select/select.component.d.ts +138 -0
- package/dist/components/select/select.component.js +311 -0
- package/dist/components/select/select.controllers.d.ts +59 -0
- package/dist/components/select/select.controllers.js +169 -0
- package/dist/components/select/select.d.ts +8 -0
- package/dist/components/select/select.js +6 -0
- package/dist/components/select/select.styles.d.ts +1 -0
- package/dist/components/select/select.styles.js +116 -0
- package/dist/components/select-option/select-option.component.d.ts +77 -0
- package/dist/components/select-option/select-option.component.js +117 -0
- package/dist/components/select-option/select-option.controllers.d.ts +9 -0
- package/dist/components/select-option/select-option.d.ts +8 -0
- package/dist/components/select-option/select-option.js +6 -0
- package/dist/components/select-option/select-option.styles.d.ts +1 -0
- package/dist/components/select-option/select-option.styles.js +53 -0
- package/dist/components/select-option-group/select-option-group.component.d.ts +16 -0
- package/dist/components/select-option-group/select-option-group.component.js +31 -0
- package/dist/components/select-option-group/select-option-group.d.ts +8 -0
- package/dist/components/select-option-group/select-option-group.js +6 -0
- package/dist/components/select-option-group/select-option-group.style.d.ts +1 -0
- package/dist/components/select-option-group/select-option-group.style.js +18 -0
- package/dist/components/tag/tag.component.d.ts +18 -2
- package/dist/components/tag/tag.component.js +69 -32
- package/dist/components/tag/tag.styles.js +0 -4
- package/dist/custom-elements.json +1279 -624
- package/dist/index.d.ts +3 -0
- package/dist/index.js +39 -30
- package/dist/internal/components/formBase.d.ts +18 -1
- package/dist/internal/components/formBase.js +25 -13
- package/dist/internal/components/skf-element.d.ts +4 -4
- package/dist/internal/components/skf-element.js +15 -19
- package/dist/internal/helpers/array.d.ts +4 -0
- package/dist/internal/helpers/findMatchingTags.d.ts +2 -0
- package/dist/internal/helpers/findMatchingTags.js +12 -0
- package/dist/internal/helpers/hintSeverity.d.ts +2 -0
- package/dist/internal/helpers/hintSeverity.js +6 -0
- package/dist/internal/helpers/raiseError.d.ts +28 -0
- package/dist/internal/helpers/raiseError.js +29 -0
- package/dist/internal/storybook/shadowRootTraverser.d.ts +2 -0
- package/dist/react/index.d.ts +6 -3
- package/dist/react/index.js +6 -3
- package/dist/react/skf-select/index.d.ts +21 -0
- package/dist/react/skf-select/index.js +21 -0
- package/dist/react/skf-select-option/index.d.ts +9 -0
- package/dist/react/skf-select-option/index.js +17 -0
- package/dist/react/skf-select-option-group/index.d.ts +3 -0
- package/dist/react/skf-select-option-group/index.js +13 -0
- package/dist/styles/form-field.styles.js +6 -6
- package/dist/types/jsx/custom-element-jsx.d.ts +326 -176
- package/dist/types/vue/index.d.ts +268 -135
- package/dist/vscode.html-custom-data.json +344 -147
- package/dist/web-types.json +755 -383
- package/package.json +34 -30
@@ -63,9 +63,9 @@ type BaseEvents = {};
|
|
63
63
|
export type SkfAccordionProps = {
|
64
64
|
/** If true, will animate the expand/collapse state */
|
65
65
|
animated?: boolean | undefined;
|
66
|
-
/**
|
67
|
-
"heading-as"?:
|
68
|
-
/** If
|
66
|
+
/** Defines which heading element will be rendered */
|
67
|
+
"heading-as"?: "h1" | "h2" | "h3" | "h4";
|
68
|
+
/** If true, adds a gap between each item */
|
69
69
|
gap?: boolean | undefined;
|
70
70
|
/** If true, allowes multiple accordion items to open */
|
71
71
|
multiple?: boolean | undefined;
|
@@ -75,20 +75,6 @@ export type SkfAccordionProps = {
|
|
75
75
|
truncate?: boolean | undefined;
|
76
76
|
};
|
77
77
|
|
78
|
-
export type SkfAlertProps = {
|
79
|
-
/** If true, alert is being used as a toast with an close button */
|
80
|
-
closeable?: boolean | undefined;
|
81
|
-
/** Close button aria-label */
|
82
|
-
"button-label"?: string;
|
83
|
-
/** If defined, displays leading icon */
|
84
|
-
icon?: SkfIcon["name"] | undefined;
|
85
|
-
/** If defined, gives the supplied appearance */
|
86
|
-
severity?: SeverityFgColor | undefined;
|
87
|
-
|
88
|
-
/** Fires when the close button is clicked */
|
89
|
-
"onskf-alert-close"?: (e: CustomEvent<never>) => void;
|
90
|
-
};
|
91
|
-
|
92
78
|
export type SkfButtonProps = {
|
93
79
|
/** If true, gives destructive appearance. **Notice!** Only applicable if `variant` is `primary`. */
|
94
80
|
destructive?: boolean;
|
@@ -261,11 +247,25 @@ export type SkfButtonProps = {
|
|
261
247
|
|
262
248
|
export type SkfCardProps = {
|
263
249
|
/** If true, removes border */
|
264
|
-
"no-border"?: boolean;
|
250
|
+
"no-border"?: boolean | undefined;
|
265
251
|
/** If true, removes padding */
|
266
|
-
"no-padding"?: boolean;
|
252
|
+
"no-padding"?: boolean | undefined;
|
267
253
|
/** If true, the Card fills the parent element height */
|
268
|
-
stretch?: boolean;
|
254
|
+
stretch?: boolean | undefined;
|
255
|
+
};
|
256
|
+
|
257
|
+
export type SkfAlertProps = {
|
258
|
+
/** If true, alert is being used as a toast (alertdialog) with an close button */
|
259
|
+
closeable?: boolean | undefined;
|
260
|
+
/** Close button aria-label */
|
261
|
+
"button-label"?: string;
|
262
|
+
/** If defined, displays leading icon */
|
263
|
+
icon?: SkfIcon["name"] | undefined;
|
264
|
+
/** If defined, gives the supplied appearance */
|
265
|
+
severity?: "error" | "info" | "warning" | "success" | "alert";
|
266
|
+
|
267
|
+
/** Fires when the close button is clicked */
|
268
|
+
"onskf-alert-close"?: (e: CustomEvent<never>) => void;
|
269
269
|
};
|
270
270
|
|
271
271
|
export type SkfCheckboxProps = {
|
@@ -289,12 +289,12 @@ export type SkfCheckboxProps = {
|
|
289
289
|
name?: string | undefined;
|
290
290
|
/** If defined, renders an alternative A11y text for the asterisk */
|
291
291
|
"required-label"?: string | undefined;
|
292
|
-
/** Size of the checkbox */
|
293
|
-
size?: "sm" | "md";
|
294
292
|
/** If defined, styles checkbox using provided severity */
|
295
|
-
severity?:
|
296
|
-
/** If
|
293
|
+
severity?: "alert" | "success" | "info" | "warning";
|
294
|
+
/** If true, displays valid state after interaction */
|
297
295
|
"show-valid"?: boolean | undefined;
|
296
|
+
/** Size of the checkbox */
|
297
|
+
size?: "sm" | "md";
|
298
298
|
/** The current value of the input field */
|
299
299
|
value?: string;
|
300
300
|
|
@@ -302,46 +302,46 @@ export type SkfCheckboxProps = {
|
|
302
302
|
onchange?: (e: CustomEvent<never>) => void;
|
303
303
|
};
|
304
304
|
|
305
|
+
export type SkfDividerProps = {
|
306
|
+
/** Defines the Divider color */
|
307
|
+
color?: "emphasised" | "primary" | "secondary" | "tertiary" | "inverse";
|
308
|
+
/** If true, renders a div for presentational purpose instead of the semantic hr-element */
|
309
|
+
decorative?: boolean | undefined;
|
310
|
+
/** If true, renders the divider vertically */
|
311
|
+
vertical?: boolean | undefined;
|
312
|
+
};
|
313
|
+
|
305
314
|
export type SkfCollapseProps = {
|
306
315
|
/** If true, will animate the expand/collapse state */
|
307
|
-
animated?: boolean;
|
316
|
+
animated?: boolean | undefined;
|
308
317
|
/** If true, will set the collapse to be expanded by default */
|
309
|
-
expanded?: boolean;
|
318
|
+
expanded?: boolean | undefined;
|
310
319
|
/** Heading for the collapse */
|
311
320
|
heading?: string | undefined;
|
312
|
-
/**
|
313
|
-
"heading-as"?:
|
321
|
+
/** Defines which heading element will be rendered */
|
322
|
+
"heading-as"?: "h1" | "h2" | "h3" | "h4";
|
314
323
|
/** If true, renders the small version */
|
315
|
-
small?: boolean;
|
324
|
+
small?: boolean | undefined;
|
316
325
|
/** If true, will truncate the heading in collapsed state */
|
317
|
-
truncate?: boolean;
|
326
|
+
truncate?: boolean | undefined;
|
318
327
|
|
319
328
|
/** Event emitted when toggled */
|
320
329
|
"onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
|
321
330
|
};
|
322
331
|
|
323
|
-
export type SkfDividerProps = {
|
324
|
-
/** If provided, alters the Divider color */
|
325
|
-
color?: "emphasised" | "primary" | "secondary" | "tertiary" | "inverse";
|
326
|
-
/** If true, renders a div for presentational purpose instead of the semantic hr-element */
|
327
|
-
decorative?: boolean;
|
328
|
-
/** If true, renders the divider vertically */
|
329
|
-
vertical?: boolean;
|
330
|
-
};
|
331
|
-
|
332
332
|
export type SkfHeadingProps = {
|
333
|
-
/** Controls which heading element will be rendered. Should not be used to affect appearance
|
334
|
-
as?:
|
333
|
+
/** Controls which heading element will be rendered. Should not be used to affect appearance */
|
334
|
+
as?: "h1" | "h2" | "h3" | "h4";
|
335
335
|
/** If provided, changes the appearance of the heading */
|
336
|
-
"styled-as"?:
|
336
|
+
"styled-as"?: "h1" | "h2" | "h3" | "h4";
|
337
337
|
};
|
338
338
|
|
339
339
|
export type SkfIconProps = {
|
340
|
-
/**
|
340
|
+
/** Sets the color of the icon */
|
341
341
|
color?: "primary" | "inverse" | "emphasised" | "secondary" | "success" | "info" | "warning" | "error" | "alert";
|
342
|
-
/** If
|
342
|
+
/** If defined, adds an alternate description to use for assistive devices */
|
343
343
|
label?: string | undefined;
|
344
|
-
/**
|
344
|
+
/** Name of the icon to display */
|
345
345
|
name?:
|
346
346
|
| "arrowDown"
|
347
347
|
| "arrowDownUp"
|
@@ -494,7 +494,7 @@ export type SkfIconProps = {
|
|
494
494
|
| "warningDiamond"
|
495
495
|
| "zoomIn"
|
496
496
|
| "zoomOut";
|
497
|
-
/**
|
497
|
+
/** Size of the icon */
|
498
498
|
size?: "xs" | "sm" | "md" | "lg";
|
499
499
|
};
|
500
500
|
|
@@ -503,62 +503,79 @@ export type SkfInputProps = {
|
|
503
503
|
disabled?: boolean;
|
504
504
|
/** If true, value is required or must be checked for the form to be submittable */
|
505
505
|
required?: boolean;
|
506
|
-
/**
|
506
|
+
/** Custom aria-label for the clear button. **Notice!** Only applicable to type=search. */
|
507
507
|
"button-aria-label-clear"?: string;
|
508
|
-
/**
|
508
|
+
/** Custom aria-label for the visibility button. **Notice!** Only applicable to type=password. */
|
509
509
|
"button-aria-label-hide"?: string;
|
510
|
-
/**
|
510
|
+
/** Custom aria-label for the visibility button **Notice!** Only applicable to type=password. */
|
511
511
|
"button-aria-label-show"?: string;
|
512
|
-
/** If
|
512
|
+
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
513
513
|
"custom-invalid"?: string;
|
514
|
-
/** If
|
515
|
-
debug?: boolean;
|
514
|
+
/** If true, outputs helping hints in console */
|
515
|
+
debug?: boolean | undefined;
|
516
516
|
/** If true, hides the label visually */
|
517
|
-
"hide-label"?: boolean;
|
518
|
-
/** If
|
517
|
+
"hide-label"?: boolean | undefined;
|
518
|
+
/** If defined, displays informational text below the field */
|
519
519
|
hint?: string | undefined;
|
520
|
-
/**
|
520
|
+
/** Tells what keyboard to use if applicable */
|
521
521
|
inputmode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search";
|
522
|
-
/**
|
522
|
+
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
523
523
|
label?: string | undefined;
|
524
|
-
/** If
|
524
|
+
/** If defined, displays a prefix/adornment before the input-element */
|
525
525
|
leading?: string | undefined;
|
526
|
-
/** If
|
526
|
+
/** If defined, sets the maximum value to accept for this input */
|
527
527
|
max?: number | string | undefined;
|
528
|
-
/** If
|
528
|
+
/** If defined, sets the maximum character length to accept for this input */
|
529
529
|
maxlength?: number | undefined;
|
530
|
-
/** If
|
530
|
+
/** If defined, sets the minimum value to accept for this input */
|
531
531
|
min?: number | string | undefined;
|
532
|
-
/** If
|
532
|
+
/** If defined, sets the minimum character length to accept for this input */
|
533
533
|
minlength?: number | undefined;
|
534
|
-
/** If
|
534
|
+
/** If defined, adds name to the input-element */
|
535
535
|
name?: string | undefined;
|
536
|
-
/** If
|
536
|
+
/** If defined, adds name to the input-element */
|
537
537
|
pattern?: string | undefined;
|
538
|
-
/** If
|
538
|
+
/** If defined, displays placeholder text */
|
539
539
|
placeholder?: string | undefined;
|
540
540
|
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
541
541
|
readonly?: boolean | undefined;
|
542
|
-
/** If
|
542
|
+
/** If defined, renders an alternative A11y text for the asterisk */
|
543
543
|
"required-label"?: string | undefined;
|
544
|
-
/** If
|
545
|
-
severity?:
|
546
|
-
/** If
|
544
|
+
/** If defined, displays provided severity state */
|
545
|
+
severity?: "alert" | "success" | "info" | "warning";
|
546
|
+
/** If true, displays valid state after interaction */
|
547
547
|
"show-valid"?: boolean | undefined;
|
548
|
-
/**
|
549
|
-
size?: "sm" | "md"
|
550
|
-
/** If
|
548
|
+
/** Size of the input */
|
549
|
+
size?: "sm" | "md";
|
550
|
+
/** If defined, displays a suffix/adornment after the input-element */
|
551
551
|
trailing?: string | undefined;
|
552
|
-
/**
|
553
|
-
type?:
|
554
|
-
|
555
|
-
|
552
|
+
/** Type of input control */
|
553
|
+
type?:
|
554
|
+
| "button"
|
555
|
+
| "color"
|
556
|
+
| "date"
|
557
|
+
| "datetime-local"
|
558
|
+
| "email"
|
559
|
+
| "file"
|
560
|
+
| "hidden"
|
561
|
+
| "image"
|
562
|
+
| "month"
|
563
|
+
| "number"
|
564
|
+
| "password"
|
565
|
+
| "range"
|
566
|
+
| "reset"
|
567
|
+
| "search"
|
568
|
+
| "submit"
|
569
|
+
| "tel"
|
570
|
+
| "text"
|
571
|
+
| "time"
|
572
|
+
| "url"
|
573
|
+
| "week";
|
574
|
+
/** Sets validation start */
|
575
|
+
"validate-on"?: "input" | "change" | "submit";
|
556
576
|
/** The current value of the input field */
|
557
577
|
value?: string;
|
558
|
-
|
559
|
-
_numberController?: string;
|
560
|
-
/** */
|
561
|
-
_passwordController?: string;
|
578
|
+
|
562
579
|
/** Fires when the value of the input changes */
|
563
580
|
onchange?: (e: CustomEvent<never>) => void;
|
564
581
|
/** Fires when the input is invalid */
|
@@ -566,17 +583,17 @@ export type SkfInputProps = {
|
|
566
583
|
};
|
567
584
|
|
568
585
|
export type SkfLinkProps = {
|
569
|
-
/**
|
586
|
+
/** Defines the semantic element to render */
|
570
587
|
as?: "button" | "a";
|
571
|
-
/**
|
588
|
+
/** Defines the text-color */
|
572
589
|
color?: "primary" | "inverse";
|
573
590
|
/** If true, disables the link */
|
574
591
|
disabled?: boolean | undefined;
|
575
|
-
/** If
|
592
|
+
/** If defined, downloads the url */
|
576
593
|
download?: string | undefined;
|
577
|
-
/** If
|
594
|
+
/** If defined, loads url on click */
|
578
595
|
href?: string | undefined;
|
579
|
-
/** If
|
596
|
+
/** If defined, renders an icon before or after the text */
|
580
597
|
icon?:
|
581
598
|
| "arrowDown"
|
582
599
|
| "arrowDownUp"
|
@@ -729,35 +746,39 @@ export type SkfLinkProps = {
|
|
729
746
|
| "warningDiamond"
|
730
747
|
| "zoomIn"
|
731
748
|
| "zoomOut";
|
732
|
-
/**
|
749
|
+
/** Defines the position of the icon in relation to the text */
|
733
750
|
"icon-placement"?: "left" | "right";
|
734
|
-
/**
|
751
|
+
/** Defines the relationship of the target object to the link object */
|
735
752
|
rel?: string;
|
736
|
-
/** If
|
753
|
+
/** If defined, used on conjunction with onClick property, second argument */
|
737
754
|
route?: string | undefined;
|
738
755
|
/** If true, fills the parents horizontal axis */
|
739
756
|
stretch?: boolean | undefined;
|
740
|
-
/** If
|
757
|
+
/** If defined, specifies where to open the linked document */
|
741
758
|
target?: "_blank" | "_parent" | "_self" | "_top" | undefined;
|
742
|
-
/**
|
759
|
+
/** Defines the type of button */
|
743
760
|
type?: "button" | "submit" | "reset";
|
744
761
|
/** If provided, custom function triggered by click where the second return parameter enables custom routing. */
|
745
762
|
onClick?: function;
|
746
763
|
};
|
747
764
|
|
748
765
|
export type SkfLoaderProps = {
|
749
|
-
/**
|
766
|
+
/** Defines the aria-label */
|
750
767
|
"aria-label"?: string;
|
751
768
|
/** If true, inverts the color (to be used on colored backgrounds) */
|
752
|
-
invert?: boolean;
|
753
|
-
/**
|
769
|
+
invert?: boolean | undefined;
|
770
|
+
/** Defines the size of the loader */
|
754
771
|
size?: "md" | "sm" | undefined;
|
772
|
+
/** */
|
773
|
+
role?: string;
|
774
|
+
/** */
|
775
|
+
ariaLive?: string;
|
755
776
|
};
|
756
777
|
|
757
778
|
export type SkfLogoProps = {
|
758
|
-
/**
|
779
|
+
/** Defines the title of the logo */
|
759
780
|
title?: string;
|
760
|
-
/** If
|
781
|
+
/** If defined, sets color of the logo */
|
761
782
|
color?: "primary" | "secondary" | "inverse";
|
762
783
|
};
|
763
784
|
|
@@ -766,25 +787,25 @@ export type SkfRadioProps = {
|
|
766
787
|
disabled?: boolean;
|
767
788
|
/** If true, value is required or must be checked for the form to be submittable */
|
768
789
|
required?: boolean;
|
769
|
-
/** If
|
770
|
-
debug?: boolean;
|
790
|
+
/** If true, outputs helping hints in console */
|
791
|
+
debug?: boolean | undefined;
|
771
792
|
/** If true, outputs helping hints in console */
|
772
793
|
checked?: boolean | undefined;
|
773
794
|
/** If true, forces component to invalid state until removed */
|
774
795
|
"custom-invalid"?: boolean | undefined;
|
775
796
|
/** If true, hides the label visually */
|
776
|
-
"hide-label"?: boolean;
|
777
|
-
/**
|
797
|
+
"hide-label"?: boolean | undefined;
|
798
|
+
/** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
|
778
799
|
label?: string | undefined;
|
779
|
-
/** If
|
800
|
+
/** If defined, adds name to the input-element */
|
780
801
|
name?: string | undefined;
|
781
|
-
/** If
|
802
|
+
/** If defined, renders an alternative A11y text for the asterisk */
|
782
803
|
"required-label"?: string | undefined;
|
783
|
-
/**
|
784
|
-
size?: "sm" | "md"
|
785
|
-
/** If
|
786
|
-
severity?:
|
787
|
-
/** If
|
804
|
+
/** Size of the Radio */
|
805
|
+
size?: "sm" | "md";
|
806
|
+
/** If defined, displays provided severity state */
|
807
|
+
severity?: "success" | "info" | "warning" | "alert";
|
808
|
+
/** If true, displays valid state after interaction */
|
788
809
|
"show-valid"?: boolean | undefined;
|
789
810
|
/** The current value of the input field */
|
790
811
|
value?: string;
|
@@ -793,6 +814,87 @@ export type SkfRadioProps = {
|
|
793
814
|
onchange?: (e: CustomEvent<never>) => void;
|
794
815
|
};
|
795
816
|
|
817
|
+
export type SkfSelectProps = {
|
818
|
+
/** If true, the select is disabled `default: false` */
|
819
|
+
disabled?: boolean;
|
820
|
+
/** Sets the first visible text on the component */
|
821
|
+
"button-label"?: string;
|
822
|
+
/** If defined, forces component to invalid state until removed */
|
823
|
+
"custom-invalid"?: string | undefined;
|
824
|
+
/** If true, hides the label visually */
|
825
|
+
"hide-label"?: boolean | undefined;
|
826
|
+
/** If true and mulltiple is true, no tags are displayed under the select */
|
827
|
+
"hide-tags"?: boolean | undefined;
|
828
|
+
/** If defined, sets the hint text under the select component in the form */
|
829
|
+
hint?: string | undefined;
|
830
|
+
/** If defined, displays provided label */
|
831
|
+
label?: string | undefined;
|
832
|
+
/** If defined, limits the number of selectable options */
|
833
|
+
max?: number | undefined;
|
834
|
+
/** If defined, sets the minimum number of required options */
|
835
|
+
min?: number | undefined;
|
836
|
+
/** If true, allows for multiple options to be selected */
|
837
|
+
multiple?: boolean | undefined;
|
838
|
+
/** If defined, set name of the component */
|
839
|
+
name?: string | undefined;
|
840
|
+
/** If defined, renders an alternative A11y text for the asterisk */
|
841
|
+
"required-label"?: string | undefined;
|
842
|
+
/** If defined, displays provided severity state */
|
843
|
+
severity?: FormFieldBaseProps["severity"] | undefined;
|
844
|
+
/** If true, displays valid state after interaction */
|
845
|
+
"show-valid"?: boolean | undefined;
|
846
|
+
/** Size of the Select */
|
847
|
+
size?: "sm" | "md";
|
848
|
+
/** A readonly property that returns the selected value(s) in a array */
|
849
|
+
getSelectedValues?: string;
|
850
|
+
/** A readonly property that returns the selected slot(s) text content in a array */
|
851
|
+
getSelectedOptionsText?: string;
|
852
|
+
/** Read only, returns the selected value. (if multiple: in a comma separated string) */
|
853
|
+
value?: string;
|
854
|
+
/** */
|
855
|
+
_selectedOptions?: array;
|
856
|
+
/** Fired when the selected option(s) changes */
|
857
|
+
onchange?: (e: CustomEvent<never>) => void;
|
858
|
+
/** Fired when the select is invalid */
|
859
|
+
oninvalid?: (e: CustomEvent<never>) => void;
|
860
|
+
/** Fired when the form is reset */
|
861
|
+
onreset?: (e: CustomEvent<never>) => void;
|
862
|
+
/** {detail: {expanded: boolean}} Fired when the select dropdown is toggled */
|
863
|
+
"onskf-select:dropdown"?: (e: CustomEvent<never>) => void;
|
864
|
+
/** {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled */
|
865
|
+
"onskf-select-option:select"?: (e: CustomEvent<never>) => void;
|
866
|
+
};
|
867
|
+
|
868
|
+
export type SkfSelectOptionProps = {
|
869
|
+
/** If true, prevents interaction with the option */
|
870
|
+
disabled?: boolean | undefined;
|
871
|
+
/** If defined, set an icon */
|
872
|
+
icon?: SkfIcon["name"] | undefined;
|
873
|
+
/** If defined, sets provided color on the icon */
|
874
|
+
"icon-color"?: IconColor | undefined;
|
875
|
+
/** If true, sets the option as selected */
|
876
|
+
selected?: boolean | undefined;
|
877
|
+
/** If defined, sets a short label */
|
878
|
+
"short-label"?: string | undefined;
|
879
|
+
/** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
|
880
|
+
value?: string;
|
881
|
+
/** The option's label text (equivalent to the tags textContent) */
|
882
|
+
text?: string;
|
883
|
+
/** */
|
884
|
+
role?: string;
|
885
|
+
/** */
|
886
|
+
_parent?: string;
|
887
|
+
/** */
|
888
|
+
_shortcutUpdate?: boolean;
|
889
|
+
/** {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected. */
|
890
|
+
"onskf-select-option:select"?: (e: CustomEvent<never>) => void;
|
891
|
+
};
|
892
|
+
|
893
|
+
export type SkfSelectOptionGroupProps = {
|
894
|
+
/** */
|
895
|
+
label?: string;
|
896
|
+
};
|
897
|
+
|
796
898
|
export type SkfSwitchProps = {
|
797
899
|
/** If true, sets disabled state */
|
798
900
|
disabled?: boolean;
|
@@ -804,7 +906,7 @@ export type SkfSwitchProps = {
|
|
804
906
|
checked?: boolean | undefined;
|
805
907
|
/** If true, hides the label visually */
|
806
908
|
"hide-label"?: boolean | undefined;
|
807
|
-
/** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
|
909
|
+
/** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
|
808
910
|
label?: string | undefined;
|
809
911
|
/** If defined, adds name to the input-element */
|
810
912
|
name?: string | undefined;
|
@@ -817,9 +919,9 @@ export type SkfSwitchProps = {
|
|
817
919
|
};
|
818
920
|
|
819
921
|
export type SkfTagProps = {
|
820
|
-
/** Specifies Tag size
|
922
|
+
/** Specifies Tag size */
|
821
923
|
size?: "sm" | "md" | "lg";
|
822
|
-
/** If defined, displays leading/provided icon
|
924
|
+
/** If defined, displays leading/provided icon */
|
823
925
|
icon?:
|
824
926
|
| "arrowDown"
|
825
927
|
| "arrowDownUp"
|
@@ -972,10 +1074,14 @@ export type SkfTagProps = {
|
|
972
1074
|
| "warningDiamond"
|
973
1075
|
| "zoomIn"
|
974
1076
|
| "zoomOut";
|
975
|
-
/** If defined, gives the supplied appearance
|
1077
|
+
/** If defined, gives the supplied appearance */
|
976
1078
|
color?: "warning" | "success" | "info" | "error" | "alert";
|
977
1079
|
/** If true, adds trailing button to remove tag */
|
978
1080
|
removable?: boolean | undefined;
|
1081
|
+
/** If defined, accepts a function that runs on click */
|
1082
|
+
onClick?: string;
|
1083
|
+
/** If defined, accepts a function that runs on click. Self removal can be overridden by using `event.stopPropagation()`. */
|
1084
|
+
onRemove?: string;
|
979
1085
|
};
|
980
1086
|
|
981
1087
|
export type SkfTextAreaProps = {
|
@@ -983,40 +1089,40 @@ export type SkfTextAreaProps = {
|
|
983
1089
|
disabled?: boolean;
|
984
1090
|
/** If true, value is required or must be checked for the form to be submittable */
|
985
1091
|
required?: boolean;
|
986
|
-
/** If
|
987
|
-
cols?: number;
|
988
|
-
/** If
|
1092
|
+
/** If defined, sets the cols of the textarea */
|
1093
|
+
cols?: number | undefined;
|
1094
|
+
/** If defined, forces component to invalid state until removed. Its value is used as hint text. */
|
989
1095
|
"custom-invalid"?: string;
|
990
|
-
/** If
|
991
|
-
debug?: boolean;
|
992
|
-
/**
|
993
|
-
"hide-label"?: boolean;
|
994
|
-
/** If
|
1096
|
+
/** If true, outputs helping hints in console */
|
1097
|
+
debug?: boolean | undefined;
|
1098
|
+
/** If true, hides the label visually */
|
1099
|
+
"hide-label"?: boolean | undefined;
|
1100
|
+
/** If defined, displays informational text below the field */
|
995
1101
|
hint?: string | undefined;
|
996
|
-
/**
|
997
|
-
label?: string;
|
998
|
-
/** If
|
1102
|
+
/** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
|
1103
|
+
label?: string | undefined;
|
1104
|
+
/** If defined, adds name to the input-element */
|
999
1105
|
name?: string | undefined;
|
1000
|
-
/** If
|
1106
|
+
/** If defined, sets the maximum character length to accept for this input */
|
1001
1107
|
maxlength?: number | undefined;
|
1002
|
-
/** If
|
1108
|
+
/** If defined, sets the minimum character length to accept for this input */
|
1003
1109
|
minlength?: number | undefined;
|
1004
|
-
/** If
|
1110
|
+
/** If defined, displays placeholder text */
|
1005
1111
|
placeholder?: string | undefined;
|
1006
1112
|
/** If true, makes the element not mutable, meaning the user can not edit the control */
|
1007
1113
|
readonly?: boolean | undefined;
|
1008
|
-
/** If
|
1114
|
+
/** If defined, renders an alternative A11y text for the asterisk */
|
1009
1115
|
"required-label"?: string | undefined;
|
1010
|
-
/** If
|
1011
|
-
rows?: number;
|
1012
|
-
/** If
|
1013
|
-
severity?: "success" | "
|
1116
|
+
/** If defined, sets the rows of the textarea */
|
1117
|
+
rows?: number | undefined;
|
1118
|
+
/** If defined, displays provided severity state */
|
1119
|
+
severity?: "success" | "info" | "warning" | "alert";
|
1014
1120
|
/** If true, displays valid state after interaction */
|
1015
1121
|
"show-valid"?: boolean | undefined;
|
1016
|
-
/**
|
1122
|
+
/** Size of the Textarea */
|
1017
1123
|
size?: "sm" | "md" | undefined;
|
1018
|
-
/**
|
1019
|
-
"validate-on"?: "input" | "change" | "submit"
|
1124
|
+
/** Sets validation start */
|
1125
|
+
"validate-on"?: "input" | "change" | "submit";
|
1020
1126
|
/** The current value of the text area */
|
1021
1127
|
value?: string;
|
1022
1128
|
|
@@ -1030,48 +1136,48 @@ export type CustomElements = {
|
|
1030
1136
|
/**
|
1031
1137
|
* The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
|
1032
1138
|
*
|
1033
|
-
* See [
|
1139
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
|
1034
1140
|
* ---
|
1035
1141
|
*
|
1036
1142
|
*
|
1037
1143
|
* ### **Slots:**
|
1038
1144
|
* - _default_ - Expects one or more <skf-accordion-item> element(s)
|
1039
1145
|
*/
|
1040
|
-
"skf-accordion": Partial<SkfAccordionProps
|
1146
|
+
"skf-accordion": Partial<SkfAccordionProps & BaseProps & BaseEvents>;
|
1041
1147
|
|
1042
1148
|
/**
|
1043
|
-
*
|
1149
|
+
* Component to be used in forms or for interactivity
|
1044
1150
|
* ---
|
1045
1151
|
*
|
1046
1152
|
*
|
1047
|
-
* ### **Events:**
|
1048
|
-
* - **skf-alert-close** - Fires when the close button is clicked
|
1049
|
-
*
|
1050
1153
|
* ### **Slots:**
|
1051
|
-
* - _default_ -
|
1052
|
-
* - **link** - lodjvodjvodjo
|
1154
|
+
* - _default_ - The Primary content
|
1053
1155
|
*/
|
1054
|
-
"skf-
|
1156
|
+
"skf-button": Partial<SkfButtonProps & BaseProps & BaseEvents>;
|
1055
1157
|
|
1056
1158
|
/**
|
1057
|
-
*
|
1159
|
+
* The `<skf-card>` can be used to group related subjects in a container
|
1058
1160
|
* ---
|
1059
1161
|
*
|
1060
1162
|
*
|
1061
1163
|
* ### **Slots:**
|
1062
|
-
* - _default_ - The
|
1164
|
+
* - _default_ - The card's main content
|
1063
1165
|
*/
|
1064
|
-
"skf-
|
1166
|
+
"skf-card": Partial<SkfCardProps & BaseProps & BaseEvents>;
|
1065
1167
|
|
1066
1168
|
/**
|
1067
|
-
* The `<skf-
|
1169
|
+
* The `<skf-alert>` is a type of notification that appears in-line
|
1068
1170
|
* ---
|
1069
1171
|
*
|
1070
1172
|
*
|
1173
|
+
* ### **Events:**
|
1174
|
+
* - **skf-alert-close** - Fires when the close button is clicked
|
1175
|
+
*
|
1071
1176
|
* ### **Slots:**
|
1072
|
-
* - _default_ -
|
1177
|
+
* - _default_ - Alert message. **Notice!** See design principles for approved content
|
1178
|
+
* - **link** - Slot for the link
|
1073
1179
|
*/
|
1074
|
-
"skf-
|
1180
|
+
"skf-alert": Partial<SkfAlertProps & BaseProps & BaseEvents>;
|
1075
1181
|
|
1076
1182
|
/**
|
1077
1183
|
* The `<skf-checkbox>` component is used to create a checkbox input
|
@@ -1082,14 +1188,25 @@ export type CustomElements = {
|
|
1082
1188
|
* - **change** - {object} - When the value of the input changes
|
1083
1189
|
*
|
1084
1190
|
* ### **Slots:**
|
1085
|
-
* -
|
1191
|
+
* - _default_ - The Radios label. Alternatively, you can use the `label` attribute.
|
1086
1192
|
*/
|
1087
|
-
"skf-checkbox": Partial<SkfCheckboxProps
|
1193
|
+
"skf-checkbox": Partial<SkfCheckboxProps & BaseProps & BaseEvents>;
|
1194
|
+
|
1195
|
+
/**
|
1196
|
+
* The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
|
1197
|
+
* ---
|
1198
|
+
*
|
1199
|
+
*
|
1200
|
+
* ### **CSS Properties:**
|
1201
|
+
* - **--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)_
|
1202
|
+
* - **--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)_
|
1203
|
+
*/
|
1204
|
+
"skf-divider": Partial<SkfDividerProps & BaseProps & BaseEvents>;
|
1088
1205
|
|
1089
1206
|
/**
|
1090
1207
|
* The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
|
1091
1208
|
*
|
1092
|
-
* See [
|
1209
|
+
* See [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.
|
1093
1210
|
* ---
|
1094
1211
|
*
|
1095
1212
|
*
|
@@ -1103,33 +1220,25 @@ export type CustomElements = {
|
|
1103
1220
|
* ### **Slots:**
|
1104
1221
|
* - _default_ - Main content
|
1105
1222
|
*/
|
1106
|
-
"skf-collapse": Partial<SkfCollapseProps
|
1107
|
-
|
1108
|
-
/**
|
1109
|
-
* The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information.
|
1110
|
-
* ---
|
1111
|
-
*
|
1112
|
-
*
|
1113
|
-
* ### **CSS Properties:**
|
1114
|
-
* - **--skf-divider-spacing** - The amount of space the divider occupies. Pass valid CSS **margin-block** values when horizontal and **margin-inline** when vertical _(default: undefined)_
|
1115
|
-
* - **--skf-divider-inset** - The amount of space the divider should be indented. Pass valid CSS **margin-inline** values when horizontal and **margin-block** when vertical _(default: undefined)_
|
1116
|
-
*/
|
1117
|
-
"skf-divider": Partial<SkfDividerProps | BaseProps | BaseEvents>;
|
1223
|
+
"skf-collapse": Partial<SkfCollapseProps & BaseProps & BaseEvents>;
|
1118
1224
|
|
1119
1225
|
/**
|
1120
1226
|
* The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
|
1121
1227
|
* It extends the interface of native html `<h1>` to `<h4>` elements.
|
1122
1228
|
* ---
|
1123
1229
|
*
|
1230
|
+
*
|
1231
|
+
* ### **Slots:**
|
1232
|
+
* - _default_ - The headings content
|
1124
1233
|
*/
|
1125
|
-
"skf-heading": Partial<SkfHeadingProps
|
1234
|
+
"skf-heading": Partial<SkfHeadingProps & BaseProps & BaseEvents>;
|
1126
1235
|
|
1127
1236
|
/**
|
1128
1237
|
* The `<skf-icon>` component is used to clarify interface elements. When used, should always be paired with (possibly invisible) text
|
1129
1238
|
* ---
|
1130
1239
|
*
|
1131
1240
|
*/
|
1132
|
-
"skf-icon": Partial<SkfIconProps
|
1241
|
+
"skf-icon": Partial<SkfIconProps & BaseProps & BaseEvents>;
|
1133
1242
|
|
1134
1243
|
/**
|
1135
1244
|
* The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.
|
@@ -1141,9 +1250,9 @@ export type CustomElements = {
|
|
1141
1250
|
* - **invalid** - Fires when the input is invalid
|
1142
1251
|
*
|
1143
1252
|
* ### **Slots:**
|
1144
|
-
* -
|
1253
|
+
* - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.
|
1145
1254
|
*/
|
1146
|
-
"skf-input": Partial<SkfInputProps
|
1255
|
+
"skf-input": Partial<SkfInputProps & BaseProps & BaseEvents>;
|
1147
1256
|
|
1148
1257
|
/**
|
1149
1258
|
* The `<skf-link>` can be used as either a regular link or a link styled semantic button
|
@@ -1153,14 +1262,14 @@ export type CustomElements = {
|
|
1153
1262
|
* ### **Slots:**
|
1154
1263
|
* - _default_ - The links' main content
|
1155
1264
|
*/
|
1156
|
-
"skf-link": Partial<SkfLinkProps
|
1265
|
+
"skf-link": Partial<SkfLinkProps & BaseProps & BaseEvents>;
|
1157
1266
|
|
1158
1267
|
/**
|
1159
|
-
* The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
|
1268
|
+
* The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities
|
1160
1269
|
* ---
|
1161
1270
|
*
|
1162
1271
|
*/
|
1163
|
-
"skf-loader": Partial<SkfLoaderProps
|
1272
|
+
"skf-loader": Partial<SkfLoaderProps & BaseProps & BaseEvents>;
|
1164
1273
|
|
1165
1274
|
/**
|
1166
1275
|
* The `<skf-logo>` component is used to display the SKF logo.
|
@@ -1170,7 +1279,7 @@ export type CustomElements = {
|
|
1170
1279
|
* ### **CSS Properties:**
|
1171
1280
|
* - **--skf-logo-height** - The height of the logo _(default: undefined)_
|
1172
1281
|
*/
|
1173
|
-
"skf-logo": Partial<SkfLogoProps
|
1282
|
+
"skf-logo": Partial<SkfLogoProps & BaseProps & BaseEvents>;
|
1174
1283
|
|
1175
1284
|
/**
|
1176
1285
|
* The `<skf-radio>` component is used to create a radio input
|
@@ -1181,19 +1290,60 @@ export type CustomElements = {
|
|
1181
1290
|
* - **change** - {object} - When the value of the input changes
|
1182
1291
|
*
|
1183
1292
|
* ### **Slots:**
|
1184
|
-
* -
|
1293
|
+
* - _default_ - The radios label. Alternatively, you can use the `label` attribute.
|
1185
1294
|
*/
|
1186
|
-
"skf-radio": Partial<SkfRadioProps
|
1295
|
+
"skf-radio": Partial<SkfRadioProps & BaseProps & BaseEvents>;
|
1187
1296
|
|
1188
1297
|
/**
|
1189
|
-
* The `<skf-
|
1298
|
+
* 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.
|
1299
|
+
* ---
|
1300
|
+
*
|
1301
|
+
*
|
1302
|
+
* ### **Events:**
|
1303
|
+
* - **change** - Fired when the selected option(s) changes
|
1304
|
+
* - **invalid** - Fired when the select is invalid
|
1305
|
+
* - **reset** - Fired when the form is reset
|
1306
|
+
* - **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
|
1307
|
+
* - **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
|
1308
|
+
*
|
1309
|
+
* ### **Slots:**
|
1310
|
+
* - _default_ - The select's placeholder content
|
1311
|
+
*/
|
1312
|
+
"skf-select": Partial<SkfSelectProps & BaseProps & BaseEvents>;
|
1313
|
+
|
1314
|
+
/**
|
1315
|
+
* The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
|
1316
|
+
* ---
|
1317
|
+
*
|
1318
|
+
*
|
1319
|
+
* ### **Events:**
|
1320
|
+
* - **skf-select-option:select** - {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected.
|
1321
|
+
*
|
1322
|
+
* ### **Slots:**
|
1323
|
+
* - _default_ - The option's text content
|
1324
|
+
* - **icon** - The option's slot for icon or custom meta information (svg).
|
1325
|
+
*/
|
1326
|
+
"skf-select-option": Partial<SkfSelectOptionProps & BaseProps & BaseEvents>;
|
1327
|
+
|
1328
|
+
/**
|
1329
|
+
* The `<skf-select-option-group>` is a component that groups select-options
|
1190
1330
|
* ---
|
1191
1331
|
*
|
1192
1332
|
*
|
1193
1333
|
* ### **Slots:**
|
1194
1334
|
* - _default_ - The component's placeholder content
|
1195
1335
|
*/
|
1196
|
-
"skf-
|
1336
|
+
"skf-select-option-group": Partial<SkfSelectOptionGroupProps & BaseProps & BaseEvents>;
|
1337
|
+
|
1338
|
+
/**
|
1339
|
+
* The `<skf-switch>` is a component that displays a list of actions or options
|
1340
|
+
* ---
|
1341
|
+
*
|
1342
|
+
*
|
1343
|
+
* ### **Slots:**
|
1344
|
+
* - _default_ - The Switchs label. Alternatively, you can use the `label` attribute.
|
1345
|
+
*/
|
1346
|
+
"skf-switch": Partial<SkfSwitchProps & BaseProps & BaseEvents>;
|
1197
1347
|
|
1198
1348
|
/**
|
1199
1349
|
* The `<skf-tag>` is a component that displays a list of actions or options
|
@@ -1203,7 +1353,7 @@ export type CustomElements = {
|
|
1203
1353
|
* ### **Slots:**
|
1204
1354
|
* - _default_ - The component's placeholder content
|
1205
1355
|
*/
|
1206
|
-
"skf-tag": Partial<SkfTagProps
|
1356
|
+
"skf-tag": Partial<SkfTagProps & BaseProps & BaseEvents>;
|
1207
1357
|
|
1208
1358
|
/**
|
1209
1359
|
* The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.
|
@@ -1215,7 +1365,7 @@ export type CustomElements = {
|
|
1215
1365
|
* - **invalid** - Fires when the input is invalid
|
1216
1366
|
*
|
1217
1367
|
* ### **Slots:**
|
1218
|
-
* -
|
1368
|
+
* - _default_ - The textareas label. Alternatively, you can use the `label` attribute.
|
1219
1369
|
*/
|
1220
|
-
"skf-textarea": Partial<SkfTextAreaProps
|
1370
|
+
"skf-textarea": Partial<SkfTextAreaProps & BaseProps & BaseEvents>;
|
1221
1371
|
};
|