@openui5/ts-types 1.126.0 → 1.127.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.126.0
282
+ // For Library Version: 1.127.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -6236,6 +6236,10 @@ declare module "sap/ui/performance/trace/Interaction" {
6236
6236
  * The default PassportAction for startup
6237
6237
  */
6238
6238
  passportAction: string;
6239
+ /**
6240
+ * The root context ID
6241
+ */
6242
+ rootId: string;
6239
6243
  };
6240
6244
 
6241
6245
  /**
@@ -7097,6 +7101,43 @@ declare module "sap/ui/test/opaQunit" {
7097
7101
  ): void;
7098
7102
  }
7099
7103
 
7104
+ declare module "sap/ui/test/utils/nextUIUpdate" {
7105
+ /**
7106
+ * Return a Promise that resolves when the next Rendering is ready. If no rendering is sheduled it resolves
7107
+ * immediately.
7108
+ *
7109
+ * **Note:** No module from `sap/ui/test` should be used for productive coding!
7110
+ *
7111
+ * @since 1.127
7112
+ *
7113
+ * @returns A promise resolving when the next UI update is finished or rejecting when the next update fails.
7114
+ */
7115
+ export default function nextUIUpdate(
7116
+ /**
7117
+ * An optional sinon clock. When using sinon faketimers the clock must be ticked to ensure async rendering.
7118
+ * Async rendering is done with a setTimeout(0) so, when given, we tick the clock by 1.
7119
+ */
7120
+ clock?: {
7121
+ tick: Function;
7122
+ }
7123
+ ): Promise<undefined>;
7124
+ }
7125
+
7126
+ declare module "sap/ui/test/utils/waitForThemeApplied" {
7127
+ /**
7128
+ * Checks whether the theme has already been applied and if not, waits for the 'applied' event to be fired.
7129
+ *
7130
+ * Returns a rejected promise if the Core is not ready yet.
7131
+ *
7132
+ * **Note:** No module from `sap/ui/test` should be used for productive coding!
7133
+ *
7134
+ * @since 1.127
7135
+ *
7136
+ * @returns Promise that resolves when the theme has been applied
7137
+ */
7138
+ export default function waitForThemeApplied(): Promise<undefined>;
7139
+ }
7140
+
7100
7141
  declare module "sap/ui/util/Mobile" {
7101
7142
  /**
7102
7143
  * @since 1.58
@@ -7546,8 +7587,6 @@ declare module "sap/ui/VersionInfo" {
7546
7587
  }
7547
7588
  /**
7548
7589
  * Root namespace for JavaScript functionality provided by SAP SE.
7549
- *
7550
- * The `sap` namespace is automatically registered with the OpenAjax hub if it exists.
7551
7590
  */
7552
7591
  declare namespace sap {
7553
7592
  /**
@@ -21066,14 +21105,64 @@ declare namespace sap {
21066
21105
  * **Note:** This static method is automatically propagated to subclasses of `ControllerExtension`.
21067
21106
  *
21068
21107
  *
21069
- * @returns A controller extension class
21108
+ * @returns The adapted controller extension class
21070
21109
  */
21071
- static override(
21110
+ static override<
21111
+ TheExtension extends new () => ControllerExtension,
21112
+ AddtlProps extends object,
21113
+ >(
21114
+ this: TheExtension,
21072
21115
  /**
21073
21116
  * The custom extension definition
21074
21117
  */
21075
- oExtension: Record<string, Function>
21076
- ): Function;
21118
+ customExtension: AddtlProps
21119
+ ): new () => InstanceType<TheExtension> & AddtlProps;
21120
+ /**
21121
+ * A marker method for applying controller extensions to controller class members in TypeScript code.
21122
+ * This method is only used to make TypeScript usage compatible to the UI5 runtime behavior, where an extension
21123
+ * *class* is assigned when the controller is defined, but each controller instance gets an *instance* of
21124
+ * this extension. This method call is removed in the class transformer when the ES class is transformed
21125
+ * to the traditional UI5 class definition syntax.
21126
+ *
21127
+ * To allow for proper removal, it may only be called directly on the base class `ControllerExtension`,
21128
+ * at the place where a controller extension is assigned to a member property of the new controller class.
21129
+ * The class transformation then removes this call. If it is not removed because it is used in any other
21130
+ * way, then it throws an error at runtime.
21131
+ *
21132
+ * Usage example:
21133
+ * ```javascript
21134
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
21135
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
21136
+ * ...
21137
+ * export default class App extends Controller {
21138
+ * routing = ControllerExtension.use(Routing);
21139
+ * ```
21140
+ *
21141
+ * Usage example with overriding extension callbacks:
21142
+ * ```javascript
21143
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
21144
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
21145
+ * ...
21146
+ * export default class App extends Controller {
21147
+ * routing = ControllerExtension.use(Routing.override({
21148
+ * ...
21149
+ * }));
21150
+ * ```
21151
+ *
21152
+ *
21153
+ *
21154
+ * @returns An instance of the given `ControllerExtension`. **NOTE:** this is only a dummy return type for
21155
+ * proper usage in TypeScript. This method does not actually return an instance of `ControllerExtension`,
21156
+ * but only throws an error at runtime. The sole purpose of this method is to mimic the actual runtime behavior
21157
+ * where a *class* is given when a controller is defined, but an *instance* is present in each controller
21158
+ * instance.
21159
+ */
21160
+ static use<TheExtension extends sap.ui.core.mvc.ControllerExtension>(
21161
+ /**
21162
+ * The ControllerExtension to use
21163
+ */
21164
+ extensionClass: new () => TheExtension
21165
+ ): TheExtension;
21077
21166
  /**
21078
21167
  * Returns an Element of the connected view with the given local ID.
21079
21168
  *
@@ -33345,6 +33434,12 @@ declare namespace sap {
33345
33434
  | sap.ui.core.dnd.DragDropBase
33346
33435
  | sap.ui.base.ManagedObject.AggregationBindingInfo
33347
33436
  | `{${string}}`;
33437
+
33438
+ /**
33439
+ * Reference to the element to show the field help for this control; if unset, field help is show on the
33440
+ * control itself.
33441
+ */
33442
+ fieldHelpDisplay?: sap.ui.core.Element | string;
33348
33443
  }
33349
33444
 
33350
33445
  /**
@@ -35023,7 +35118,7 @@ declare namespace sap {
35023
35118
  * @deprecated (since 1.118) - without replacement. In the next major version, synchronously rendering UI
35024
35119
  * updates is no longer supported as it can lead to unnecessary intermediate DOM updates or layout shifting
35025
35120
  * etc. Controls should rather use invalidation and apps should not trigger rendering at all but rather
35026
- * rely on the framework's automatic update mechanisms. Test code can use the test module `sap/ui/qunit/utils/nextUIUpdate`
35121
+ * rely on the framework's automatic update mechanisms. Test code can use the test module `sap/ui/test/utils/nextUIUpdate`
35027
35122
  * as a convenient way to wait for the next asynchronous rendering.
35028
35123
  */
35029
35124
  applyChanges(): void;
@@ -39512,7 +39607,7 @@ declare namespace sap {
39512
39607
  *
39513
39608
  * @returns Current accessibility state of the control.
39514
39609
  */
39515
- getAccessibilityInfo(): sap.ui.core.AccessibilityInfo;
39610
+ getAccessibilityInfo?(): sap.ui.core.AccessibilityInfo;
39516
39611
  /**
39517
39612
  * Gets current value of property blocked.
39518
39613
  *
@@ -40702,7 +40797,7 @@ declare namespace sap {
40702
40797
  *
40703
40798
  * @ui5-protected Do not call from applications (only from related classes in the framework)
40704
40799
  */
40705
- enhanceAccessibilityState(
40800
+ enhanceAccessibilityState?(
40706
40801
  /**
40707
40802
  * The Control/Element for which ARIA properties are collected
40708
40803
  */
@@ -40849,6 +40944,36 @@ declare namespace sap {
40849
40944
  */
40850
40945
  sModelName?: string
40851
40946
  ): sap.ui.model.ContextBinding | undefined;
40947
+ /**
40948
+ * ID of the element which is the current target of the association {@link #getFieldHelpDisplay fieldHelpDisplay},
40949
+ * or `null`.
40950
+ */
40951
+ getFieldHelpDisplay(): sap.ui.core.ID | null;
40952
+ /**
40953
+ * This function (if available on the concrete subclass) provides information for the field help.
40954
+ *
40955
+ * Applications must not call this hook method directly, it is called by the framework.
40956
+ *
40957
+ * Subclasses should implement this hook to provide any necessary information for displaying field help:
40958
+ *
40959
+ *
40960
+ * ```javascript
40961
+ *
40962
+ * MyElement.prototype.getFieldHelpInfo = function() {
40963
+ * return {
40964
+ * label: "some label"
40965
+ * };
40966
+ * };
40967
+ * ```
40968
+ *
40969
+ *
40970
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
40971
+ *
40972
+ * @returns Field Help Information of the element.
40973
+ */
40974
+ getFieldHelpInfo?(): {
40975
+ label: string;
40976
+ };
40852
40977
  /**
40853
40978
  * Returns the DOM Element that should get the focus or `null` if there's no such element currently.
40854
40979
  *
@@ -41059,6 +41184,19 @@ declare namespace sap {
41059
41184
  * @returns Whether the element can get the focus after calling {@link #focus}
41060
41185
  */
41061
41186
  isFocusable(): boolean;
41187
+ /**
41188
+ * Handles the 'focusfail' event by attempting to find and focus on a tabbable element. The 'focusfail'
41189
+ * event is triggered when the current element, which initially holds the focus, becomes disabled or invisible.
41190
+ * The event is received by the parent of the element that failed to retain the focus.
41191
+ *
41192
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
41193
+ */
41194
+ onfocusfail(
41195
+ /**
41196
+ * The event object containing the source element that failed to gain focus.
41197
+ */
41198
+ oEvent: Event
41199
+ ): void;
41062
41200
  /**
41063
41201
  * This function either calls set[sPropertyName] or get[sPropertyName] with the specified property name
41064
41202
  * depending if an `oValue` is provided or not.
@@ -41177,6 +41315,19 @@ declare namespace sap {
41177
41315
  * @ui5-protected Do not call from applications (only from related classes in the framework)
41178
41316
  */
41179
41317
  rerender(): void;
41318
+ /**
41319
+ * Sets the associated {@link #getFieldHelpDisplay fieldHelpDisplay}.
41320
+ *
41321
+ *
41322
+ * @returns Reference to `this` in order to allow method chaining
41323
+ */
41324
+ setFieldHelpDisplay(
41325
+ /**
41326
+ * ID of an element which becomes the new target of this fieldHelpDisplay association; alternatively, an
41327
+ * element instance may be given
41328
+ */
41329
+ oFieldHelpDisplay: sap.ui.core.ID | sap.ui.core.Element
41330
+ ): this;
41180
41331
  /**
41181
41332
  * Sets the {@link sap.ui.core.LayoutData} defining the layout constraints for this control when it is used
41182
41333
  * inside a layout.
@@ -50444,6 +50595,27 @@ declare namespace sap {
50444
50595
  */
50445
50596
  Polite = "Polite",
50446
50597
  }
50598
+ /**
50599
+ * Defines the selection mode of the menu items.
50600
+ *
50601
+ * This enum is part of the 'sap/ui/core/library' module export and must be accessed by the property 'ItemSelectionMode'.
50602
+ *
50603
+ * @since 1.127.0
50604
+ */
50605
+ enum ItemSelectionMode {
50606
+ /**
50607
+ * Multi selection mode (more than one menu item can be selected).
50608
+ */
50609
+ MultiSelect = "undefined",
50610
+ /**
50611
+ * No selection mode.
50612
+ */
50613
+ None = "undefined",
50614
+ /**
50615
+ * Single selection mode (only one menu item can be selected).
50616
+ */
50617
+ SingleSelect = "undefined",
50618
+ }
50447
50619
  /**
50448
50620
  * Specifies possible message types.
50449
50621
  *
@@ -63159,7 +63331,7 @@ declare namespace sap {
63159
63331
  * of reset or failure.
63160
63332
  *
63161
63333
  * Since 1.125.0, deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
63162
- * is supported. As a precondition, the context must not be both {@link #setKeepAlive kept-alive} and hidden
63334
+ * is supported. As a precondition, the context must not be both {@link #setKeepAlive kept alive} and hidden
63163
63335
  * (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
63164
63336
  * Such a deletion is not a pending change.
63165
63337
  * See:
@@ -63217,14 +63389,22 @@ declare namespace sap {
63217
63389
  */
63218
63390
  destroy(): void;
63219
63391
  /**
63220
- * Expands the group node that this context points to.
63392
+ * Expands the group node that this context points to. Since 1.127.0, it is possible to expand a group node
63393
+ * by a given number of levels.
63221
63394
  * See:
63222
63395
  * #collapse
63223
63396
  * #isExpanded
63224
63397
  *
63225
63398
  * @since 1.77.0
63226
63399
  */
63227
- expand(): void;
63400
+ expand(
63401
+ /**
63402
+ * The number of levels to expand (@experimental as of version 1.127.0), `iLevels >= Number.MAX_SAFE_INTEGER`
63403
+ * can be used to expand all levels. If a node is expanded a second time, the expand state of the descendants
63404
+ * is not changed.
63405
+ */
63406
+ iLevels?: number
63407
+ ): void;
63228
63408
  /**
63229
63409
  * Returns the binding this context belongs to.
63230
63410
  *
@@ -64169,7 +64349,7 @@ declare namespace sap {
64169
64349
  * because they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} (since 1.97.0)
64170
64350
  * or {@link sap.ui.model.odata.v4.Context#delete deleted} (since 1.108.0) context of this binding. Since
64171
64351
  * 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding }
64172
- * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
64352
+ * are treated as kept alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
64173
64353
  * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
64174
64354
  */
64175
64355
  bIgnoreKeptAlive?: boolean
@@ -65107,7 +65287,7 @@ declare namespace sap {
65107
65287
  * because they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} (since 1.97.0)
65108
65288
  * or {@link sap.ui.model.odata.v4.Context#delete deleted} (since 1.108.0) context of this binding. Since
65109
65289
  * 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding }
65110
- * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
65290
+ * are treated as kept alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
65111
65291
  * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
65112
65292
  */
65113
65293
  bIgnoreKeptAlive?: boolean
@@ -65977,6 +66157,11 @@ declare namespace sap {
65977
66157
  * results in "@com.sap.vocabularies.Common.v1.Label" and a slash does not make any difference as long as
65978
66158
  * the annotation does not have a "$Type" property. A technical property (that is, a numerical segment
65979
66159
  * or one starting with a "$") immediately before "@sapui.name" is invalid, for example "/$EntityContainer@sapui.name".
66160
+ * Since 1.127.0, "@sapui.name" can also be used to access the resulting name of an entity set via
66161
+ * a navigation property binding. This allows XML Templating to use "${entitySet>@sapui.name}" no matter
66162
+ * whether the variable "entitySet" refers to "/TEAMS" or "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES".
66163
+ * This way, "/TEAMS@sapui.name" results in "TEAMS" and "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES@sapui.name"
66164
+ * results either in a simple name like "EMPLOYEES" or maybe in a path like "some.other.EntityContainer/SomeEntitySet".
65980
66165
  * The path must not continue after "@sapui.name".
65981
66166
  *
65982
66167
  * If the current object is a string value, that string value is treated as a relative path and followed
@@ -66413,7 +66598,8 @@ declare namespace sap {
66413
66598
  synchronizationMode?: string;
66414
66599
  /**
66415
66600
  * The group ID that is used for update requests. If no update group ID is specified, `mParameters.groupId`
66416
- * is used. Valid update group IDs are `undefined`, '$auto', '$direct' or an application group ID.
66601
+ * is used. Valid update group IDs are `undefined`, '$auto', '$auto.*', '$direct' or an application group
66602
+ * ID.
66417
66603
  */
66418
66604
  updateGroupId?: string;
66419
66605
  /**
@@ -66777,9 +66963,8 @@ declare namespace sap {
66777
66963
  * If the target type specified in the corresponding control property's binding info is "any" and the binding
66778
66964
  * is relative or points to metadata, the binding may have an object value; in this case and unless the
66779
66965
  * binding refers to an action advertisement the binding's mode must be {@link sap.ui.model.BindingMode.OneTime}.
66780
- * {@link sap.ui.model.BindingMode.OneWay OneWay} is also supported (@experimental as of version 1.126.0),
66781
- * but client-side updates of the object are not supported and `$$patchWithoutSideEffects` should be used
66782
- * for the parent entity.
66966
+ * {@link sap.ui.model.BindingMode.OneWay OneWay} is also supported (@experimental as of version 1.126.0)
66967
+ * for complex types and collections thereof; for entity types, use {@link #bindContext} instead.
66783
66968
  * See:
66784
66969
  * sap.ui.base.ManagedObject#bindProperty
66785
66970
  * sap.ui.model.Model#bindProperty
@@ -67513,7 +67698,7 @@ declare namespace sap {
67513
67698
  * because they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} (since 1.97.0)
67514
67699
  * or {@link sap.ui.model.odata.v4.Context#delete deleted} (since 1.108.0) context of this binding. Since
67515
67700
  * 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding }
67516
- * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
67701
+ * are treated as kept alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
67517
67702
  * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
67518
67703
  */
67519
67704
  bIgnoreKeptAlive?: boolean
@@ -85672,6 +85857,8 @@ declare namespace sap {
85672
85857
 
85673
85858
  "sap/ui/dom/includeStylesheet": undefined;
85674
85859
 
85860
+ "sap/ui/dom/isElementCovered": undefined;
85861
+
85675
85862
  "sap/ui/dom/isHidden": undefined;
85676
85863
 
85677
85864
  "sap/ui/dom/jquery/Aria": undefined;
@@ -86050,6 +86237,10 @@ declare namespace sap {
86050
86237
 
86051
86238
  "sap/ui/test/RecordReplay": undefined;
86052
86239
 
86240
+ "sap/ui/test/utils/nextUIUpdate": undefined;
86241
+
86242
+ "sap/ui/test/utils/waitForThemeApplied": undefined;
86243
+
86053
86244
  "sap/ui/thirdparty/jquery": undefined;
86054
86245
 
86055
86246
  "sap/ui/util/ActivityDetection": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.0
1
+ // For Library Version: 1.127.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.0
1
+ // For Library Version: 1.127.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1328,6 +1328,8 @@ declare namespace sap {
1328
1328
 
1329
1329
  "sap/ui/fl/apply/_internal/changes/descriptor/app/RemoveAllInboundsExceptOne": undefined;
1330
1330
 
1331
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/SetAch": undefined;
1332
+
1331
1333
  "sap/ui/fl/apply/_internal/changes/descriptor/app/SetTitle": undefined;
1332
1334
 
1333
1335
  "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.0
1
+ // For Library Version: 1.127.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -890,6 +890,18 @@ declare namespace sap {
890
890
  | sap.ui.base.ManagedObject.PropertyBindingInfo
891
891
  | `{${string}}`;
892
892
 
893
+ /**
894
+ * If the card should change depending on its size. This property is temporary. Should be used to enable
895
+ * the feature for cards where it is needed.
896
+ *
897
+ * @since 1.127
898
+ * @experimental (since 1.127)
899
+ */
900
+ useProgressiveDisclosure?:
901
+ | boolean
902
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
903
+ | `{${string}}`;
904
+
893
905
  /**
894
906
  * Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
895
907
  * is destroyed when the property `manifest` changes.
@@ -1731,6 +1743,20 @@ declare namespace sap {
1731
1743
  */
1732
1744
  bIgnoreKeyFallback?: boolean
1733
1745
  ): string;
1746
+ /**
1747
+ * Gets current value of property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
1748
+ *
1749
+ * If the card should change depending on its size. This property is temporary. Should be used to enable
1750
+ * the feature for cards where it is needed.
1751
+ *
1752
+ * Default value is `false`.
1753
+ *
1754
+ * @since 1.127
1755
+ * @experimental (since 1.127)
1756
+ *
1757
+ * @returns Value of property `useProgressiveDisclosure`
1758
+ */
1759
+ getUseProgressiveDisclosure(): boolean;
1734
1760
  /**
1735
1761
  * Hide the blocking message that is shown in the card by `showBlockingMessage` call.
1736
1762
  *
@@ -2109,6 +2135,27 @@ declare namespace sap {
2109
2135
  */
2110
2136
  sReferenceId?: string
2111
2137
  ): this;
2138
+ /**
2139
+ * Sets a new value for property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
2140
+ *
2141
+ * If the card should change depending on its size. This property is temporary. Should be used to enable
2142
+ * the feature for cards where it is needed.
2143
+ *
2144
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2145
+ *
2146
+ * Default value is `false`.
2147
+ *
2148
+ * @since 1.127
2149
+ * @experimental (since 1.127)
2150
+ *
2151
+ * @returns Reference to `this` in order to allow method chaining
2152
+ */
2153
+ setUseProgressiveDisclosure(
2154
+ /**
2155
+ * New value for property `useProgressiveDisclosure`
2156
+ */
2157
+ bUseProgressiveDisclosure?: boolean
2158
+ ): this;
2112
2159
  /**
2113
2160
  * Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
2114
2161
  * after the `cardReady` lifecycle hook in Component cards and Extensions.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.0
1
+ // For Library Version: 1.127.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -3031,7 +3031,7 @@ declare namespace sap {
3031
3031
  *
3032
3032
  * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
3033
3033
  * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
3034
- * In this case provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
3034
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
3035
3035
  * to the needed value.
3036
3036
  */
3037
3037
  title?:
@@ -3043,7 +3043,7 @@ declare namespace sap {
3043
3043
  * Toolbar of the `Form`.
3044
3044
  *
3045
3045
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
3046
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
3046
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
3047
3047
  * Use the right title level to meet the visual requirements. This might be theme-dependent.
3048
3048
  *
3049
3049
  * @since 1.36.0
@@ -3059,6 +3059,10 @@ declare namespace sap {
3059
3059
  /**
3060
3060
  * Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`).
3061
3061
  *
3062
+ * **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
3063
+ * `Title` is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel }
3064
+ * or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
3065
+ *
3062
3066
  * @since 1.28.0
3063
3067
  */
3064
3068
  ariaLabelledBy?: Array<sap.ui.core.Control | string>;
@@ -3138,6 +3142,10 @@ declare namespace sap {
3138
3142
  * **Note:** This attribute is only rendered if the `FormContainer` has it's own DOM representation in the
3139
3143
  * used `FormLayout`.
3140
3144
  *
3145
+ * **Note:** If there is more than one `FormContainers`, every `FormContainer` needs to have some title
3146
+ * or label (at least for screen reader support). If no `Title` is set, a label or title needs to be assigned
3147
+ * using the `ariaLabelledBy` association.
3148
+ *
3141
3149
  * @since 1.36.0
3142
3150
  */
3143
3151
  ariaLabelledBy?: Array<sap.ui.core.Control | string>;
@@ -3889,6 +3897,13 @@ declare namespace sap {
3889
3897
  /**
3890
3898
  * Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
3891
3899
  *
3900
+ * **Note:** If a `Toolbar` is used, the `Title` is ignored.
3901
+ *
3902
+ * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
3903
+ * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
3904
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
3905
+ * to the needed value.
3906
+ *
3892
3907
  * @since 1.16.3
3893
3908
  */
3894
3909
  title?:
@@ -3900,7 +3915,7 @@ declare namespace sap {
3900
3915
  * Toolbar of the `SimpleForm`.
3901
3916
  *
3902
3917
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
3903
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
3918
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
3904
3919
  *
3905
3920
  * @since 1.36.0
3906
3921
  */
@@ -3909,6 +3924,10 @@ declare namespace sap {
3909
3924
  /**
3910
3925
  * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
3911
3926
  *
3927
+ * **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
3928
+ * `Title` is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel }
3929
+ * or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
3930
+ *
3912
3931
  * @since 1.32.0
3913
3932
  */
3914
3933
  ariaLabelledBy?: Array<sap.ui.core.Control | string>;
@@ -4682,7 +4701,7 @@ declare namespace sap {
4682
4701
  *
4683
4702
  * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
4684
4703
  * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
4685
- * In this case provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
4704
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
4686
4705
  * to the needed value.
4687
4706
  */
4688
4707
  getTitle(): sap.ui.core.Title | string;
@@ -4692,7 +4711,7 @@ declare namespace sap {
4692
4711
  * Toolbar of the `Form`.
4693
4712
  *
4694
4713
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
4695
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
4714
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
4696
4715
  * Use the right title level to meet the visual requirements. This might be theme-dependent.
4697
4716
  *
4698
4717
  * @since 1.36.0
@@ -7480,6 +7499,13 @@ declare namespace sap {
7480
7499
  *
7481
7500
  * Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
7482
7501
  *
7502
+ * **Note:** If a `Toolbar` is used, the `Title` is ignored.
7503
+ *
7504
+ * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
7505
+ * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
7506
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
7507
+ * to the needed value.
7508
+ *
7483
7509
  * @since 1.16.3
7484
7510
  */
7485
7511
  getTitle(): sap.ui.core.Title | string;
@@ -7489,7 +7515,7 @@ declare namespace sap {
7489
7515
  * Toolbar of the `SimpleForm`.
7490
7516
  *
7491
7517
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
7492
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
7518
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
7493
7519
  *
7494
7520
  * @since 1.36.0
7495
7521
  */
@@ -14651,6 +14677,9 @@ declare namespace sap {
14651
14677
  /**
14652
14678
  * In this layout the content controls are rendered one below the other.
14653
14679
  *
14680
+ * **Note:** `VerticalLayout` is not a focusable element and therefore the inheritance of the `tooltip`
14681
+ * property isn't supported.
14682
+ *
14654
14683
  * @since 1.16.0
14655
14684
  */
14656
14685
  class VerticalLayout extends sap.ui.core.Control {