@openui5/ts-types-esm 1.96.0 → 1.96.4

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types-esm",
3
- "version": "1.96.0",
3
+ "version": "1.96.4",
4
4
  "description": "OpenUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * OpenUI5
3
- * Copyright 2009-2021 SAP SE or an SAP affiliate company.
3
+ * Copyright 2009-2022 SAP SE or an SAP affiliate company.
4
4
  *
5
5
  * Licensed under the Apache License, Version 2.0 (the "License");
6
6
  * you may not use this file except in compliance with the License.
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/f/library" {
4
4
  export interface IShellBar {
@@ -24255,12 +24255,12 @@ declare module "sap/m/GenericTag" {
24255
24255
  GenericTagValueState,
24256
24256
  } from "sap/m/library";
24257
24257
 
24258
+ import { ID, ValueState } from "sap/ui/core/library";
24259
+
24258
24260
  import Event from "sap/ui/base/Event";
24259
24261
 
24260
24262
  import ElementMetadata from "sap/ui/core/ElementMetadata";
24261
24263
 
24262
- import { ValueState } from "sap/ui/core/library";
24263
-
24264
24264
  import ObjectNumber from "sap/m/ObjectNumber";
24265
24265
 
24266
24266
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
@@ -24336,6 +24336,17 @@ declare module "sap/m/GenericTag" {
24336
24336
  * Returns a metadata object for class sap.m.GenericTag.
24337
24337
  */
24338
24338
  static getMetadata(): ElementMetadata;
24339
+ /**
24340
+ * @SINCE 1.96.4
24341
+ *
24342
+ * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
24343
+ */
24344
+ addAriaLabelledBy(
24345
+ /**
24346
+ * The ariaLabelledBy to add; if empty, nothing is inserted
24347
+ */
24348
+ vAriaLabelledBy: ID | Control
24349
+ ): this;
24339
24350
  /**
24340
24351
  * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.m.GenericTag`.
24341
24352
  *
@@ -24405,6 +24416,13 @@ declare module "sap/m/GenericTag" {
24405
24416
  */
24406
24417
  mParameters?: object
24407
24418
  ): this;
24419
+ /**
24420
+ * @SINCE 1.96.4
24421
+ *
24422
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
24423
+ * ariaLabelledBy}.
24424
+ */
24425
+ getAriaLabelledBy(): ID[];
24408
24426
  /**
24409
24427
  * Gets current value of property {@link #getDesign design}.
24410
24428
  *
@@ -24451,6 +24469,23 @@ declare module "sap/m/GenericTag" {
24451
24469
  * Default value is `None`.
24452
24470
  */
24453
24471
  getValueState(): GenericTagValueState | keyof typeof GenericTagValueState;
24472
+ /**
24473
+ * @SINCE 1.96.4
24474
+ *
24475
+ * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
24476
+ */
24477
+ removeAllAriaLabelledBy(): ID[];
24478
+ /**
24479
+ * @SINCE 1.96.4
24480
+ *
24481
+ * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
24482
+ */
24483
+ removeAriaLabelledBy(
24484
+ /**
24485
+ * The ariaLabelledBy to be removed or its index or ID
24486
+ */
24487
+ vAriaLabelledBy: int | ID | Control
24488
+ ): ID;
24454
24489
  /**
24455
24490
  * Sets a new value for property {@link #getDesign design}.
24456
24491
  *
@@ -24555,6 +24590,14 @@ declare module "sap/m/GenericTag" {
24555
24590
  */
24556
24591
  value?: ObjectNumber;
24557
24592
 
24593
+ /**
24594
+ * @SINCE 1.96.4
24595
+ *
24596
+ * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy). Note:
24597
+ * This is a downported feature introduced in version 1.97.0.
24598
+ */
24599
+ ariaLabelledBy?: Array<Control | string>;
24600
+
24558
24601
  /**
24559
24602
  * Fired when the user clicks/taps on the control.
24560
24603
  */
@@ -24939,6 +24982,16 @@ declare module "sap/m/GenericTile" {
24939
24982
  * Text for navigate action button. Default Value is "Read More". Works only in ArticleMode.
24940
24983
  */
24941
24984
  getNavigationButtonText(): string;
24985
+ /**
24986
+ * @EXPERIMENTAL (since 1.96)
24987
+ *
24988
+ * Gets current value of property {@link #getPressEnabled pressEnabled}.
24989
+ *
24990
+ * Disables press event for the tile control.
24991
+ *
24992
+ * Default value is `true`.
24993
+ */
24994
+ getPressEnabled(): boolean;
24942
24995
  /**
24943
24996
  * @SINCE 1.46.0
24944
24997
  *
@@ -25707,6 +25760,13 @@ declare module "sap/m/GenericTile" {
25707
25760
  */
25708
25761
  enableNavigationButton?: boolean | PropertyBindingInfo;
25709
25762
 
25763
+ /**
25764
+ * @EXPERIMENTAL (since 1.96)
25765
+ *
25766
+ * Disables press event for the tile control.
25767
+ */
25768
+ pressEnabled?: boolean | PropertyBindingInfo;
25769
+
25710
25770
  /**
25711
25771
  * @EXPERIMENTAL (since 1.96)
25712
25772
  *
@@ -33094,6 +33154,10 @@ declare module "sap/m/InputBase" {
33094
33154
  * Defines the value of the control.
33095
33155
  */
33096
33156
  getValue(): string;
33157
+ /**
33158
+ * Gets the value of the accessibility description info field.
33159
+ */
33160
+ getValueDescriptionInfo(): string;
33097
33161
  /**
33098
33162
  * Gets current value of property {@link #getValueState valueState}.
33099
33163
  *
@@ -50374,6 +50438,9 @@ declare module "sap/m/ObjectHeader" {
50374
50438
  *
50375
50439
  * Determines the alternative text of the `ObjectHeader` icon. The text is displayed if the image for the
50376
50440
  * icon is not available, or cannot be displayed.
50441
+ *
50442
+ * **Note:** Provide an empty string value for the `iconAlt` property in case you want to use the icon for
50443
+ * decoration only.
50377
50444
  */
50378
50445
  getIconAlt(): string;
50379
50446
  /**
@@ -50964,18 +51031,13 @@ declare module "sap/m/ObjectHeader" {
50964
51031
  bIconActive?: boolean
50965
51032
  ): this;
50966
51033
  /**
50967
- * Sets a new value for property {@link #getIconAlt iconAlt}.
50968
- *
50969
- * Determines the alternative text of the `ObjectHeader` icon. The text is displayed if the image for the
50970
- * icon is not available, or cannot be displayed.
50971
- *
50972
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
51034
+ * Sets the alternative text of the `ObjectHeader` icon.
50973
51035
  */
50974
51036
  setIconAlt(
50975
51037
  /**
50976
- * New value for property `iconAlt`
51038
+ * the alternative icon text
50977
51039
  */
50978
- sIconAlt?: string
51040
+ sIconAlt: boolean
50979
51041
  ): this;
50980
51042
  /**
50981
51043
  * Sets a new value for property {@link #getIconDensityAware iconDensityAware}.
@@ -51387,6 +51449,9 @@ declare module "sap/m/ObjectHeader" {
51387
51449
  /**
51388
51450
  * Determines the alternative text of the `ObjectHeader` icon. The text is displayed if the image for the
51389
51451
  * icon is not available, or cannot be displayed.
51452
+ *
51453
+ * **Note:** Provide an empty string value for the `iconAlt` property in case you want to use the icon for
51454
+ * decoration only.
51390
51455
  */
51391
51456
  iconAlt?: string | PropertyBindingInfo;
51392
51457
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  /**
@@ -1340,6 +1340,14 @@ declare module "sap/tnt/SideNavigation" {
1340
1340
  item?: Item;
1341
1341
  }
1342
1342
  ): this;
1343
+ /**
1344
+ * @SINCE 1.96.2
1345
+ *
1346
+ * Gets current value of property {@link #getAriaLabel ariaLabel}.
1347
+ *
1348
+ * Specifies an optional aria-label that can be used by the screen readers.
1349
+ */
1350
+ getAriaLabel(): string;
1343
1351
  /**
1344
1352
  * Gets current value of property {@link #getExpanded expanded}.
1345
1353
  *
@@ -1381,6 +1389,21 @@ declare module "sap/tnt/SideNavigation" {
1381
1389
  * Specifies the currently selected key.
1382
1390
  */
1383
1391
  getSelectedKey(): string;
1392
+ /**
1393
+ * @SINCE 1.96.2
1394
+ *
1395
+ * Sets a new value for property {@link #getAriaLabel ariaLabel}.
1396
+ *
1397
+ * Specifies an optional aria-label that can be used by the screen readers.
1398
+ *
1399
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1400
+ */
1401
+ setAriaLabel(
1402
+ /**
1403
+ * New value for property `ariaLabel`
1404
+ */
1405
+ sAriaLabel?: string
1406
+ ): this;
1384
1407
  /**
1385
1408
  * Sets if the control is in expanded or collapsed mode.
1386
1409
  */
@@ -1454,6 +1477,13 @@ declare module "sap/tnt/SideNavigation" {
1454
1477
  */
1455
1478
  selectedKey?: string | PropertyBindingInfo;
1456
1479
 
1480
+ /**
1481
+ * @SINCE 1.96.2
1482
+ *
1483
+ * Specifies an optional aria-label that can be used by the screen readers.
1484
+ */
1485
+ ariaLabel?: string | PropertyBindingInfo;
1486
+
1457
1487
  /**
1458
1488
  * Defines the content inside the flexible part.
1459
1489
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.96.0
267
+ // For Library Version: 1.96.4
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -31245,14 +31245,6 @@ declare module "sap/ui/core/theming/Parameters" {
31245
31245
  * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
31246
31246
  * API calls for the same parameter name will always result in the same parameter value.
31247
31247
  *
31248
- * **Important, since 1.93:** When using the `Parameters.get()` API to retrieve theming parameters defined
31249
- * as CSS variables, please be aware that the API can also unknowingly retrieve arbitrary CSS variables
31250
- * defined in the DOM. All CSS variables defined via the `:root` pseudo-class can be retrieved this way.
31251
- * Please make sure to only access theming parameters defined in a UI5 theme/library.
31252
- *
31253
- *
31254
- *
31255
- *
31256
31248
  * The following API variants are available (see also the below examples):
31257
31249
  * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
31258
31250
  * returned
@@ -37058,10 +37050,9 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
37058
37050
  /**
37059
37051
  * A comma-separated list of property names that need to be selected.
37060
37052
  * If the `select` parameter is given, it has to contain all properties that are contained in the analytical
37061
- * information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}) and their associated
37062
- * dimensions and measures. It must not contain additional dimensions or measures or associated properties
37063
- * for additional dimensions or measures. But it may contain additional properties like a text property
37064
- * of a dimension that is also selected.
37053
+ * information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}). It must not
37054
+ * contain additional dimensions or measures or associated properties for additional dimensions or measures.
37055
+ * But it may contain additional properties like a text property of a dimension that is also selected.
37065
37056
  * All properties of the `select` parameter are also considered in {@link sap.ui.model.analytics.AnalyticalBinding#getDownloadUrl}.
37066
37057
  * The `select` parameter must not contain any duplicate entry.
37067
37058
  * If the `select` parameter does not fit to the analytical information or if the `select` parameter contains
@@ -37417,34 +37408,41 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
37417
37408
  * Updates the binding's structure with new analytical information.
37418
37409
  *
37419
37410
  * Analytical information is the mapping of UI columns to properties in the bound OData entity set. Every
37420
- * column object contains the name of the bound property and in addition:
37411
+ * column object contains the `name` of the bound property and in addition:
37421
37412
  * - A column bound to a dimension property has further boolean properties:
37422
- * grouped: dimension will be used for building groups
37423
- * - visible: if the column is visible, values for the related property will be fetched from the OData
37424
- * service
37413
+ * grouped: dimension is used for building groups
37425
37414
  * - inResult: if the column is not visible, but declared to be part of the result, values for the related
37426
- * property will also be fetched from the OData service
37415
+ * property are also fetched from the OData service
37416
+ * - visible: if the column is visible, values for the related property are fetched from the OData service
37417
+ *
37427
37418
  * - A column bound to a measure property has further boolean properties:
37428
- * total: totals and sub-totals will be provided for the measure at all aggregation levels
37419
+ * inResult: if the column is not visible, but declared to be part of the result, values for the related
37420
+ * property are also fetched from the OData service
37421
+ * - total: totals and sub-totals are provided for the measure at all aggregation levels
37422
+ * - visible: if the column is visible, values for the related property are fetched from the OData service
37429
37423
  *
37430
37424
  * - A column bound to a hierarchy property has further properties:
37431
- * grouped: boolean value; indicates whether the hierarchy will be used for building groups
37425
+ * grouped: boolean value; indicates whether the hierarchy is used for building groups
37432
37426
  * - level: integer value; the hierarchy level is mandatory for at least one of those columns that represent
37433
- * the same hierarchy.
37427
+ * the same hierarchy
37434
37428
  *
37435
37429
  * Invoking this function resets the state of the binding and subsequent data requests such as calls to
37436
- * getNodeContexts() will need to trigger OData requests in order to fetch the data that are in line with
37437
- * this analytical information.
37430
+ * getNodeContexts() trigger OData requests in order to fetch the data that are in line with this analytical
37431
+ * information.
37438
37432
  *
37439
- * Please be aware that a call of this function might lead to additional back-end requests, as well as a
37440
- * control re-rendering later on. Whenever possible use the API of the analytical control, instead of relying
37441
- * on the binding.
37433
+ * Be aware that a call of this function might lead to additional back-end requests, as well as a control
37434
+ * re-rendering later on. Whenever possible use the API of the analytical control, instead of relying on
37435
+ * the binding.
37442
37436
  */
37443
37437
  updateAnalyticalInfo(
37444
37438
  /**
37445
- * an array with objects holding the analytical information for every column, from left to right.
37439
+ * An array with objects holding the analytical information for every column
37440
+ */
37441
+ aColumns: object[],
37442
+ /**
37443
+ * Whether to fire a change event asynchronously even if columns didn't change
37446
37444
  */
37447
- aColumns: any[]
37445
+ bForceChange: boolean
37448
37446
  ): void;
37449
37447
  }
37450
37448
  }
@@ -53524,6 +53522,7 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53524
53522
  isInitial(): boolean;
53525
53523
  /**
53526
53524
  * @SINCE 1.95.0
53525
+ * @deprecated (since 1.96.5)
53527
53526
  * @EXPERIMENTAL
53528
53527
  *
53529
53528
  * Moves the bound entity into the given list binding. This binding loses its data. The method may only
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/mdc/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import UI5Element from "sap/ui/core/Element";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,8 +1,8 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
5
- * @SINCE 1.96.0
5
+ * @SINCE 1.96.4
6
6
  *
7
7
  * Defines the Audiences.
8
8
  */
@@ -21,7 +21,7 @@ declare module "sap/ui/support/library" {
21
21
  Internal = "Internal",
22
22
  }
23
23
  /**
24
- * @SINCE 1.96.0
24
+ * @SINCE 1.96.4
25
25
  *
26
26
  * Issue Categories.
27
27
  */
@@ -76,7 +76,7 @@ declare module "sap/ui/support/library" {
76
76
  Usage = "Usage",
77
77
  }
78
78
  /**
79
- * @SINCE 1.96.0
79
+ * @SINCE 1.96.4
80
80
  *
81
81
  * Analysis history formats.
82
82
  */
@@ -91,7 +91,7 @@ declare module "sap/ui/support/library" {
91
91
  String = "String",
92
92
  }
93
93
  /**
94
- * @SINCE 1.96.0
94
+ * @SINCE 1.96.4
95
95
  *
96
96
  * Defines severity types.
97
97
  */
@@ -110,7 +110,7 @@ declare module "sap/ui/support/library" {
110
110
  Medium = "Medium",
111
111
  }
112
112
  /**
113
- * @SINCE 1.96.0
113
+ * @SINCE 1.96.4
114
114
  *
115
115
  * Contains the available system presets.
116
116
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/ux3/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/webc/common/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/webc/fiori/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/ui/webc/main/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.0
1
+ // For Library Version: 1.96.4
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**