@openui5/types 1.133.1 → 1.135.0

package/types/sap.tnt.d.ts

@@ -1,10 +1,12 @@
-// For Library Version: 1.133.1
+// For Library Version: 1.135.0
 
 declare module "sap/tnt/library" {
   /**
    * Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
    *
    * @since 1.68
+   * @deprecated As of version 1.135. This interface is not needed anymore. The `ToolPage` now accepts any
+   * control as a header or subheader.
    */
   export interface IToolHeader {
     __implements__sap_tnt_IToolHeader: boolean;
@@ -43,6 +45,24 @@ declare module "sap/tnt/library" {
      */
     Narrow = "Narrow",
   }
+  /**
+   * Available options for the Side Navigation design.
+   *
+   * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'SideNavigationDesign'.
+   *
+   * @since 1.134.0
+   * @experimental Behavior might change.
+   */
+  export enum SideNavigationDesign {
+    /**
+     * Side Navigation has a shadow and border.
+     */
+    Decorated = "Decorated",
+    /**
+     * Side Navigation without any shadow or border.
+     */
+    Plain = "Plain",
+  }
 }
 
 declare module "sap/tnt/IllustratedMessageType" {
@@ -765,6 +785,53 @@ declare module "sap/tnt/NavigationList" {
        */
       oItem: NavigationListItemBase
     ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.NavigationList`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.tnt.NavigationList` itself.
+     *
+     * Fired when an item is pressed.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachItemPress(
+      /**
+       * An application-specific payload object that will be passed to the event handler along with the event
+       * object when firing the event
+       */
+      oData: object,
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: NavigationList$ItemPressEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.NavigationList`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.tnt.NavigationList` itself.
+     *
+     * Fired when an item is pressed.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachItemPress(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: NavigationList$ItemPressEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
      *
@@ -819,6 +886,24 @@ declare module "sap/tnt/NavigationList" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyItems(): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:itemPress itemPress} event of this `sap.tnt.NavigationList`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachItemPress(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: NavigationList$ItemPressEvent) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
     /**
      * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
      *
@@ -837,6 +922,19 @@ declare module "sap/tnt/NavigationList" {
        */
       oListener?: object
     ): this;
+    /**
+     * Fires event {@link #event:itemPress itemPress} to attached listeners.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    fireItemPress(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: NavigationList$ItemPressEventParameters
+    ): this;
     /**
      * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
      *
@@ -1101,8 +1199,31 @@ declare module "sap/tnt/NavigationList" {
      * Fired when an item is selected.
      */
     itemSelect?: (oEvent: NavigationList$ItemSelectEvent) => void;
+
+    /**
+     * Fired when an item is pressed.
+     */
+    itemPress?: (oEvent: NavigationList$ItemPressEvent) => void;
   }
 
+  /**
+   * Parameters of the NavigationList#itemPress event.
+   */
+  export interface NavigationList$ItemPressEventParameters {
+    /**
+     * The pressed item.
+     */
+    item?: Item;
+  }
+
+  /**
+   * Event object of the NavigationList#itemPress event.
+   */
+  export type NavigationList$ItemPressEvent = Event<
+    NavigationList$ItemPressEventParameters,
+    NavigationList
+  >;
+
   /**
    * Parameters of the NavigationList#itemSelect event.
    */
@@ -1549,8 +1670,17 @@ declare module "sap/tnt/NavigationListItem" {
     /**
      * Gets current value of property {@link #getSelectable selectable}.
      *
-     * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
-     * `href` is also used.
+     * Specifies if the item can be selected. By default all items are selectable.
+     *
+     * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
+     * its sub-items.
+     *
+     * To improve user experience do not mix selectable parent items with not selectable parent items within
+     * a single side navigation.
+     *
+     * **Guidelines:**
+     * 	 - External links should not be selectable.
+     * 	 - Items that trigger actions (with design "Action") should not be selectable.
      *
      * Default value is `true`.
      *
@@ -1716,8 +1846,17 @@ declare module "sap/tnt/NavigationListItem" {
     /**
      * Sets a new value for property {@link #getSelectable selectable}.
      *
-     * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
-     * `href` is also used.
+     * Specifies if the item can be selected. By default all items are selectable.
+     *
+     * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
+     * its sub-items.
+     *
+     * To improve user experience do not mix selectable parent items with not selectable parent items within
+     * a single side navigation.
+     *
+     * **Guidelines:**
+     * 	 - External links should not be selectable.
+     * 	 - Items that trigger actions (with design "Action") should not be selectable.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -1793,8 +1932,17 @@ declare module "sap/tnt/NavigationListItem" {
     visible?: boolean | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
-     * `href` is also used.
+     * Specifies if the item can be selected. By default all items are selectable.
+     *
+     * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
+     * its sub-items.
+     *
+     * To improve user experience do not mix selectable parent items with not selectable parent items within
+     * a single side navigation.
+     *
+     * **Guidelines:**
+     * 	 - External links should not be selectable.
+     * 	 - Items that trigger actions (with design "Action") should not be selectable.
      *
      * @since 1.116
      * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
@@ -2191,6 +2339,8 @@ declare module "sap/tnt/SideNavigation" {
     PropertyBindingInfo,
   } from "sap/ui/base/ManagedObject";
 
+  import { SideNavigationDesign } from "sap/tnt/library";
+
   import NavigationList from "sap/tnt/NavigationList";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -2209,6 +2359,9 @@ declare module "sap/tnt/SideNavigation" {
    * 	 - The flexible part adapts its size to the fixed one.
    * 	 - The flexible part has a scrollbar when the content is larger than the available space.  **Note:**
    *     In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`.
+   *     **Note:** If used outside the intended parent layout `sap.tnt.ToolPage`, for example inside a `sap.m.ResponsivePopover`
+   *     to achieve a Side Navigation Overlay Mode, the application developer should set the `design` property
+   *     to `Plain`.
    *
    * @since 1.34
    */
@@ -2275,6 +2428,53 @@ declare module "sap/tnt/SideNavigation" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.SideNavigation`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
+     *
+     * Fired when an item is pressed.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachItemPress(
+      /**
+       * An application-specific payload object that will be passed to the event handler along with the event
+       * object when firing the event
+       */
+      oData: object,
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: SideNavigation$ItemPressEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.SideNavigation`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
+     *
+     * Fired when an item is pressed.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachItemPress(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: SideNavigation$ItemPressEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
      *
@@ -2359,6 +2559,24 @@ declare module "sap/tnt/SideNavigation" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyItem(): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:itemPress itemPress} event of this `sap.tnt.SideNavigation`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachItemPress(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: SideNavigation$ItemPressEvent) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
     /**
      * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
      *
@@ -2377,6 +2595,19 @@ declare module "sap/tnt/SideNavigation" {
        */
       oListener?: object
     ): this;
+    /**
+     * Fires event {@link #event:itemPress itemPress} to attached listeners.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    fireItemPress(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: SideNavigation$ItemPressEventParameters
+    ): this;
     /**
      * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
      *
@@ -2400,6 +2631,21 @@ declare module "sap/tnt/SideNavigation" {
      * @returns Value of property `ariaLabel`
      */
     getAriaLabel(): string;
+    /**
+     * Gets current value of property {@link #getDesign design}.
+     *
+     * Specifies whether the control should have own container styling, such as a box-shadow and border, or
+     * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
+     * to achieve a Side Navigation Overlay Mode.
+     *
+     * Default value is `Decorated`.
+     *
+     * @since 1.134
+     * @experimental As of version 1.134.
+     *
+     * @returns Value of property `design`
+     */
+    getDesign(): SideNavigationDesign;
     /**
      * Gets current value of property {@link #getExpanded expanded}.
      *
@@ -2478,6 +2724,28 @@ declare module "sap/tnt/SideNavigation" {
        */
       sAriaLabel?: string
     ): this;
+    /**
+     * Sets a new value for property {@link #getDesign design}.
+     *
+     * Specifies whether the control should have own container styling, such as a box-shadow and border, or
+     * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
+     * to achieve a Side Navigation Overlay Mode.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `Decorated`.
+     *
+     * @since 1.134
+     * @experimental As of version 1.134.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setDesign(
+      /**
+       * New value for property `design`
+       */
+      sDesign?: SideNavigationDesign | keyof typeof SideNavigationDesign
+    ): this;
     /**
      * Sets if the control is in expanded or collapsed mode.
      *
@@ -2612,6 +2880,19 @@ declare module "sap/tnt/SideNavigation" {
      */
     ariaLabel?: string | PropertyBindingInfo;
 
