@sapui5/ts-types 1.118.0 → 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 namespace sap {
   namespace fe {
@@ -49,7 +49,7 @@ declare namespace sap {
           /**
            * Defines nested actions
            */
-          actions: undefined[];
+          actions: sap.fe.macros.chart.Action[];
           /**
            * Reference to the key of another action or action group already displayed in the toolbar to properly place
            * this one
@@ -125,7 +125,7 @@ declare namespace sap {
           /**
            * Defines nested actions
            */
-          actions: undefined[];
+          actions: sap.fe.macros.table.Action[];
           /**
            * Reference to the key of another action or action group already displayed in the toolbar to properly place
            * this one
@@ -179,9 +179,13 @@ declare namespace sap {
           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;
         };
 
         /**
@@ -216,7 +220,6 @@ declare namespace sap {
            * 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'.
@@ -547,6 +550,109 @@ declare namespace sap {
         id?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      interface $RichTextEditorSettings extends sap.ui.core.$ControlSettings {
+        /**
+         * With the 'buttonGroups' attribute you can customize the buttons that are displayed on the toolbar of
+         * the editor.
+         */
+        buttonGroups?:
+          | any[]
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * ID of the editor
+         */
+        id?: string | sap.ui.base.ManagedObject.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
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * Use the 'required' attribute to make sure that the editor is filled with some text.
+         */
+        required?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * The value contained in the editor. You can use this attribute to set a default value.
+         */
+        value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      }
+
+      interface $RichTextEditorWithMetadataSettings
+        extends sap.ui.core.$ControlSettings {
+        /**
+         * With the 'buttonGroups' attribute, you can customize the buttons that are displayed on the toolbar of
+         * the editor.
+         */
+        buttonGroups?:
+          | any[]
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * The context path of the property displayed
+         */
+        contextPath?:
+          | sap.ui.model.Context
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * ID of the editor
+         */
+        id?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * The metaPath of the displayed property
+         */
+        metaPath?:
+          | sap.ui.model.Context
+          | sap.ui.base.ManagedObject.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
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * Use the 'required' attribute, to make sure that the editor is filled with some text.
+         */
+        required?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+      }
+
+      interface $ShareSettings extends sap.ui.core.$ControlSettings {
+        /**
+         * The identifier of the Share control.
+         */
+        id?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * Whether the share control should be visible on the screen.
+         */
+        visible?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+      }
+
       interface $TableSettings extends sap.fe.macros.$MacroAPISettings {
         /**
          * An expression that allows you to control the 'busy' state of the table.
@@ -691,7 +797,7 @@ declare namespace sap {
           | `{${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.
@@ -728,6 +834,14 @@ declare namespace sap {
           | string
           | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * Indicates if the column header should be a part of the width calculation.
+         */
+        widthIncludingColumnHeader?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Aggregate actions of the table.
          */
@@ -778,6 +892,7 @@ declare namespace sap {
        *
        *
        * Usually, a contextPath and metaPath is expected.
+       *
        * Usage example:
        *
        * ```javascript
@@ -801,6 +916,7 @@ declare namespace sap {
        *
        * 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
@@ -818,7 +934,7 @@ declare namespace sap {
          */
         addMessage(
           /**
-           * undefined
+           * The parameters to create message
            */
           parameters: {
             /**
@@ -860,6 +976,7 @@ declare namespace sap {
        *
        *
        * Usually, a SelectionFields annotation is expected.
+       *
        * Usage example:
        *
        * ```javascript
@@ -886,7 +1003,7 @@ declare namespace sap {
         /**
          * 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<sap.fe.navigation.SelectionVariant>;
         /**
@@ -902,23 +1019,30 @@ declare namespace sap {
            */
           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: sap.fe.navigation.SelectionVariant
         ): Promise<unknown>;
@@ -935,6 +1059,7 @@ declare namespace sap {
        *
        * 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
@@ -1000,6 +1125,26 @@ declare namespace sap {
       class Paginator extends sap.ui.core.Control {
         constructor();
       }
+      /**
+       * @since 1.117.0
+       * @experimental (since 1.117.0)
+       *
+       * Building block that exposes the RichTextEditor UI5 control.
+       * It's used to enter formatted text, and uses the third-party component called TinyMCE.
+       */
+      class RichTextEditor extends sap.ui.core.Control {
+        constructor();
+      }
+      /**
+       * @since 1.117.0
+       * @experimental (since 1.117.0)
+       *
+       * 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.
+       */
+      class RichTextEditorWithMetadata extends sap.ui.core.Control {
+        constructor();
+      }
       /**
        * @since 1.93.0
        *
@@ -1012,18 +1157,18 @@ declare namespace sap {
        *
        * 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"
        * />
        * ```
        */
-      class Share
-        /* was: sap.fe.core.buildingBlocks.RuntimeBuildingBlock */ extends Object {
+      class Share extends sap.ui.core.Control {
         constructor();
       }
       /**
@@ -1032,6 +1177,7 @@ declare namespace sap {
        *
        * Usually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also
        * be used to display an EntitySet.
+       *
        * Usage example:
        *
        * ```javascript
@@ -1051,7 +1197,7 @@ declare namespace sap {
          */
         addMessage(
           /**
-           * undefined
+           * The parameters to create the message
            */
           parameters: {
             /**
@@ -1098,9 +1244,9 @@ declare namespace sap {
        */
       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;
         /**
@@ -1113,7 +1259,6 @@ declare namespace sap {
          * 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;
@@ -1121,7 +1266,6 @@ declare namespace sap {
          * 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;
@@ -1129,7 +1273,6 @@ declare namespace sap {
          * 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;