@sapui5/ts-types-esm 1.130.2 → 1.131.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/export/library" {
   /**
@@ -616,7 +616,7 @@ declare module "sap/ui/export/Spreadsheet" {
      * Example:
      * ```javascript
      *
-     *   var oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
+     *   const oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
      *   oSpreadsheet.build();
      * ```
      *
@@ -627,7 +627,7 @@ declare module "sap/ui/export/Spreadsheet" {
      * Example:
      * ```javascript
      *
-     *   var oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
+     *   const oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
      *   oSpreadsheet.onprogress = function(iValue) {
      *   	{@link sap.base.Log#debug Log.debug}("Export: %" + iValue + " completed");
      *   };
@@ -640,7 +640,7 @@ declare module "sap/ui/export/Spreadsheet" {
      * Example of column configuration:
      * ```javascript
      *
-     *   var aColumns = [];
+     *   const aColumns = [];
      *   aColumns.push({
      *   	label: "Name",
      *   	property: "name"
@@ -652,7 +652,7 @@ declare module "sap/ui/export/Spreadsheet" {
      *     scale: 2
      *   });
      *
-     *   var mSettings = {
+     *   const mSettings = {
      *     workbook: {
      *       columns: aColumns,
      *       context: {
@@ -685,7 +685,7 @@ declare module "sap/ui/export/Spreadsheet" {
      *     dataSource: mDataSource,
      *     fileName: "salary.xlsx"
      *   };
-     *   var oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
+     *   const oSpreadsheet = new sap.ui.export.Spreadsheet(mSettings);
      *   oSpreadsheet.build();
      * ```
      *

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/fl/library" {}
 

package/types/sap.ui.generic.app.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/ui/generic/app/library" {
   export namespace navigation {
@@ -1108,7 +1108,7 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
      *  If an error occurs, an error object of type {@link sap.ui.generic.app.navigation.service.NavError},
      * URL parameters (if available) and the type of navigation are returned.
      */
-    parseNavigation(): object;
+    parseNavigation(): jQuery.Promise;
     /**
      * Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control
      * and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover

package/types/sap.ui.generic.template.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/integration/library" {
   import { URI } from "sap/ui/core/library";
@@ -251,6 +251,14 @@ declare module "sap/ui/integration/library" {
      * The parameters of the action.
      */
     parameters: object;
+    /**
+     * If visual separator should be rendered before the item.
+     */
+    startsSection: boolean;
+    /**
+     * The nested actions.
+     */
+    actions: any[];
   };
 
   /**
@@ -331,7 +339,10 @@ declare module "sap/ui/integration/ActionDefinition" {
 
   import { CardActionType } from "sap/ui/integration/library";
 
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
 
   /**
    * Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
@@ -404,6 +415,18 @@ declare module "sap/ui/integration/ActionDefinition" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
+    /**
+     * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    addActionDefinition(
+      /**
+       * The actionDefinition to add; if empty, nothing is inserted
+       */
+      oActionDefinition: ActionDefinition
+    ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
      *
@@ -453,6 +476,13 @@ declare module "sap/ui/integration/ActionDefinition" {
        */
       oListener?: object
     ): this;
+    /**
+     * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    destroyActionDefinitions(): this;
     /**
      * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
      *
@@ -484,6 +514,13 @@ declare module "sap/ui/integration/ActionDefinition" {
        */
       mParameters?: object
     ): this;
+    /**
+     * Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
+     *
+     * Action Definitions which will appear as nested items in the menu. **Note**: The parent action definition
+     * will not fire a press anymore, it will only be used to hold the subitem.
+     */
+    getActionDefinitions(): ActionDefinition[];
     /**
      * Gets current value of property {@link #getButtonType buttonType}.
      *
@@ -491,6 +528,7 @@ declare module "sap/ui/integration/ActionDefinition" {
      *
      * Default value is `Transparent`.
      *
+     * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
      *
      * @returns Value of property `buttonType`
      */
@@ -525,6 +563,18 @@ declare module "sap/ui/integration/ActionDefinition" {
      * @returns Value of property `parameters`
      */
     getParameters(): object;
+    /**
+     * Gets current value of property {@link #getStartsSection startsSection}.
+     *
+     * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
+     * its separator is also not displayed.
+     *
+     * Default value is `false`.
+     *
+     *
+     * @returns Value of property `startsSection`
+     */
+    getStartsSection(): boolean;
     /**
      * Gets current value of property {@link #getText text}.
      *
@@ -556,6 +606,58 @@ declare module "sap/ui/integration/ActionDefinition" {
      * @returns Value of property `visible`
      */
     getVisible(): boolean;
+    /**
+     * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
+     * and returns its index if found or -1 otherwise.
+     *
+     *
+     * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+     */
+    indexOfActionDefinition(
+      /**
+       * The actionDefinition whose index is looked for
+       */
+      oActionDefinition: ActionDefinition
+    ): int;
+    /**
+     * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    insertActionDefinition(
+      /**
+       * The actionDefinition to insert; if empty, nothing is inserted
+       */
+      oActionDefinition: ActionDefinition,
+      /**
+       * The `0`-based index the actionDefinition should be inserted at; for a negative value of `iIndex`, the
+       * actionDefinition is inserted at position 0; for a value greater than the current size of the aggregation,
+       * the actionDefinition is inserted at the last position
+       */
+      iIndex: int
+    ): this;
+    /**
+     * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
+     *
+     *
+     * @returns The removed actionDefinition or `null`
+     */
+    removeActionDefinition(
+      /**
+       * The actionDefinition to remove or its index or id
+       */
+      vActionDefinition: int | string | ActionDefinition
+    ): ActionDefinition | null;
+    /**
+     * Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
+     *
+     * Additionally, it unregisters them from the hosting UIArea.
+     *
+     *
+     * @returns An array of the removed elements (might be empty)
+     */
+    removeAllActionDefinitions(): ActionDefinition[];
     /**
      * Sets a new value for property {@link #getButtonType buttonType}.
      *
@@ -565,6 +667,7 @@ declare module "sap/ui/integration/ActionDefinition" {
      *
      * Default value is `Transparent`.
      *
+     * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -625,6 +728,25 @@ declare module "sap/ui/integration/ActionDefinition" {
        */
       oParameters: object
     ): this;