+    /**
+     * Specifies whether the control should have own container styling, such as a box-shadow and border, or
+     * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
+     * to achieve a Side Navigation Overlay Mode.
+     *
+     * @since 1.134
+     * @experimental As of version 1.134.
+     */
+    design?:
+      | (SideNavigationDesign | keyof typeof SideNavigationDesign)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
     /**
      * Defines the content inside the flexible part.
      */
@@ -2640,8 +2921,31 @@ declare module "sap/tnt/SideNavigation" {
      * Fired when an item is selected.
      */
     itemSelect?: (oEvent: SideNavigation$ItemSelectEvent) => void;
+
+    /**
+     * Fired when an item is pressed.
+     */
+    itemPress?: (oEvent: SideNavigation$ItemPressEvent) => void;
   }
 
+  /**
+   * Parameters of the SideNavigation#itemPress event.
+   */
+  export interface SideNavigation$ItemPressEventParameters {
+    /**
+     * The pressed item.
+     */
+    item?: Item;
+  }
+
+  /**
+   * Event object of the SideNavigation#itemPress event.
+   */
+  export type SideNavigation$ItemPressEvent = Event<
+    SideNavigation$ItemPressEventParameters,
+    SideNavigation
+  >;
+
   /**
    * Parameters of the SideNavigation#itemSelect event.
    */
