@skf-design-system/ui-components 1.0.2-beta.6 → 1.0.2-beta.7

package/dist/types/jsx/custom-element-jsx.d.ts

@@ -43,7 +43,7 @@ import type { SkfTab, CustomEvent } from "../../components/tab/tab.component.js"
 import type { SkfTextArea } from "../../components/textarea/textarea.component.js";
 import type { SkfToastWrapper } from "../../components/toast-wrapper/toast-wrapper.component.js";
 import type { SkfToast } from "../../components/toast/toast.component.js";
-import type { SkfTooltip } from "../../components/tooltip/tooltip.component.js";
+import type { SkfTooltip, CustomEvent } from "../../components/tooltip/tooltip.component.js";
 
 /**
  * This type can be used to create scoped tags for your components.
@@ -258,10 +258,10 @@ export type SkfAccordionProps = {
 };
 
 export type SkfAlertProps = {
-  /** Close button aria-label */
-  "button-label"?: SkfAlert["buttonLabel"];
   /** If defined, displays leading icon */
   icon?: SkfAlert["icon"];
+  /** Sets the internal language of the component */
+  lang?: SkfAlert["lang"];
   /** If true, renders with an close button and sets aria-role to `status` */
   persistent?: SkfAlert["persistent"];
   /** If defined, gives the supplied appearance */
