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

package/dist/types/vue/index.d.ts

@@ -1,12 +1,12 @@
 import type { DefineComponent } from "vue";
 
 import type { SkfAccordion } from "../../components/accordion/accordion.component.js";
+import type { SkfAlert } from "../../components/alert/alert.component.js";
 import type { SkfButton } from "../../components/button/button.component.js";
 import type { SkfCard } from "../../components/card/card.component.js";
-import type { SkfAlert } from "../../components/alert/alert.component.js";
 import type { SkfCheckbox } from "../../components/checkbox/checkbox.component.js";
-import type { SkfDivider } from "../../components/divider/divider.component.js";
 import type { SkfCollapse, CustomEvent } from "../../components/collapse/collapse.component.js";
+import type { SkfDivider } from "../../components/divider/divider.component.js";
 import type { SkfHeading } from "../../components/heading/heading.component.js";
 import type { SkfIcon } from "../../components/icon/icon.component.js";
 import type { SkfInput } from "../../components/input/input.component.js";
@@ -20,6 +20,8 @@ import type { SkfSelectOptionGroup } from "../../components/select-option-group/
 import type { SkfSwitch } from "../../components/switch/switch.component.js";
 import type { SkfTag } from "../../components/tag/tag.component.js";
 import type { SkfTextArea } from "../../components/textarea/textarea.component.js";