@@ -2667,8 +2971,6 @@ declare module "sap/tnt/ToolHeader" {
     $OverflowToolbarSettings,
   } from "sap/m/OverflowToolbar";
 
-  import { IToolHeader } from "sap/tnt/library";
-
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   /**
@@ -2709,11 +3011,7 @@ declare module "sap/tnt/ToolHeader" {
    *
    * @since 1.34
    */
-  export default class ToolHeader
-    extends OverflowToolbar
-    implements IToolHeader
-  {
-    __implements__sap_tnt_IToolHeader: boolean;
+  export default class ToolHeader extends OverflowToolbar {
     /**
      * Constructor for a new ToolHeader.
      *
@@ -2882,8 +3180,6 @@ declare module "sap/tnt/ToolPage" {
 
   import { PageBackgroundDesign } from "sap/m/library";
 
-  import { IToolHeader } from "sap/tnt/library";
-
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import SideNavigation from "sap/tnt/SideNavigation";
@@ -3023,7 +3319,7 @@ declare module "sap/tnt/ToolPage" {
      *
      * The control to appear in the header area.
      */
-    getHeader(): IToolHeader;
+    getHeader(): Control;
     /**
      * Gets content of aggregation {@link #getMainContents mainContents}.
      *
@@ -3054,7 +3350,7 @@ declare module "sap/tnt/ToolPage" {
      *
      * @since 1.93
      */
-    getSubHeader(): IToolHeader;
+    getSubHeader(): Control;
     /**
      * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
      * and returns its index if found or -1 otherwise.
@@ -3138,7 +3434,7 @@ declare module "sap/tnt/ToolPage" {
       /**
        * The header to set
        */
-      oHeader: IToolHeader
+      oHeader: Control
     ): this;
     /**
      * Sets the aggregated {@link #getSideContent sideContent}.
@@ -3175,7 +3471,7 @@ declare module "sap/tnt/ToolPage" {
       /**
        * The subHeader to set
        */
-      oSubHeader: IToolHeader
+      oSubHeader: Control
     ): this;
     /**
      * Toggles the expand/collapse state of the SideContent.
@@ -3207,14 +3503,14 @@ declare module "sap/tnt/ToolPage" {
     /**
      * The control to appear in the header area.
      */
-    header?: IToolHeader;
+    header?: Control;
 
     /**
      * The control to appear in the subheader area.
      *
      * @since 1.93
      */
-    subHeader?: IToolHeader;
+    subHeader?: Control;
 
     /**
      * The side menu of the layout.

package/types/sap.ui.codeeditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.1
+// For Library Version: 1.135.0
 
 declare module "sap/ui/codeeditor/library" {}
 
@@ -270,12 +270,13 @@ declare module "sap/ui/codeeditor/CodeEditor" {
      *
      * Sets the editor color theme. Possible values are:
      * 	 - default: best fitting to the current UI5 theme
-     * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
-     *     iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
+     * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
+     *     github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
+     *
      * 	 - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
      *     cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
      *     one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
-     *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark
+     *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
      *
      * Default value is `"default"`.
      *
@@ -688,12 +689,13 @@ declare module "sap/ui/codeeditor/CodeEditor" {
     /**
      * Sets the editor color theme. Possible values are:
      * 	 - default: best fitting to the current UI5 theme
-     * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
-     *     iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
+     * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
+     *     github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
+     *
      * 	 - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
      *     cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
      *     one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
-     *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark
+     *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
      */
     colorTheme?: string | PropertyBindingInfo;
 

package/types/sap.ui.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.1
+// For Library Version: 1.135.0
 
 declare module "sap/ui/commons/library" {
   import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";