@skf-design-system/ui-components 0.0.1-beta.4 → 1.0.0-beta.3

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.
Files changed (102) hide show
  1. package/dist/components/accordion/accordion.component.d.ts +9 -5
  2. package/dist/components/accordion/accordion.component.js +22 -19
  3. package/dist/components/accordion/accordion.d.ts +1 -1
  4. package/dist/components/accordion/accordion.styles.js +3 -3
  5. package/dist/components/alert/alert.component.d.ts +7 -4
  6. package/dist/components/alert/alert.component.js +1 -1
  7. package/dist/components/alert/alert.styles.js +1 -1
  8. package/dist/components/button/button.component.js +1 -1
  9. package/dist/components/button/button.styles.js +1 -1
  10. package/dist/components/card/card.component.d.ts +3 -3
  11. package/dist/components/card/card.component.js +16 -19
  12. package/dist/components/card/card.styles.js +11 -3
  13. package/dist/components/checkbox/checkbox.component.d.ts +9 -6
  14. package/dist/components/checkbox/checkbox.component.js +8 -8
  15. package/dist/components/checkbox/checkbox.styles.js +1 -1
  16. package/dist/components/checkbox/checkbox.test.d.ts +1 -0
  17. package/dist/components/collapse/collapse.component.d.ts +9 -6
  18. package/dist/components/collapse/collapse.component.js +39 -36
  19. package/dist/components/collapse/collapse.styles.js +3 -3
  20. package/dist/components/collapse/collapse.test.d.ts +1 -0
  21. package/dist/components/divider/divider.component.d.ts +13 -10
  22. package/dist/components/divider/divider.component.js +34 -29
  23. package/dist/components/divider/divider.styles.js +1 -5
  24. package/dist/components/heading/heading.component.d.ts +12 -2
  25. package/dist/components/heading/heading.component.js +14 -14
  26. package/dist/components/heading/heading.styles.js +1 -1
  27. package/dist/components/icon/icon.component.d.ts +14 -8
  28. package/dist/components/icon/icon.component.js +6 -6
  29. package/dist/components/icon/icon.styles.js +1 -1
  30. package/dist/components/input/input.component.d.ts +34 -29
  31. package/dist/components/input/input.component.js +36 -36
  32. package/dist/components/link/link.component.d.ts +15 -12
  33. package/dist/components/link/link.component.js +7 -7
  34. package/dist/components/link/link.styles.js +1 -1
  35. package/dist/components/loader/loader.component.d.ts +7 -7
  36. package/dist/components/loader/loader.component.js +35 -61
  37. package/dist/components/loader/loader.styles.js +42 -10
  38. package/dist/components/logo/logo.component.d.ts +5 -3
  39. package/dist/components/logo/logo.component.js +8 -8
  40. package/dist/components/logo/logo.styles.js +2 -2
  41. package/dist/components/radio/radio.component.d.ts +15 -13
  42. package/dist/components/radio/radio.component.js +3 -3
  43. package/dist/components/radio/radio.styles.js +3 -3
  44. package/dist/components/select/select.component.d.ts +137 -0
  45. package/dist/components/select/select.component.js +311 -0
  46. package/dist/components/select/select.controllers.d.ts +59 -0
  47. package/dist/components/select/select.controllers.js +169 -0
  48. package/dist/components/select/select.d.ts +8 -0
  49. package/dist/components/select/select.js +6 -0
  50. package/dist/components/select/select.styles.d.ts +1 -0
  51. package/dist/components/select/select.styles.js +116 -0
  52. package/dist/components/select-option/select-option.component.d.ts +77 -0
  53. package/dist/components/select-option/select-option.component.js +117 -0
  54. package/dist/components/select-option/select-option.controllers.d.ts +9 -0
  55. package/dist/components/select-option/select-option.d.ts +8 -0
  56. package/dist/components/select-option/select-option.js +6 -0
  57. package/dist/components/select-option/select-option.styles.d.ts +1 -0
  58. package/dist/components/select-option/select-option.styles.js +53 -0
  59. package/dist/components/select-option-group/select-option-group.component.d.ts +16 -0
  60. package/dist/components/select-option-group/select-option-group.component.js +31 -0
  61. package/dist/components/select-option-group/select-option-group.d.ts +8 -0
  62. package/dist/components/select-option-group/select-option-group.js +6 -0
  63. package/dist/components/select-option-group/select-option-group.style.d.ts +1 -0
  64. package/dist/components/select-option-group/select-option-group.style.js +18 -0
  65. package/dist/components/switch/switch.component.d.ts +2 -3
  66. package/dist/components/switch/switch.component.js +1 -1
  67. package/dist/components/switch/switch.styles.js +1 -1
  68. package/dist/components/switch/switch.test.d.ts +1 -0
  69. package/dist/components/tag/tag.component.d.ts +25 -4
  70. package/dist/components/tag/tag.component.js +66 -29
  71. package/dist/components/tag/tag.styles.js +6 -5
  72. package/dist/components/textarea/textarea.component.d.ts +26 -23
  73. package/dist/components/textarea/textarea.component.js +15 -12
  74. package/dist/custom-elements.json +960 -305
  75. package/dist/index.d.ts +3 -0
  76. package/dist/index.js +39 -30
  77. package/dist/internal/components/formBase.d.ts +18 -1
  78. package/dist/internal/components/formBase.js +25 -13
  79. package/dist/internal/components/skf-element.d.ts +4 -4
  80. package/dist/internal/components/skf-element.js +15 -19
  81. package/dist/internal/helpers/array.d.ts +4 -0
  82. package/dist/internal/helpers/findMatchingTags.d.ts +2 -0
  83. package/dist/internal/helpers/findMatchingTags.js +12 -0
  84. package/dist/internal/helpers/hintSeverity.d.ts +2 -0
  85. package/dist/internal/helpers/hintSeverity.js +6 -0
  86. package/dist/internal/helpers/raiseError.d.ts +28 -0
  87. package/dist/internal/helpers/raiseError.js +29 -0
  88. package/dist/internal/storybook/shadowRootTraverser.d.ts +16 -6
  89. package/dist/react/index.d.ts +3 -0
  90. package/dist/react/index.js +3 -0
  91. package/dist/react/skf-select/index.d.ts +21 -0
  92. package/dist/react/skf-select/index.js +21 -0
  93. package/dist/react/skf-select-option/index.d.ts +9 -0
  94. package/dist/react/skf-select-option/index.js +17 -0
  95. package/dist/react/skf-select-option-group/index.d.ts +3 -0
  96. package/dist/react/skf-select-option-group/index.js +13 -0
  97. package/dist/styles/form-field.styles.js +7 -7
  98. package/dist/types/jsx/custom-element-jsx.d.ts +290 -140
  99. package/dist/types/vue/index.d.ts +223 -90
  100. package/dist/vscode.html-custom-data.json +294 -97
  101. package/dist/web-types.json +614 -242
  102. package/package.json +34 -30
