@siemens/ix 2.6.0 → 2.7.0

package/dist/types/components.d.ts

@@ -19,6 +19,7 @@ import { InputState } from "./components/category-filter/input-state";
 import { ColumnSize } from "./components/col/col";
 import { ContentHeaderVariant } from "./components/content-header/content-header";
 import { CssGridTemplateType } from "./components/css-grid/css-grid";
+import { ButtonVariant as ButtonVariant1 } from "./components/button/button";
 import { DateDropdownOption, DateRangeChangeEvent } from "./components/date-dropdown/date-dropdown";
 import { DateInputValidityState } from "./components/date-input/date-input";
 import { DateTimeCardCorners } from "./components/date-time-card/date-time-card";
@@ -33,7 +34,6 @@ import { EmptyStateLayout } from "./components/empty-state/empty-state";
 import { MakeRef } from "./components/utils/make-ref";
 import { FlipTileState } from "./components/flip-tile/flip-tile-state";
 import { IconButtonVariant } from "./components/icon-button/icon-button";
-import { ButtonVariant as ButtonVariant1 } from "./components/button/button";
 import { KeyValueLabelPosition } from "./components/key-value/key-value";
 import { CustomCloseEvent, CustomLabelChangeEvent } from "./components/utils/menu-tabs/menu-tabs-utils";
 import { IxModalSize } from "./components/modal/modal";
@@ -65,6 +65,7 @@ export { InputState } from "./components/category-filter/input-state";
 export { ColumnSize } from "./components/col/col";
 export { ContentHeaderVariant } from "./components/content-header/content-header";
 export { CssGridTemplateType } from "./components/css-grid/css-grid";
+export { ButtonVariant as ButtonVariant1 } from "./components/button/button";
 export { DateDropdownOption, DateRangeChangeEvent } from "./components/date-dropdown/date-dropdown";
 export { DateInputValidityState } from "./components/date-input/date-input";
 export { DateTimeCardCorners } from "./components/date-time-card/date-time-card";
@@ -79,7 +80,6 @@ export { EmptyStateLayout } from "./components/empty-state/empty-state";
 export { MakeRef } from "./components/utils/make-ref";
 export { FlipTileState } from "./components/flip-tile/flip-tile-state";
 export { IconButtonVariant } from "./components/icon-button/icon-button";
-export { ButtonVariant as ButtonVariant1 } from "./components/button/button";
 export { KeyValueLabelPosition } from "./components/key-value/key-value";
 export { CustomCloseEvent, CustomLabelChangeEvent } from "./components/utils/menu-tabs/menu-tabs-utils";
 export { IxModalSize } from "./components/modal/modal";
