@siemens/ix 4.2.0 → 4.3.0

package/dist/types/components.d.ts

@@ -126,6 +126,11 @@ export namespace Components {
           * @default undefined
          */
         "icon": string | undefined;
+        /**
+          * If true, disables hover and active styles and changes cursor to default
+          * @default false
+         */
+        "passive": boolean;
         /**
           * Card selection
           * @default false
@@ -190,6 +195,7 @@ export namespace Components {
         /**
           * ARIA label for the menu expand icon button
           * @since 3.2.0
+          * @deprecated This prop is no longer used as the menu expand button is hidden from screen readers. Will be removed in 5.0.0
          */
         "ariaLabelMenuExpandIconButton"?: string;
         /**
@@ -207,6 +213,12 @@ export namespace Components {
           * @since 4.0.0
          */
         "companyLogoAlt"?: string;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Hides the bottom border of the header
           * @since 4.0.0
@@ -296,6 +308,12 @@ export namespace Components {
           * @default 'previous'
          */
         "ariaLabelPreviousButton": string;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Items will be accessible through a dropdown
           * @default []
@@ -425,6 +443,11 @@ export namespace Components {
         "variant": ButtonVariant;
     }
     interface IxCard {
+        /**
+          * If true, disables hover and active styles and changes cursor to default
+          * @default false
+         */
+        "passive": boolean;
         /**
           * Show card in selected state
           * @default false
@@ -538,6 +561,12 @@ export namespace Components {
           * @default false
          */
         "disabled": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * A set of search criteria to populate the component with.
          */
@@ -847,6 +876,12 @@ export namespace Components {
           * @default false
          */
         "disabled": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Date format string. See {@link https://moment.github.io/luxon/#/formatting?id=table-of-tokens} for all available tokens.
           * @default 'yyyy/LL/dd'
@@ -948,6 +983,12 @@ export namespace Components {
           * @default false
          */
         "disabled": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Focuses the input field
          */
@@ -1077,6 +1118,12 @@ export namespace Components {
           * @default false
          */
         "embedded": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Date format string. See {@link https://moment.github.io/luxon/#/formatting?id=table-of-tokens} for all available tokens.
           * @default 'yyyy/LL/dd'
@@ -1300,6 +1347,11 @@ export namespace Components {
          */
         "discoverAllSubmenus": boolean;
         "discoverSubmenu": () => Promise<void>;
+        /**
+          * Enable Popover API rendering for top-layer positioning.
+          * @default false in v4.x, will default to true in v5.0.0
+         */
+        "enableTopLayer": boolean;
         /**
           * An optional header shown at the top of the dropdown
          */
@@ -1369,6 +1421,12 @@ export namespace Components {
           * @default false
          */
         "disabled": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Button icon
          */
@@ -2142,6 +2200,7 @@ export namespace Components {
         "i18nExpand": string;
         /**
           * Accessibility i18n label for the burger menu of the sidebar
+          * @deprecated Since 4.2.0. Will be removed in 5.0.0. The expand button is now hidden from screen readers with aria-hidden="true".
           * @default 'Expand sidebar'
          */
         "i18nExpandSidebar": string;
@@ -2206,6 +2265,11 @@ export namespace Components {
           * Active tab
          */
         "activeTabLabel"?: string;
+        /**
+          * Aria label for close button
+          * @default 'Close About'
+         */
+        "ariaLabelCloseButton": string;
         /**
           * Content of the header
           * @default 'About & legal information'
@@ -2247,10 +2311,21 @@ export namespace Components {
         "show": boolean;
     }
     interface IxMenuAvatar {
+        /**
+          * aria-label for the tooltip
+          * @since 4.3.0.
+         */
+        "ariaLabelTooltip"?: string;
         /**
           * Second line of text
          */
         "bottom"?: string;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Control the visibility of the logout button
           * @default false
@@ -2269,6 +2344,11 @@ export namespace Components {
           * Display the initials of the user. Will be overwritten by image
          */
         "initials"?: string;
+        /**
+          * Tooltip text to display on hover. If not set, the 'top' property (user name) will be used as the default tooltip text.
+          * @since 4.3.0.
+         */
+        "tooltipText"?: string;
         /**
           * First line of text
          */
@@ -2315,10 +2395,11 @@ export namespace Components {
          */
         "expanded": boolean;
         /**
-          * Accessibility label for the menu expand icon (MANDATORY)
+          * Accessibility label for the menu expand icon
+          * @deprecated This prop is no longer used as the component is hidden from screen readers (aria-hidden="true"). Will be removed in 5.0.0
           * @default 'Expand'
          */
-        "ixAriaLabel": string;
+        "ixAriaLabel"?: string;
         /**
           * Display as pinned
           * @default false
@@ -2389,6 +2470,11 @@ export namespace Components {
           * Active tab
          */
         "activeTabLabel"?: string;
+        /**
+          * Aria label for close button
+          * @default 'Close Settings'
+         */
+        "ariaLabelCloseButton": string;
         /**
           * Label of first tab
           * @default 'Settings'
@@ -2882,6 +2968,11 @@ export namespace Components {
           * Card KPI value
          */
         "notification"?: string;
+        /**
+          * If true, disables hover and active styles and changes cursor to default
+          * @default false
+         */
+        "passive": boolean;
         /**
           * Card subheading
          */
@@ -3023,6 +3114,12 @@ export namespace Components {
           * @default false
          */
         "editable": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Focuses the input field
          */
@@ -3112,7 +3209,7 @@ export namespace Components {
         "validText"?: string;
         /**
           * Current selected value. This corresponds to the value property of ix-select-items
-          * @default []
+          * @default ''
          */
         "value": string | string[];
         /**
@@ -3144,6 +3241,9 @@ export namespace Components {
          */
         "value": string;
     }
+    /**
+     * @form-ready 
+     */
     interface IxSlider {
         /**
           * Show control as disabled
@@ -3152,8 +3252,31 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Show error state and message
+          * @deprecated Will be removed in 5.0.0. Use invalid class instead.
          */
         "error"?: boolean | string;
+        "hasValidValue": () => Promise<boolean>;
+        /**
+          * Show text below the field component
+          * @since 4.3.0
+         */
+        "helperText"?: string;
+        /**
+          * Info text for the field component
+          * @since 4.3.0
+         */
+        "infoText"?: string;
+        /**
+          * Error text for the field component
+          * @since 4.3.0
+         */
+        "invalidText"?: string;
+        "isTouched": () => Promise<boolean>;
+        /**
+          * Label for the field component
+          * @since 4.3.0
+         */
+        "label"?: string;
         /**
           * Define tick marker on the slider. Marker has to be within slider min/max
          */
@@ -3168,6 +3291,12 @@ export namespace Components {
           * @default 0
          */
         "min": number;
+        /**
+          * Show helper, info, warning, error and valid text as tooltip
+          * @since 4.3.0
+          * @default false
+         */
+        "showTextAsTooltip": boolean;
         /**
           * Legal number intervals  {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#step}
           * @default 1
@@ -3183,11 +3312,21 @@ export namespace Components {
           * @default 0
          */
         "traceReference": number;
+        /**
+          * Valid text for the field component
+          * @since 4.3.0
+         */
+        "validText"?: string;
         /**
           * Current value of the slider
           * @default 0
          */
         "value": number;
+        /**
+          * Warning text for the field component
+          * @since 4.3.0
+         */
+        "warningText"?: string;
     }
     interface IxSpinner {
         /**
@@ -3238,6 +3377,12 @@ export namespace Components {
           * @default false
          */
         "disabled": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Button icon
          */
@@ -3460,6 +3605,12 @@ export namespace Components {
           * @default false
          */
         "disabled": boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer": boolean;
         /**
           * Focuses the input field
          */
@@ -3702,6 +3853,11 @@ export namespace Components {
           * @default 5000
          */
         "autoCloseDelay": number;
+        /**
+          * Allows to hide the icon in the toast.
+          * @default false
+         */
+        "hideIcon": boolean;
         /**
           * Icon of toast
          */
@@ -3815,7 +3971,7 @@ export namespace Components {
     }
     interface IxToggleButton {
         /**
-          * ARIA label for the button Will be set as aria-label on the nested HTML button element
+          * ARIA label that will be set on the native HTML button element
           * @since 3.2.0
          */
         "ariaLabelButton"?: string;
@@ -5447,6 +5603,9 @@ declare global {
     interface HTMLIxSliderElementEventMap {
         "valueChange": number;
     }
+    /**
+     * @form-ready 
+     */
     interface HTMLIxSliderElement extends Components.IxSlider, HTMLStencilElement {
         addEventListener<K extends keyof HTMLIxSliderElementEventMap>(type: K, listener: (this: HTMLIxSliderElement, ev: IxSliderCustomEvent<HTMLIxSliderElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -5895,6 +6054,11 @@ declare namespace LocalJSX {
           * @default undefined
          */
         "icon"?: string | undefined;
+        /**
+          * If true, disables hover and active styles and changes cursor to default
+          * @default false
+         */
+        "passive"?: boolean;
         /**
           * Card selection
           * @default false
@@ -5959,6 +6123,7 @@ declare namespace LocalJSX {
         /**
           * ARIA label for the menu expand icon button
           * @since 3.2.0
+          * @deprecated This prop is no longer used as the menu expand button is hidden from screen readers. Will be removed in 5.0.0
          */
         "ariaLabelMenuExpandIconButton"?: string;
         /**
@@ -5976,6 +6141,12 @@ declare namespace LocalJSX {
           * @since 4.0.0
          */
         "companyLogoAlt"?: string;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Hides the bottom border of the header
           * @since 4.0.0
@@ -6077,6 +6248,12 @@ declare namespace LocalJSX {
           * @default 'previous'
          */
         "ariaLabelPreviousButton"?: string;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Items will be accessible through a dropdown
           * @default []
@@ -6190,6 +6367,11 @@ declare namespace LocalJSX {
         "variant"?: ButtonVariant;
     }
     interface IxCard {
+        /**
+          * If true, disables hover and active styles and changes cursor to default
+          * @default false
+         */
+        "passive"?: boolean;
         /**
           * Show card in selected state
           * @default false
@@ -6314,6 +6496,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "disabled"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * A set of search criteria to populate the component with.
          */
@@ -6650,6 +6838,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "disabled"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Date format string. See {@link https://moment.github.io/luxon/#/formatting?id=table-of-tokens} for all available tokens.
           * @default 'yyyy/LL/dd'
@@ -6747,6 +6941,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "disabled"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Date format string. See {@link https://moment.github.io/luxon/#/formatting?id=table-of-tokens} for all available tokens.
           * @default 'yyyy/LL/dd'
@@ -6865,6 +7065,12 @@ declare namespace LocalJSX {
           * @default 'rounded'
          */
         "corners"?: DateTimeCardCorners;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Date format string. See {@link https://moment.github.io/luxon/#/formatting?id=table-of-tokens} for all available tokens.
           * @default 'yyyy/LL/dd'
@@ -7101,6 +7307,11 @@ declare namespace LocalJSX {
           * @default 'both'
          */
         "closeBehavior"?: CloseBehavior;
+        /**
+          * Enable Popover API rendering for top-layer positioning.
+          * @default false in v4.x, will default to true in v5.0.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * An optional header shown at the top of the dropdown
          */
@@ -7150,6 +7361,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "disabled"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Button icon
          */
@@ -7928,6 +8145,7 @@ declare namespace LocalJSX {
         "i18nExpand"?: string;
         /**
           * Accessibility i18n label for the burger menu of the sidebar
+          * @deprecated Since 4.2.0. Will be removed in 5.0.0. The expand button is now hidden from screen readers with aria-hidden="true".
           * @default 'Expand sidebar'
          */
         "i18nExpandSidebar"?: string;
@@ -7995,6 +8213,11 @@ declare namespace LocalJSX {
           * Active tab
          */
         "activeTabLabel"?: string;
+        /**
+          * Aria label for close button
+          * @default 'Close About'
+         */
+        "ariaLabelCloseButton"?: string;
         /**
           * Content of the header
           * @default 'About & legal information'
@@ -8049,10 +8272,21 @@ declare namespace LocalJSX {
         "show"?: boolean;
     }
     interface IxMenuAvatar {
+        /**
+          * aria-label for the tooltip
+          * @since 4.3.0.
+         */
+        "ariaLabelTooltip"?: string;
         /**
           * Second line of text
          */
         "bottom"?: string;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Control the visibility of the logout button
           * @default false
@@ -8075,6 +8309,11 @@ declare namespace LocalJSX {
           * Logout click
          */
         "onLogoutClick"?: (event: IxMenuAvatarCustomEvent<any>) => void;
+        /**
+          * Tooltip text to display on hover. If not set, the 'top' property (user name) will be used as the default tooltip text.
+          * @since 4.3.0.
+         */
+        "tooltipText"?: string;
         /**
           * First line of text
          */
@@ -8124,7 +8363,8 @@ declare namespace LocalJSX {
          */
         "expanded"?: boolean;
         /**
-          * Accessibility label for the menu expand icon (MANDATORY)
+          * Accessibility label for the menu expand icon
+          * @deprecated This prop is no longer used as the component is hidden from screen readers (aria-hidden="true"). Will be removed in 5.0.0
           * @default 'Expand'
          */
         "ixAriaLabel"?: string;
@@ -8194,6 +8434,11 @@ declare namespace LocalJSX {
           * Active tab
          */
         "activeTabLabel"?: string;
+        /**
+          * Aria label for close button
+          * @default 'Close Settings'
+         */
+        "ariaLabelCloseButton"?: string;
         /**
           * Label of first tab
           * @default 'Settings'
@@ -8714,6 +8959,11 @@ declare namespace LocalJSX {
           * Card KPI value
          */
         "notification"?: string;
+        /**
+          * If true, disables hover and active styles and changes cursor to default
+          * @default false
+         */
+        "passive"?: boolean;
         /**
           * Card subheading
          */
@@ -8860,6 +9110,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "editable"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Helper text for the select component
          */
@@ -8951,7 +9207,7 @@ declare namespace LocalJSX {
         "validText"?: string;
         /**
           * Current selected value. This corresponds to the value property of ix-select-items
-          * @default []
+          * @default ''
          */
         "value"?: string | string[];
         /**
@@ -8978,6 +9234,9 @@ declare namespace LocalJSX {
          */
         "value": string;
     }
+    /**
+     * @form-ready 
+     */
     interface IxSlider {
         /**
           * Show control as disabled
@@ -8986,8 +9245,29 @@ declare namespace LocalJSX {
         "disabled"?: boolean;
         /**
           * Show error state and message
+          * @deprecated Will be removed in 5.0.0. Use invalid class instead.
          */
         "error"?: boolean | string;
+        /**
+          * Show text below the field component
+          * @since 4.3.0
+         */
+        "helperText"?: string;
+        /**
+          * Info text for the field component
+          * @since 4.3.0
+         */
+        "infoText"?: string;
+        /**
+          * Error text for the field component
+          * @since 4.3.0
+         */
+        "invalidText"?: string;
+        /**
+          * Label for the field component
+          * @since 4.3.0
+         */
+        "label"?: string;
         /**
           * Define tick marker on the slider. Marker has to be within slider min/max
          */
@@ -9002,7 +9282,16 @@ declare namespace LocalJSX {
           * @default 0
          */
         "min"?: number;
+        /**
+          * Will emit the value when it changes
+         */
         "onValueChange"?: (event: IxSliderCustomEvent<number>) => void;
+        /**
+          * Show helper, info, warning, error and valid text as tooltip
+          * @since 4.3.0
+          * @default false
+         */
+        "showTextAsTooltip"?: boolean;
         /**
           * Legal number intervals  {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#step}
           * @default 1
@@ -9018,11 +9307,21 @@ declare namespace LocalJSX {
           * @default 0
          */
         "traceReference"?: number;
+        /**
+          * Valid text for the field component
+          * @since 4.3.0
+         */
+        "validText"?: string;
         /**
           * Current value of the slider
           * @default 0
          */
         "value"?: number;
+        /**
+          * Warning text for the field component
+          * @since 4.3.0
+         */
+        "warningText"?: string;
     }
     interface IxSpinner {
         /**
@@ -9069,6 +9368,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "disabled"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Button icon
          */
@@ -9301,6 +9606,12 @@ declare namespace LocalJSX {
           * @default false
          */
         "disabled"?: boolean;
+        /**
+          * Enable Popover API rendering for dropdown.
+          * @default false
+          * @since 4.3.0
+         */
+        "enableTopLayer"?: boolean;
         /**
           * Format of time string See {@link https://moment.github.io/luxon/#/formatting?id=table-of-tokens} for all available tokens.
           * @default 'TT'
@@ -9536,6 +9847,11 @@ declare namespace LocalJSX {
           * @default 5000
          */
         "autoCloseDelay"?: number;
+        /**
+          * Allows to hide the icon in the toast.
+          * @default false
+         */
+        "hideIcon"?: boolean;
         /**
           * Icon of toast
          */
@@ -9641,7 +9957,7 @@ declare namespace LocalJSX {
     }
     interface IxToggleButton {
         /**
-          * ARIA label for the button Will be set as aria-label on the nested HTML button element
+          * ARIA label that will be set on the native HTML button element
           * @since 3.2.0
          */
         "ariaLabelButton"?: string;
@@ -10163,6 +10479,9 @@ declare module "@stencil/core" {
              */
             "ix-select": LocalJSX.IxSelect & JSXBase.HTMLAttributes<HTMLIxSelectElement>;
             "ix-select-item": LocalJSX.IxSelectItem & JSXBase.HTMLAttributes<HTMLIxSelectItemElement>;
+            /**
+             * @form-ready 
+             */
             "ix-slider": LocalJSX.IxSlider & JSXBase.HTMLAttributes<HTMLIxSliderElement>;
             "ix-spinner": LocalJSX.IxSpinner & JSXBase.HTMLAttributes<HTMLIxSpinnerElement>;
             "ix-split-button": LocalJSX.IxSplitButton & JSXBase.HTMLAttributes<HTMLIxSplitButtonElement>;