+import type { SkfToast } from "../../components/toast/toast.component.js";
+import type { SkfToastWrapper } from "../../components/toast-wrapper/toast-wrapper.component.js";
 
 type SkfAccordionProps = {
   /** If true, will animate the expand/collapse state */
@@ -36,6 +38,20 @@ type SkfAccordionProps = {
   truncate?: SkfAccordion["truncate"];
 };
 
+type SkfAlertProps = {
+  /** If true, alert is being used as a toast (alertdialog) with an close button */
+  closeable?: SkfAlert["closeable"];
+  /** Close button aria-label */
+  "button-label"?: SkfAlert["buttonLabel"];
+  /** If defined, displays leading icon */
+  icon?: SkfAlert["icon"];
+  /** If defined, gives the supplied appearance */
+  severity?: SkfAlert["severity"];
+
+  /** Fires when the close button is clicked */
+  "onskf-alert-close"?: (e: CustomEvent<never>) => void;
+};
+
 type SkfButtonProps = {
   /** If true, gives destructive appearance. **Notice!** Only applicable if `variant` is `primary`. */
   destructive?: SkfButton["destructive"];
@@ -64,20 +80,6 @@ type SkfCardProps = {
   stretch?: SkfCard["stretch"];
 };
 
-type SkfAlertProps = {
-  /** If true, alert is being used as a toast (alertdialog) with an close button */
-  closeable?: SkfAlert["closeable"];
-  /** Close button aria-label */
-  "button-label"?: SkfAlert["buttonLabel"];
-  /** If defined, displays leading icon */
-  icon?: SkfAlert["icon"];
-  /** If defined, gives the supplied appearance */
-  severity?: SkfAlert["severity"];
-
-  /** Fires when the close button is clicked */
-  "onskf-alert-close"?: (e: CustomEvent<never>) => void;
-};
-
 type SkfCheckboxProps = {
   /** If true, sets disabled state */
   disabled?: SkfCheckbox["undefined"];
@@ -112,15 +114,6 @@ type SkfCheckboxProps = {
   onchange?: (e: CustomEvent<never>) => void;
 };
 
-type SkfDividerProps = {
-  /** Defines the Divider color */
-  color?: SkfDivider["color"];
-  /** If true, renders a div for presentational purpose instead of the semantic hr-element */
-  decorative?: SkfDivider["decorative"];
-  /** If true, renders the divider vertically */
-  vertical?: SkfDivider["vertical"];
-};
-
 type SkfCollapseProps = {
   /** If true, will animate the expand/collapse state */
   animated?: SkfCollapse["animated"];
@@ -139,6 +132,15 @@ type SkfCollapseProps = {
   "onskf-collapse-toggle"?: (e: CustomEvent<CustomEvent>) => void;
 };
 
+type SkfDividerProps = {
+  /** Defines the Divider color */
+  color?: SkfDivider["color"];
+  /** If true, renders a div for presentational purpose instead of the semantic hr-element */
+  decorative?: SkfDivider["decorative"];
+  /** If true, renders the divider vertically */
+  vertical?: SkfDivider["vertical"];
+};
+
 type SkfHeadingProps = {
   /** Controls which heading element will be rendered. Should not be used to affect appearance */
   as?: SkfHeading["as"];
@@ -334,9 +336,9 @@ type SkfSelectProps = {
   /** Size of the Select */
   size?: SkfSelect["size"];
   /** A readonly property that returns the selected value(s) in a array */
-  getSelectedValues?: SkfSelect["getSelectedValues"];
+  selectedValues?: SkfSelect["selectedValues"];
   /** A readonly property that returns the selected slot(s) text content in a array */
-  getSelectedOptionsText?: SkfSelect["getSelectedOptionsText"];
+  selectedOptionsText?: SkfSelect["selectedOptionsText"];
   /** Read only, returns the selected value. (if multiple: in a comma separated string) */
   value?: SkfSelect["value"];
   /**  */
@@ -469,6 +471,24 @@ type SkfTextAreaProps = {
   oninvalid?: (e: CustomEvent<never>) => void;
 };
 
+type SkfToastProps = {
+  /** If provided, adds a close button to the toast and will not disapear until user actively dismisses it. */
+  closeable?: SkfToast["closeable"];
+  /**  */
+  debug?: SkfToast["debug"];
+  /** Severity of the toast. */
+  severity?: SkfToast["severity"];
+  /** Time in seconds before the toast disappears. */
+  timer?: SkfToast["timer"];
+  /** offsets where toasts emerge vertically */
+  topOffset?: SkfToast["topOffset"];
+};
+
+type SkfToastWrapperProps = {
+  /**  */
+  debug?: SkfToastWrapper["debug"];
+};
+
 export type CustomElements = {
   /**
    * The `<skf-accordion>` component consists of multiple `<skf-collapse>`, working together.
@@ -483,38 +503,38 @@ export type CustomElements = {
   "skf-accordion": DefineComponent<SkfAccordionProps>;
 
   /**
-   * Component to be used in forms or for interactivity
+   * The `<skf-alert>` is a type of notification that appears in-line
    * ---
    *
    *
+   * ### **Events:**
+   *  - **skf-alert-close** - Fires when the close button is clicked
+   *
    * ### **Slots:**
-   *  - _default_ - The Primary content
+   *  - _default_ - Alert message. **Notice!** See design principles for approved content
+   * - **link** - Slot for the link
    */
-  "skf-button": DefineComponent<SkfButtonProps>;
+  "skf-alert": DefineComponent<SkfAlertProps>;
 
   /**
-   * The `<skf-card>` can be used to group related subjects in a container
+   * Component to be used in forms or for interactivity
    * ---
    *
    *
    * ### **Slots:**
-   *  - _default_ - The card's main content
+   *  - _default_ - The Primary content
    */
-  "skf-card": DefineComponent<SkfCardProps>;
+  "skf-button": DefineComponent<SkfButtonProps>;
 
   /**
-   * The `<skf-alert>` is a type of notification that appears in-line
+   * The `<skf-card>` can be used to group related subjects in a container
    * ---
    *
    *
-   * ### **Events:**
-   *  - **skf-alert-close** - Fires when the close button is clicked
-   *
    * ### **Slots:**
-   *  - _default_ - Alert message. **Notice!** See design principles for approved content
-   * - **link** - Slot for the link
+   *  - _default_ - The card's main content
    */
-  "skf-alert": DefineComponent<SkfAlertProps>;
+  "skf-card": DefineComponent<SkfCardProps>;
 
   /**
    * The `<skf-checkbox>` component is used to create a checkbox input
@@ -529,17 +549,6 @@ export type CustomElements = {
    */
   "skf-checkbox": DefineComponent<SkfCheckboxProps>;
 
-  /**
-   * The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
-   * ---
-   *
-   *
-   * ### **CSS Properties:**
-   *  - **--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)_
-   * - **--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)_
-   */
-  "skf-divider": DefineComponent<SkfDividerProps>;
-
   /**
    * The `<skf-collapse>` component is a general purpose container for content that can be collapsed / expanded.
    *
@@ -559,6 +568,17 @@ export type CustomElements = {
    */
   "skf-collapse": DefineComponent<SkfCollapseProps>;
 
+  /**
+   * The `<Divider>` component can separate items from each other, to visually emphasize their lack of a relationship between groups of information
+   * ---
+   *
+   *
+   * ### **CSS Properties:**
+   *  - **--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)_
+   * - **--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)_
+   */
+  "skf-divider": DefineComponent<SkfDividerProps>;
+
   /**
    * The `<Heading>` component is to deliniate content on a page. When using, take note not to skip heading levels.<br>
    * It extends the interface of native html `<h1>` to `<h4>` elements.
@@ -705,6 +725,26 @@ export type CustomElements = {
    *  - _default_ - The textareas label. Alternatively, you can use the `label` attribute.
    */
   "skf-textarea": DefineComponent<SkfTextAreaProps>;
+
+  /**
+   * A simple toast component that displays a message to the user. Use by appending a &lt;skf-toast&gt; tag to the DOM. Position in DOM is irrelevant.
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - The component's placeholder content
+   */
+  "skf-toast": DefineComponent<SkfToastProps>;
+
+  /**
+   * 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.
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - The alert components that the toast creates will render here.
+   */
+  "skf-toast-wrapper": DefineComponent<SkfToastWrapperProps>;
 };
 
 declare module "vue" {

package/dist/vscode.html-custom-data.json

@@ -44,6 +44,39 @@
       ],
       "references": []
     },
+    {
+      "name": "skf-alert",
+      "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",
+      "attributes": [
+        {
+          "name": "closeable",
+          "description": "If true, alert is being used as a toast (alertdialog) with an close button",
+          "values": []
+        },
+        {
+          "name": "button-label",
+          "description": "Close button aria-label",
+          "values": []
+        },
+        {
+          "name": "icon",
+          "description": "If defined, displays leading icon",
+          "values": [{ "name": "SkfIcon['name']" }]
+        },
+        {
+          "name": "severity",
+          "description": "If defined, gives the supplied appearance",
+          "values": [
+            { "name": "error" },
+            { "name": "info" },
+            { "name": "warning" },
+            { "name": "success" },
+            { "name": "alert" }
+          ]
+        }
+      ],
+      "references": []
+    },
     {
       "name": "skf-button",
       "description": "Component to be used in forms or for interactivity\n---\n\n\n### **Slots:**\n - _default_ - The Primary content",
@@ -269,39 +302,6 @@
       ],
       "references": []
     },
-    {
-      "name": "skf-alert",
-      "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",
-      "attributes": [
-        {
-          "name": "closeable",
-          "description": "If true, alert is being used as a toast (alertdialog) with an close button",
-          "values": []
-        },
-        {
-          "name": "button-label",
-          "description": "Close button aria-label",
-          "values": []
-        },
-        {
-          "name": "icon",
-          "description": "If defined, displays leading icon",
-          "values": [{ "name": "SkfIcon['name']" }]
-        },
-        {
-          "name": "severity",
-          "description": "If defined, gives the supplied appearance",
-          "values": [
-            { "name": "error" },
-            { "name": "info" },
-            { "name": "warning" },
-            { "name": "success" },
-            { "name": "alert" }
-          ]
-        }
-      ],
-      "references": []
-    },
     {
       "name": "skf-checkbox",
       "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.",
@@ -384,34 +384,6 @@
       ],
       "references": []
     },
-    {
-      "name": "skf-divider",
-      "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)_",
-      "attributes": [
-        {
-          "name": "color",
-          "description": "Defines the Divider color",
-          "values": [
-            { "name": "emphasised" },
-            { "name": "primary" },
-            { "name": "secondary" },
-            { "name": "tertiary" },
-            { "name": "inverse" }
-          ]
-        },
-        {
-          "name": "decorative",
-          "description": "If true, renders a div for presentational purpose instead of the semantic hr-element",
-          "values": []
-        },
-        {
-          "name": "vertical",
-          "description": "If true, renders the divider vertically",
-          "values": []
-        }
-      ],
-      "references": []
-    },
     {
       "name": "skf-collapse",
       "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",
@@ -454,6 +426,34 @@
       ],
       "references": []
     },
+    {
+      "name": "skf-divider",
+      "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)_",
+      "attributes": [
+        {
+          "name": "color",
+          "description": "Defines the Divider color",
+          "values": [
+            { "name": "emphasised" },
+            { "name": "primary" },
+            { "name": "secondary" },
+            { "name": "tertiary" },
+            { "name": "inverse" }
+          ]
+        },
+        {
+          "name": "decorative",
+          "description": "If true, renders a div for presentational purpose instead of the semantic hr-element",
+          "values": []
+        },
+        {
+          "name": "vertical",
+          "description": "If true, renders the divider vertically",
+          "values": []
+        }
+      ],
+      "references": []
+    },
     {
       "name": "skf-heading",
       "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",
@@ -1308,7 +1308,7 @@
         {
           "name": "icon-color",
           "description": "If defined, sets provided color on the icon",
-          "values": [{ "name": "IconColor" }]
+          "values": [{ "name": "SeverityFgColor" }]
         },
         {
           "name": "selected",
@@ -1691,6 +1691,45 @@
         }
       ],
       "references": []
+    },
+    {
+      "name": "skf-toast",
+      "description": "A simple toast component that displays a message to the user. Use by appending a &lt;skf-toast&gt; tag to the DOM. Position in DOM is irrelevant.\n---\n\n\n### **Slots:**\n - _default_ - The component's placeholder content",
+      "attributes": [
+        {
+          "name": "closeable",
+          "description": "If provided, adds a close button to the toast and will not disapear until user actively dismisses it.",
+          "values": []
+        },
+        { "name": "debug", "values": [] },
+        {
+          "name": "severity",
+          "description": "Severity of the toast.",
+          "values": [
+            { "name": "info" },
+            { "name": "success" },
+            { "name": "warning" },
+            { "name": "error" }
+          ]
+        },
+        {
+          "name": "timer",
+          "description": "Time in seconds before the toast disappears.",
+          "values": []
+        },
+        {
+          "name": "topOffset",
+          "description": "offsets where toasts emerge vertically",
+          "values": []
+        }
+      ],
+      "references": []
+    },
+    {
+      "name": "skf-toast-wrapper",
+      "description": "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.\n---\n\n\n### **Slots:**\n - _default_ - The alert components that the toast creates will render here.",
+      "attributes": [{ "name": "debug", "values": [] }],
+      "references": []
     }
   ]
 }