@@ -289,8 +289,6 @@ export type SkfBreadcrumbProps = {
 };
 
 export type SkfLoaderProps = {
-  /** Defines the aria-label */
-  "aria-label"?: SkfLoader["ariaLabel"];
   /** If true, inverts the color (to be used on colored backgrounds) */
   invert?: SkfLoader["invert"];
   /** Defines the size of the loader */
@@ -347,10 +345,10 @@ export type SkfCheckboxProps = {
   indeterminate?: SkfCheckbox["indeterminate"];
   /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
   label?: SkfCheckbox["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfCheckbox["lang"];
   /** If defined, adds name to the input-element */
   name?: SkfCheckbox["name"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfCheckbox["requiredLabel"];
   /** If defined, styles checkbox using provided severity */
   severity?: SkfCheckbox["severity"];
   /** If true, displays valid state after interaction */
@@ -371,6 +369,8 @@ export type SkfDatepickerCalendarProps = {
   firstDayOfWeek?: SkfDatepickerCalendar["firstDayOfWeek"];
   /** A comma-separated list of dates (yyyy-mm-dd format) that are not selectable. */
   "invalid-dates"?: SkfDatepickerCalendar["invalidDates"];
+  /** Sets the internal language of the component */
+  lang?: SkfDatepickerCalendar["lang"];
   /**  */
   locale?: SkfDatepickerCalendar["locale"];
   /**  */
@@ -398,6 +398,8 @@ export type SkfDatepickerProps = {
   id?: SkfDatepicker["id"];
   /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
   label?: SkfDatepicker["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfDatepicker["lang"];
   /** If true, hides the label visually */
   "hide-label"?: SkfDatepicker["hideLabel"];
   /** If defined, displays informational text below the field */
@@ -412,8 +414,6 @@ export type SkfDatepickerProps = {
   range?: SkfDatepicker["range"];
   /** If true, makes the element not mutable, meaning the user can not edit the control */
   readonly?: SkfDatepicker["readonly"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfDatepicker["requiredLabel"];
   /** Earliest selectable date. (yyyy-mm-dd format) */
   "selectable-from"?: SkfDatepicker["selectableFrom"];
   /** Latest selectable date. (yyyy-mm-dd format) */
@@ -438,12 +438,12 @@ export type SkfHeadingProps = {
 };
 
 export type SkfDialogProps = {
-  /** If defined, sets the aria-label for the close button */
-  "close-button-aria-label"?: SkfDialog["closeButtonAriaLabel"];
   /** Title for the modal/dialog */
   heading?: SkfDialog["heading"];
   /** If true, makes the dialog stretch edge to edge on screen */
   fullscreen?: SkfDialog["fullscreen"];
+  /** Sets the internal language of the component */
+  lang?: SkfDialog["lang"];
   /** If true, removes the close button */
   "no-close-button"?: SkfDialog["noCloseButton"];
   /** If defined, removes the inner padding */
@@ -469,10 +469,10 @@ export type SkfDividerProps = {
 };
 
 export type SkfDrawerProps = {
-  /** If defined, sets the aria-label for the close button */
-  "close-button-aria-label"?: SkfDrawer["closeButtonAriaLabel"];
   /** Heading for the Drawer */
   heading?: SkfDrawer["heading"];
+  /** Sets the internal language of the component */
+  lang?: SkfDrawer["lang"];
   /** Sets the max-width */
   size?: SkfDrawer["size"];
   /** If true, Drawer is open */
@@ -533,6 +533,8 @@ export type SkfNavItemProps = {
 };
 
 export type SkfNavProps = {
+  /** Sets the internal language of the component */
+  lang?: SkfNav["lang"];
   /** If true, the navigation will be displayed vertically */
   vertical?: SkfNav["vertical"];
 };
@@ -540,8 +542,8 @@ export type SkfNavProps = {
 export type SkfHeaderProps = {
   /** If true, sets header to display in compact mode only (hanburger menu and drawer) */
   compact?: SkfHeader["compact"];
-  /** If defined, sets the aria-label for the hamburger button */
-  "hamburger-aria-label"?: SkfHeader["hamburgerAriaLabel"];
+  /** Sets the internal language of the component */
+  lang?: SkfHeader["lang"];
   /** If defined, sets the app or site's name */
   "site-name"?: SkfHeader["siteName"];
   /** If defined, sets the site's base-url for the "logo-link" */
@@ -556,12 +558,6 @@ export type SkfInputProps = {
   /** Indicates whether the value of the control can be automatically completed by the browser. See
 [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/autocomplete) for details. */
   autocomplete?: SkfInput["autocomplete"];
-  /** Custom aria-label for the clear button. **Notice!** Only applicable to type=search. */
-  "button-aria-label-clear"?: SkfInput["buttonAriaLabelClear"];
-  /** Custom aria-label for the visibility button. **Notice!** Only applicable to type=password. */
-  "button-aria-label-hide"?: SkfInput["buttonAriaLabelHide"];
-  /** Custom aria-label for the visibility button **Notice!** Only applicable to type=password. */
-  "button-aria-label-show"?: SkfInput["buttonAriaLabelShow"];
   /** If defined, forces component to invalid state until removed. Its value is used as hint text. */
   "custom-invalid"?: SkfInput["customInvalid"];
   /** If true, outputs helping hints in console */
@@ -575,6 +571,8 @@ export type SkfInputProps = {
   inputmode?: SkfInput["inputmode"];
   /** If defined, sets the input's label. Alternatively, you can use the `label` attribute. */
   label?: SkfInput["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfInput["lang"];
   /** If defined, displays a prefix/adornment before the input-element */
   leading?: SkfInput["leading"];
   /** If defined, sets the maximum value to accept for this input */
@@ -593,8 +591,6 @@ export type SkfInputProps = {
   placeholder?: SkfInput["placeholder"];
   /** If true, makes the element not mutable, meaning the user can not edit the control */
   readonly?: SkfInput["readonly"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfInput["requiredLabel"];
   /** If defined, displays provided severity state */
   severity?: SkfInput["severity"];
   /** If true, displays valid state after interaction */
@@ -649,7 +645,10 @@ export type SkfMenuProps = {
   placement?: SkfMenu["undefined"];
   /** The id of the element the menu will be anchored to */
   anchor?: SkfMenu["undefined"];
-
+  /** Method that opens the menu */
+  "open()"?: SkfMenu["open()"];
+  /** Method that closes the menu */
+  "close()"?: SkfMenu["close()"];
   /** Fired when the menu is opened */
   "onskf-opened"?: (e: CustomEvent<CustomEvent>) => void;
   /** Fired when the menu is closed */
@@ -659,16 +658,19 @@ export type SkfMenuProps = {
 export type SkfPopoverProps = {
   /** The placement of the popover */
   placement?: SkfPopover["undefined"];
-  /** The id of the element the menu will be anchored to */
+  /** The id of the element the popover will be anchored to */
   anchor?: SkfPopover["undefined"];
   /** If defined, sets a custom offset for the popover */
   offset?: SkfPopover["offset"];
   /** If true, hides the arrow */
   hideArrow?: SkfPopover["hideArrow"];
-
-  /** Fired when the menu is opened */
+  /** Method that opens the popover */
+  "open()"?: SkfPopover["open()"];
+  /** Method that closes the popover */
+  "close()"?: SkfPopover["close()"];
+  /** Fired when the popover is opened */
   "onskf-opened"?: (e: CustomEvent<CustomEvent>) => void;
-  /** Fired when the menu is closed */
+  /** Fired when the popover is closed */
   "onskf-closed"?: (e: CustomEvent<CustomEvent>) => void;
 };
 
@@ -694,10 +696,10 @@ export type SkfRadioProps = {
   "custom-invalid"?: SkfRadio["customInvalid"];
   /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
   label?: SkfRadio["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfRadio["lang"];
   /** If defined, adds name to the input-element */
   name?: SkfRadio["name"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfRadio["requiredLabel"];
   /** Size of the Radio */
   size?: SkfRadio["size"];
   /** If defined, displays provided severity state */
@@ -742,6 +744,8 @@ export type SkfTagProps = {
   icon?: SkfTag["icon"];
   /** If defined, gives the supplied appearance */
   color?: SkfTag["color"];
+  /** Sets the internal language of the component */
+  lang?: SkfTag["lang"];
   /** If true, adds trailing button to remove tag */
   removable?: SkfTag["removable"];
   /** If defined, accepts a function that runs on click */
@@ -767,6 +771,8 @@ export type SkfSelectProps = {
   hint?: SkfSelect["hint"];
   /** If defined, displays provided label */
   label?: SkfSelect["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfSelect["lang"];
   /** If defined, limits the number of selectable options */
   max?: SkfSelect["max"];
   /** If defined, sets the minimum number of required options */
@@ -775,8 +781,6 @@ export type SkfSelectProps = {
   multiple?: SkfSelect["multiple"];
   /** If defined, set name of the component */
   name?: SkfSelect["name"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfSelect["requiredLabel"];
   /** If defined, displays provided severity state */
   severity?: SkfSelect["severity"];
   /** If true, displays valid state after interaction */
@@ -787,7 +791,7 @@ export type SkfSelectProps = {
   selectedValues?: SkfSelect["selectedValues"];
   /** A readonly property that returns the selected slot(s) text content in a array */
   selectedOptionsText?: SkfSelect["selectedOptionsText"];
-  /** Read only, returns the selected value. (if multiple: in a comma separated string) */
+  /** Returns the selected value. (if multiple: in a comma separated string). If set will default set corresponding option. */
   value?: SkfSelect["value"];
   /**  */
   _selectedOptions?: SkfSelect["_selectedOptions"];
@@ -801,6 +805,8 @@ export type SkfSelectProps = {
   "onskf-select-dropdown"?: (e: CustomEvent<CustomEvent>) => void;
   /** {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled */
   "onskf-select-option-select"?: (e: CustomEvent<CustomEvent>) => void;
+  /** Fires when the calendar view is updated */
+  "onskf-update-calendar-view"?: (e: CustomEvent<CustomEvent>) => void;
 };
 
 export type SkfSelectOptionProps = {
@@ -814,7 +820,7 @@ export type SkfSelectOptionProps = {
   selected?: SkfSelectOption["selected"];
   /** If defined, sets a short label */
   "short-label"?: SkfSelectOption["shortLabel"];
-  /** Returns or sets the tags value. If value is omitted, defaults to the tags text. */
+  /** Returns or sets the option value. If value is omitted, defaults to the tags slotted text. */
   value?: SkfSelectOption["value"];
   /** The option's label text (equivalent to the tags textContent) */
   text?: SkfSelectOption["text"];
@@ -860,10 +866,10 @@ export type SkfSwitchProps = {
   "hide-label"?: SkfSwitch["hideLabel"];
   /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
   label?: SkfSwitch["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfSwitch["lang"];
   /** If defined, adds name to the input-element */
   name?: SkfSwitch["name"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfSwitch["requiredLabel"];
   /** Size of the Switch */
   size?: SkfSwitch["size"];
   /** The current value of the input field */
@@ -920,6 +926,8 @@ export type SkfTextAreaProps = {
   hint?: SkfTextArea["hint"];
   /** If defined, sets the input's label unless the default slot is used. Alternatively, you can use the `label` attribute. */
   label?: SkfTextArea["label"];
+  /** Sets the internal language of the component */
+  lang?: SkfTextArea["lang"];
   /** If defined, adds name to the input-element */
   name?: SkfTextArea["name"];
   /** If defined, sets the maximum character length to accept for this input */
@@ -930,8 +938,6 @@ export type SkfTextAreaProps = {
   placeholder?: SkfTextArea["placeholder"];
   /** If true, makes the element not mutable, meaning the user can not edit the control */
   readonly?: SkfTextArea["readonly"];
-  /** If defined, renders an alternative A11y text for the asterisk */
-  "required-label"?: SkfTextArea["requiredLabel"];
   /** If defined, sets the rows of the textarea */
   rows?: SkfTextArea["rows"];
   /** If defined, displays provided severity state */
@@ -982,10 +988,14 @@ export type SkfTooltipProps = {
   placement?: SkfTooltip["placement"];
   /**  */
   variant?: SkfTooltip["variant"];
-  /** Fired when the dropdown is opened */
-  "onskf-opened"?: (e: CustomEvent<never>) => void;
-  /** Fired when the dropdown is closed */
-  "onskf-closed"?: (e: CustomEvent<never>) => void;
+  /** Method that opens the tooltip */
+  "open()"?: SkfTooltip["open()"];
+  /** Method that closes the tooltip */
+  "close()"?: SkfTooltip["close()"];
+  /** Fired when the tooltip is opened */
+  "onskf-opened"?: (e: CustomEvent<CustomEvent>) => void;
+  /** Fired when the tooltip is closed */
+  "onskf-closed"?: (e: CustomEvent<CustomEvent>) => void;
 };
 
 export type CustomElements = {
@@ -1292,7 +1302,7 @@ export type CustomElements = {
    * - **skf-closed** - Fired when the menu is closed
    *
    * ### **Slots:**
-   *  - _default_ - The menu popover content
+   *  - _default_ - The menu content
    */
   "skf-menu": Partial<SkfMenuProps & BaseProps & BaseEvents>;
 
@@ -1304,8 +1314,8 @@ export type CustomElements = {
    *
    *
    * ### **Events:**
-   *  - **skf-opened** - Fired when the menu is opened
-   * - **skf-closed** - Fired when the menu is closed
+   *  - **skf-opened** - Fired when the popover is opened
+   * - **skf-closed** - Fired when the popover is closed
    *
    * ### **Slots:**
    *  - _default_ - The popover content
@@ -1392,6 +1402,7 @@ export type CustomElements = {
    * - **reset** - Fired when the form is reset
    * - **skf-select-dropdown** - {detail: {expanded: boolean}} Fired when the select dropdown is toggled
    * - **skf-select-option-select** - {detail: {value: string | null, option: SkfSelectOption}} Fired when the select dropdown is toggled
+   * - **skf-update-calendar-view** - Fires when the calendar view is updated
    *
    * ### **Slots:**
    *  - _default_ - The select's placeholder content
@@ -1400,6 +1411,7 @@ export type CustomElements = {
 
   /**
    * The `<skf-select-option>` is a component is used nested in a skf-select or skf-select-option-group.
+   * It represents an individual option in a select dropdown.
    * ---
    *
    *
@@ -1525,8 +1537,8 @@ export type CustomElements = {
    *
    *
    * ### **Events:**
-   *  - **skf-opened** - Fired when the dropdown is opened
-   * - **skf-closed** - Fired when the dropdown is closed
+   *  - **skf-opened** - Fired when the tooltip is opened
+   * - **skf-closed** - Fired when the tooltip is closed
    *
    * ### **Slots:**
    *  - _default_ - The tooltip popover content