+    /**
+     * Sets a new value for property {@link #getStartsSection startsSection}.
+     *
+     * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
+     * its separator is also not displayed.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `false`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setStartsSection(
+      /**
+       * New value for property `startsSection`
+       */
+      bStartsSection?: boolean
+    ): this;
     /**
      * Sets a new value for property {@link #getText text}.
      *
@@ -705,6 +827,8 @@ declare module "sap/ui/integration/ActionDefinition" {
 
     /**
      * The type of the action button.
+     *
+     * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
      */
     buttonType?:
       | (ButtonType | keyof typeof ButtonType)
@@ -727,6 +851,22 @@ declare module "sap/ui/integration/ActionDefinition" {
      */
     parameters?: object | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
+     * its separator is also not displayed.
+     */
+    startsSection?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Action Definitions which will appear as nested items in the menu. **Note**: The parent action definition
+     * will not fire a press anymore, it will only be used to hold the subitem.
+     */
+    actionDefinitions?:
+      | ActionDefinition[]
+      | ActionDefinition
+      | AggregationBindingInfo
+      | `{${string}}`;
+
     /**
      * Fired when the action button is pressed.
      */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/layout/library" {
   import Control from "sap/ui/core/Control";
@@ -9305,15 +9305,18 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
   } from "sap/ui/base/ManagedObject";
 
   /**
-   * A `SemanticFormElement` element is a special `FormElement` that contains semantically connected fields.
-   * These field controls are divided by delimiter controls. In display mode, they are rendered as one condensed
-   * string, in edit mode as separate fields.
+   * A `SemanticFormElement` element is a special {@link sap.ui.layout.form.FormElement FormElement} that
+   * contains semantically connected fields. These field controls are divided by delimiter controls. In display
+   * mode, they are rendered as one condensed string, in edit mode as separate fields.
    *
-   * **Note:** Please use the `ColumnLayout` as `layout` of the `Form`. For other layouts, the field arrangement
-   * might not be suitable in every case.
+   * Only controls implementing the {@link sap.ui.core.ISemanticFormContent ISemanticFormContent} interface
+   * are supported.
+   *
+   * **Note:** Please use the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.Form#setLayout layout }
+   * of the {@link sap.ui.layout.form.Form Form}. For other layouts, the field arrangement might not be suitable
+   * in every case.
    *
    * @since 1.86.0
-   * @experimental (since 1.86)
    */
   export default class SemanticFormElement extends FormElement {
     /**
@@ -9411,13 +9414,11 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
     /**
      * Gets content of aggregation {@link #getFieldLabels fieldLabels}.
      *
-     * Labels of the individual fields. Can either be a `Label` control or a string.
-     *
-     * If a `Label` control is used, the properties of the `Label` can be set.
+     * Labels of the individual fields.
      *
-     * These labels are not rendered directly. If the `Label` property of `SemanticFormElement` is not set,
-     * the texts of the labels are concatenated into the `Label` property of `SemanticFormElement`. Otherwise
-     * the set `Label` is shown.
+     * These labels are not rendered directly. If the {@link #getLabel label} aggregation of `SemanticFormElement`
+     * is not set, the texts of the labels are concatenated into the {@link #setLabel label} aggregation of
+     * `SemanticFormElement`. Otherwise the set `Label` is shown.
      *
      * **Note:** If this aggregation is used, a label is assigned to every single field of `SemanticFormElement`.
      * The order of the labels and the fields must be the same.
@@ -9496,8 +9497,6 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
   }
   /**
    * Describes the settings that can be provided to the SemanticFormElement constructor.
-   *
-   * @experimental (since 1.86)
    */
   export interface $SemanticFormElementSettings extends $FormElementSettings {
     /**
@@ -9506,13 +9505,11 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
     delimiter?: string | PropertyBindingInfo;
 
     /**
-     * Labels of the individual fields. Can either be a `Label` control or a string.
-     *
-     * If a `Label` control is used, the properties of the `Label` can be set.
+     * Labels of the individual fields.
      *
-     * These labels are not rendered directly. If the `Label` property of `SemanticFormElement` is not set,
-     * the texts of the labels are concatenated into the `Label` property of `SemanticFormElement`. Otherwise
-     * the set `Label` is shown.
+     * These labels are not rendered directly. If the {@link #getLabel label} aggregation of `SemanticFormElement`
+     * is not set, the texts of the labels are concatenated into the {@link #setLabel label} aggregation of
+     * `SemanticFormElement`. Otherwise the set `Label` is shown.
      *
      * **Note:** If this aggregation is used, a label is assigned to every single field of `SemanticFormElement`.
      * The order of the labels and the fields must be the same.