@sapui5/types 1.118.1 → 1.119.0

package/types/sap.fe.macros.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.119.0
 
 declare module "sap/fe/macros/library" {}
 
@@ -52,6 +52,7 @@ declare module "sap/fe/macros/chart/ChartAPI" {
    *
    *
    * Usually, a contextPath and metaPath is expected.
+   *
    * Usage example:
    *
    * ```javascript
@@ -111,7 +112,7 @@ declare module "sap/fe/macros/chart/ChartAPI" {
     /**
      * Defines nested actions
      */
-    actions: undefined[];
+    actions: Action[];
     /**
      * Reference to the key of another action or action group already displayed in the toolbar to properly place
      * this one
@@ -235,6 +236,7 @@ declare module "sap/fe/macros/field/FieldAPI" {
    *
    * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
    * property from the entity type.
+   *
    * Usage example:
    *
    * ```javascript
@@ -252,7 +254,7 @@ declare module "sap/fe/macros/field/FieldAPI" {
      */
     addMessage(
       /**
-       * undefined
+       * The parameters to create message
        */
       parameters: {
         /**
@@ -294,9 +296,9 @@ declare module "sap/fe/macros/field/FieldAPI" {
    */
   export type FieldFormatOptions = {
     /**
-     *  Defines how the field value and associated text will be displayed together.
+     * Defines how the field value and associated text will be displayed together.
      *
-     *  Allowed values are "Value", "Description", "DescriptionValue" and "ValueDescription"
+     * Allowed values are "Value", "Description", "DescriptionValue" and "ValueDescription"
      */
     displayMode: string;
     /**
@@ -309,7 +311,6 @@ declare module "sap/fe/macros/field/FieldAPI" {
      * Defines if the date part of a date time with timezone field should be shown.
      *
      * The dateTimeOffset field must have a timezone annotation.
-     *
      * The default value is true.
      */
     showDate: boolean;
@@ -317,7 +318,6 @@ declare module "sap/fe/macros/field/FieldAPI" {
      * Defines if the time part of a date time with timezone field should be shown.
      *
      * The dateTimeOffset field must have a timezone annotation.
-     *
      * The default value is true.
      */
     showTime: boolean;
@@ -325,7 +325,6 @@ declare module "sap/fe/macros/field/FieldAPI" {
      * Defines if the timezone part of a date time with timezone field should be shown.
      *
      * The dateTimeOffset field must have a timezone annotation.
-     *
      * The default value is true.
      */
     showTimezone: boolean;
@@ -438,6 +437,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
    *
    *
    * Usually, a SelectionFields annotation is expected.
+   *
    * Usage example:
    *
    * ```javascript
@@ -464,7 +464,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
     /**
      * Get the selection variant from the filter bar.
      *
-     * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
+     * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
      */
     getSelectionVariant(): Promise<SelectionVariant>;
     /**
@@ -480,23 +480,30 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
        */
       sConditionPath: string,
       /**
-       * undefined
+       * The operator to be used (optional) - if not set, the default operator (EQ) will be used
        */
       sOperator: string | undefined,
       /**
        * The values to be applied
        */
-      vValues?: boolean | boolean[] | number | number[] | string | string[]
+      vValues?:
+        | boolean
+        | boolean[]
+        | number
+        | number[]
+        | string
+        | string[]
+        | undefined
     ): Promise<void>;
     /**
-     * Sets {@link sap.fe.navigation.SelectionVariant} to the filter bar. Note: setSelectionVariant will clear
+     * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
      * existing filters and then apply the SelectionVariant values.
      *
      * @returns A promise for asynchronous handling
      */
     setSelectionVariant(
       /**
-       * The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
+       * The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
        */
       selectionVariant: SelectionVariant
     ): Promise<unknown>;
@@ -617,6 +624,7 @@ declare module "sap/fe/macros/form/Form.block" {
    *
    * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
    * or a CollectionFacet
+   *
    * Usage example:
    *
    * ```javascript
@@ -804,6 +812,10 @@ declare module "sap/fe/macros/paginator/Paginator.block" {
 }
 
 declare module "sap/fe/macros/richtexteditor/RichTextEditor.block" {
+  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
   /**
    * @since 1.117.0
    * @experimental (since 1.117.0)
@@ -811,13 +823,47 @@ declare module "sap/fe/macros/richtexteditor/RichTextEditor.block" {
    * Building block that exposes the RichTextEditor UI5 control.
    * It's used to enter formatted text, and uses the third-party component called TinyMCE.
    */
-  export default class RichTextEditor
-    /* was: sap.fe.core.buildingBlocks.RuntimeBuildingBlock */ extends Object {
+  export default class RichTextEditor extends Control {
     constructor();
   }
+
+  export interface $RichTextEditorSettings extends $ControlSettings {
+    /**
+     * With the 'buttonGroups' attribute you can customize the buttons that are displayed on the toolbar of
+     * the editor.
+     */
+    buttonGroups?: any[] | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * ID of the editor
+     */
+    id?: string | PropertyBindingInfo;
+
+    /**
+     * Use the readOnly attribute to override the edit flow of the page.
+     * By setting 'readOnly' to true, a FormattedText will be displayed instead of the editor.
+     */
+    readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Use the 'required' attribute to make sure that the editor is filled with some text.
+     */
+    required?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * The value contained in the editor. You can use this attribute to set a default value.
+     */
+    value?: string | PropertyBindingInfo;
+  }
 }
 
 declare module "sap/fe/macros/richtexteditor/RichTextEditorWithMetadata.block" {
+  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  import Context from "sap/ui/model/Context";
+
   /**
    * @since 1.117.0
    * @experimental (since 1.117.0)
@@ -825,13 +871,51 @@ declare module "sap/fe/macros/richtexteditor/RichTextEditorWithMetadata.block" {
    * Metadata-driven building block that exposes the RichTextEditor UI5 control.
    * It's used to enter formatted text and uses the third-party component called TinyMCE.
    */
-  export default class RichTextEditorWithMetadata
-    /* was: sap.fe.core.buildingBlocks.RuntimeBuildingBlock */ extends Object {
+  export default class RichTextEditorWithMetadata extends Control {
     constructor();
   }
+
+  export interface $RichTextEditorWithMetadataSettings
+    extends $ControlSettings {
+    /**
+     * With the 'buttonGroups' attribute, you can customize the buttons that are displayed on the toolbar of
+     * the editor.
+     */
+    buttonGroups?: any[] | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * The context path of the property displayed
+     */
+    contextPath?: Context | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * ID of the editor
+     */
+    id?: string | PropertyBindingInfo;
+
+    /**
+     * The metaPath of the displayed property
+     */
+    metaPath?: Context | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Use the readOnly attribute to override the edit flow of the page.
+     * By setting 'readOnly' to true, a FormattedText is displayed instead of the editor.
+     */
+    readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Use the 'required' attribute, to make sure that the editor is filled with some text.
+     */
+    required?: boolean | PropertyBindingInfo | `{${string}}`;
+  }
 }
 
 declare module "sap/fe/macros/share/Share.block" {
+  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
   /**
    * @since 1.93.0
    *
@@ -844,20 +928,32 @@ declare module "sap/fe/macros/share/Share.block" {
    *
    * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
    * the 'Save as Tile' option is not visible.
+   *
    * Usage example:
    *
    * ```javascript
    *
    * <macro:Share
    * 	id="someID"
-   * 	visible="true"
+   * visible="true"
    * />
    * ```
    */
-  export default class Share
-    /* was: sap.fe.core.buildingBlocks.RuntimeBuildingBlock */ extends Object {
+  export default class Share extends Control {
     constructor();
   }
+
+  export interface $ShareSettings extends $ControlSettings {
+    /**
+     * The identifier of the Share control.
+     */
+    id?: string | PropertyBindingInfo;
+
+    /**
+     * Whether the share control should be visible on the screen.
+     */
+    visible?: boolean | PropertyBindingInfo | `{${string}}`;
+  }
 }
 
 declare module "sap/fe/macros/table/TableAPI" {
@@ -883,6 +979,7 @@ declare module "sap/fe/macros/table/TableAPI" {
    *
    * Usually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also
    * be used to display an EntitySet.
+   *
    * Usage example:
    *
    * ```javascript
@@ -902,7 +999,7 @@ declare module "sap/fe/macros/table/TableAPI" {
      */
     addMessage(
       /**
-       * undefined
+       * The parameters to create the message
        */
       parameters: {
         /**
@@ -985,7 +1082,7 @@ declare module "sap/fe/macros/table/TableAPI" {
     /**
      * Defines nested actions
      */
-    actions: undefined[];
+    actions: Action[];
     /**
      * Reference to the key of another action or action group already displayed in the toolbar to properly place
      * this one
@@ -1039,9 +1136,13 @@ declare module "sap/fe/macros/table/TableAPI" {
     placement: string;
     /**
      * Defines the column's width.
-     * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize}
+     * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
      */
     width: string;
+    /**
+     * Indicates if the column header should be a part of the width calculation.
+     */
+    widthIncludingColumnHeader: boolean;
   };
 
   /**
@@ -1076,7 +1177,6 @@ declare module "sap/fe/macros/table/TableAPI" {
      * InlineCreationsRows - The creation is done inline with an empty row
      *
      * External - The creation is done in a different application specified via the parameter 'outbound'
-     *
      * If not set with any value:
      *
      * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
@@ -1195,7 +1295,7 @@ declare module "sap/fe/macros/table/TableAPI" {
     rowCount?: number | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Defines how the table handles the visible rows. Does not apply to responsive tables.
+     * Defines how the table handles the visible rows. Does not apply to Responsive tables.
      * Allowed values are `Auto`, `Fixed`.
      *
      * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
@@ -1230,6 +1330,11 @@ declare module "sap/fe/macros/table/TableAPI" {
      */
     variantManagement?: string | PropertyBindingInfo;
 
+    /**
+     * Indicates if the column header should be a part of the width calculation.
+     */
+    widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Aggregate actions of the table.
      */