@@ -131,7 +131,7 @@ export namespace Components {
         /**
           * Define application switch configuration
          */
-        "appSwitchConfig": AppSwitchConfiguration;
+        "appSwitchConfig"?: AppSwitchConfiguration;
         /**
           * Supported layouts
          */
@@ -143,7 +143,7 @@ export namespace Components {
         /**
           * Application theme
          */
-        "theme": IxTheme;
+        "theme"?: IxTheme;
         /**
           * Use the system appearance dark or light
          */
@@ -163,7 +163,7 @@ export namespace Components {
     interface IxApplicationSidebar {
     }
     interface IxApplicationSwitchModal {
-        "config": AppSwitchConfiguration;
+        "config"?: AppSwitchConfiguration;
     }
     /**
      * @since 2.0.0
@@ -192,7 +192,7 @@ export namespace Components {
         /**
           * Application name
          */
-        "applicationName": string;
+        "applicationName"?: string;
         /**
           * Supported layouts
           * @example ['sm', 'md']
@@ -256,12 +256,12 @@ export namespace Components {
         /**
           * Icon to be displayed next ot the label
          */
-        "icon": string;
+        "icon"?: string;
         "isDropdownTrigger": boolean;
         /**
           * Breadcrumb label
          */
-        "label": string;
+        "label"?: string;
         "showChevron": boolean;
         "visible": boolean;
     }
@@ -537,7 +537,7 @@ export namespace Components {
         /**
           * Show icon
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Show chip with outline style
          */
@@ -681,6 +681,10 @@ export namespace Components {
           * Retrieves the currently selected date range from the component. This method returns the selected date range as a `DateChangeEvent` object.
          */
         "getDateRange": () => Promise<DateRangeChangeEvent>;
+        /**
+          * Button with no background or outline
+         */
+        "ghost": boolean;
         /**
           * Text for custom dropdown item. Will be used for translation.
          */
@@ -693,6 +697,10 @@ export namespace Components {
           * Text for the done button. Will be used for translation.
          */
         "i18nNoRange": string;
+        /**
+          * Loading button
+         */
+        "loading": boolean;
         /**
           * Locale identifier (e.g. 'en' or 'de').
           * @since 2.6.0
@@ -706,6 +714,10 @@ export namespace Components {
           * The earliest date that can be selected by the date picker. If not set there will be no restriction.
          */
         "minDate": string;
+        /**
+          * Outline button
+         */
+        "outline": boolean;
         /**
           * If true a range of dates can be selected.
          */
@@ -715,6 +727,10 @@ export namespace Components {
          */
         "to": string;
         "today": string;
+        /**
+          * Button variant
+         */
+        "variant": ButtonVariant1;
         /**
           * The index of which day to start the week on, based on the Locale#weekdays array. E.g. if the locale is en-us, weekStartIndex = 1 results in starting the week on monday.
           * @since 2.6.0
@@ -826,7 +842,7 @@ export namespace Components {
         /**
           * Get the currently selected date-range.
          */
-        "getCurrentDate": () => Promise<{ from: string; to: string; }>;
+        "getCurrentDate": () => Promise<{ from: string | undefined; to: string | undefined; }>;
         /**
           * Text of date select button
           * @since 2.1.0
@@ -1112,7 +1128,7 @@ export namespace Components {
         /**
           * Display name of the header
          */
-        "label": string;
+        "label"?: string;
     }
     interface IxDropdownItem {
         /**
@@ -1155,7 +1171,7 @@ export namespace Components {
         /**
           * Optional empty state action
          */
-        "action": string;
+        "action"?: string;
         /**
           * Empty state header
          */
@@ -1163,7 +1179,7 @@ export namespace Components {
         /**
           * Optional empty state icon
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Optional empty state layout - one of 'large', 'compact' or 'compactBreak'
          */
@@ -1171,7 +1187,7 @@ export namespace Components {
         /**
           * Optional empty state sub header
          */
-        "subHeader": string;
+        "subHeader"?: string;
     }
     interface IxEventList {
         /**
@@ -1222,10 +1238,18 @@ export namespace Components {
           * @since 1.6.0
          */
         "fullWidth": boolean;
+        /**
+          * Button with no background or outline
+         */
+        "ghost": boolean;
         /**
           * Search icon
          */
         "icon": string;
+        /**
+          * Outline button
+         */
+        "outline": boolean;
         /**
           * Placeholder text
          */
@@ -1234,9 +1258,15 @@ export namespace Components {
           * Default value
          */
         "value": string;
+        /**
+          * button variant
+         */
+        "variant": ButtonVariant1;
     }
     interface IxFieldLabel {
-        "controlRef"?: MakeRef<HTMLElement>;
+        "controlRef"?: | MakeRef<HTMLElement>
+    | MakeRef<HTMLInputElement>
+    | MakeRef<HTMLTextAreaElement>;
         /**
           * The id of the form element that the label is associated with
          */
@@ -1251,7 +1281,9 @@ export namespace Components {
         /**
           * The control element that the label is associated with
          */
-        "controlRef"?: MakeRef<HTMLElement>;
+        "controlRef"?: | MakeRef<HTMLElement>
+    | MakeRef<HTMLInputElement>
+    | MakeRef<HTMLTextAreaElement>;
         /**
           * Show text below the field component
          */
@@ -1325,7 +1357,7 @@ export namespace Components {
         /**
           * Variation of the Flip
          */
-        "state": FlipTileState;
+        "state"?: FlipTileState;
         /**
           * Width interpreted as REM
           * @since 1.5.0
@@ -1431,12 +1463,12 @@ export namespace Components {
           * Accessibility label for the icon button Will be set as aria-label on the nested HTML button element
           * @since 2.1.0
          */
-        "a11yLabel": string;
+        "a11yLabel"?: string;
         /**
           * Color of icon in  button
           * @deprecated since 2.1.0 use `icon-color`
          */
-        "color": string;
+        "color"?: string;
         /**
           * Disabled
          */
@@ -1448,11 +1480,11 @@ export namespace Components {
         /**
           * Icon name
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Color of icon in  button
          */
-        "iconColor": string;
+        "iconColor"?: string;
         /**
           * Loading button
           * @since 2.0.0
@@ -1496,7 +1528,7 @@ export namespace Components {
         /**
           * Icon name
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Loading button
          */
@@ -1615,7 +1647,7 @@ export namespace Components {
         /**
           * Optional key value icon
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Key value label
          */
@@ -1627,7 +1659,7 @@ export namespace Components {
         /**
           * Optional key value text value
          */
-        "value": string;
+        "value"?: string;
     }
     /**
      * @since 1.6.0
@@ -1639,11 +1671,11 @@ export namespace Components {
         "striped": boolean;
     }
     interface IxKpi {
-        "label": string;
+        "label"?: string;
         "orientation": 'horizontal' | 'vertical';
         "state": 'neutral' | 'warning' | 'alarm';
-        "unit": string;
-        "value": string | number;
+        "unit"?: string;
+        "value"?: string | number;
     }
     /**
      * @since 2.6.0
@@ -1689,13 +1721,13 @@ export namespace Components {
         /**
           * Url for the link button
          */
-        "url": string;
+        "url"?: string;
     }
     interface IxMapNavigation {
         /**
           * Application name
          */
-        "applicationName": string;
+        "applicationName"?: string;
         /**
           * Close current shown overlay
           * @deprecated Will be removed in 2.0.0. Use slot based approach
@@ -1708,7 +1740,7 @@ export namespace Components {
         /**
           * Navigation title
          */
-        "navigationTitle": string;
+        "navigationTitle"?: string;
         /**
           * Open a overlay inside content area
           * @deprecated Will be removed in 2.0.0. Use slot based approach
@@ -1730,19 +1762,19 @@ export namespace Components {
           * Color of icon
           * @deprecated since 2.1.0. Use `icon-color`
          */
-        "color": string;
+        "color"?: string;
         /**
           * Icon of overlay
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Color of icon
          */
-        "iconColor": string;
+        "iconColor"?: string;
         /**
           * Title of overlay
          */
-        "name": string;
+        "name"?: string;
     }
     interface IxMenu {
         /**
@@ -1825,7 +1857,7 @@ export namespace Components {
         /**
           * Active tab
          */
-        "activeTabLabel": string;
+        "activeTabLabel"?: string;
         /**
           * Content of the header
          */
@@ -1839,13 +1871,13 @@ export namespace Components {
         /**
           * About Item label
          */
-        "label": string;
+        "label"?: string;
     }
     interface IxMenuAboutNews {
         /**
           * Subtitle of the about news
          */
-        "aboutItemLabel": string;
+        "aboutItemLabel"?: string;
         /**
           * Internal
          */
@@ -1854,7 +1886,7 @@ export namespace Components {
         /**
           * Title of the about news
          */
-        "label": string;
+        "label"?: string;
         /**
           * Bottom offset
          */
@@ -1868,7 +1900,7 @@ export namespace Components {
         /**
           * Second line of text
          */
-        "bottom": string;
+        "bottom"?: string;
         /**
           * Use for translation
          */
@@ -1877,12 +1909,12 @@ export namespace Components {
           * Display a avatar image
           * @since 1.4.0
          */
-        "image": string;
+        "image"?: string;
         /**
           * Display the initials of the user. Will be overwritten by image
           * @since 1.4.0
          */
-        "initials": string;
+        "initials"?: string;
         /**
           * Control the visibility of the logout button
           * @since 2.1.0
@@ -1891,18 +1923,18 @@ export namespace Components {
         /**
           * First line of text
          */
-        "top": string;
+        "top"?: string;
     }
     interface IxMenuAvatarItem {
         "getDropdownItemElement": () => Promise<HTMLIxDropdownItemElement>;
         /**
           * Avatar dropdown icon
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Avatar dropdown label
          */
-        "label": string;
+        "label"?: string;
     }
     /**
      * @since 2.0.0
@@ -1911,21 +1943,21 @@ export namespace Components {
         /**
           * Icon of the category
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Display name of the category
          */
-        "label": string;
+        "label"?: string;
         /**
           * Show notification count on the category
          */
-        "notifications": number;
+        "notifications"?: number;
     }
     interface IxMenuExpandIcon {
         /**
           * Controls which icon is displayed
          */
-        "breakpoint": Breakpoint;
+        "breakpoint"?: Breakpoint;
         /**
           * Whether the menu expand icon displays the expanded state or not
          */
@@ -1982,7 +2014,7 @@ export namespace Components {
         /**
           * Active tab
          */
-        "activeTabLabel": string;
+        "activeTabLabel"?: string;
         /**
           * Label of first tab
          */
@@ -1996,7 +2028,7 @@ export namespace Components {
         /**
           * Settings Item label
          */
-        "label": string;
+        "label"?: string;
     }
     interface IxMessageBar {
         /**
@@ -2020,7 +2052,7 @@ export namespace Components {
         /**
           * Is called before the modal is dismissed.  - Return `true` to proceed in dismissing the modal - Return `false` to abort in dismissing the modal
          */
-        "beforeDismiss": (reason?: any) => boolean | Promise<boolean>;
+        "beforeDismiss"?: (reason?: any) => boolean | Promise<boolean>;
         /**
           * Centered modal
          */
@@ -2429,6 +2461,16 @@ export namespace Components {
           * If true the select will be in disabled state
          */
         "disabled": boolean;
+        /**
+          * The maximum width of the dropdown element with value and unit (e.g. "200px" or "12.5rem"). By default the maximum width of the dropdown element is set to 100%.
+          * @since 2.7.0
+         */
+        "dropdownMaxWidth"?: string;
+        /**
+          * The width of the dropdown element with value and unit (e.g. "200px" or "12.5rem").
+          * @since 2.7.0
+         */
+        "dropdownWidth"?: string;
         /**
           * Select is extendable
          */
@@ -2624,7 +2666,7 @@ export namespace Components {
         /**
           * Button label
          */
-        "label": string;
+        "label"?: string;
         /**
           * Button outline variant
          */
@@ -2650,11 +2692,11 @@ export namespace Components {
         /**
           * Dropdown icon
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Dropdown label
          */
-        "label": string;
+        "label"?: string;
     }
     interface IxTabItem {
         /**
@@ -2827,7 +2869,7 @@ export namespace Components {
         /**
           * Get the current time based on the wanted format
          */
-        "getCurrentTime": () => Promise<string>;
+        "getCurrentTime": () => Promise<string | undefined>;
         /**
           * @deprecated Not supported since 2.0.0.
          */
@@ -2886,15 +2928,15 @@ export namespace Components {
         /**
           * Icon of toast
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Icon color of toast
          */
-        "iconColor": string;
+        "iconColor"?: string;
         /**
           * Toast title
          */
-        "toastTitle": string;
+        "toastTitle"?: string;
         /**
           * Toast type
          */
@@ -2972,7 +3014,7 @@ export namespace Components {
         /**
           * Icon name
          */
-        "icon": string;
+        "icon"?: string;
         /**
           * Loading button
          */
@@ -3136,7 +3178,7 @@ export namespace Components {
         /**
           * Message of the tooltip
          */
-        "message": string;
+        "message"?: string;
         /**
           * Placement of the tooltip
          */
@@ -3453,6 +3495,7 @@ declare global {
     };
     interface HTMLIxApplicationHeaderElementEventMap {
         "menuToggle": boolean;
+        "openAppSwitch": void;
     }
     interface HTMLIxApplicationHeaderElement extends Components.IxApplicationHeader, HTMLStencilElement {
         addEventListener<K extends keyof HTMLIxApplicationHeaderElementEventMap>(type: K, listener: (this: HTMLIxApplicationHeaderElement, ev: IxApplicationHeaderCustomEvent<HTMLIxApplicationHeaderElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -4222,6 +4265,7 @@ declare global {
     interface HTMLIxMenuElementEventMap {
         "expandChange": boolean;
         "mapExpandChange": boolean;
+        "openAppSwitch": void;
     }
     interface HTMLIxMenuElement extends Components.IxMenu, HTMLStencilElement {
         addEventListener<K extends keyof HTMLIxMenuElementEventMap>(type: K, listener: (this: HTMLIxMenuElement, ev: IxMenuCustomEvent<HTMLIxMenuElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -5152,6 +5196,11 @@ declare namespace LocalJSX {
           * @since 2.5.0
          */
         "onMenuToggle"?: (event: IxApplicationHeaderCustomEvent<boolean>) => void;
+        /**
+          * Event emitted when the app switch button is clicked
+          * @since 3.0.0
+         */
+        "onOpenAppSwitch"?: (event: IxApplicationHeaderCustomEvent<void>) => void;
         /**
           * Controls the visibility of the menu toggle button based on the context of the application header.  When the application header is utilized outside the application frame, the menu toggle button is displayed. Conversely, if the header is within the application frame, this property is ineffective.
           * @since 2.5.0
@@ -5653,7 +5702,7 @@ declare namespace LocalJSX {
         /**
           * Grid item name
          */
-        "itemName"?: string;
+        "itemName": string;
     }
     /**
      * @since 2.6.0
@@ -5722,6 +5771,10 @@ declare namespace LocalJSX {
           * Picker date. If the picker is in range mode this property is the start date. If set to `null` no default start date will be pre-selected.  Format is based on `format`
          */
         "from"?: string;
+        /**
+          * Button with no background or outline
+         */
+        "ghost"?: boolean;
         /**
           * Text for custom dropdown item. Will be used for translation.
          */
@@ -5734,6 +5787,10 @@ declare namespace LocalJSX {
           * Text for the done button. Will be used for translation.
          */
         "i18nNoRange"?: string;
+        /**
+          * Loading button
+         */
+        "loading"?: boolean;
         /**
           * Locale identifier (e.g. 'en' or 'de').
           * @since 2.6.0
@@ -5751,6 +5808,10 @@ declare namespace LocalJSX {
           * EventEmitter for date range change events.  This event is emitted when the date range changes within the component. The event payload contains information about the selected date range.
          */
         "onDateRangeChange"?: (event: IxDateDropdownCustomEvent<DateRangeChangeEvent>) => void;
+        /**
+          * Outline button
+         */
+        "outline"?: boolean;
         /**
           * If true a range of dates can be selected.
          */
@@ -5759,6 +5820,10 @@ declare namespace LocalJSX {
           * Picker date. If the picker is in range mode this property is the end date. If the picker is not in range mode leave this value `null`  Format is based on `format`
          */
         "to"?: string;
+        /**
+          * Button variant
+         */
+        "variant"?: ButtonVariant1;
         /**
           * The index of which day to start the week on, based on the Locale#weekdays array. E.g. if the locale is en-us, weekStartIndex = 1 results in starting the week on monday.
           * @since 2.6.0
@@ -6284,6 +6349,10 @@ declare namespace LocalJSX {
           * @since 1.6.0
          */
         "fullWidth"?: boolean;
+        /**
+          * Button with no background or outline
+         */
+        "ghost"?: boolean;
         /**
           * Search icon
          */
@@ -6292,6 +6361,10 @@ declare namespace LocalJSX {
           * Value changed
          */
         "onValueChange"?: (event: IxExpandingSearchCustomEvent<string>) => void;
+        /**
+          * Outline button
+         */
+        "outline"?: boolean;
         /**
           * Placeholder text
          */
@@ -6300,6 +6373,10 @@ declare namespace LocalJSX {
           * Default value
          */
         "value"?: string;
+        /**
+          * button variant
+         */
+        "variant"?: ButtonVariant1;
     }
     interface IxFieldLabel {
         /**
@@ -6315,7 +6392,9 @@ declare namespace LocalJSX {
         /**
           * The control element that the label is associated with
          */
-        "controlRef"?: MakeRef<HTMLElement>;
+        "controlRef"?: | MakeRef<HTMLElement>
+    | MakeRef<HTMLInputElement>
+    | MakeRef<HTMLTextAreaElement>;
         /**
           * Show text below the field component
          */
@@ -6869,6 +6948,11 @@ declare namespace LocalJSX {
           * Map Sidebar expanded
          */
         "onMapExpandChange"?: (event: IxMenuCustomEvent<boolean>) => void;
+        /**
+          * Event emitted when the app switch button is clicked
+          * @since 3.0.0
+         */
+        "onOpenAppSwitch"?: (event: IxMenuCustomEvent<void>) => void;
         /**
           * Menu stays pinned to the left
          */
@@ -7559,6 +7643,16 @@ declare namespace LocalJSX {
           * If true the select will be in disabled state
          */
         "disabled"?: boolean;
+        /**
+          * The maximum width of the dropdown element with value and unit (e.g. "200px" or "12.5rem"). By default the maximum width of the dropdown element is set to 100%.
+          * @since 2.7.0
+         */
+        "dropdownMaxWidth"?: string;
+        /**
+          * The width of the dropdown element with value and unit (e.g. "200px" or "12.5rem").
+          * @since 2.7.0
+         */
+        "dropdownWidth"?: string;
         /**
           * Select is extendable
          */