diff --git a/types/openui5/openui5-tests.ts b/types/openui5/openui5-tests.ts index e3e58e5913f9a5..80ab755fbb314d 100644 --- a/types/openui5/openui5-tests.ts +++ b/types/openui5/openui5-tests.ts @@ -284,3 +284,5 @@ const p13nEngine = new Engine(); // version 1.141.0 added - tests are not required as the type definitions are generated and the generator is sufficiently tested // version 1.142.0 added - tests are not required as the type definitions are generated and the generator is sufficiently tested + +// version 1.143.0 added - tests are not required as the type definitions are generated and the generator is sufficiently tested diff --git a/types/openui5/package.json b/types/openui5/package.json index f125dab93d6fd2..a8dd195858a368 100644 --- a/types/openui5/package.json +++ b/types/openui5/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/openui5", - "version": "1.142.9999", + "version": "1.143.9999", "nonNpm": true, "nonNpmDescription": "openui5", "projects": [ diff --git a/types/openui5/sap.f.d.ts b/types/openui5/sap.f.d.ts index a90dd24b90e777..2a7ba062f03a33 100644 --- a/types/openui5/sap.f.d.ts +++ b/types/openui5/sap.f.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/tnt/library" { export interface IToolHeader { @@ -21074,6 +21074,13 @@ declare module "sap/f/ShellBar" { import Button from "sap/m/Button"; /** + * **Note:** `sap.f.ShellBar` is not UXC-compliant and will no longer be aligned with future UXC design + * updates. For UXC-compliant applications, use the ui5-shellbar web component instead. It can be integrated + * seamlessly using ui5-tooling-modules. See {@link https://ui5.sap.com/#/topic/1c80793df5bb424091954697fc0b2828 Using Web Components}. + * + * + * + * * A horizontal bar control holding multiple child controls used as application shell header. * * Overview: diff --git a/types/openui5/sap.m.d.ts b/types/openui5/sap.m.d.ts index 0b444ef929174f..6671d34c3f47f7 100644 --- a/types/openui5/sap.m.d.ts +++ b/types/openui5/sap.m.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/f/library" { export interface IShellBar { @@ -2224,6 +2224,8 @@ declare module "sap/m/library" { None = "None", /** * Right-positioned single selection mode (only one list item can be selected). + * + * @deprecated As of version 1.143. replaced by {@link sap.m.ListMode.SingleSelectLeft}. */ SingleSelect = "SingleSelect", /** @@ -2325,6 +2327,34 @@ declare module "sap/m/library" { */ Split = "Split", } + /** + * Available color set variants for the {@link sap.m.MessageStrip} control. + * + * **Notes:** + * - The Default color set uses standard semantic colors based on the message type (Information, Success, + * Warning, Error). + * - ColorSet1 and ColorSet2 provide custom color palettes with 10 predefined color schemes each. + * - When using ColorSet1 or ColorSet2, the `colorScheme` property determines which color variation is + * applied. + * + * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'MessageStripColorSet'. + * + * @since 1.143.0 + */ + export enum MessageStripColorSet { + /** + * Uses a custom color palette with predefined color schemes + */ + ColorSet1 = "ColorSet1", + /** + * Uses an alternative custom color palette with predefined color schemes + */ + ColorSet2 = "ColorSet2", + /** + * Uses standard semantic colors based on the type property (Information, Success, Warning, Error) + */ + Default = "Default", + } /** * Enumeration of the `multiSelectMode>/code> in ListBase`. * @@ -3148,13 +3178,13 @@ declare module "sap/m/library" { /** * Each item fits its content and extra space is placed after the last item. * - * @since 1.42 + * @since 1.142.0 */ ContentFit = "ContentFit", /** * All items are sized equally to fill the available space. * - * @since 1.42 + * @since 1.142.0 */ EqualSized = "EqualSized", } @@ -61844,6 +61874,8 @@ declare module "sap/m/MessageStrip" { import Event from "sap/ui/base/Event"; + import { MessageStripColorSet } from "sap/m/library"; + import { URI } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; @@ -61858,7 +61890,8 @@ declare module "sap/m/MessageStrip" { /** * MessageStrip is a control that enables the embedding of application-related messages in the application. * Overview: The message strip displays 4 types of messages, each with a corresponding semantic color and - * icon: Information, Success, Warning and Error. + * icon: Information, Success, Warning and Error. Additionally, it supports custom color schemes through + * ColorSet1 and ColorSet2 design types, each providing 10 predefined color variations. * * Each message can have a close button, so that it can be removed from the UI if needed. * @@ -61870,10 +61903,14 @@ declare module "sap/m/MessageStrip" { * - With version 1.85 * -
* + * Color Schemes: When using ColorSet1 or ColorSet2 as the design type, you can specify a `colorScheme` + * from "1" to "10" to apply different color variations. This allows for better visual categorization and + * theming flexibility while maintaining accessibility standards. + * * Dynamically generated Message Strip: To meet the accessibility requirements when using dynamically generated * Message Strip you must implement it alongside `sap.ui.core.InvisibleMessage`. This will allow screen * readers to announce it in real time. We suggest such dynamically generated message strips to be announced - * as Information Bar, as shown in our “Dynamic Message Strip Generator sample.” + * as Information Bar, as shown in our "Dynamic Message Strip Generator sample." * * Usage: When to use: * - You want to provide information or status update within the detail area of an object When not @@ -62061,6 +62098,41 @@ declare module "sap/m/MessageStrip" { */ mParameters?: object ): this; + /** + * Gets current value of property {@link #getColorScheme colorScheme}. + * + * Determines the color scheme when using ColorSet1 or ColorSet2 colorSet variants. Available values are + * 1 through 10, each providing a different color variation. This property is only effective when `colorSet` + * is set to "ColorSet1" or "ColorSet2". + * + * Default value is `1`. + * + * @since 1.143.0 + * + * @returns Value of property `colorScheme` + */ + getColorScheme(): int; + /** + * Gets current value of property {@link #getColorSet colorSet}. + * + * Determines the color set variant of the MessageStrip. Available options: + * - **Default** - Uses standard semantic colors based on the type property (Information, Success, Warning, + * Error) + * - **ColorSet1** - Uses a custom color palette with 10 predefined color schemes + * - **ColorSet2** - Uses an alternative custom color palette with 10 predefined color schemes When + * ColorSet1 or ColorSet2 is selected, the `colorScheme` property determines which of the 10 color variations + * is applied. + * + * **Note:** When using ColorSet1 or ColorSet2 designs, the type property is still used for semantic purposes + * but will be ignored for visual styling. + * + * Default value is `Default`. + * + * @since 1.143.0 + * + * @returns Value of property `colorSet` + */ + getColorSet(): MessageStripColorSet; /** * Gets content of aggregation {@link #getControls controls}. * @@ -62075,7 +62147,7 @@ declare module "sap/m/MessageStrip" { * Gets current value of property {@link #getCustomIcon customIcon}. * * Determines a custom icon which is displayed. If none is set, the default icon for this message type is - * used. + * used. **Note**: For ColorSet1 and ColorSet2 designs, no default icon is displayed unless explicitly provided. * * Default value is `empty string`. * @@ -62213,11 +62285,60 @@ declare module "sap/m/MessageStrip" { */ vControl: int | string | Link ): Link | null; + /** + * Sets a new value for property {@link #getColorScheme colorScheme}. + * + * Determines the color scheme when using ColorSet1 or ColorSet2 colorSet variants. Available values are + * 1 through 10, each providing a different color variation. This property is only effective when `colorSet` + * is set to "ColorSet1" or "ColorSet2". + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `1`. + * + * @since 1.143.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setColorScheme( + /** + * New value for property `colorScheme` + */ + iColorScheme?: int + ): this; + /** + * Sets a new value for property {@link #getColorSet colorSet}. + * + * Determines the color set variant of the MessageStrip. Available options: + * - **Default** - Uses standard semantic colors based on the type property (Information, Success, Warning, + * Error) + * - **ColorSet1** - Uses a custom color palette with 10 predefined color schemes + * - **ColorSet2** - Uses an alternative custom color palette with 10 predefined color schemes When + * ColorSet1 or ColorSet2 is selected, the `colorScheme` property determines which of the 10 color variations + * is applied. + * + * **Note:** When using ColorSet1 or ColorSet2 designs, the type property is still used for semantic purposes + * but will be ignored for visual styling. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `Default`. + * + * @since 1.143.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setColorSet( + /** + * New value for property `colorSet` + */ + sColorSet?: MessageStripColorSet | keyof typeof MessageStripColorSet + ): this; /** * Sets a new value for property {@link #getCustomIcon customIcon}. * * Determines a custom icon which is displayed. If none is set, the default icon for this message type is - * used. + * used. **Note**: For ColorSet1 and ColorSet2 designs, no default icon is displayed unless explicitly provided. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -62361,9 +62482,37 @@ declare module "sap/m/MessageStrip" { | PropertyBindingInfo | `{${string}}`; + /** + * Determines the color set variant of the MessageStrip. Available options: + * - **Default** - Uses standard semantic colors based on the type property (Information, Success, Warning, + * Error) + * - **ColorSet1** - Uses a custom color palette with 10 predefined color schemes + * - **ColorSet2** - Uses an alternative custom color palette with 10 predefined color schemes When + * ColorSet1 or ColorSet2 is selected, the `colorScheme` property determines which of the 10 color variations + * is applied. + * + * **Note:** When using ColorSet1 or ColorSet2 designs, the type property is still used for semantic purposes + * but will be ignored for visual styling. + * + * @since 1.143.0 + */ + colorSet?: + | (MessageStripColorSet | keyof typeof MessageStripColorSet) + | PropertyBindingInfo + | `{${string}}`; + + /** + * Determines the color scheme when using ColorSet1 or ColorSet2 colorSet variants. Available values are + * 1 through 10, each providing a different color variation. This property is only effective when `colorSet` + * is set to "ColorSet1" or "ColorSet2". + * + * @since 1.143.0 + */ + colorScheme?: int | PropertyBindingInfo | `{${string}}`; + /** * Determines a custom icon which is displayed. If none is set, the default icon for this message type is - * used. + * used. **Note**: For ColorSet1 and ColorSet2 designs, no default icon is displayed unless explicitly provided. */ customIcon?: URI | PropertyBindingInfo | `{${string}}`; @@ -111819,7 +111968,7 @@ declare module "sap/m/SegmentedButton" { * * Default value is `EqualSized`. * - * @since 1.42.0 + * @since 1.142.0 * * @returns Value of property `contentMode` */ @@ -112043,7 +112192,7 @@ declare module "sap/m/SegmentedButton" { * * Default value is `EqualSized`. * - * @since 1.42.0 + * @since 1.142.0 * * @returns Reference to `this` in order to allow method chaining */ @@ -112181,7 +112330,7 @@ declare module "sap/m/SegmentedButton" { * - **ContentFit**: Each button is sized according to its content. * - **EqualSized**: All buttons have equal width, regardless of their content. * - * @since 1.42.0 + * @since 1.142.0 */ contentMode?: | (SegmentedButtonContentMode | keyof typeof SegmentedButtonContentMode) @@ -130370,6 +130519,11 @@ declare module "sap/m/SinglePlanningCalendar" { * The end date as a UI5Date or JavaScript Date object of the focused grid cell. */ endDate?: object; + + /** + * The original browser event. + */ + originalEvent?: object; } /** @@ -174270,6 +174424,8 @@ declare namespace sap { "sap/m/p13n/modules/AdaptationProvider": undefined; + "sap/m/p13n/PersistenceProvider": undefined; + "sap/m/p13n/Popup": undefined; "sap/m/p13n/QueryPanel": undefined; diff --git a/types/openui5/sap.tnt.d.ts b/types/openui5/sap.tnt.d.ts index deec39d6554891..3cb1ba34905e55 100644 --- a/types/openui5/sap.tnt.d.ts +++ b/types/openui5/sap.tnt.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/tnt/library" { /** diff --git a/types/openui5/sap.ui.codeeditor.d.ts b/types/openui5/sap.ui.codeeditor.d.ts index 881b3d80b0a86c..a302479ce2290b 100644 --- a/types/openui5/sap.ui.codeeditor.d.ts +++ b/types/openui5/sap.ui.codeeditor.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/codeeditor/library" {} diff --git a/types/openui5/sap.ui.commons.d.ts b/types/openui5/sap.ui.commons.d.ts index 178eb77126bcbf..c1dc2e47bcec17 100644 --- a/types/openui5/sap.ui.commons.d.ts +++ b/types/openui5/sap.ui.commons.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/commons/library" { import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library"; diff --git a/types/openui5/sap.ui.core.d.ts b/types/openui5/sap.ui.core.d.ts index 433d5a0d670b93..e977da5f41e9b3 100644 --- a/types/openui5/sap.ui.core.d.ts +++ b/types/openui5/sap.ui.core.d.ts @@ -279,7 +279,7 @@ declare namespace sap { "sap/ui/thirdparty/qunit-2": undefined; } } -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/base/assert" { /** @@ -6693,8 +6693,6 @@ declare module "sap/ui/model/odata/v2/ODataModel" { */ treeState?: any; /** - * This parameter is experimental as of version 1.141.0. - * * Whether the tree state is restored on hierarchy maintenance, such as adding, removing, or deleting a * node. This is only supported if the following conditions are met: * - The binding has to use {@link sap.ui.model.odata.OperationMode.Server OperationMode.Server} @@ -17347,10 +17345,11 @@ declare module "sap/ui/core/library" { export type ID = string; /** - * Marker interface for controls that can be used as content of `sap.ui.layout.form.Form` or `sap.ui.layout.form.SimpleForm`. + * Marker interface for controls that can be used as content of {@link sap.ui.layout.form.Form} or {@link sap.ui.layout.form.SimpleForm}. * - * If the control's width must not be adjusted by the `Form` control to meet the cell's width, the control - * must implement the `getFormDoNotAdjustWidth` function and return `true`. + * If the control's width must not be adjusted by the {@link sap.ui.layout.form.Form Form} control to meet + * the cell's width, the control must implement the {@link sap.ui.core.IFormContent.getFormDoNotAdjustWidth getFormDoNotAdjustWidth } + * function and return `true`. * * @since 1.48.0 */ @@ -17358,17 +17357,18 @@ declare module "sap/ui/core/library" { __implements__sap_ui_core_IFormContent: boolean; /** - * Whether a control wants to keep its original width even when used in a `Form`. + * Whether a control wants to keep its original width even when used in a {@link sap.ui.layout.form.Form Form}. * - * In the `Form` control, all content controls are positioned on a grid cell base. By default, the controls - * use the full width of the used grid cell. But for some controls (like image controls), this is not the - * desired behavior. In this case the control must keep its original width. + * In the {@link sap.ui.layout.form.Form Form} control, all content controls are positioned on a grid cell + * base. By default, the controls use the full width of the used grid cell. But for some controls (like + * image controls), this is not the desired behavior. In this case the control must keep its original width. * * This is an optional method. When not defined, the width of the control might be adjusted. * * @since 1.48.0 * - * @returns true if the `Form` is not allowed to adjust the width of the control to use the cell's width + * @returns `true` if the {@link sap.ui.layout.form.Form Form} is not allowed to adjust the width of the + * control to use the cell's width */ getFormDoNotAdjustWidth?(): boolean; } @@ -17576,7 +17576,7 @@ declare module "sap/ui/core/library" { /** * Marker interface for controls that can be used as content of {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}. * - * If the value-holding property of the control is not `valuetext`, the name of the value-holding + * If the value-holding property of the control is not `value` or `text`, the name of the value-holding * property must be returned in the {@link sap.ui.core.ISemanticFormContent.getFormValueProperty getFormValueProperty } * function. * @@ -66762,8 +66762,9 @@ declare module "sap/ui/model/odata/type/Boolean" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.Boolean`. + * This class represents the OData primitive type `Edm.Boolean`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `boolean`. @@ -66884,8 +66885,9 @@ declare module "sap/ui/model/odata/type/Byte" { import Metadata from "sap/ui/base/Metadata"; /** - * This class represents the OData primitive type - * `Edm.Byte`. + * This class represents the OData primitive type `Edm.Byte`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `number`. @@ -67185,7 +67187,7 @@ declare module "sap/ui/model/odata/type/Date" { /** * Constructor for an OData primitive type `Edm.Date`. * See: - * http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part3-csdl.html + * https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#_Toc38530338 */ constructor( /** @@ -67561,8 +67563,9 @@ declare module "sap/ui/model/odata/type/DateTimeOffset" { import ParseException from "sap/ui/model/ParseException"; /** - * This class represents the OData primitive type - * `Edm.DateTimeOffset`. + * This class represents the OData primitive type `Edm.DateTimeOffset`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In {@link sap.ui.model.odata.v2.ODataModel} this type is represented as a `Date` instance in local time. * In {@link sap.ui.model.odata.v4.ODataModel} this type is represented as a `string` like "1970-12-31T23:59:58Z". @@ -67901,8 +67904,9 @@ declare module "sap/ui/model/odata/type/Decimal" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.Decimal`. + * This class represents the OData primitive type `Edm.Decimal`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `string`. @@ -68087,8 +68091,9 @@ declare module "sap/ui/model/odata/type/Double" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.Double`. + * This class represents the OData primitive type `Edm.Double`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `number`. @@ -68231,8 +68236,9 @@ declare module "sap/ui/model/odata/type/Guid" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.Guid`. + * This class represents the OData primitive type `Edm.Guid`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `string`. @@ -68356,8 +68362,10 @@ declare module "sap/ui/model/odata/type/Int" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This is an abstract base class for integer-based - * OData primitive types like `Edm.Int16` or `Edm.Int32`. + * This is an abstract base class for integer-based OData primitive types like `Edm.Int16` or `Edm.Int32`, + * see + * type definitions for OData V4.01 or + * type definitions for OData V2. * * @since 1.27.0 */ @@ -68475,8 +68483,9 @@ declare module "sap/ui/model/odata/type/Int16" { import Metadata from "sap/ui/base/Metadata"; /** - * This class represents the OData primitive type - * `Edm.Int16`. + * This class represents the OData primitive type `Edm.Int16`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `number`. @@ -68566,8 +68575,9 @@ declare module "sap/ui/model/odata/type/Int32" { import Metadata from "sap/ui/base/Metadata"; /** - * This class represents the OData primitive type - * `Edm.Int32`. + * This class represents the OData primitive type `Edm.Int32`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `number`. @@ -68663,8 +68673,9 @@ declare module "sap/ui/model/odata/type/Int64" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.Int64`. + * This class represents the OData primitive type `Edm.Int64`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `string`. @@ -68806,8 +68817,8 @@ declare module "sap/ui/model/odata/type/ODataType" { import Metadata from "sap/ui/base/Metadata"; /** - * This class is an abstract base class for all OData primitive types (see {@link http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part3-csdl/odata-v4.0-errata02-os-part3-csdl-complete.html#_The_edm:Documentation_Element OData V4 Edm Types } - * and {@link http://www.odata.org/documentation/odata-version-2-0/overview#AbstractTypeSystem OData V2 Edm Types}). + * This class is an abstract base class for all OData primitive types (see {@link https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#_Toc38530338 OData V4.01 Edm Types } + * and {@link https://www.odata.org/documentation/odata-version-2-0/overview#AbstractTypeSystem OData V2 Edm Types}). * All subtypes implement the interface of {@link sap.ui.model.SimpleType}. That means they implement next * to the constructor: * - {@link sap.ui.model.Type#getName getName} @@ -69000,8 +69011,9 @@ declare module "sap/ui/model/odata/type/SByte" { import Metadata from "sap/ui/base/Metadata"; /** - * This class represents the OData primitive type - * `Edm.SByte`. + * This class represents the OData primitive type `Edm.SByte`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `number`. @@ -69096,8 +69108,9 @@ declare module "sap/ui/model/odata/type/Single" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.Single`. + * This class represents the OData primitive type `Edm.Single`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `number`. @@ -69239,7 +69252,7 @@ declare module "sap/ui/model/odata/type/Stream" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData V4 primitive type {@link http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part3-csdl/odata-v4.0-errata02-os-part3-csdl-complete.html#_The_edm:Documentation_Element `Edm.Stream`}. + * This class represents the OData V4 primitive type {@link https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#_Toc38530338 `Edm.Stream`}. * The values for stream properties do not appear in the entity payload. Instead, the values are read or * written through URLs. * @@ -69359,8 +69372,9 @@ declare module "sap/ui/model/odata/type/String" { import ValidateException from "sap/ui/model/ValidateException"; /** - * This class represents the OData primitive type - * `Edm.String`. + * This class represents the OData primitive type `Edm.String`, see + * type definition for OData V4.01 or + * type definition for OData V2. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type * is represented as a `string`. @@ -69675,7 +69689,7 @@ declare module "sap/ui/model/odata/type/TimeOfDay" { import ParseException from "sap/ui/model/ParseException"; /** - * This class represents the OData V4 primitive type {@link http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part3-csdl/odata-v4.0-errata02-os-part3-csdl-complete.html#_The_edm:Documentation_Element `Edm.TimeOfDay`}. + * This class represents the OData V4 primitive type {@link https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#_Toc38530338 `Edm.TimeOfDay`}. * In {@link sap.ui.model.odata.v4.ODataModel} this type is represented as a `string`. * * @since 1.37.0 @@ -76178,7 +76192,8 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ metadataUrlParams?: object; /** - * The version of the OData service. Supported values are "2.0", "4.0", and "4.01". + * The version of the OData service. Supported values are "2.0", "4.0", and "4.01". **Note:** "2.0" is deprecated + * since 1.143.0. We recommend migrating your service to OData V4. */ odataVersion?: string; /** @@ -76524,9 +76539,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" { * An array of navigation property names which are omitted from the main list request (since 1.137.0). Instead, * each of them is loaded in a separate request. This results in the main list becoming available faster, * while the separate properties are merged as soon as the data is received. Note that the separate properties - * must be single valued and part of the '$expand' system query option, either automatically via the "autoExpandSelect" - * model parameter (see {@link #constructor}) or manually. The `$$separate` parameter must not be combined - * with `$$aggregation`. + * must be single valued. If they are not part of the '$expand' system query option, either automatically + * via the "autoExpandSelect" model parameter (see {@link #constructor}) or manually, they are ignored. + * The `$$separate` parameter must not be combined with `$$aggregation`. */ $$separate?: string[]; /** diff --git a/types/openui5/sap.ui.dt.d.ts b/types/openui5/sap.ui.dt.d.ts index b9b521da11f749..65ab2838986ca9 100644 --- a/types/openui5/sap.ui.dt.d.ts +++ b/types/openui5/sap.ui.dt.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/dt/library" { export namespace designtime { diff --git a/types/openui5/sap.ui.fl.d.ts b/types/openui5/sap.ui.fl.d.ts index 7523632e93e44a..d7c99d683004f9 100644 --- a/types/openui5/sap.ui.fl.d.ts +++ b/types/openui5/sap.ui.fl.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/fl/library" {} @@ -712,7 +712,8 @@ declare module "sap/ui/fl/variants/VariantManagement" { mParameters?: VariantManagement$SelectEventParameters ): this; /** - * Gets the currently selected variant key. + * Gets the variant key that is currently selected in the VM control. Can be different to the actually selected + * variant in the state during a variant switch. * * * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned @@ -1514,8 +1515,6 @@ declare namespace sap { "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewDataSource": undefined; - "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewInbound": undefined; - "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewOutbound": undefined; "sap/ui/fl/apply/_internal/changes/descriptor/app/AddTechnicalAttributes": undefined; @@ -1546,8 +1545,6 @@ declare namespace sap { "sap/ui/fl/apply/_internal/changes/descriptor/ovp/DeleteCard": undefined; - "sap/ui/fl/apply/_internal/changes/descriptor/Preprocessor": undefined; - "sap/ui/fl/apply/_internal/changes/descriptor/Registration": undefined; "sap/ui/fl/apply/_internal/changes/descriptor/RegistrationBuild": undefined; diff --git a/types/openui5/sap.ui.integration.d.ts b/types/openui5/sap.ui.integration.d.ts index 67196ea339c476..25bda57a627af5 100644 --- a/types/openui5/sap.ui.integration.d.ts +++ b/types/openui5/sap.ui.integration.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/integration/library" { import { URI } from "sap/ui/core/library"; @@ -2314,7 +2314,9 @@ declare module "sap/ui/integration/widgets/Card" { /** * Facade of the {@link sap.ui.integration.widgets.Card} control. * - * @experimental As of version 1.79. + * This facade contains methods accessible within the card extension. The available methods represent a + * limited subset of all card methods, since not all card methods function as expected when called from + * within the extension. */ export interface CardFacade { __implements__sap_ui_integration_widgets_CardFacade: boolean; @@ -2334,6 +2336,27 @@ declare module "sap/ui/integration/widgets/Card" { */ oActionDefinition: ActionDefinition ): this; + /** + * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}. + * + * @since 1.85 + * @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API + * changes may be done before its official public release. Use at your own discretion. + * + * @returns Reference to `this` in order to allow method chaining + */ + destroyActionDefinitions(): this; + /** + * Gets content of aggregation {@link #getActionDefinitions actionDefinitions}. + * + * Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation + * is destroyed when the property `manifest` changes. + * + * @since 1.85 + * @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API + * changes may be done before its official public release. Use at your own discretion. + */ + getActionDefinitions(): ActionDefinition[]; /** * Gets current value of property {@link #getBaseUrl baseUrl}. * @@ -2369,6 +2392,11 @@ declare module "sap/ui/integration/widgets/Card" { * @returns Object containing parameters in format `{parameterKey: parameterValue}`. */ getCombinedParameters(): Record; + /** + * @deprecated As of version 1.143. Do not access the card dom reference, as this is not supported in a + * mobile native environment. + */ + getDomRef(): void; /** * Returns a value from the Manifest based on the specified path. * @@ -2384,15 +2412,19 @@ declare module "sap/ui/integration/widgets/Card" { */ sPath: string ): any; + /** + * @deprecated As of version 1.143. Avoid accessing the models directly, use the binding syntax instead. + */ + getModel(): void; /** * Gets current value of property {@link #getParameters parameters}. * - * Overrides the default values of the parameters, which are defined in the manifest. The value is an object - * containing parameters in format `{parameterKey: parameterValue}`. + * Overrides the default values of the parameters, which are defined in the manifest. The returned value + * is an object containing parameters in format `{parameterKey: parameterValue}`. * - * @experimental As of version 1.65. This property might be changed in future. + * @deprecated As of version 1.143. Use `getCombinedParameters()` instead. * - * @returns Value of property `parameters` + * @returns Value of property parameters */ getParameters(): object; /** @@ -2584,6 +2616,11 @@ declare module "sap/ui/integration/widgets/Card" { */ sKey: string ): Promise; + /** + * @deprecated As of version 1.143. Use `hide()` to hide a card opened by `showCard()`. The card facade + * does not provide methods for showing or hiding the main card itself. + */ + setVisible(): void; /** * Show blocking message in the card's content area. Should be used after the `manifestApplied` event or * after the `cardReady` lifecycle hook in Component cards and Extensions. @@ -3923,7 +3960,6 @@ declare module "sap/ui/integration/Host" { * Examples may include, but are not limited to options like: share a card, remove a card. * * @since 1.75 - * @experimental As of version 1.75. */ export default class Host extends UI5Element { /** @@ -4484,6 +4520,7 @@ declare module "sap/ui/integration/Host" { * Editor. * * @since 1.83 + * @experimental As of version 1.143. * * @returns A promise which contains the context structure. */ @@ -4500,6 +4537,7 @@ declare module "sap/ui/integration/Host" { * userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } } * * @since 1.83 + * @experimental As of version 1.143. * * @returns A promise which resolves with the value of this context. */ @@ -4612,8 +4650,6 @@ declare module "sap/ui/integration/Host" { } /** * Describes the settings that can be provided to the Host constructor. - * - * @experimental As of version 1.75. */ export interface $HostSettings extends $ElementSettings { /** diff --git a/types/openui5/sap.ui.layout.d.ts b/types/openui5/sap.ui.layout.d.ts index 67ee8e0a4dd3c1..ce6fe9a3636c63 100644 --- a/types/openui5/sap.ui.layout.d.ts +++ b/types/openui5/sap.ui.layout.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/layout/library" { import Control from "sap/ui/core/Control"; @@ -445,8 +445,9 @@ declare module "sap/ui/layout/library" { ResponsiveLayout = "ResponsiveLayout", } /** - * An `int` type that defines how many cells a control inside of a column of a `Form` control using the - * `ColumnLayout` control as layout can use. + * An `int` type that defines how many cells a control inside of a column of a {@link sap.ui.layout.form.Form Form } + * control using the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control as {@link sap.ui.layout.form.FormE#setLayout layout } + * can use. * * Allowed values are numbers from 1 to 12 and -1. -1 means the value is calculated. * @@ -455,8 +456,9 @@ declare module "sap/ui/layout/library" { type ColumnCells = int; /** - * An `int` type that defines how many columns a `Form` control using the `ColumnLayout` as layout can have - * if it has large size + * An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the + * {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout } + * can have if it has large size * * Allowed values are numbers from 1 to 4. **Note:** In versions lower than 1.122 only 3 columns are allowed. * @@ -465,8 +467,9 @@ declare module "sap/ui/layout/library" { type ColumnsL = int; /** - * An `int` type that defines how many columns a `Form` control using the `ColumnLayout` as layout can have - * if it has medium size + * An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the + * {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout } + * can have if it has medium size * * Allowed values are numbers from 1 to 3. **Note:** In versions lower than 1.122 only 2 columns are allowed. * @@ -475,8 +478,9 @@ declare module "sap/ui/layout/library" { type ColumnsM = int; /** - * An `int` type that defines how many columns a `Form` control using the `ColumnLayout` as layout can have - * if it has extra-large size + * An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the + * {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout } + * can have if it has extra-large size * * Allowed values are numbers from 1 to 6. **Note:** In versions lower than 1.89 only 4 columns are allowed. * @@ -485,8 +489,9 @@ declare module "sap/ui/layout/library" { type ColumnsXL = int; /** - * An `int` type that defines how many cells beside the controls inside of a column of a `Form` control - * using the `ColumnLayout` control as layout are empty. + * An `int` type that defines how many cells beside the controls inside of a column of a {@link sap.ui.layout.form.Form Form } + * control using the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control as {@link sap.ui.layout.form.FormE#setLayout layout } + * are empty. * * Allowed values are numbers from 0 to 11. * @@ -5816,10 +5821,12 @@ declare module "sap/ui/layout/form/ColumnContainerData" { import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** - * The `ColumnLayout`-specific layout data for the `FormContainer` element. + * The {@link sap.ui.layout.form.ColumnLayout ColumnLayout}-specific layout data for the {@link sap.ui.layout.form.FormContainer FormContainer } + * element. * - * Depending on its size, the `Form` control is divided into 1, 2, 3 or 4 columns by the `ColumnLayout` - * control. Using `ColumnContainerData`, the size of the `FormContainer` element can be influenced. + * Depending on its size, the {@link sap.ui.layout.form.Form Form} control is divided into 1, 2, 3 or 4 + * columns by the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control. Using `ColumnContainerData`, + * the size of the {@link sap.ui.layout.form.FormContainer FormContainer} element can be influenced. * * @since 1.56.0 */ @@ -5889,7 +5896,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" { /** * Gets current value of property {@link #getColumnsL columnsL}. * - * Number of columns the `FormContainer` element uses if the `Form` control has large size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has large size. * * The number of columns for large size must not be smaller than the number of columns for medium size. * @@ -5902,7 +5910,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" { /** * Gets current value of property {@link #getColumnsM columnsM}. * - * Number of columns the `FormContainer` element uses if the `Form` control has medium size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has medium size. * * Default value is `1`. * @@ -5913,7 +5922,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" { /** * Gets current value of property {@link #getColumnsXL columnsXL}. * - * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has extra-large size. * * The number of columns for extra-large size must not be smaller than the number of columns for large size. * @@ -5926,7 +5936,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" { /** * Sets a new value for property {@link #getColumnsL columnsL}. * - * Number of columns the `FormContainer` element uses if the `Form` control has large size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has large size. * * The number of columns for large size must not be smaller than the number of columns for medium size. * @@ -5946,7 +5957,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" { /** * Sets a new value for property {@link #getColumnsM columnsM}. * - * Number of columns the `FormContainer` element uses if the `Form` control has medium size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -5964,7 +5976,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" { /** * Sets a new value for property {@link #getColumnsXL columnsXL}. * - * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has extra-large size. * * The number of columns for extra-large size must not be smaller than the number of columns for large size. * @@ -5987,21 +6000,24 @@ declare module "sap/ui/layout/form/ColumnContainerData" { */ export interface $ColumnContainerDataSettings extends $LayoutDataSettings { /** - * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has extra-large size. * * The number of columns for extra-large size must not be smaller than the number of columns for large size. */ columnsXL?: form.ColumnsXL | PropertyBindingInfo | `{${string}}`; /** - * Number of columns the `FormContainer` element uses if the `Form` control has large size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has large size. * * The number of columns for large size must not be smaller than the number of columns for medium size. */ columnsL?: form.ColumnsL | PropertyBindingInfo | `{${string}}`; /** - * Number of columns the `FormContainer` element uses if the `Form` control has medium size. + * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form } + * control has medium size. */ columnsM?: form.ColumnsM | PropertyBindingInfo | `{${string}}`; } @@ -6020,10 +6036,12 @@ declare module "sap/ui/layout/form/ColumnElementData" { import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** - * The `ColumnLayout`-specific layout data for the `FormElement` content fields. + * The {@link sap.ui.layout.form.ColumnLayout ColumnLayout}-specific layout data for the {@link sap.ui.layout.form.Form Form } + * content fields. * - * One `FormElement` element contains 12 cells and has two sizes, small and large. Using `ColumnElementData`, - * the default calculation of the cells used for a field or label can be overwritten. + * One {@link sap.ui.layout.form.FormElement FormElement} element contains 12 cells and has two sizes, small + * and large. Using `ColumnElementData`, the default calculation of the cells used for a field or label + * can be overwritten. * * @since 1.56.0 */ @@ -6093,10 +6111,10 @@ declare module "sap/ui/layout/form/ColumnElementData" { /** * Gets current value of property {@link #getCellsLarge cellsLarge}. * - * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields - * per default. + * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is + * large. The label is then beside the fields per default. * - * If set to `12`, the full size of the `FormElement` element is used. + * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used. * * Default value is `8`. * @@ -6107,10 +6125,10 @@ declare module "sap/ui/layout/form/ColumnElementData" { /** * Gets current value of property {@link #getCellsSmall cellsSmall}. * - * Number of cells used by a field if the `FormElement` element is small. The label is then above the fields - * per default. + * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is + * small. The label is then above the fields per default. * - * If set to `12`, the full size of the `FormElement` is used. + * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used. * * Default value is `12`. * @@ -6121,10 +6139,10 @@ declare module "sap/ui/layout/form/ColumnElementData" { /** * Sets a new value for property {@link #getCellsLarge cellsLarge}. * - * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields - * per default. + * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is + * large. The label is then beside the fields per default. * - * If set to `12`, the full size of the `FormElement` element is used. + * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -6142,10 +6160,10 @@ declare module "sap/ui/layout/form/ColumnElementData" { /** * Sets a new value for property {@link #getCellsSmall cellsSmall}. * - * Number of cells used by a field if the `FormElement` element is small. The label is then above the fields - * per default. + * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is + * small. The label is then above the fields per default. * - * If set to `12`, the full size of the `FormElement` is used. + * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -6166,18 +6184,18 @@ declare module "sap/ui/layout/form/ColumnElementData" { */ export interface $ColumnElementDataSettings extends $LayoutDataSettings { /** - * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields - * per default. + * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is + * large. The label is then beside the fields per default. * - * If set to `12`, the full size of the `FormElement` element is used. + * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used. */ cellsLarge?: form.ColumnCells | PropertyBindingInfo | `{${string}}`; /** - * Number of cells used by a field if the `FormElement` element is small. The label is then above the fields - * per default. + * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is + * small. The label is then above the fields per default. * - * If set to `12`, the full size of the `FormElement` is used. + * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used. */ cellsSmall?: form.ColumnCells | PropertyBindingInfo | `{${string}}`; } @@ -6223,7 +6241,7 @@ declare module "sap/ui/layout/form/ColumnLayout" { * of the used column. If there is enough space, the labels are beside the fields, otherwise above the fields. * * The default size of a content control of a {@link sap.ui.layout.form.FormElement FormElement} element - * can be overwritten using {@link sap.ui.layout.form.ColumnElementData ColumnElementData} as `LayoutData`. + * can be overwritten using {@link sap.ui.layout.form.ColumnElementData ColumnElementData} as {@link sap.ui.core.Element#setLayoutData LayoutData}. * If one control assigned to a {@link sap.ui.layout.form.FormElement FormElement} element has {@link sap.ui.layout.form.ColumnElementData ColumnElementData } * set, the size calculation of the other controls assigned to the {@link sap.ui.layout.form.FormElement FormElement } * element might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnElementData ColumnElementData } @@ -6234,7 +6252,7 @@ declare module "sap/ui/layout/form/ColumnLayout" { * results than might be expected. * * **Note:** This control cannot be used stand-alone, it just renders a {@link sap.ui.layout.form.Form Form } - * control, so it must be assigned to a {@link sap.ui.layout.form.Form Form} control using the `layout` + * control, so it must be assigned to a {@link sap.ui.layout.form.Form Form} control using the {@link sap.ui.layout.form.Form#setLayout layout } * aggregation. * * @since 1.56.0 diff --git a/types/openui5/sap.ui.mdc.d.ts b/types/openui5/sap.ui.mdc.d.ts index fd79eea0680b34..c5d47a7faaf779 100644 --- a/types/openui5/sap.ui.mdc.d.ts +++ b/types/openui5/sap.ui.mdc.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/mdc/AggregationBaseDelegate" { import BaseDelegate from "sap/ui/mdc/BaseDelegate"; @@ -3788,6 +3788,20 @@ declare module "sap/ui/mdc/library" { >; }; + /** + * Interface for subclasses of {@link sap.m.OverflowToolbarLayoutData} that position actions within the + * toolbar and configure the overflow menu. Classes implementing this interface must provide a `position` + * property, which uses an enumeration to define the relative order of the actions. The sequence of the + * enumeration values determines the placement of the actions. Enumeration values can be organized into + * groups by using the same prefix ending with the `Actions` keyword, such as `ClipboardActionsCopy` and + * `ClipboardActionsPaste`. + * + * @since 1.143 + */ + export interface IActionLayoutData { + __implements__sap_ui_mdc_IActionLayoutData: boolean; + } + /** * Interface for controls or entities which can serve as filters in the `sap.ui.mdc.Table` & `sap.ui.mdc.Chart`. * @@ -8907,6 +8921,60 @@ declare module "sap/ui/mdc/enums/RequestShowContainerReason" { export default RequestShowContainerReason; } +declare module "sap/ui/mdc/enums/TableActionPosition" { + /** + * Defines the supported positions for table-relevant actions within the table toolbar, in accordance with + * the {@link https://www.sap.com/design-system/fiori-design-web/ui-elements/table-bar/ SAP Design System}. + * + * @since 1.143 + */ + enum TableActionPosition { + /** + * Extension point for actions displayed after all table-relevant actions. These actions allow applications + * to add additional functionality, such as Pagination, Refresh. + */ + EndActions = "EndActions", + /** + * Extension point for the export actions at the start of the group. These actions convert the content of + * the table into an external format, such as Excel, PDF, Print. + */ + ExportActions = "ExportActions", + /** + * Extension point for the modification actions at the start of the group. These actions modify the structure + * or content of the table, such as cut, copy, paste, reorder. + */ + ModificationActions = "ModificationActions", + /** + * Extension point for the modification actions at the end of the group. These actions modify the structure + * or content of the table, such as cut, copy, paste, reorder. + */ + ModificationActionsEnd = "ModificationActionsEnd", + /** + * Extension point for the personalization actions at the start of the group. These actions change the arrangement + * or personalization of the table at the item level, such as Expand/Collapse All Rows, Show/Hide Details, + * Table Settings. + */ + PersonalizationActions = "PersonalizationActions", + /** + * Extension point for the personalization actions inserted after the first and before the second group + * of predefined actions. These actions change the arrangement or personalization of the table on an item + * level, such as Expand/Collapse Node, Show/Hide Details, Table Settings. + */ + PersonalizationActionsMiddle = "PersonalizationActionsMiddle", + /** + * Extension point for the share actions at the start of the group. These actions allow users to share table + * content with another application or with the homepage as a tile, such as Send as Email, Save as Tile. + */ + ShareActions = "ShareActions", + /** + * Extension point for the view actions at the start of the group. These actions change the representation + * of the entire table, such as View Switch, Fullscreen. + */ + ViewActions = "ViewActions", + } + export default TableActionPosition; +} + declare module "sap/ui/mdc/enums/TableGrowingMode" { /** * Growing mode of the table. @@ -8962,6 +9030,26 @@ declare module "sap/ui/mdc/enums/TableP13nMode" { export default TableP13nMode; } +declare module "sap/ui/mdc/enums/TablePopinDisplay" { + /** + * Pop-in display mode of the table. + * + * @since 1.143 + */ + enum TablePopinDisplay { + /** + * The header is displayed in the first line, and the cell content is displayed in the next line. + */ + Block = "Block", + /** + * The cell content is displayed next to the header in the same line. **Note:** If there is not enough space + * for the cell content, then it is displayed in the next line. + */ + Inline = "Inline", + } + export default TablePopinDisplay; +} + declare module "sap/ui/mdc/enums/TableRowActionType" { /** * Type of a table row action. @@ -9120,12 +9208,15 @@ declare module "sap/ui/mdc/Field" { * * * - In display mode, usually a {@link sap.m.Text Text} control is rendered. - * - If `multipleLines` is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered. - * - If `fieldInfo` is set and it is configured to be triggerable, a {@link sap.m.Link Link} control is - * rendered. The `multipleLines` property is forwarded to the `wrapping` property of the {@link sap.m.Link Link } + * - If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, an {@link sap.m.ExpandableText ExpandableText } + * control is rendered. + * - If {@link sap.ui.mdc.field.FieldBase#getFieldInfo fieldInfo} is set and it is configured to be triggerable, + * a {@link sap.m.Link Link} control is rendered. The {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines } + * property is forwarded to the {@link sap.m.Link#setWrapping wrapping} property of the {@link sap.m.Link Link } * control. * - In edit mode, usually an {@link sap.m.Input Input} control is rendered. - * - If `multipleLines` is set, a {@link sap.m.TextArea TextArea} control is rendered. + * - If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, a {@link sap.m.TextArea TextArea } + * control is rendered. * - If a date type is used, a {@link sap.m.DatePicker DatePicker} control is rendered. * - If a date/time type is used, a {@link sap.m.DateTimePicker DateTimePicker} control is rendered. * - If a time type is used, a {@link sap.m.TimePicker TimePicker} control is rendered. @@ -9215,7 +9306,7 @@ declare module "sap/ui/mdc/Field" { * 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.ui.mdc.Field` itself. * - * This event is fired when the `value` property of the field is changed by user interaction. + * This event is fired when the {@link #getValue value} property of the field is changed by user interaction. * * **Note** This event is only triggered if the used content control has a change event. * @@ -9243,7 +9334,7 @@ declare module "sap/ui/mdc/Field" { * 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.ui.mdc.Field` itself. * - * This event is fired when the `value` property of the field is changed by user interaction. + * This event is fired when the {@link #getValue value} property of the field is changed by user interaction. * * **Note** This event is only triggered if the used content control has a change event. * @@ -9603,7 +9694,7 @@ declare module "sap/ui/mdc/Field" { additionalValue?: any | PropertyBindingInfo | `{${string}}`; /** - * This event is fired when the `value` property of the field is changed by user interaction. + * This event is fired when the {@link #getValue value} property of the field is changed by user interaction. * * **Note** This event is only triggered if the used content control has a change event. */ @@ -9617,7 +9708,8 @@ declare module "sap/ui/mdc/Field" { /** * The new value of the `Field`. * - * If a `ValueHelp` is assigned to the `Field`, the `value` is used as key for the `ValueHelp` items. + * If a {@link sap.ui.mdc.field.FieldBase#getValueHelp ValueHelp} is assigned to the `Field`, the `value` + * is used as key for the {@link sap.ui.mdc.field.FieldBase#getValueHelp ValueHelp} items. */ value?: string; @@ -10334,7 +10426,10 @@ declare module "sap/ui/mdc/field/FieldBase" { CSSSize, } from "sap/ui/core/library"; - import { IOverflowToolbarContent } from "sap/m/library"; + import { + IOverflowToolbarContent, + IToolbarInteractiveControl, + } from "sap/m/library"; import Control1 from "sap/ui/core/Control"; @@ -10372,12 +10467,14 @@ declare module "sap/ui/mdc/field/FieldBase" { IFormContent, ISemanticFormContent, IOverflowToolbarContent, - ILabelable + ILabelable, + IToolbarInteractiveControl { __implements__sap_ui_core_IFormContent: boolean; __implements__sap_ui_core_ISemanticFormContent: boolean; __implements__sap_m_IOverflowToolbarContent: boolean; __implements__sap_ui_core_ILabelable: boolean; + __implements__sap_m_IToolbarInteractiveControl: boolean; /** * Constructor for a new `FieldBase`. * @@ -10460,7 +10557,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * This event is fired when the value of the field is changed, for example, each time a key is pressed. * - * **Note** This event is only triggered if the used content control has a `liveChange` event. + * **Note:** This event is only triggered if the used content control has a `liveChange` event. * * * @returns Reference to `this` in order to allow method chaining @@ -10488,7 +10585,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * This event is fired when the value of the field is changed, for example, each time a key is pressed. * - * **Note** This event is only triggered if the used content control has a `liveChange` event. + * **Note:** This event is only triggered if the used content control has a `liveChange` event. * * * @returns Reference to `this` in order to allow method chaining @@ -10559,7 +10656,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * This event is fired when the user presses Enter. It allows the application to implement some * submit logic. * - * **Note** This event is only triggered if the field is editable. + * **Note:** This event is only triggered if the field is editable. * * @since 1.82.0 * @@ -10589,7 +10686,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * This event is fired when the user presses Enter. It allows the application to implement some * submit logic. * - * **Note** This event is only triggered if the field is editable. + * **Note:** This event is only triggered if the field is editable. * * @since 1.82.0 * @@ -10642,12 +10739,13 @@ declare module "sap/ui/mdc/field/FieldBase" { vValue: any ): boolean; /** - * Assigns a `Label` control to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.MultiValueField MultiValueField}, + * Assigns a {@link sap.m.Label Label} control to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.MultiValueField MultiValueField}, * or {@link sap.ui.mdc.FilterField FilterField} controls. * * The text of the label is taken from the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.MultiValueField MultiValueField}, - * or {@link sap.ui.mdc.FilterField FilterField} controls. The `labelFor` association is set to the {@link sap.ui.mdc.Field Field}, - * {@link sap.ui.mdc.MultiValueField MultiValueField}, or {@link sap.ui.mdc.FilterField FilterField} control. + * or {@link sap.ui.mdc.FilterField FilterField} controls. The {@link sap.m.Label#setLabelFor labelFor } + * association is set to the {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.MultiValueField MultiValueField}, + * or {@link sap.ui.mdc.FilterField FilterField} control. * * @since 1.62.0 * @@ -10841,10 +10939,11 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Returns the configuration for the additional data type. * - * For a {@link sap.ui.mdc.Field Field}, the data type is determined from the binding of the `additionalValue`. + * For a {@link sap.ui.mdc.Field Field}, the data type is determined from the binding of the {@link sap.ui.mdc.Field#getAdditionalValue additionalValue}. * For a {@link sap.ui.mdc.MultiValueField MultiValueField}, the data type is determined from the binding - * of the `description` of an item. For a {@link sap.ui.mdc.FilterField FilterField}, the data type is provided - * via the `additionalDataType` property. + * of the {@link sap.ui.mdc.field.MultiValueFieldItem#getDescription description} of an item. For a {@link sap.ui.mdc.FilterField FilterField}, + * the data type is provided via the {@link sap.ui.mdc.FilterField#getAdditionalDataType additionalDataType } + * property. * * @since 1.118.0 * @ui5-protected Do not call from applications (only from related classes in the framework) @@ -10865,7 +10964,8 @@ declare module "sap/ui/mdc/field/FieldBase" { */ getBaseType(): BaseType; /** - * Creates parameter for a `ParseError`, `ValidationError` or `ValidationSuccess` event based on the corresponding + * Creates parameter for a {@link sap.ui.base.ManagedObject#event:ParseError ParseError}, {@link sap.ui.base.ManagedObject#event:ValidationError ValidationError } + * or {@link sap.ui.base.ManagedObject#event:ValidationSuccess ValidationSuccess} event based on the corresponding * event fired on the inner control. * * The basic implementation just adds the element and error information. The `property` and `type` information @@ -10891,9 +10991,9 @@ declare module "sap/ui/mdc/field/FieldBase" { * These should be bound to a {@link sap.ui.mdc.FilterBar FilterBar} using the corresponding `propertyPath`. * * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property is used - * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link @link sap.ui.mdc.FilterBar FilterBar}. - * If this property is not explicitly configured, the {@link @link sap.ui.mdc.FilterBar FilterBar} sets - * a default binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar } + * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link sap.ui.mdc.FilterBar FilterBar}. + * If this property is not explicitly configured, the {@link sap.ui.mdc.FilterBar FilterBar} sets a default + * binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar } * control, the binding looks like this: * `conditions="{$filters>/conditions/propertyPath}"` with the following data: * - `$filters` as the name of the condition model @@ -10913,9 +11013,10 @@ declare module "sap/ui/mdc/field/FieldBase" { * * Optional content that can be rendered. * - * Per default, depending on `editMode`, `multipleLines` and the used data type, a content control is rendered. - * For simple string types, a {@link sap.m.Text Text} control is rendered in display mode and a {@link sap.m.Input Input } - * control in edit mode. If a control is assigned in the `content` aggregation, this will be rendered instead. + * Per default, depending on {@link #getEditMode editMode}, {@link #getMultipleLines multipleLines} and + * the used data type, a content control is rendered. For simple string types, a {@link sap.m.Text Text } + * control is rendered in display mode and a {@link sap.m.Input Input} control in edit mode. If a control + * is assigned in the `content` aggregation, this will be rendered instead. * * **Note:** Bind the value-holding property of the control to `'$field>/conditions'` using {@link sap.ui.mdc.field.ConditionsType ConditionsType } * as type. @@ -10932,11 +11033,11 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Gets content of aggregation {@link #getContentDisplay contentDisplay}. * - * Optional content to be rendered if the `editMode` property is set to `Display`. + * Optional content to be rendered if the {@link #getEditMode editMode} property is set to `Display`. * - * Per default, depending on `multipleLines` and the used data type, a content control is rendered in display - * mode. For simple string types, a {@link sap.m.Text Text} control is rendered in display mode. If a control - * is assigned in the `contentDisplay` aggregation, this will be rendered instead. + * Per default, depending on {@link #getMultipleLines multipleLines} and the used data type, a content control + * is rendered in display mode. For simple string types, a {@link sap.m.Text Text} control is rendered in + * display mode. If a control is assigned in the `contentDisplay` aggregation, this will be rendered instead. * * **Note:** If a control is assigned to the `content` aggregation, this one is ignored. * @@ -10957,11 +11058,11 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Gets content of aggregation {@link #getContentEdit contentEdit}. * - * Optional content to be rendered if the `editMode` property is not set to `Display`. + * Optional content to be rendered if the {@link #getEditMode editMode} property is not set to `Display`. * - * Per default, depending on `multipleLines` and the used data type, a content control is rendered in edit - * mode. For simple string types, an {@link sap.m.Input Input} control is rendered in edit mode. If a control - * is assigned in the `contentEdit` aggregation, this will be rendered instead. + * Per default, depending on {@link #getMultipleLines multipleLines} and the used data type, a content control + * is rendered in edit mode. For simple string types, an {@link sap.m.Input Input} control is rendered in + * edit mode. If a control is assigned in the `contentEdit` aggregation, this will be rendered instead. * * **Note:** If a control is assigned to the `content` aggregation, this one is ignored. * @@ -11004,7 +11105,7 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Gets current value of property {@link #getDataTypeConstraints dataTypeConstraints}. * - * The constraints of the type specified in `dataType`. + * The constraints of the type specified in {@link #setDataType dataType}. * * * @returns Value of property `dataTypeConstraints` @@ -11013,7 +11114,7 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Gets current value of property {@link #getDataTypeFormatOptions dataTypeFormatOptions}. * - * The format options of the type specified in `dataType`. + * The format options of the type specified in {@link #setDataType dataType}. * * * @returns Value of property `dataTypeFormatOptions` @@ -11096,7 +11197,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * @since 1.126.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * - * @returns returns a promise waiting for ongoing formatting + * @returns returns a `Promise` waiting for ongoing formatting */ getFormattingPromise(): undefined | Promise; /** @@ -11121,7 +11222,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * The default value of -1 indicates that an unlimited number of conditions can be defined. * - * **Note** If the data type used doesn't support multiple conditions, an error is thrown. + * **Note:** If the data type used doesn't support multiple conditions, an error is thrown. * * Default value is `-1`. * @@ -11138,7 +11239,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * This property is only used for single-value fields. * - * **Note** If the data type used doesn't support multiple lines, an error is thrown. + * **Note:** If the data type used doesn't support multiple lines, an error is thrown. * * Default value is `false`. * @@ -11152,7 +11253,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * @ui5-protected Do not call from applications (only from related classes in the framework) * - * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface. + * @returns Configuration information for the {@link sap.m.IOverflowToolbarContent} interface. */ getOverflowToolbarConfig(): object; /** @@ -11198,10 +11299,10 @@ declare module "sap/ui/mdc/field/FieldBase" { * * If set, an empty `Field` renders an empty indicator in display mode. * - * This property only takes effect if `editMode` is set to `Display`. + * This property only takes effect if {@link #setEditMode editMode} is set to `Display`. * - * **Note** Empty means the `Field` holds no value. If an empty string is a valid value, the `Field` might - * show nothing, depending on the `display` settings and assigned description or `ValueHelp`. + * **Note:** Empty means the `Field` holds no value. If an empty string is a valid value, the `Field` might + * show nothing, depending on the {@link #setDisplay display} settings and assigned description or {@link #setValueHelp ValueHelp}. * * Default value is `false`. * @@ -11267,8 +11368,8 @@ declare module "sap/ui/mdc/field/FieldBase" { * Visualizes the validation state of the control, for example, `Error`, `Warning` or `Success`. * * **Note:** The visualization of the `ValueState` property is handled by the inner rendered control. If - * a control is set (using `content`, `contentEdit`, or `contentDisplay`), this control needs to support - * the `valueState` behavior, otherwise `valueState` is not visualized. + * a control is set (using {@link #setContent content}, {@link #setContentEdit contentEdit}, or {@link #setContentDisplay contentDisplay}), + * this control needs to support the `valueState` behavior, otherwise `valueState` is not visualized. * * Default value is `None`. * @@ -11277,7 +11378,7 @@ declare module "sap/ui/mdc/field/FieldBase" { */ getValueState(): ValueState; /** - * Gets the ValueState for content controls + * Gets the `ValueState` for content controls * * @since 1.138.0 * @ui5-protected Do not call from applications (only from related classes in the framework) @@ -11310,7 +11411,7 @@ declare module "sap/ui/mdc/field/FieldBase" { */ getWidth(): CSSSize; /** - * Handler of the `ModelContextChange` event. + * Handler of the {@link sap.ui.base.ManagedObject#event:modelContextChange modelContextChange} event. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ @@ -11332,12 +11433,12 @@ declare module "sap/ui/mdc/field/FieldBase" { * Returns the user interaction state of the control. * * If the user starts typing or navigates via arrow keys in a value help, the shown value might be updated. - * But as long as the user has not left the field or pressed the Enter key, the current user input will - * not be validated or updated or an event fired. + * But as long as the user has not left the field or pressed the Enter key, the current user + * input will not be validated or updated or an event fired. * * As long as the user is interacting with the field, this function returns `true`. If the user interaction - * has been completed because the user has left the field, pressed the Enter key, or chosen a value from - * the value help, the function returns `false`. + * has been completed because the user has left the field, pressed the Enter key, or chosen a + * value from the value help, the function returns `false`. * * @since 1.117.0 * @ui5-protected Do not call from applications (only from related classes in the framework) @@ -11373,8 +11474,8 @@ declare module "sap/ui/mdc/field/FieldBase" { isFieldDestroyed(): boolean; /** * Returns whether the given property value is initial and has not been explicitly set or no binding exist. - * Even after setting the default value or setting null/undefined (which also causes the default value to - * be set), the property is no longer initial. A property can be reset to initial state by calling `resetProperty(sPropertyName)`. + * Even after setting the default value or setting `null`/`undefined` (which also causes the default value + * to be set), the property is no longer initial. A property can be reset to initial state by calling `{@link sap.ui.base.ManagedObject#resetProperty resetProperty}(sPropertyName)`. * * @ui5-protected Do not call from applications (only from related classes in the framework) * @@ -11448,12 +11549,13 @@ declare module "sap/ui/mdc/field/FieldBase" { */ resetInvalidInput( /** - * If set to `true` the `ValueState` and `ValueStateText` is removed + * If set to `true` the {@link #getValueState ValueState} and {@link #getValueStateText ValueStateText } + * is removed */ bRemoveUIMessage: boolean ): void; /** - * Resets the ValueState for content controls + * Resets the `ValueState` for content controls * * @since 1.138.0 * @ui5-protected Do not call from applications (only from related classes in the framework) @@ -11467,9 +11569,9 @@ declare module "sap/ui/mdc/field/FieldBase" { * These should be bound to a {@link sap.ui.mdc.FilterBar FilterBar} using the corresponding `propertyPath`. * * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property is used - * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link @link sap.ui.mdc.FilterBar FilterBar}. - * If this property is not explicitly configured, the {@link @link sap.ui.mdc.FilterBar FilterBar} sets - * a default binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar } + * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link sap.ui.mdc.FilterBar FilterBar}. + * If this property is not explicitly configured, the {@link sap.ui.mdc.FilterBar FilterBar} sets a default + * binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar } * control, the binding looks like this: * `conditions="{$filters>/conditions/propertyPath}"` with the following data: * - `$filters` as the name of the condition model @@ -11553,7 +11655,7 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Sets a new value for property {@link #getDataTypeConstraints dataTypeConstraints}. * - * The constraints of the type specified in `dataType`. + * The constraints of the type specified in {@link #setDataType dataType}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -11569,7 +11671,7 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Sets a new value for property {@link #getDataTypeFormatOptions dataTypeFormatOptions}. * - * The format options of the type specified in `dataType`. + * The format options of the type specified in {@link #setDataType dataType}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -11704,7 +11806,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * The default value of -1 indicates that an unlimited number of conditions can be defined. * - * **Note** If the data type used doesn't support multiple conditions, an error is thrown. + * **Note:** If the data type used doesn't support multiple conditions, an error is thrown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -11728,7 +11830,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * This property is only used for single-value fields. * - * **Note** If the data type used doesn't support multiple lines, an error is thrown. + * **Note:** If the data type used doesn't support multiple lines, an error is thrown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -11787,10 +11889,10 @@ declare module "sap/ui/mdc/field/FieldBase" { * * If set, an empty `Field` renders an empty indicator in display mode. * - * This property only takes effect if `editMode` is set to `Display`. + * This property only takes effect if {@link #setEditMode editMode} is set to `Display`. * - * **Note** Empty means the `Field` holds no value. If an empty string is a valid value, the `Field` might - * show nothing, depending on the `display` settings and assigned description or `ValueHelp`. + * **Note:** Empty means the `Field` holds no value. If an empty string is a valid value, the `Field` might + * show nothing, depending on the {@link #setDisplay display} settings and assigned description or {@link #setValueHelp ValueHelp}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -11865,8 +11967,8 @@ declare module "sap/ui/mdc/field/FieldBase" { * Visualizes the validation state of the control, for example, `Error`, `Warning` or `Success`. * * **Note:** The visualization of the `ValueState` property is handled by the inner rendered control. If - * a control is set (using `content`, `contentEdit`, or `contentDisplay`), this control needs to support - * the `valueState` behavior, otherwise `valueState` is not visualized. + * a control is set (using {@link #setContent content}, {@link #setContentEdit contentEdit}, or {@link #setContentDisplay contentDisplay}), + * this control needs to support the `valueState` behavior, otherwise `valueState` is not visualized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -11882,7 +11984,7 @@ declare module "sap/ui/mdc/field/FieldBase" { sValueState?: ValueState | keyof typeof ValueState ): this; /** - * Sets the ValueState for content controls + * Sets the `ValueState` for content controls * * @since 1.138.0 * @ui5-protected Do not call from applications (only from related classes in the framework) @@ -11935,7 +12037,8 @@ declare module "sap/ui/mdc/field/FieldBase" { sWidth?: CSSSize ): this; /** - * Checks if a condition update needs to fire a `ValidationSuccess` event. + * Checks if a condition update needs to fire a {@link sap.ui.base.ManagedObject#event:ValidationSuccess ValidationSuccess } + * event. * * This is required in {@link sap.ui.mdc.field.Field Field} if the condition update doesn't lead to an update * of the {@link sap.ui.mdc.field.Field#setValue value} property. (If only description or payload is changed.) @@ -11943,7 +12046,8 @@ declare module "sap/ui/mdc/field/FieldBase" { * @since 1.142.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * - * @returns `true` if the `ValidationSuccess` event is fired + * @returns `true` if the {@link sap.ui.base.ManagedObject#event:ValidationSuccess ValidationSuccess} event + * is fired */ shouldFireValidationSuccessOnConditionUpdate( /** @@ -11990,12 +12094,12 @@ declare module "sap/ui/mdc/field/FieldBase" { dataType?: string | PropertyBindingInfo; /** - * The constraints of the type specified in `dataType`. + * The constraints of the type specified in {@link #setDataType dataType}. */ dataTypeConstraints?: object | PropertyBindingInfo | `{${string}}`; /** - * The format options of the type specified in `dataType`. + * The format options of the type specified in {@link #setDataType dataType}. */ dataTypeFormatOptions?: object | PropertyBindingInfo | `{${string}}`; @@ -12052,8 +12156,8 @@ declare module "sap/ui/mdc/field/FieldBase" { * Visualizes the validation state of the control, for example, `Error`, `Warning` or `Success`. * * **Note:** The visualization of the `ValueState` property is handled by the inner rendered control. If - * a control is set (using `content`, `contentEdit`, or `contentDisplay`), this control needs to support - * the `valueState` behavior, otherwise `valueState` is not visualized. + * a control is set (using {@link #setContent content}, {@link #setContentEdit contentEdit}, or {@link #setContentDisplay contentDisplay}), + * this control needs to support the `valueState` behavior, otherwise `valueState` is not visualized. */ valueState?: | (ValueState | keyof typeof ValueState) @@ -12078,7 +12182,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * This property is only used for single-value fields. * - * **Note** If the data type used doesn't support multiple lines, an error is thrown. + * **Note:** If the data type used doesn't support multiple lines, an error is thrown. */ multipleLines?: boolean | PropertyBindingInfo | `{${string}}`; @@ -12087,7 +12191,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * The default value of -1 indicates that an unlimited number of conditions can be defined. * - * **Note** If the data type used doesn't support multiple conditions, an error is thrown. + * **Note:** If the data type used doesn't support multiple conditions, an error is thrown. */ maxConditions?: int | PropertyBindingInfo | `{${string}}`; @@ -12097,9 +12201,9 @@ declare module "sap/ui/mdc/field/FieldBase" { * These should be bound to a {@link sap.ui.mdc.FilterBar FilterBar} using the corresponding `propertyPath`. * * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property is used - * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link @link sap.ui.mdc.FilterBar FilterBar}. - * If this property is not explicitly configured, the {@link @link sap.ui.mdc.FilterBar FilterBar} sets - * a default binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar } + * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link sap.ui.mdc.FilterBar FilterBar}. + * If this property is not explicitly configured, the {@link sap.ui.mdc.FilterBar FilterBar} sets a default + * binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar } * control, the binding looks like this: * `conditions="{$filters>/conditions/propertyPath}"` with the following data: * - `$filters` as the name of the condition model @@ -12141,10 +12245,10 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * If set, an empty `Field` renders an empty indicator in display mode. * - * This property only takes effect if `editMode` is set to `Display`. + * This property only takes effect if {@link #setEditMode editMode} is set to `Display`. * - * **Note** Empty means the `Field` holds no value. If an empty string is a valid value, the `Field` might - * show nothing, depending on the `display` settings and assigned description or `ValueHelp`. + * **Note:** Empty means the `Field` holds no value. If an empty string is a valid value, the `Field` might + * show nothing, depending on the {@link #setDisplay display} settings and assigned description or {@link #setValueHelp ValueHelp}. * * @since 1.85.0 */ @@ -12153,9 +12257,10 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Optional content that can be rendered. * - * Per default, depending on `editMode`, `multipleLines` and the used data type, a content control is rendered. - * For simple string types, a {@link sap.m.Text Text} control is rendered in display mode and a {@link sap.m.Input Input } - * control in edit mode. If a control is assigned in the `content` aggregation, this will be rendered instead. + * Per default, depending on {@link #getEditMode editMode}, {@link #getMultipleLines multipleLines} and + * the used data type, a content control is rendered. For simple string types, a {@link sap.m.Text Text } + * control is rendered in display mode and a {@link sap.m.Input Input} control in edit mode. If a control + * is assigned in the `content` aggregation, this will be rendered instead. * * **Note:** Bind the value-holding property of the control to `'$field>/conditions'` using {@link sap.ui.mdc.field.ConditionsType ConditionsType } * as type. @@ -12171,11 +12276,11 @@ declare module "sap/ui/mdc/field/FieldBase" { content?: Control1; /** - * Optional content to be rendered if the `editMode` property is not set to `Display`. + * Optional content to be rendered if the {@link #getEditMode editMode} property is not set to `Display`. * - * Per default, depending on `multipleLines` and the used data type, a content control is rendered in edit - * mode. For simple string types, an {@link sap.m.Input Input} control is rendered in edit mode. If a control - * is assigned in the `contentEdit` aggregation, this will be rendered instead. + * Per default, depending on {@link #getMultipleLines multipleLines} and the used data type, a content control + * is rendered in edit mode. For simple string types, an {@link sap.m.Input Input} control is rendered in + * edit mode. If a control is assigned in the `contentEdit` aggregation, this will be rendered instead. * * **Note:** If a control is assigned to the `content` aggregation, this one is ignored. * @@ -12195,11 +12300,11 @@ declare module "sap/ui/mdc/field/FieldBase" { contentEdit?: Control1; /** - * Optional content to be rendered if the `editMode` property is set to `Display`. + * Optional content to be rendered if the {@link #getEditMode editMode} property is set to `Display`. * - * Per default, depending on `multipleLines` and the used data type, a content control is rendered in display - * mode. For simple string types, a {@link sap.m.Text Text} control is rendered in display mode. If a control - * is assigned in the `contentDisplay` aggregation, this will be rendered instead. + * Per default, depending on {@link #getMultipleLines multipleLines} and the used data type, a content control + * is rendered in display mode. For simple string types, a {@link sap.m.Text Text} control is rendered in + * display mode. If a control is assigned in the `contentDisplay` aggregation, this will be rendered instead. * * **Note:** If a control is assigned to the `content` aggregation, this one is ignored. * @@ -12233,7 +12338,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * * **Note:** If the field is inside of a table, do not set the `ValueHelp` instance as `dependent` to the * field. If you do, every field instance in every table row gets a clone of it. Put the `ValueHelp` instance - * e.g. as dependent on the table or page. The `FieldHelp` instance must be somewhere in the control tree, + * e.g. as dependent on the table or page. The `ValueHelp` instance must be somewhere in the control tree, * otherwise there might be rendering or update issues. * * **Note:** For `Boolean` fields, no `ValueHelp` should be added, but a default `ValueHelp` used instead. @@ -12245,12 +12350,14 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * Optional `ValueHelp`. * - * This is an association that allows the usage of one `ValueHelp` instance for multiple fields. + * This is an association that allows the usage of one {@link sap.ui.mdc.ValueHelp ValueHelp} instance for + * multiple fields. * - * **Note:** If the field is inside of a table, do not set the `ValueHelp` instance as `dependent` to the - * field. If you do, every field instance in every table row gets a clone of it. Put the `ValueHelp` instance - * e.g. as dependent on the table or page. The `ValueHelp` instance must be somewhere in the control tree, - * otherwise there might be rendering or update issues. + * **Note:** If the field is inside of a table, do not set the {@link sap.ui.mdc.ValueHelp ValueHelp} instance + * as {@link sap.ui.core.Element#addDependent dependent} to the field. If you do, every field instance in + * every table row gets a clone of it. Put the {@link sap.ui.mdc.ValueHelp ValueHelp} instance e.g. as {@link sap.ui.core.Element#addDependent dependent } + * on the table or page. The {@link sap.ui.mdc.ValueHelp ValueHelp} instance must be somewhere in the control + * tree, otherwise there might be rendering or update issues. * * **Note:** For `Boolean` fields, no `ValueHelp` should be added, but a default `ValueHelp` used instead. */ @@ -12264,7 +12371,7 @@ declare module "sap/ui/mdc/field/FieldBase" { /** * This event is fired when the value of the field is changed, for example, each time a key is pressed. * - * **Note** This event is only triggered if the used content control has a `liveChange` event. + * **Note:** This event is only triggered if the used content control has a `liveChange` event. */ liveChange?: (oEvent: FieldBase$LiveChangeEvent) => void; @@ -12277,7 +12384,7 @@ declare module "sap/ui/mdc/field/FieldBase" { * This event is fired when the user presses Enter. It allows the application to implement some * submit logic. * - * **Note** This event is only triggered if the field is editable. + * **Note:** This event is only triggered if the field is editable. * * @since 1.82.0 */ @@ -14124,19 +14231,21 @@ declare module "sap/ui/mdc/FilterField" { /** * The `FilterField` control is used to filter data based on the conditions. The conditions are managed - * in the corresponding {@link sap.ui.mdc.FilterBar FilterBar}. That is why the `conditions` property must - * be bound to the related conditions in the {@link sap.ui.mdc.FilterBar FilterBar}. The type of this data - * must be defined in the `dataType` property. + * in the corresponding {@link sap.ui.mdc.FilterBar FilterBar}. That is why the {@link sap.ui.mdc.field.FieldBase#bindConditions conditions } + * property must be bound to the related conditions in the {@link sap.ui.mdc.FilterBar FilterBar}. The type + * of this data must be defined in the {@link sap.ui.mdc.field.FieldBase#setDataType dataType} property. * * Based on the data type settings, a default control is rendered by the `FilterField` as follows: * * * - In display mode, usually a {@link sap.m.Text Text} control is rendered. - * - If `multipleLines` is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered. + * - If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, an {@link sap.m.ExpandableText ExpandableText } + * control is rendered. * - If multiple values are allowed, a {@link sap.m.Tokenizer Tokenizer} control is rendered. * - In edit mode, usually an {@link sap.m.Input Input} control is rendered. * - If multiple values are allowed, a {@link sap.m.MultiInput MultiInput} control is rendered. - * - If `multipleLines` is set, a {@link sap.m.TextArea TextArea} control is rendered. + * - If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, a {@link sap.m.TextArea TextArea } + * control is rendered. * - If a date type or a date/time type is used and only one condition is supported, a {@link sap.m.DynamicDateRange DynamicDateRange } * control is rendered. * - If a date type is used and only single values are allowed, a {@link sap.m.DatePicker DatePicker } @@ -14229,8 +14338,8 @@ declare module "sap/ui/mdc/FilterField" { /** * Adds an operator to the list of known operators. * - * **Note**: If no operator is set, the used `datatType` of the `FilterField` defines the set of default - * operators. The standard operators are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + * **Note:** If no operator is set, the used {@link sap.ui.mdc.field.FieldBase#getDataType dataType} of + * the `FilterField` defines the set of default operators. The standard operators are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. * * * @returns Reference to `this` to allow method chaining @@ -14244,7 +14353,7 @@ declare module "sap/ui/mdc/FilterField" { /** * Adds an array of operators to the list of known operators. * - * **Note**: `aOperators` can be the name of an {@link sap.ui.mdc.condition.Operator Operator}, the instance + * **Note:** `aOperators` can be the name of an {@link sap.ui.mdc.condition.Operator Operator}, the instance * itself, or multiple operators inside an array. The standard operators are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. * * @@ -14262,7 +14371,8 @@ declare module "sap/ui/mdc/FilterField" { * 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.ui.mdc.FilterField` itself. * - * This event is fired when the `conditions` property of the `FilterField` is changed by a user interaction. + * This event is fired when the {@link sap.ui.mdc.field.FieldBase#getConditions conditions} property of + * the `FilterField` is changed by a user interaction. * * **Note** This event is only triggered if the used content control has a change event. * @@ -14290,7 +14400,8 @@ declare module "sap/ui/mdc/FilterField" { * 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.ui.mdc.FilterField` itself. * - * This event is fired when the `conditions` property of the `FilterField` is changed by a user interaction. + * This event is fired when the {@link sap.ui.mdc.field.FieldBase#getConditions conditions} property of + * the `FilterField` is changed by a user interaction. * * **Note** This event is only triggered if the used content control has a change event. * @@ -14357,7 +14468,7 @@ declare module "sap/ui/mdc/FilterField" { * Default operator name for conditions. If empty, the relevant default operator depending on the data type * used is taken. * - * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the + * **Note:** `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the * instance itself. * * @since 1.88.0 @@ -14414,7 +14525,7 @@ declare module "sap/ui/mdc/FilterField" { /** * Removes all given operators from the list of known operators. * - * **Note**: `aOperators` can be the name of an {@link sap.ui.mdc.condition.Operator Operator}, the instance + * **Note:** `aOperators` can be the name of an {@link sap.ui.mdc.condition.Operator Operator}, the instance * itself, or multiple operators inside an array. The standard operators are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. */ removeOperators( @@ -14449,7 +14560,7 @@ declare module "sap/ui/mdc/FilterField" { * Default operator name for conditions. If empty, the relevant default operator depending on the data type * used is taken. * - * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the + * **Note:** `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the * instance itself. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. @@ -14536,7 +14647,7 @@ declare module "sap/ui/mdc/FilterField" { * Default operator name for conditions. If empty, the relevant default operator depending on the data type * used is taken. * - * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the + * **Note:** `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the * instance itself. * * @since 1.88.0 @@ -14561,7 +14672,8 @@ declare module "sap/ui/mdc/FilterField" { additionalDataType?: object | PropertyBindingInfo | `{${string}}`; /** - * This event is fired when the `conditions` property of the `FilterField` is changed by a user interaction. + * This event is fired when the {@link sap.ui.mdc.field.FieldBase#getConditions conditions} property of + * the `FilterField` is changed by a user interaction. * * **Note** This event is only triggered if the used content control has a change event. */ @@ -16215,9 +16327,11 @@ declare module "sap/ui/mdc/MultiValueField" { * * * - In display mode, usually a {@link sap.m.Tokenizer Tokenizer} control is rendered. - * - If `multipleLines` is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered. + * - If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, an {@link sap.m.ExpandableText ExpandableText } + * control is rendered. * - In edit mode, usually a {@link sap.m.MultiInput MultiInput} control is rendered. - * - If `multipleLines` is set, a {@link sap.m.TextArea TextArea} control is rendered. + * - If {@link sap.ui.mdc.field.FieldBase#getMultipleLines multipleLines} is set, a {@link sap.m.TextArea TextArea } + * control is rendered. * * @since 1.93.0 */ @@ -16308,7 +16422,7 @@ declare module "sap/ui/mdc/MultiValueField" { * 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.ui.mdc.MultiValueField` itself. * - * This event is fired when the `items` aggregation of the field is changed by user interaction. + * This event is fired when the {@link #getItems items} aggregation of the field is changed by user interaction. * * **Note** This event is only triggered if the used content control has a change event. * @@ -16336,7 +16450,7 @@ declare module "sap/ui/mdc/MultiValueField" { * 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.ui.mdc.MultiValueField` itself. * - * This event is fired when the `items` aggregation of the field is changed by user interaction. + * This event is fired when the {@link #getItems items} aggregation of the field is changed by user interaction. * * **Note** This event is only triggered if the used content control has a change event. * @@ -16760,7 +16874,7 @@ declare module "sap/ui/mdc/MultiValueField" { | `{${string}}`; /** - * This event is fired when the `items` aggregation of the field is changed by user interaction. + * This event is fired when the {@link #getItems items} aggregation of the field is changed by user interaction. * * **Note** This event is only triggered if the used content control has a change event. */ @@ -16774,8 +16888,9 @@ declare module "sap/ui/mdc/MultiValueField" { /** * The new items of the `MultiValueField` control. * - * If a `ValueHelp` element is assigned to the `MultiValueField` control, the `key` of the items is used - * as key for the `ValueHelp` items. + * If a {@link sap.ui.mdc.field.FieldBase#getValueHelp ValueHelp} element is assigned to the `MultiValueField` + * control, the {@link sap.ui.mdc.field.MultiValueFieldItem#getKey key} of the items is used as key for + * the {@link sap.ui.mdc.field.FieldBase#getValueHelp ValueHelp} items. */ items?: MultiValueFieldItem[]; @@ -17040,6 +17155,19 @@ declare module "sap/ui/mdc/Table" { * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; + /** + * Adds some tableAction to the aggregation {@link #getTableActions tableActions}. + * + * @since 1.143 + * + * @returns Reference to `this` in order to allow method chaining + */ + addTableAction( + /** + * The tableAction to add; if empty, nothing is inserted + */ + oTableAction: Control1 + ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeExport beforeExport} event of this `sap.ui.mdc.Table`. * @@ -17345,6 +17473,14 @@ declare module "sap/ui/mdc/Table" { * @returns Reference to `this` in order to allow method chaining */ destroyRowSettings(): this; + /** + * Destroys all the tableActions in the aggregation {@link #getTableActions tableActions}. + * + * @since 1.143 + * + * @returns Reference to `this` in order to allow method chaining + */ + destroyTableActions(): this; /** * Destroys the type in the aggregation {@link #getType type}. * @@ -17911,6 +18047,20 @@ declare module "sap/ui/mdc/Table" { * @returns Value of property `showRowCount` */ getShowRowCount(): boolean; + /** + * Gets content of aggregation {@link #getTableActions tableActions}. + * + * Additional table-related actions that are positioned together with other table-generated actions, based + * on the {@link sap.ui.mdc.table.ActionLayoutData ActionLayoutData} provided. + * + * **Note:** All actions should use layout data of the {@link sap.ui.mdc.table.ActionLayoutData ActionLayoutData } + * type to ensure correct ordering. Actions that do not use this layout data will be placed after the table-generated + * actions. + * **Note:** Like other table-generated actions, these actions are excluded from the UI adaptation. + * + * @since 1.143 + */ + getTableActions(): Control1[]; /** * Gets current value of property {@link #getThreshold threshold}. * @@ -17994,6 +18144,20 @@ declare module "sap/ui/mdc/Table" { */ oColumn: Column ): int; + /** + * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTableActions tableActions}. + * and returns its index if found or -1 otherwise. + * + * @since 1.143 + * + * @returns The index of the provided control in the aggregation if found, or -1 otherwise + */ + indexOfTableAction( + /** + * The tableAction whose index is looked for + */ + oTableAction: Control1 + ): int; /** * Returns a `Promise` that resolves after the table has been initialized, and after it has been created * or its type has been changed. @@ -18002,6 +18166,25 @@ declare module "sap/ui/mdc/Table" { * @returns A `Promise` that resolves after the table has been initialized */ initialized(): Promise; + /** + * Inserts a tableAction into the aggregation {@link #getTableActions tableActions}. + * + * @since 1.143 + * + * @returns Reference to `this` in order to allow method chaining + */ + insertTableAction( + /** + * The tableAction to insert; if empty, nothing is inserted + */ + oTableAction: Control1, + /** + * The `0`-based index the tableAction should be inserted at; for a negative value of `iIndex`, the tableAction + * is inserted at position 0; for a value greater than the current size of the aggregation, the tableAction + * is inserted at the last position + */ + iIndex: int + ): this; /** * Checks whether the table is bound. * @@ -18018,6 +18201,29 @@ declare module "sap/ui/mdc/Table" { * for example because there are invalid filters. */ rebind(): Promise; + /** + * Removes all the controls from the aggregation {@link #getTableActions tableActions}. + * + * Additionally, it unregisters them from the hosting UIArea. + * + * @since 1.143 + * + * @returns An array of the removed elements (might be empty) + */ + removeAllTableActions(): Control1[]; + /** + * Removes a tableAction from the aggregation {@link #getTableActions tableActions}. + * + * @since 1.143 + * + * @returns The removed tableAction or `null` + */ + removeTableAction( + /** + * The tableAction to remove or its index or id + */ + vTableAction: int | string | Control1 + ): Control1 | null; /** * Scrolls the table to the row with the given index. Depending on the table type, this might cause additional * requests. If the given index is -1, it will scroll to the end of the table based on the length of the @@ -19088,6 +19294,23 @@ declare module "sap/ui/mdc/Table" { */ actions?: Control1[] | Control1 | AggregationBindingInfo | `{${string}}`; + /** + * Additional table-related actions that are positioned together with other table-generated actions, based + * on the {@link sap.ui.mdc.table.ActionLayoutData ActionLayoutData} provided. + * + * **Note:** All actions should use layout data of the {@link sap.ui.mdc.table.ActionLayoutData ActionLayoutData } + * type to ensure correct ordering. Actions that do not use this layout data will be placed after the table-generated + * actions. + * **Note:** Like other table-generated actions, these actions are excluded from the UI adaptation. + * + * @since 1.143 + */ + tableActions?: + | Control1[] + | Control1 + | AggregationBindingInfo + | `{${string}}`; + /** * VariantManagement control for the table. */ @@ -19303,6 +19526,138 @@ declare module "sap/ui/mdc/Table" { >; } +declare module "sap/ui/mdc/table/ActionLayoutData" { + import { + default as OverflowToolbarLayoutData, + $OverflowToolbarLayoutDataSettings, + } from "sap/m/OverflowToolbarLayoutData"; + + import { IActionLayoutData } from "sap/ui/mdc/library"; + + import ElementMetadata from "sap/ui/core/ElementMetadata"; + + import TableActionPosition from "sap/ui/mdc/enums/TableActionPosition"; + + import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; + + /** + * Defines the layout data for the {@link sap.ui.mdc.Table#getActions actions} and {@link sap.ui.mdc.Table#getTableActions tableActions } + * of the {@link sap.ui.mdc.Table Table}. + * + * @since 1.143 + */ + export default class ActionLayoutData + extends OverflowToolbarLayoutData + implements IActionLayoutData + { + __implements__sap_ui_mdc_IActionLayoutData: boolean; + /** + * Constructor for a new `ActionLayoutData`. + * + * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated + * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description + * of the syntax of the settings object. + */ + constructor( + /** + * Initial settings for the new layout data + */ + mSettings?: $ActionLayoutDataSettings + ); + /** + * Constructor for a new `ActionLayoutData`. + * + * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated + * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description + * of the syntax of the settings object. + */ + constructor( + /** + * ID for the new layout data, generated automatically if no ID is given + */ + sId?: string, + /** + * Initial settings for the new layout data + */ + mSettings?: $ActionLayoutDataSettings + ); + + /** + * Creates a new subclass of class sap.ui.mdc.table.ActionLayoutData with name `sClassName` and enriches + * it with the information contained in `oClassInfo`. + * + * `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbarLayoutData.extend}. + * + * + * @returns Created class / constructor function + */ + static extend>( + /** + * Name of the class being created + */ + sClassName: string, + /** + * Object literal with information about the class + */ + oClassInfo?: sap.ClassInfo, + /** + * Constructor function for the metadata object; if not given, it defaults to the metadata implementation + * used by this class + */ + FNMetaImpl?: Function + ): Function; + /** + * Returns a metadata object for class sap.ui.mdc.table.ActionLayoutData. + * + * + * @returns Metadata object describing this class + */ + static getMetadata(): ElementMetadata; + /** + * Gets current value of property {@link #getPosition position}. + * + * Defines the position of the action within the group of table actions. + * + * Default value is `EndActions`. + * + * + * @returns Value of property `position` + */ + getPosition(): TableActionPosition; + /** + * Sets a new value for property {@link #getPosition position}. + * + * Defines the position of the action within the group of table actions. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `EndActions`. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + setPosition( + /** + * New value for property `position` + */ + sPosition?: TableActionPosition | keyof typeof TableActionPosition + ): this; + } + /** + * Describes the settings that can be provided to the ActionLayoutData constructor. + */ + export interface $ActionLayoutDataSettings + extends $OverflowToolbarLayoutDataSettings { + /** + * Defines the position of the action within the group of table actions. + */ + position?: + | (TableActionPosition | keyof typeof TableActionPosition) + | PropertyBindingInfo + | `{${string}}`; + } +} + declare module "sap/ui/mdc/table/Column" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; @@ -21356,6 +21711,8 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" { import ElementMetadata from "sap/ui/core/ElementMetadata"; + import TablePopinDisplay from "sap/ui/mdc/enums/TablePopinDisplay"; + import { PopinLayout } from "sap/m/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; @@ -21455,6 +21812,18 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" { * @returns Value of property `growingMode` */ getGrowingMode(): TableGrowingMode; + /** + * Gets current value of property {@link #getPopinDisplay popinDisplay}. + * + * Defines how the pop-in content is displayed. + * + * Default value is `Inline`. + * + * @since 1.143 + * + * @returns Value of property `popinDisplay` + */ + getPopinDisplay(): TablePopinDisplay; /** * Gets current value of property {@link #getPopinLayout popinLayout}. * @@ -21526,6 +21895,25 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" { */ sGrowingMode?: TableGrowingMode | keyof typeof TableGrowingMode ): this; + /** + * Sets a new value for property {@link #getPopinDisplay popinDisplay}. + * + * Defines how the pop-in content is displayed. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `Inline`. + * + * @since 1.143 + * + * @returns Reference to `this` in order to allow method chaining + */ + setPopinDisplay( + /** + * New value for property `popinDisplay` + */ + sPopinDisplay?: TablePopinDisplay | keyof typeof TablePopinDisplay + ): this; /** * Sets a new value for property {@link #getPopinLayout popinLayout}. * @@ -21621,6 +22009,16 @@ declare module "sap/ui/mdc/table/ResponsiveTableType" { | (PopinLayout | keyof typeof PopinLayout) | PropertyBindingInfo | `{${string}}`; + + /** + * Defines how the pop-in content is displayed. + * + * @since 1.143 + */ + popinDisplay?: + | (TablePopinDisplay | keyof typeof TablePopinDisplay) + | PropertyBindingInfo + | `{${string}}`; } } @@ -27262,12 +27660,16 @@ declare namespace sap { "sap/ui/mdc/enums/RequestShowContainerReason": undefined; + "sap/ui/mdc/enums/TableActionPosition": undefined; + "sap/ui/mdc/enums/TableGrowingMode": undefined; "sap/ui/mdc/enums/TableMultiSelectMode": undefined; "sap/ui/mdc/enums/TableP13nMode": undefined; + "sap/ui/mdc/enums/TablePopinDisplay": undefined; + "sap/ui/mdc/enums/TableRowActionType": undefined; "sap/ui/mdc/enums/TableRowCountMode": undefined; @@ -27396,6 +27798,8 @@ declare namespace sap { "sap/ui/mdc/Table": undefined; + "sap/ui/mdc/table/ActionLayoutData": undefined; + "sap/ui/mdc/table/Column": undefined; "sap/ui/mdc/table/ColumnSettings": undefined; diff --git a/types/openui5/sap.ui.rta.d.ts b/types/openui5/sap.ui.rta.d.ts index be648a99e1c08e..c354e5318880ed 100644 --- a/types/openui5/sap.ui.rta.d.ts +++ b/types/openui5/sap.ui.rta.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/rta/api/startAdaptation" { import Control from "sap/ui/core/Control"; diff --git a/types/openui5/sap.ui.suite.d.ts b/types/openui5/sap.ui.suite.d.ts index 8011fafa06dccf..67d7190dd2d08e 100644 --- a/types/openui5/sap.ui.suite.d.ts +++ b/types/openui5/sap.ui.suite.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/suite/library" { /** diff --git a/types/openui5/sap.ui.support.d.ts b/types/openui5/sap.ui.support.d.ts index 6f2b6987263023..1f6a7588769ff8 100644 --- a/types/openui5/sap.ui.support.d.ts +++ b/types/openui5/sap.ui.support.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/support/library" { /** diff --git a/types/openui5/sap.ui.table.d.ts b/types/openui5/sap.ui.table.d.ts index dc7c7678dcbdad..90046dcb59555c 100644 --- a/types/openui5/sap.ui.table.d.ts +++ b/types/openui5/sap.ui.table.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/table/library" { import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode"; @@ -4941,7 +4941,7 @@ declare module "sap/ui/table/RowActionItem" { * @returns Value of property `visible` */ getVisible(): boolean; - /* + /** * Sets a new value for property {@link #getIcon icon}. * * The icon of the item. diff --git a/types/openui5/sap.ui.testrecorder.d.ts b/types/openui5/sap.ui.testrecorder.d.ts index d0148feb575c6a..8a766e23a3dda8 100644 --- a/types/openui5/sap.ui.testrecorder.d.ts +++ b/types/openui5/sap.ui.testrecorder.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/testrecorder/library" {} diff --git a/types/openui5/sap.ui.unified.d.ts b/types/openui5/sap.ui.unified.d.ts index e04bb52e8ec2bc..4e6d602576ae83 100644 --- a/types/openui5/sap.ui.unified.d.ts +++ b/types/openui5/sap.ui.unified.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/unified/library" { /** diff --git a/types/openui5/sap.ui.ux3.d.ts b/types/openui5/sap.ui.ux3.d.ts index 51fdbf952914df..c4fdda13987a61 100644 --- a/types/openui5/sap.ui.ux3.d.ts +++ b/types/openui5/sap.ui.ux3.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/ux3/library" { /** diff --git a/types/openui5/sap.ui.webc.common.d.ts b/types/openui5/sap.ui.webc.common.d.ts index 1aace19ff0ab34..8e7a157d83c45e 100644 --- a/types/openui5/sap.ui.webc.common.d.ts +++ b/types/openui5/sap.ui.webc.common.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/webc/common/library" {} diff --git a/types/openui5/sap.ui.webc.fiori.d.ts b/types/openui5/sap.ui.webc.fiori.d.ts index 1820f3d6cba42d..503c7b5050a692 100644 --- a/types/openui5/sap.ui.webc.fiori.d.ts +++ b/types/openui5/sap.ui.webc.fiori.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/webc/fiori/library" { /** diff --git a/types/openui5/sap.ui.webc.main.d.ts b/types/openui5/sap.ui.webc.main.d.ts index 712d389e084324..a785b9511c4587 100644 --- a/types/openui5/sap.ui.webc.main.d.ts +++ b/types/openui5/sap.ui.webc.main.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/ui/webc/main/library" { /** diff --git a/types/openui5/sap.uxap.d.ts b/types/openui5/sap.uxap.d.ts index 414cf8bc8a3863..dac8d5c2cbe197 100644 --- a/types/openui5/sap.uxap.d.ts +++ b/types/openui5/sap.uxap.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.142.0 +// For Library Version: 1.143.0 declare module "sap/uxap/library" { /** diff --git a/types/relay-runtime/experimental.d.ts b/types/relay-runtime/experimental.d.ts index 64fb38f77fc658..c76e9dfca8be93 100644 --- a/types/relay-runtime/experimental.d.ts +++ b/types/relay-runtime/experimental.d.ts @@ -1,3 +1,27 @@ +import { DataID } from "./lib/util/RelayRuntimeTypes"; + +export { resolverDataInjector } from "./lib/store/live-resolvers/resolverDataInjector"; export { observeFragment } from "./lib/store/observeFragmentExperimental"; export { observeQuery } from "./lib/store/observeQueryExperimental"; export { waitForFragmentData } from "./lib/store/waitForFragmentExperimental"; + +export type IdOf<_A extends string, Typename extends undefined | string = undefined> = Typename extends undefined + ? { id: DataID } + : { id: DataID; __typename: Typename }; + +interface ErrorResult { + ok: false; + errors: readonly E[]; +} + +interface OkayResult { + ok: true; + value: T; +} + +// The type returned by fields annotated with `@catch` +export type Result = OkayResult | ErrorResult; + +export function isValueResult(input: Result): input is OkayResult; + +export function isErrorResult(input: Result): input is ErrorResult; diff --git a/types/relay-runtime/index.d.ts b/types/relay-runtime/index.d.ts index 0fa5f0ce691d79..c54148d2958d19 100644 --- a/types/relay-runtime/index.d.ts +++ b/types/relay-runtime/index.d.ts @@ -154,6 +154,7 @@ export { RelayModernRecord as Record } from "./lib/store/RelayModernRecord"; export { default as Store } from "./lib/store/RelayModernStore"; export { RelayRecordSource as RecordSource } from "./lib/store/RelayRecordSource"; +export { type IdOf, isErrorResult, isValueResult, type Result } from "./experimental"; export { createFragmentSpecResolver } from "./lib/store/createFragmentSpecResolver"; export { readInlineData } from "./lib/store/readInlineData"; export { createOperationDescriptor, createRequestDescriptor } from "./lib/store/RelayModernOperationDescriptor"; @@ -185,6 +186,7 @@ export { ROOT_TYPE, TYPENAME_KEY, } from "./lib/store/RelayStoreUtils"; +export { readFragment } from "./lib/store/ResolverFragments"; // Extensions import RelayDefaultHandlerProvider from "./lib/handlers/RelayDefaultHandlerProvider"; @@ -267,16 +269,3 @@ export type FragmentRefs = { // This is a utility type for converting from a data type to a fragment reference that will resolve to that data type. export type FragmentRef = Fragment extends _RefType ? _FragmentRefs : never; - -interface ErrorResult { - ok: false; - errors: readonly Error[]; -} - -interface OkayResult { - ok: true; - value: T; -} - -// The type returned by fields annotated with `@catch` -export type Result = OkayResult | ErrorResult; diff --git a/types/relay-runtime/lib/store/live-resolvers/resolverDataInjector.d.ts b/types/relay-runtime/lib/store/live-resolvers/resolverDataInjector.d.ts new file mode 100644 index 00000000000000..84cd33db4a5f45 --- /dev/null +++ b/types/relay-runtime/lib/store/live-resolvers/resolverDataInjector.d.ts @@ -0,0 +1,20 @@ +import type { GraphQLTaggedNode } from "../../query/RelayModernGraphQLTag"; +import type { FragmentType } from "../RelayStoreTypes"; + +/** + * This a higher order function that returns a relay resolver that can read the data for + * the fragment`. + * + * - fragment: contains fragment Reader AST with resolver's data dependencies. + * - resolverFn: original resolver function that expects a data from the fragment + * - (optional) fieldName: individual field that needs to be read out of the fragment. + * + * This will not call the `resolverFn` if the fragment data for it is null/undefined. + * The compiler generates calls to this function, ensuring the correct set of arguments. + */ +export function resolverDataInjector( + fragment: GraphQLTaggedNode, + _resolverFn: unknown, + fieldName?: string, + isRequiredField?: boolean, +): (fragmentKey: FragmentType, args: unknown) => unknown; diff --git a/types/relay-runtime/package.json b/types/relay-runtime/package.json index 8f7c429923b686..f5ff4136d43bb4 100644 --- a/types/relay-runtime/package.json +++ b/types/relay-runtime/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/relay-runtime", - "version": "19.0.9999", + "version": "20.1.9999", "projects": [ "https://github.com/facebook/relay", "https://facebook.github.io/relay" diff --git a/types/relay-runtime/relay-runtime-tests.tsx b/types/relay-runtime/relay-runtime-tests.tsx index c3361c65480d7d..b52e400269ebd0 100644 --- a/types/relay-runtime/relay-runtime-tests.tsx +++ b/types/relay-runtime/relay-runtime-tests.tsx @@ -15,7 +15,9 @@ import { getRefetchMetadata, getRequest, graphql, + isErrorResult, isPromise, + isValueResult, LiveState, Network, PreloadableConcreteRequest, @@ -23,6 +25,7 @@ import { QueryResponseCache, ReaderFragment, ReaderInlineDataFragment, + readFragment, readInlineData, RecordProxy, RecordSource, @@ -35,7 +38,13 @@ import { suspenseSentinel, Variables, } from "relay-runtime"; -import { observeFragment, observeQuery, waitForFragmentData } from "relay-runtime/experimental"; +import { + IdOf, + observeFragment, + observeQuery, + resolverDataInjector, + waitForFragmentData, +} from "relay-runtime/experimental"; import type { HandlerProvider } from "relay-runtime/lib/handlers/RelayDefaultHandlerProvider"; import * as multiActorEnvironment from "relay-runtime/multi-actor-environment"; @@ -701,8 +710,6 @@ function multiActors() { // Relay Resolvers // ~~~~~~~~~~~~~~~~~~~~~~~ -const { readFragment } = __internal.ResolverFragments; - // Regular fragment. interface UserComponent_user { readonly id: string; @@ -921,6 +928,20 @@ export function handleResult(result: Result) { } } +// eslint-disable-next-line @definitelytyped/no-unnecessary-generics +export function handleValueResult(result: Result) { + if (isValueResult(result)) { + const value: T = result.value; + } +} + +// eslint-disable-next-line @definitelytyped/no-unnecessary-generics +export function handleErrorResult(result: Result) { + if (isErrorResult(result)) { + const errors: readonly E[] = result.errors; + } +} + // ~~~~~~~~~~~~~~~~~~ // Metadata // ~~~~~~~~~~~~~~~~~~ @@ -1048,3 +1069,61 @@ function observeQueryTest() { subscription.unsubscribe(); } + +// ~~~~~~~~~~~~~~~~~~ +// resolverDataInjector +// ~~~~~~~~~~~~~~~~~~ + +const MyResolverType__id_graphql: ReaderFragment = { + "argumentDefinitions": [], + "kind": "Fragment", + "metadata": null, + "name": "MyResolverType__id", + "selections": [ + { + "kind": "ClientExtension", + "selections": [ + { + "alias": null, + "args": null, + "kind": "ScalarField", + "name": "id", + "storageKey": null, + }, + ], + }, + ], + "type": "MyResolverType", + "abstractKey": null, +}; + +interface MyResolverType { + id: string; +} + +function myResolverTypeRelayModelInstanceResolver(id: DataID): MyResolverType { + return { + id, + }; +} + +export const resolverModule = resolverDataInjector( + MyResolverType__id_graphql, + myResolverTypeRelayModelInstanceResolver, + "id", + true, +); + +// ~~~~~~~~~~~~~~~~~~ +// Client edge resolver +// ~~~~~~~~~~~~~~~~~~ + +export function myDog(): IdOf<"Dog"> { + return { id: "5" }; +} + +type AnimalTypenames = "Cat" | "Dog"; + +export function myAnimal(): IdOf<"Animal", AnimalTypenames> { + return Math.random() > 0.5 ? { id: "5", __typename: "Dog" } : { id: "6", __typename: "Cat" }; +}