@@ -4,7 +4,7 @@
4
4
  "tags": [
5
5
  {
6
6
  "name": "skf-accordion",
7
- "description": "The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.\n\nSee [InVision DSM](https://skf.invisionapp.com/dsm/ab-skf/4-web-applications/nav/5fa7caf78c01200018354495/asset/6256cb1b44eba592d319d92e) for design principles.\n---\n\n\n### **Slots:**\n - _default_ - Expects one or more <skf-accordion-item> element(s)",
7
+ "description": "The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.\n\nSee [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.\n---\n\n\n### **Slots:**\n - _default_ - Expects one or more <skf-accordion-item> element(s)",
8
8
  "attributes": [
9
9
  {
10
10
  "name": "animated",
@@ -13,12 +13,17 @@
13
13
  },
14
14
  {
15
15
  "name": "heading-as",
16
- "description": "Controls which heading element will be rendered",
17
- "values": [{ "name": "Exclude<HeadingType" }, { "name": "'h1'>" }]
16
+ "description": "Defines which heading element will be rendered",
17
+ "values": [
18
+ { "name": "h1" },
19
+ { "name": "h2" },
20
+ { "name": "h3" },
21
+ { "name": "h4" }
22
+ ]
18
23
  },
19
24
  {
20
25
  "name": "gap",
21
- "description": "If provided, adds a gap between each item",
26
+ "description": "If true, adds a gap between each item",
22
27
  "values": []
23
28
  },
24
29
  {
@@ -41,11 +46,11 @@
41
46
  },
42
47
  {
43
48
  "name": "skf-alert",
44
- "description": "The `<skf-alert>` is a type of notification that appears in-line\n---\n\n\n### **Events:**\n - **skf-alert-close** - Fires when the close button is clicked\n\n### **Slots:**\n - _default_ - Alert message. **Notice!** See design principles for approved content\n- **link** - lodjvodjvodjo",
49
+ "description": "The `<skf-alert>` is a type of notification that appears in-line\n---\n\n\n### **Events:**\n - **skf-alert-close** - Fires when the close button is clicked\n\n### **Slots:**\n - _default_ - Alert message. **Notice!** See design principles for approved content\n- **link** - Slot for the link",
45
50
  "attributes": [
46
51
  {
47
52
  "name": "closeable",
48
- "description": "If true, alert is being used as a toast with an close button",
53
+ "description": "If true, alert is being used as a toast (alertdialog) with an close button",
49
54
  "values": []
50
55
  },
51
56
  {
@@ -61,7 +66,13 @@
61
66
  {
62
67
  "name": "severity",
63
68
  "description": "If defined, gives the supplied appearance",
64
- "values": [{ "name": "SeverityFgColor" }]
69
+ "values": [
70
+ { "name": "error" },
71
+ { "name": "info" },
72
+ { "name": "warning" },
73
+ { "name": "success" },
74
+ { "name": "alert" }
75
+ ]
65
76
  }
66
77
  ],
67
78
  "references": []
@@ -293,7 +304,7 @@
293
304
  },
294
305
  {
295
306
  "name": "skf-checkbox",
296
- "description": "The `<skf-checkbox>` component is used to create a checkbox input\n---\n\n\n### **Events:**\n - **change** - {object} - When the value of the input changes\n\n### **Slots:**\n - **Default** - Alternatively, you can use the `label` attribute",
307
+ "description": "The `<skf-checkbox>` component is used to create a checkbox input\n---\n\n\n### **Events:**\n - **change** - {object} - When the value of the input changes\n\n### **Slots:**\n - _default_ - The Radios label. Alternatively, you can use the `label` attribute.",
297
308
  "attributes": [
298
309
  {
299
310
  "name": "disabled",
@@ -345,21 +356,26 @@
345
356
  "description": "If defined, renders an alternative A11y text for the asterisk",
346
357
  "values": []
347
358
  },
348
- {
349
- "name": "size",
350
- "description": "Size of the checkbox",
351
- "values": [{ "name": "sm" }, { "name": "md" }]
352
- },
353
359
  {
354
360
  "name": "severity",
355
361
  "description": "If defined, styles checkbox using provided severity",
356
- "values": [{ "name": "FormFieldBaseProps['severity']" }]
362
+ "values": [
363
+ { "name": "alert" },
364
+ { "name": "success" },
365
+ { "name": "info" },
366
+ { "name": "warning" }
367
+ ]
357
368
  },
358
369
  {
359
370
  "name": "show-valid",
360
- "description": "If defined, displays valid state after interaction",
371
+ "description": "If true, displays valid state after interaction",
361
372
  "values": []
362
373
  },
374
+ {
375
+ "name": "size",
376
+ "description": "Size of the checkbox",
377
+ "values": [{ "name": "sm" }, { "name": "md" }]
378
+ },
363
379
  {
364
380
  "name": "value",
365
381
  "description": "The current value of the input field",
@@ -370,7 +386,7 @@
370
386
  },
371
387
  {
372
388
  "name": "skf-collapse",
373
- "description": "The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.\n\nSee [InVision DSM](https://skf.invisionapp.com/dsm/ab-skf/4-web-applications/nav/5fa7caf78c01200018354495/asset/6229e2eb8a8dacf366dc3243) for design principles.\n---\n\n\n### **Events:**\n - **skf-collapse-toggle** - Event emitted when toggled\n\n### **Methods:**\n - **setClose()** - Class method as alternative to manipulate attribute\n- **setOpen()** - Class method as alternative to manipulate attribute\n\n### **Slots:**\n - _default_ - Main content",
389
+ "description": "The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.\n\nSee [zeroheight](https://zeroheight.com/853e936c9/p/6590bf-accordion) for design principles.\n---\n\n\n### **Events:**\n - **skf-collapse-toggle** - Event emitted when toggled\n\n### **Methods:**\n - **setClose()** - Class method as alternative to manipulate attribute\n- **setOpen()** - Class method as alternative to manipulate attribute\n\n### **Slots:**\n - _default_ - Main content",
374
390
  "attributes": [
375
391
  {
376
392
  "name": "animated",
@@ -389,8 +405,13 @@
389
405
  },
390
406
  {
391
407
  "name": "heading-as",
392
- "description": "Controls which heading element will be rendered",
393
- "values": [{ "name": "Exclude<HeadingType" }, { "name": "'h1'>" }]
408
+ "description": "Defines which heading element will be rendered",
409
+ "values": [
410
+ { "name": "h1" },
411
+ { "name": "h2" },
412
+ { "name": "h3" },
413
+ { "name": "h4" }
414
+ ]
394
415
  },
395
416
  {
396
417
  "name": "small",
@@ -407,11 +428,11 @@
407
428
  },
408
429
  {
409
430
  "name": "skf-divider",
410
- "description": "The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information.\n---\n\n\n### **CSS Properties:**\n - **--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)_\n- **--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)_",
431
+ "description": "The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information\n---\n\n\n### **CSS Properties:**\n - **--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)_\n- **--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)_",
411
432
  "attributes": [
412
433
  {
413
434
  "name": "color",
414
- "description": "If provided, alters the Divider color",
435
+ "description": "Defines the Divider color",
415
436
  "values": [
416
437
  { "name": "emphasised" },
417
438
  { "name": "primary" },
@@ -435,17 +456,27 @@
435
456
  },
436
457
  {
437
458
  "name": "skf-heading",
438
- "description": "The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>\nIt extends the interface of native html `<h1>` to `<h4>` elements.\n---\n",
459
+ "description": "The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>\nIt extends the interface of native html `<h1>` to `<h4>` elements.\n---\n\n\n### **Slots:**\n - _default_ - The headings content",
439
460
  "attributes": [
440
461
  {
441
462
  "name": "as",
442
- "description": "Controls which heading element will be rendered. Should not be used to affect appearance.",
443
- "values": [{ "name": "HeadingType" }]
463
+ "description": "Controls which heading element will be rendered. Should not be used to affect appearance",
464
+ "values": [
465
+ { "name": "h1" },
466
+ { "name": "h2" },
467
+ { "name": "h3" },
468
+ { "name": "h4" }
469
+ ]
444
470
  },
445
471
  {
446
472
  "name": "styled-as",
447
473
  "description": "If provided, changes the appearance of the heading",
448
- "values": [{ "name": "HeadingType" }]
474
+ "values": [
475
+ { "name": "h1" },
476
+ { "name": "h2" },
477
+ { "name": "h3" },
478
+ { "name": "h4" }
479
+ ]
449
480
  }
450
481
  ],
451
482
  "references": []
@@ -456,6 +487,7 @@
456
487
  "attributes": [
457
488
  {
458
489
  "name": "color",
490
+ "description": "Sets the color of the icon",
459
491
  "values": [
460
492
  { "name": "primary" },
461
493
  { "name": "inverse" },
@@ -470,11 +502,12 @@
470
502
  },
471
503
  {
472
504
  "name": "label",
473
- "description": "If provided, adds an alternate description to use for assistive devices",
505
+ "description": "If defined, adds an alternate description to use for assistive devices",
474
506
  "values": []
475
507
  },
476
508
  {
477
509
  "name": "name",
510
+ "description": "Name of the icon to display",
478
511
  "values": [
479
512
  { "name": "arrowDown" },
480
513
  { "name": "arrowDownUp" },
@@ -631,6 +664,7 @@
631
664
  },
632
665
  {
633
666
  "name": "size",
667
+ "description": "Size of the icon",
634
668
  "values": [
635
669
  { "name": "xs" },
636
670
  { "name": "sm" },
@@ -643,7 +677,7 @@
643
677
  },
644
678
  {
645
679
  "name": "skf-input",
646
- "description": "The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.\n---\n\n\n### **Events:**\n - **change** - Fires when the value of the input changes\n- **invalid** - Fires when the input is invalid\n\n### **Slots:**\n - **Default** - Alternatively, you can use the `label` attribute",
680
+ "description": "The skf-text-field is used to create a text input field. It can be used inside a form element or standalone.\n---\n\n\n### **Events:**\n - **change** - Fires when the value of the input changes\n- **invalid** - Fires when the input is invalid\n\n### **Slots:**\n - _default_ - The Inputs label. Alternatively, you can use the `label` attribute.",
647
681
  "attributes": [
648
682
  {
649
683
  "name": "disabled",
@@ -657,27 +691,27 @@
657
691
  },
658
692
  {
659
693
  "name": "button-aria-label-clear",
660
- "description": "If provided, renders a custom aria-label for the clear button **Notice!** Only applicable to type=search.",
694
+ "description": "Custom aria-label for the clear button. **Notice!** Only applicable to type=search.",
661
695
  "values": []
662
696
  },
663
697
  {
664
698
  "name": "button-aria-label-hide",
665
- "description": "If provided, renders a custom aria-label for the visibility button. **Notice!** Only applicable to type=password.",
699
+ "description": "Custom aria-label for the visibility button. **Notice!** Only applicable to type=password.",
666
700
  "values": []
667
701
  },
668
702
  {
669
703
  "name": "button-aria-label-show",
670
- "description": "If provided, renders a custom aria-label for the visibility button **Notice!** Only applicable to type=password.",
704
+ "description": "Custom aria-label for the visibility button **Notice!** Only applicable to type=password.",
671
705
  "values": []
672
706
  },
673
707
  {
674
708
  "name": "custom-invalid",
675
- "description": "If provided, forces component to invalid state until removed. Its value is used as hint text.",
709
+ "description": "If defined, forces component to invalid state until removed. Its value is used as hint text.",
676
710
  "values": []
677
711
  },
678
712
  {
679
713
  "name": "debug",
680
- "description": "If provided, outputs helping hints in console",
714
+ "description": "If true, outputs helping hints in console",
681
715
  "values": []
682
716
  },
683
717
  {
@@ -687,12 +721,12 @@
687
721
  },
688
722
  {
689
723
  "name": "hint",
690
- "description": "If provided, displays informational text below the field",
724
+ "description": "If defined, displays informational text below the field",
691
725
  "values": []
692
726
  },
693
727
  {
694
728
  "name": "inputmode",
695
- "description": "If provided, tells what keyboard to use if applicable",
729
+ "description": "Tells what keyboard to use if applicable",
696
730
  "values": [
697
731
  { "name": "none" },
698
732
  { "name": "text" },
@@ -706,47 +740,47 @@
706
740
  },
707
741
  {
708
742
  "name": "label",
709
- "description": "The input's label. Alternatively, you can use the `label` attribute.",
743
+ "description": "If defined, sets the input's label. Alternatively, you can use the `label` attribute.",
710
744
  "values": []
711
745
  },
712
746
  {
713
747
  "name": "leading",
714
- "description": "If provided, displays a prefix/adornment before the input-element",
748
+ "description": "If defined, displays a prefix/adornment before the input-element",
715
749
  "values": []
716
750
  },
717
751
  {
718
752
  "name": "max",
719
- "description": "If provided, sets the maximum value to accept for this input",
753
+ "description": "If defined, sets the maximum value to accept for this input",
720
754
  "values": []
721
755
  },
722
756
  {
723
757
  "name": "maxlength",
724
- "description": "If provided, sets the maximum character length to accept for this input",
758
+ "description": "If defined, sets the maximum character length to accept for this input",
725
759
  "values": []
726
760
  },
727
761
  {
728
762
  "name": "min",
729
- "description": "If provided, sets the minimum value to accept for this input",
763
+ "description": "If defined, sets the minimum value to accept for this input",
730
764
  "values": []
731
765
  },
732
766
  {
733
767
  "name": "minlength",
734
- "description": "If provided, sets the minimum character length to accept for this input",
768
+ "description": "If defined, sets the minimum character length to accept for this input",
735
769
  "values": []
736
770
  },
737
771
  {
738
772
  "name": "name",
739
- "description": "If provided, adds name to the input-element",
773
+ "description": "If defined, adds name to the input-element",
740
774
  "values": []
741
775
  },
742
776
  {
743
777
  "name": "pattern",
744
- "description": "If provided, adds name to the input-element",
778
+ "description": "If defined, adds name to the input-element",
745
779
  "values": []
746
780
  },
747
781
  {
748
782
  "name": "placeholder",
749
- "description": "If provided, displays placeholder text",
783
+ "description": "If defined, displays placeholder text",
750
784
  "values": []
751
785
  },
752
786
  {
@@ -756,40 +790,63 @@
756
790
  },
757
791
  {
758
792
  "name": "required-label",
759
- "description": "If provided, renders an alternative A11y text for the asterisk",
793
+ "description": "If defined, renders an alternative A11y text for the asterisk",
760
794
  "values": []
761
795
  },
762
796
  {
763
797
  "name": "severity",
764
- "description": "If provided, displays provided severity state",
765
- "values": [{ "name": "FormFieldBaseProps['severity']" }]
798
+ "description": "If defined, displays provided severity state",
799
+ "values": [
800
+ { "name": "alert" },
801
+ { "name": "success" },
802
+ { "name": "info" },
803
+ { "name": "warning" }
804
+ ]
766
805
  },
767
806
  {
768
807
  "name": "show-valid",
769
- "description": "If provided, displays provided severity state",
808
+ "description": "If true, displays valid state after interaction",
770
809
  "values": []
771
810
  },
772
811
  {
773
812
  "name": "size",
774
- "description": "If provided, displays an alternative size",
813
+ "description": "Size of the input",
775
814
  "values": [{ "name": "sm" }, { "name": "md" }]
776
815
  },
777
816
  {
778
817
  "name": "trailing",
779
- "description": "If provided, displays a suffix/adornment after the input-element",
818
+ "description": "If defined, displays a suffix/adornment after the input-element",
780
819
  "values": []
781
820
  },
782
821
  {
783
822
  "name": "type",
784
- "description": "If provided, changes the type of form control",
823
+ "description": "Type of input control",
785
824
  "values": [
786
- { "name": "Exclude<FormFieldBaseProps['type'], 'checkbox'" },
787
- { "name": "'radio'>" }
825
+ { "name": "button" },
826
+ { "name": "color" },
827
+ { "name": "date" },
828
+ { "name": "datetime-local" },
829
+ { "name": "email" },
830
+ { "name": "file" },
831
+ { "name": "hidden" },
832
+ { "name": "image" },
833
+ { "name": "month" },
834
+ { "name": "number" },
835
+ { "name": "password" },
836
+ { "name": "range" },
837
+ { "name": "reset" },
838
+ { "name": "search" },
839
+ { "name": "submit" },
840
+ { "name": "tel" },
841
+ { "name": "text" },
842
+ { "name": "time" },
843
+ { "name": "url" },
844
+ { "name": "week" }
788
845
  ]
789
846
  },
790
847
  {
791
848
  "name": "validate-on",
792
- "description": "If provided, sets validation start, \"input\", \"change\" or \"submit\"",
849
+ "description": "Sets validation start",
793
850
  "values": [
794
851
  { "name": "input" },
795
852
  { "name": "change" },
@@ -810,11 +867,12 @@
810
867
  "attributes": [
811
868
  {
812
869
  "name": "as",
813
- "description": "Specifies semantic element to render -",
870
+ "description": "Defines the semantic element to render",
814
871
  "values": [{ "name": "button" }, { "name": "a" }]
815
872
  },
816
873
  {
817
874
  "name": "color",
875
+ "description": "Defines the text-color",
818
876
  "values": [{ "name": "primary" }, { "name": "inverse" }]
819
877
  },
820
878
  {
@@ -824,17 +882,17 @@
824
882
  },
825
883
  {
826
884
  "name": "download",
827
- "description": "If provided, downloads the url",
885
+ "description": "If defined, downloads the url",
828
886
  "values": []
829
887
  },
830
888
  {
831
889
  "name": "href",
832
- "description": "If provided, loads url on click",
890
+ "description": "If defined, loads url on click",
833
891
  "values": []
834
892
  },
835
893
  {
836
894
  "name": "icon",
837
- "description": "If provided, renders an icon before or after the text",
895
+ "description": "If defined, renders an icon before or after the text",
838
896
  "values": [
839
897
  { "name": "arrowDown" },
840
898
  { "name": "arrowDownUp" },
@@ -991,17 +1049,17 @@
991
1049
  },
992
1050
  {
993
1051
  "name": "icon-placement",
994
- "description": "Position of the icon in relation to the text -",
1052
+ "description": "Defines the position of the icon in relation to the text",
995
1053
  "values": [{ "name": "left" }, { "name": "right" }]
996
1054
  },
997
1055
  {
998
1056
  "name": "rel",
999
- "description": "Specifies the relationship of the target object to the link object -",
1057
+ "description": "Defines the relationship of the target object to the link object",
1000
1058
  "values": []
1001
1059
  },
1002
1060
  {
1003
1061
  "name": "route",
1004
- "description": "If provided, used on conjunction with onClick property, second argument",
1062
+ "description": "If defined, used on conjunction with onClick property, second argument",
1005
1063
  "values": []
1006
1064
  },
1007
1065
  {
@@ -1011,7 +1069,7 @@
1011
1069
  },
1012
1070
  {
1013
1071
  "name": "target",
1014
- "description": "If provided, specifies where to open the linked document",
1072
+ "description": "If defined, specifies where to open the linked document",
1015
1073
  "values": [
1016
1074
  { "name": "_blank" },
1017
1075
  { "name": "_parent" },
@@ -1021,7 +1079,7 @@
1021
1079
  },
1022
1080
  {
1023
1081
  "name": "type",
1024
- "description": "Type of button -",
1082
+ "description": "Defines the type of button",
1025
1083
  "values": [
1026
1084
  { "name": "button" },
1027
1085
  { "name": "submit" },
@@ -1033,9 +1091,13 @@
1033
1091
  },
1034
1092
  {
1035
1093
  "name": "skf-loader",
1036
- "description": "The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities.\n---\n",
1094
+ "description": "The `<skf-loader>` component is a progress indicator that uses circular indicators for short, indeterminate activities\n---\n",
1037
1095
  "attributes": [
1038
- { "name": "aria-label", "values": [] },
1096
+ {
1097
+ "name": "aria-label",
1098
+ "description": "Defines the aria-label",
1099
+ "values": []
1100
+ },
1039
1101
  {
1040
1102
  "name": "invert",
1041
1103
  "description": "If true, inverts the color (to be used on colored backgrounds)",
@@ -1043,7 +1105,7 @@
1043
1105
  },
1044
1106
  {
1045
1107
  "name": "size",
1046
- "description": "If provided, displays an alternative size",
1108
+ "description": "Defines the size of the loader",
1047
1109
  "values": [{ "name": "md" }, { "name": "sm" }]
1048
1110
  }
1049
1111
  ],
@@ -1055,12 +1117,12 @@
1055
1117
  "attributes": [
1056
1118
  {
1057
1119
  "name": "title",
1058
- "description": "The title of the logo",
1120
+ "description": "Defines the title of the logo",
1059
1121
  "values": []
1060
1122
  },
1061
1123
  {
1062
1124
  "name": "color",
1063
- "description": "If provided, sets color of the logo",
1125
+ "description": "If defined, sets color of the logo",
1064
1126
  "values": [
1065
1127
  { "name": "primary" },
1066
1128
  { "name": "secondary" },
@@ -1072,7 +1134,7 @@
1072
1134
  },
1073
1135
  {
1074
1136
  "name": "skf-radio",
1075
- "description": "The `<skf-radio>` component is used to create a radio input\n---\n\n\n### **Events:**\n - **change** - {object} - When the value of the input changes\n\n### **Slots:**\n - **Default** - Alternatively, you can use the `label` attribute",
1137
+ "description": "The `<skf-radio>` component is used to create a radio input\n---\n\n\n### **Events:**\n - **change** - {object} - When the value of the input changes\n\n### **Slots:**\n - _default_ - The radios label. Alternatively, you can use the `label` attribute.",
1076
1138
  "attributes": [
1077
1139
  {
1078
1140
  "name": "disabled",
@@ -1086,7 +1148,7 @@
1086
1148
  },
1087
1149
  {
1088
1150
  "name": "debug",
1089
- "description": "If provided, outputs helping hints in console",
1151
+ "description": "If true, outputs helping hints in console",
1090
1152
  "values": []
1091
1153
  },
1092
1154
  {
@@ -1106,32 +1168,37 @@
1106
1168
  },
1107
1169
  {
1108
1170
  "name": "label",
1109
- "description": "The input's label. Alternatively, you can use the `label` attribute.",
1171
+ "description": "If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute.",
1110
1172
  "values": []
1111
1173
  },
1112
1174
  {
1113
1175
  "name": "name",
1114
- "description": "If provided, adds name to the input-element",
1176
+ "description": "If defined, adds name to the input-element",
1115
1177
  "values": []
1116
1178
  },
1117
1179
  {
1118
1180
  "name": "required-label",
1119
- "description": "If provided, renders an alternative A11y text for the asterisk",
1181
+ "description": "If defined, renders an alternative A11y text for the asterisk",
1120
1182
  "values": []
1121
1183
  },
1122
1184
  {
1123
1185
  "name": "size",
1124
- "description": "If provided, displays an alternative size",
1186
+ "description": "Size of the Radio",
1125
1187
  "values": [{ "name": "sm" }, { "name": "md" }]
1126
1188
  },
1127
1189
  {
1128
1190
  "name": "severity",
1129
- "description": "If provided, displays provided severity state",
1130
- "values": [{ "name": "FormFieldBaseProps['severity']" }]
1191
+ "description": "If defined, displays provided severity state",
1192
+ "values": [
1193
+ { "name": "success" },
1194
+ { "name": "info" },
1195
+ { "name": "warning" },
1196
+ { "name": "alert" }
1197
+ ]
1131
1198
  },
1132
1199
  {
1133
1200
  "name": "show-valid",
1134
- "description": "If provided, displays valid state after interaction",
1201
+ "description": "If true, displays valid state after interaction",
1135
1202
  "values": []
1136
1203
  },
1137
1204
  {
@@ -1142,9 +1209,134 @@
1142
1209
  ],
1143
1210
  "references": []
1144
1211
  },
1212
+ {
1213
+ "name": "skf-select",
1214
+ "description": "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.\n---\n\n\n### **Events:**\n - **change** - Fired when the selected option(s) changes\n- **invalid** - Fired when the select is invalid\n- **reset** - Fired when the form is reset\n- **skf-select:dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled\n- **skf-select-option:select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled\n\n### **Slots:**\n - _default_ - The select's placeholder content",
1215
+ "attributes": [
1216
+ {
1217
+ "name": "disabled",
1218
+ "description": "If true, the select is disabled\t`default: false`",
1219
+ "values": []
1220
+ },
1221
+ {
1222
+ "name": "button-label",
1223
+ "description": "Sets the first visible text on the component",
1224
+ "values": []
1225
+ },
1226
+ {
1227
+ "name": "custom-invalid",
1228
+ "description": "If defined, forces component to invalid state until removed",
1229
+ "values": []
1230
+ },
1231
+ {
1232
+ "name": "hide-label",
1233
+ "description": "If true, hides the label visually",
1234
+ "values": []
1235
+ },
1236
+ {
1237
+ "name": "hide-tags",
1238
+ "description": "If true and mulltiple is true, no tags are displayed under the select",
1239
+ "values": []
1240
+ },
1241
+ {
1242
+ "name": "hint",
1243
+ "description": "If defined, sets the hint text under the select component in the form",
1244
+ "values": []
1245
+ },
1246
+ {
1247
+ "name": "label",
1248
+ "description": "If defined, displays provided label",
1249
+ "values": []
1250
+ },
1251
+ {
1252
+ "name": "max",
1253
+ "description": "If defined, limits the number of selectable options",
1254
+ "values": []
1255
+ },
1256
+ {
1257
+ "name": "min",
1258
+ "description": "If defined, sets the minimum number of required options",
1259
+ "values": []
1260
+ },
1261
+ {
1262
+ "name": "multiple",
1263
+ "description": "If true, allows for multiple options to be selected",
1264
+ "values": []
1265
+ },
1266
+ {
1267
+ "name": "name",
1268
+ "description": "If defined, set name of the component",
1269
+ "values": []
1270
+ },
1271
+ {
1272
+ "name": "required-label",
1273
+ "description": "If defined, renders an alternative A11y text for the asterisk",
1274
+ "values": []
1275
+ },
1276
+ {
1277
+ "name": "severity",
1278
+ "description": "If defined, displays provided severity state",
1279
+ "values": [{ "name": "FormFieldBaseProps['severity']" }]
1280
+ },
1281
+ {
1282
+ "name": "show-valid",
1283
+ "description": "If true, displays valid state after interaction",
1284
+ "values": []
1285
+ },
1286
+ {
1287
+ "name": "size",
1288
+ "description": "Size of the Select",
1289
+ "values": [{ "name": "sm" }, { "name": "md" }]
1290
+ }
1291
+ ],
1292
+ "references": []
1293
+ },
1294
+ {
1295
+ "name": "skf-select-option",
1296
+ "description": "The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.\n---\n\n\n### **Events:**\n - **skf-select-option:select** - {detail: { value: string | null, option: SkfSelectOption }} Fires when the option is selected/deselected.\n\n### **Slots:**\n - _default_ - The option's text content\n- **icon** - The option's slot for icon or custom meta information (svg).",
1297
+ "attributes": [
1298
+ {
1299
+ "name": "disabled",
1300
+ "description": "If true, prevents interaction with the option",
1301
+ "values": []
1302
+ },
1303
+ {
1304
+ "name": "icon",
1305
+ "description": "If defined, set an icon",
1306
+ "values": [{ "name": "SkfIcon['name']" }]
1307
+ },
1308
+ {
1309
+ "name": "icon-color",
1310
+ "description": "If defined, sets provided color on the icon",
1311
+ "values": [{ "name": "IconColor" }]
1312
+ },
1313
+ {
1314
+ "name": "selected",
1315
+ "description": "If true, sets the option as selected",
1316
+ "values": []
1317
+ },
1318
+ {
1319
+ "name": "short-label",
1320
+ "description": "If defined, sets a short label",
1321
+ "values": []
1322
+ },
1323
+ {
1324
+ "name": "value",
1325
+ "description": "Returns or sets the tags value. If value is omitted, defaults to the tags text.",
1326
+ "values": []
1327
+ }
1328
+ ],
1329
+ "references": []
1330
+ },
1331
+ {
1332
+ "name": "skf-select-option-group",
1333
+ "description": "The `<skf-select-option-group>` is a component that groups select-options\n---\n\n\n### **Slots:**\n - _default_ - The component's placeholder content",
1334
+ "attributes": [{ "name": "label", "values": [] }],
1335
+ "references": []
1336
+ },
1145
1337
  {
1146
1338
  "name": "skf-switch",
1147
- "description": "The `<skf-switch>` is a component that displays a list of actions or options\n---\n\n\n### **Slots:**\n - _default_ - The component's placeholder content",
1339
+ "description": "The `<skf-switch>` is a component that displays a list of actions or options\n---\n\n\n### **Slots:**\n - _default_ - The Switchs label. Alternatively, you can use the `label` attribute.",
1148
1340
  "attributes": [
1149
1341
  {
1150
1342
  "name": "disabled",
@@ -1173,7 +1365,7 @@
1173
1365
  },
1174
1366
  {
1175
1367
  "name": "label",
1176
- "description": "If defined, sets the input's label. Alternatively, you can use the `label` attribute.",
1368
+ "description": "If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute.",
1177
1369
  "values": []
1178
1370
  },
1179
1371
  {
@@ -1205,12 +1397,12 @@
1205
1397
  "attributes": [
1206
1398
  {
1207
1399
  "name": "size",
1208
- "description": "Specifies Tag size -",
1400
+ "description": "Specifies Tag size",
1209
1401
  "values": [{ "name": "sm" }, { "name": "md" }, { "name": "lg" }]
1210
1402
  },
1211
1403
  {
1212
1404
  "name": "icon",
1213
- "description": "If defined, displays leading/provided icon -",
1405
+ "description": "If defined, displays leading/provided icon",
1214
1406
  "values": [
1215
1407
  { "name": "arrowDown" },
1216
1408
  { "name": "arrowDownUp" },
@@ -1367,7 +1559,7 @@
1367
1559
  },
1368
1560
  {
1369
1561
  "name": "color",
1370
- "description": "If defined, gives the supplied appearance -",
1562
+ "description": "If defined, gives the supplied appearance",
1371
1563
  "values": [
1372
1564
  { "name": "warning" },
1373
1565
  { "name": "success" },
@@ -1386,7 +1578,7 @@
1386
1578
  },
1387
1579
  {
1388
1580
  "name": "skf-textarea",
1389
- "description": "The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.\n---\n\n\n### **Events:**\n - **change** - Fires when the value of the input changes\n- **invalid** - Fires when the input is invalid\n\n### **Slots:**\n - **The** - textareas label. Alternatively, you can use the `label` attribute.",
1581
+ "description": "The skf-textarea is used to create a textarea. Use it inside a form element or wherever you like.\n---\n\n\n### **Events:**\n - **change** - Fires when the value of the input changes\n- **invalid** - Fires when the input is invalid\n\n### **Slots:**\n - _default_ - The textareas label. Alternatively, you can use the `label` attribute.",
1390
1582
  "attributes": [
1391
1583
  {
1392
1584
  "name": "disabled",
@@ -1400,52 +1592,52 @@
1400
1592
  },
1401
1593
  {
1402
1594
  "name": "cols",
1403
- "description": "If provided, sets the cols of the textarea",
1595
+ "description": "If defined, sets the cols of the textarea",
1404
1596
  "values": []
1405
1597
  },
1406
1598
  {
1407
1599
  "name": "custom-invalid",
1408
- "description": "If provided, forces component to invalid state until removed. Its value is used as hint text.",
1600
+ "description": "If defined, forces component to invalid state until removed. Its value is used as hint text.",
1409
1601
  "values": []
1410
1602
  },
1411
1603
  {
1412
1604
  "name": "debug",
1413
- "description": "If provided, outputs helping hints in console",
1605
+ "description": "If true, outputs helping hints in console",
1414
1606
  "values": []
1415
1607
  },
1416
1608
  {
1417
1609
  "name": "hide-label",
1418
- "description": "hide-label - If true, hides the label visually",
1610
+ "description": "If true, hides the label visually",
1419
1611
  "values": []
1420
1612
  },
1421
1613
  {
1422
1614
  "name": "hint",
1423
- "description": "If provided, displays informational text below the field",
1615
+ "description": "If defined, displays informational text below the field",
1424
1616
  "values": []
1425
1617
  },
1426
1618
  {
1427
1619
  "name": "label",
1428
- "description": "The input's label. Alternatively, you can use the component slot.",
1620
+ "description": "If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute.",
1429
1621
  "values": []
1430
1622
  },
1431
1623
  {
1432
1624
  "name": "name",
1433
- "description": "If provided, adds name to the input-element",
1625
+ "description": "If defined, adds name to the input-element",
1434
1626
  "values": []
1435
1627
  },
1436
1628
  {
1437
1629
  "name": "maxlength",
1438
- "description": "If provided, sets the maximum character length to accept for this input",
1630
+ "description": "If defined, sets the maximum character length to accept for this input",
1439
1631
  "values": []
1440
1632
  },
1441
1633
  {
1442
1634
  "name": "minlength",
1443
- "description": "If provided, sets the minimum character length to accept for this input",
1635
+ "description": "If defined, sets the minimum character length to accept for this input",
1444
1636
  "values": []
1445
1637
  },
1446
1638
  {
1447
1639
  "name": "placeholder",
1448
- "description": "If provided, displays placeholder text",
1640
+ "description": "If defined, displays placeholder text",
1449
1641
  "values": []
1450
1642
  },
1451
1643
  {
@@ -1455,18 +1647,23 @@
1455
1647
  },
1456
1648
  {
1457
1649
  "name": "required-label",
1458
- "description": "If provided, renders an alternative A11y text for the asterisk",
1650
+ "description": "If defined, renders an alternative A11y text for the asterisk",
1459
1651
  "values": []
1460
1652
  },
1461
1653
  {
1462
1654
  "name": "rows",
1463
- "description": "If provided, sets the rows of the textarea",
1655
+ "description": "If defined, sets the rows of the textarea",
1464
1656
  "values": []
1465
1657
  },
1466
1658
  {
1467
1659
  "name": "severity",
1468
- "description": "If provided, displays provided severity state",
1469
- "values": [{ "name": "success" }, { "name": "error" }]
1660
+ "description": "If defined, displays provided severity state",
1661
+ "values": [
1662
+ { "name": "success" },
1663
+ { "name": "info" },
1664
+ { "name": "warning" },
1665
+ { "name": "alert" }
1666
+ ]
1470
1667
  },
1471
1668
  {
1472
1669
  "name": "show-valid",
@@ -1475,12 +1672,12 @@
1475
1672
  },
1476
1673
  {
1477
1674
  "name": "size",
1478
- "description": "If provided, displays an alternative size",
1675
+ "description": "Size of the Textarea",
1479
1676
  "values": [{ "name": "sm" }, { "name": "md" }]
1480
1677
  },
1481
1678
  {
1482
1679
  "name": "validate-on",
1483
- "description": "If provided, sets validation start, \"input\", \"change\" or \"submit\"",
1680
+ "description": "Sets validation start",
1484
1681
  "values": [
1485
1682
  { "name": "input" },
1486
1683
  { "name": "change" },