@siemens/ix 2.4.1 → 2.5.0

package/dist/types/components.d.ts

@@ -110,6 +110,7 @@ export namespace Components {
         "subheading": string;
         /**
           * Card variant
+          * @deprecated variant "insight" and "notification" will be removed in 3.0. Use "outline" or "filled" instead.
          */
         "variant": ActionCardVariant;
     }
@@ -143,6 +144,11 @@ export namespace Components {
           * Application name
          */
         "name"?: string;
+        /**
+          * 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
+         */
+        "showMenu"?: boolean;
     }
     interface IxApplicationSidebar {
     }
@@ -178,7 +184,8 @@ export namespace Components {
          */
         "applicationName": string;
         /**
-          * Supported layouts e.g ['sm', 'md']
+          * Supported layouts
+          * @example ['sm', 'md']
          */
         "breakpoints": Breakpoint[];
         /**
@@ -292,6 +299,7 @@ export namespace Components {
         "selected": boolean;
         /**
           * Card variant
+          * @deprecated variant insight and notification will be removed in 3.0. Use 'outline' or 'filled' instead.
          */
         "variant": CardVariant;
     }
@@ -359,9 +367,9 @@ export namespace Components {
     }
     interface IxCategoryFilter {
         /**
-          * Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
+          * Configuration object hash used to populate the dropdown menu for type-ahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
          */
-        "categories": {
+        "categories"?: {
     [id: string]: {
       label: string;
       options: string[];
@@ -374,7 +382,7 @@ export namespace Components {
         /**
           * A set of search criteria to populate the component with.
          */
-        "filterState": FilterState;
+        "filterState"?: FilterState;
         /**
           * Allows to hide the icon inside the text input. Defaults to false
          */
@@ -400,13 +408,13 @@ export namespace Components {
         /**
           * Placeholder text to be displayed in an empty input field.
          */
-        "placeholder": string;
+        "placeholder"?: string;
         /**
           * If true the filter will be in readonly mode
          */
         "readonly": boolean;
         /**
-          * If set to true allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
+          * If set to true, allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
          */
         "repeatCategories": boolean;
         /**
@@ -415,9 +423,9 @@ export namespace Components {
          */
         "staticOperator"?: LogicalFilterOperator;
         /**
-          * A list of strings that will be supplied as typeahead suggestions not tied to any categories.
+          * A list of strings that will be supplied as type-ahead suggestions not tied to any categories.
          */
-        "suggestions": string[];
+        "suggestions"?: string[];
         "tmpDisableScrollIntoView": boolean;
     }
     interface IxChip {
@@ -913,12 +921,12 @@ export namespace Components {
         /**
           * Icon of dropdown item
          */
-        "icon": string;
+        "icon"?: string;
         "isSubMenu": boolean;
         /**
           * Label of dropdown item
          */
-        "label": string;
+        "label"?: string;
         "suppressChecked": boolean;
     }
     /**
@@ -1548,23 +1556,23 @@ export namespace Components {
           * Name of the icon you want to display. Icon names can be resolved from the documentation
           * @link https://ix.siemens.io/docs/icon-library/icons
          */
-        "icon": string;
+        "icon"?: string;
         "isCategory": boolean;
         /**
           * Label of the menu item. Will also be used as tooltip text
           * @since 2.2.0
          */
-        "label": string;
+        "label"?: string;
         /**
           * Show notification count on tab
          */
-        "notifications": number;
+        "notifications"?: number;
         /**
           * Name of the icon you want to display. Icon names can be resolved from the documentation
           * @link https://ix.siemens.io/docs/icon-library/icons
           * @deprecated since 2.0.0 use `icon` property. Will be removed in 3.0.0
          */
-        "tabIcon": string;
+        "tabIcon"?: string;
     }
     interface IxMenuSettings {
         /**
@@ -1827,7 +1835,7 @@ export namespace Components {
         /**
           * Card heading
          */
-        "heading": string;
+        "heading"?: string;
         /**
           * Card icon
          */
@@ -1835,13 +1843,14 @@ export namespace Components {
         /**
           * Card KPI value
          */
-        "notification": string;
+        "notification"?: string;
         /**
           * Card subheading
          */
-        "subheading": string;
+        "subheading"?: string;
         /**
           * Card variant
+          * @deprecated variant "insight" and "notification" will be removed in 3.0. Use "outline" or "filled" instead.
          */
         "variant": PushCardVariant;
     }
@@ -2268,7 +2277,7 @@ export namespace Components {
          */
         "interactive": boolean;
         /**
-          * Initial placement of the tooltip. If the placement don"t have enough space, the tooltip will placed on another location.
+          * Initial placement of the tooltip. If the selected placement doesn't have enough space, the tooltip will be repositioned to another location.
           * @since 1.5.0
          */
         "placement": 'top' | 'right' | 'bottom' | 'left';
@@ -2291,7 +2300,7 @@ export namespace Components {
         /**
           * Render function of tree items
          */
-        "renderItem": <T = any>(
+        "renderItem"?: <T = any>(
     index: number,
     data: T,
     dataList: Array<T>,
@@ -2307,7 +2316,7 @@ export namespace Components {
         /**
           * Context
          */
-        "context": TreeItemContext;
+        "context"?: TreeItemContext;
         /**
           * Has tree item children
          */
@@ -2315,7 +2324,7 @@ export namespace Components {
         /**
           * Text
          */
-        "text": string;
+        "text"?: string;
     }
     /**
      * @since 2.0.0
@@ -2455,6 +2464,10 @@ export namespace Components {
         "vertical": boolean;
     }
 }
+export interface IxApplicationHeaderCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLIxApplicationHeaderElement;
+}
 export interface IxBlindCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLIxBlindElement;
@@ -2686,7 +2699,18 @@ declare global {
         prototype: HTMLIxApplicationElement;
         new (): HTMLIxApplicationElement;
     };
+    interface HTMLIxApplicationHeaderElementEventMap {
+        "menuToggle": boolean;
+    }
     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;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLIxApplicationHeaderElementEventMap>(type: K, listener: (this: HTMLIxApplicationHeaderElement, ev: IxApplicationHeaderCustomEvent<HTMLIxApplicationHeaderElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     }
     var HTMLIxApplicationHeaderElement: {
         prototype: HTMLIxApplicationHeaderElement;
@@ -4132,6 +4156,7 @@ declare namespace LocalJSX {
         "subheading"?: string;
         /**
           * Card variant
+          * @deprecated variant "insight" and "notification" will be removed in 3.0. Use "outline" or "filled" instead.
          */
         "variant"?: ActionCardVariant;
     }
@@ -4165,6 +4190,16 @@ declare namespace LocalJSX {
           * Application name
          */
         "name"?: string;
+        /**
+          * Event emitted when the menu toggle button is clicked
+          * @since 2.5.0
+         */
+        "onMenuToggle"?: (event: IxApplicationHeaderCustomEvent<boolean>) => 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
+         */
+        "showMenu"?: boolean;
     }
     interface IxApplicationSidebar {
     }
@@ -4199,7 +4234,8 @@ declare namespace LocalJSX {
          */
         "applicationName"?: string;
         /**
-          * Supported layouts e.g ['sm', 'md']
+          * Supported layouts
+          * @example ['sm', 'md']
          */
         "breakpoints"?: Breakpoint[];
         /**
@@ -4319,6 +4355,7 @@ declare namespace LocalJSX {
         "selected"?: boolean;
         /**
           * Card variant
+          * @deprecated variant insight and notification will be removed in 3.0. Use 'outline' or 'filled' instead.
          */
         "variant"?: CardVariant;
     }
@@ -4398,7 +4435,7 @@ declare namespace LocalJSX {
     }
     interface IxCategoryFilter {
         /**
-          * Configuration object hash used to populate the dropwdown menu for typeahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
+          * Configuration object hash used to populate the dropdown menu for type-ahead and quick selection functionality. Each ID maps to an object with a label and an array of options to select from.
          */
         "categories"?: {
     [id: string]: {
@@ -4437,7 +4474,7 @@ declare namespace LocalJSX {
     [id: string]: string;
   };
         /**
-          * Event dispatched whenever the a category gets selected in the dropdown
+          * Event dispatched whenever a category gets selected in the dropdown
          */
         "onCategoryChanged"?: (event: IxCategoryFilterCustomEvent<string>) => void;
         /**
@@ -4457,7 +4494,7 @@ declare namespace LocalJSX {
          */
         "readonly"?: boolean;
         /**
-          * If set to true allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
+          * If set to true, allows that a single category can be set more than once. An already set category will not appear in the category dropdown if set to false.  Defaults to true
          */
         "repeatCategories"?: boolean;
         /**
@@ -4466,7 +4503,7 @@ declare namespace LocalJSX {
          */
         "staticOperator"?: LogicalFilterOperator;
         /**
-          * A list of strings that will be supplied as typeahead suggestions not tied to any categories.
+          * A list of strings that will be supplied as type-ahead suggestions not tied to any categories.
          */
         "suggestions"?: string[];
     }
@@ -5978,6 +6015,7 @@ declare namespace LocalJSX {
         "subheading"?: string;
         /**
           * Card variant
+          * @deprecated variant "insight" and "notification" will be removed in 3.0. Use "outline" or "filled" instead.
          */
         "variant"?: PushCardVariant;
     }
@@ -6451,7 +6489,7 @@ declare namespace LocalJSX {
          */
         "interactive"?: boolean;
         /**
-          * Initial placement of the tooltip. If the placement don"t have enough space, the tooltip will placed on another location.
+          * Initial placement of the tooltip. If the selected placement doesn't have enough space, the tooltip will be repositioned to another location.
           * @since 1.5.0
          */
         "placement"?: 'top' | 'right' | 'bottom' | 'left';
@@ -6500,7 +6538,7 @@ declare namespace LocalJSX {
         /**
           * Initial root element will not be rendered
          */
-        "root"?: string;
+        "root": string;
     }
     interface IxTreeItem {
         /**
@@ -6512,7 +6550,7 @@ declare namespace LocalJSX {
          */
         "hasChildren"?: boolean;
         /**
-          * Clicked
+          * Click on item not on the expand/collapse icon
          */
         "onItemClick"?: (event: IxTreeItemCustomEvent<void>) => void;
         /**

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export * from './components/tree/tree-model';
 export * from './components/upload/upload-file-state';
 export * from './components/utils/delegate';
 export * from './components/utils/modal';
+export * from './components/utils/typed-event';
 export { NotificationColor } from './components/utils/notification-color';
 export { convertToAbbreviationString, convertToRemString, } from './components/utils/rwd.util';
 export * from './components/utils/theme-switcher';