@openui5/ts-types 1.108.19 → 1.108.21

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",
3
- "version": "1.108.19",
3
+ "version": "1.108.21",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  /**
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -14397,11 +14397,8 @@ declare namespace sap {
14397
14397
  __implements__sap_m_IScale: boolean;
14398
14398
 
14399
14399
  /**
14400
- * Returns how many tickmarks would be drawn on the screen.
14401
- *
14402
- * **Note:** There would always be a tickmark in the beginning and in the end of the slider, regardless
14403
- * of the value this method returns. The start and the end tickmark are taken into account for the later
14404
- * calculations.
14400
+ * Returns how many tickmarks would be drawn on the screen. The start and the end tickmark should be specified
14401
+ * in this method.
14405
14402
  *
14406
14403
  * @returns The number of tickmarks
14407
14404
  */
@@ -14441,9 +14438,6 @@ declare namespace sap {
14441
14438
  /**
14442
14439
  * Returns the number of tickmarks, which should be placed between labels.
14443
14440
  *
14444
- * **Note:** There would always be a tickmark in the beginning and in the end of the slider, regardless
14445
- * of the value that this method returns.
14446
- *
14447
14441
  * @returns The number of tickmarks
14448
14442
  */
14449
14443
  getTickmarksBetweenLabels(
@@ -14870,6 +14864,18 @@ declare namespace sap {
14870
14864
  | sap.ui.base.ManagedObject.PropertyBindingInfo
14871
14865
  | `{${string}}`;
14872
14866
 
14867
+ /**
14868
+ * @SINCE 1.120.0
14869
+ *
14870
+ * Determines whether the `Avatar` is active/toggled (default is set to `false`). Active state is meant
14871
+ * to be toggled when user clicks on the `Avatar`. The Active state is only applied, when the `Avatar` has
14872
+ * `press` listeners.
14873
+ */
14874
+ active?:
14875
+ | boolean
14876
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
14877
+ | `{${string}}`;
14878
+
14873
14879
  /**
14874
14880
  * A `sap.m.LightBox` instance, that will be opened automatically when the user interacts with the `Avatar`
14875
14881
  * control.
@@ -35518,6 +35524,20 @@ declare namespace sap {
35518
35524
  */
35519
35525
  mParameters?: object
35520
35526
  ): this;
35527
+ /**
35528
+ * @SINCE 1.120.0
35529
+ *
35530
+ * Gets current value of property {@link #getActive active}.
35531
+ *
35532
+ * Determines whether the `Avatar` is active/toggled (default is set to `false`). Active state is meant
35533
+ * to be toggled when user clicks on the `Avatar`. The Active state is only applied, when the `Avatar` has
35534
+ * `press` listeners.
35535
+ *
35536
+ * Default value is `false`.
35537
+ *
35538
+ * @returns Value of property `active`
35539
+ */
35540
+ getActive(): boolean;
35521
35541
  /**
35522
35542
  * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
35523
35543
  * ariaDescribedBy}.
@@ -35760,6 +35780,27 @@ declare namespace sap {
35760
35780
  */
35761
35781
  vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
35762
35782
  ): sap.ui.core.ID | null;
35783
+ /**
35784
+ * @SINCE 1.120.0
35785
+ *
35786
+ * Sets a new value for property {@link #getActive active}.
35787
+ *
35788
+ * Determines whether the `Avatar` is active/toggled (default is set to `false`). Active state is meant
35789
+ * to be toggled when user clicks on the `Avatar`. The Active state is only applied, when the `Avatar` has
35790
+ * `press` listeners.
35791
+ *
35792
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
35793
+ *
35794
+ * Default value is `false`.
35795
+ *
35796
+ * @returns Reference to `this` in order to allow method chaining
35797
+ */
35798
+ setActive(
35799
+ /**
35800
+ * New value for property `active`
35801
+ */
35802
+ bActive?: boolean
35803
+ ): this;
35763
35804
  /**
35764
35805
  * @SINCE 1.99.0
35765
35806
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -24,7 +24,8 @@ declare namespace sap {
24
24
 
25
25
  /**
26
26
  * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
27
- * loose. It is recommended to use narrow (smaller) paddings for numeric texts.
27
+ * loose. It is recommended to use narrow (smaller) paddings for numeric texts. **Note:** In Horizon theme
28
+ * there is only one mode and setting this property will not have effect.
28
29
  */
29
30
  renderMode?:
30
31
  | sap.tnt.RenderMode
@@ -35,7 +36,7 @@ declare namespace sap {
35
36
  * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
36
37
  * choose from 10 predefined background and text color combinations. The color schemes are non-semantic,
37
38
  * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
38
- * Fiori 3 theme. The default `colorScheme` is 7.
39
+ * Fiori 3 and Horizon themes. The default `colorScheme` is 7.
39
40
  */
40
41
  colorScheme?:
41
42
  | int
@@ -316,20 +317,19 @@ declare namespace sap {
316
317
  *
317
318
  * Overview:
318
319
  *
319
- * The control visualizes text information without user interaction. The text inside the control is always
320
- * in upper case. It can have smaller or larger side paddings which can be specified by the `renderMode`
321
- * property. The text-background color pair can be changed by setting a number between 1 and 10 that corresponds
322
- * to the 10 predefined color combinations of the `colorScheme` property. The control is designed to be
323
- * vertically aligned with UI5 Input and Button control families. When using `InfoLabel` in non-editable
324
- * `Forms`, `Tables`, etc., set `displayOnly=true` for best visual results.
320
+ * The control visualizes text information without user interaction. The text-background color pair can
321
+ * be changed by setting a number between 1 and 10 that corresponds to the 10 predefined color combinations
322
+ * of the `colorScheme` property. The control is designed to be vertically aligned with UI5 Input and Button
323
+ * control families. When using `InfoLabel` in non-editable `Forms`, `Tables`, etc., set `displayOnly=true`
324
+ * for best visual results.
325
325
  *
326
326
  * Usage Guidelines:
327
327
  * - If the text is longer than the width of the control, it doesn’t wrap. Instead, it’s represented as
328
328
  * ellipsis.
329
329
  * - When truncated, the full text in the control is not visible. Therefore, it’s recommended to make
330
330
  * more space for longer items to be fully displayed.
331
- * - Colors are not semantic and have no visual representation in sap_belize_hcb and sap_belize_hcw themes.
332
- *
331
+ * - Colors are not semantic and have no visual representation in sap_belize_hcb, sap_belize_hcw, sap_fiori_3_hcb
332
+ * and sap_fiori_3_hcw themes.
333
333
  * - The control shows plain text only, formatting is not visualized.
334
334
  */
335
335
  class InfoLabel
@@ -416,7 +416,7 @@ declare namespace sap {
416
416
  * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
417
417
  * choose from 10 predefined background and text color combinations. The color schemes are non-semantic,
418
418
  * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
419
- * Fiori 3 theme. The default `colorScheme` is 7.
419
+ * Fiori 3 and Horizon themes. The default `colorScheme` is 7.
420
420
  *
421
421
  * Default value is `7`.
422
422
  *
@@ -451,7 +451,8 @@ declare namespace sap {
451
451
  * Gets current value of property {@link #getRenderMode renderMode}.
452
452
  *
453
453
  * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
454
- * loose. It is recommended to use narrow (smaller) paddings for numeric texts.
454
+ * loose. It is recommended to use narrow (smaller) paddings for numeric texts. **Note:** In Horizon theme
455
+ * there is only one mode and setting this property will not have effect.
455
456
  *
456
457
  * Default value is `Loose`.
457
458
  *
@@ -494,7 +495,7 @@ declare namespace sap {
494
495
  * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
495
496
  * choose from 10 predefined background and text color combinations. The color schemes are non-semantic,
496
497
  * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
497
- * Fiori 3 theme. The default `colorScheme` is 7.
498
+ * Fiori 3 and Horizon themes. The default `colorScheme` is 7.
498
499
  *
499
500
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
500
501
  *
@@ -550,7 +551,8 @@ declare namespace sap {
550
551
  * Sets a new value for property {@link #getRenderMode renderMode}.
551
552
  *
552
553
  * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
553
- * loose. It is recommended to use narrow (smaller) paddings for numeric texts.
554
+ * loose. It is recommended to use narrow (smaller) paddings for numeric texts. **Note:** In Horizon theme
555
+ * there is only one mode and setting this property will not have effect.
554
556
  *
555
557
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
556
558
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.108.19
267
+ // For Library Version: 1.108.21
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -29983,6 +29983,8 @@ declare namespace sap {
29983
29983
  onDeactivate(): void;
29984
29984
  /**
29985
29985
  * @SINCE 1.15.1
29986
+ * @deprecated (since 1.108) - (starting with a patch release acc. to the changelog), recommended to use
29987
+ * the browser-native page lifecycle API, providing events such as 'pageshow' and 'pagehide'
29986
29988
  *
29987
29989
  * The window before unload hook. Override this method in your Component class implementation, to handle
29988
29990
  * cleanup before the real unload or to prompt a question to the user, if the component should be exited.
@@ -29993,6 +29995,8 @@ declare namespace sap {
29993
29995
  onWindowBeforeUnload(): string | undefined;
29994
29996
  /**
29995
29997
  * @SINCE 1.15.1
29998
+ * @deprecated (since 1.108) - (starting with a patch release acc. to the changelog), recommended to use
29999
+ * the browser-native API to listen for errors: window.addEventListener("error", function() { ... })
29996
30000
  *
29997
30001
  * The window error hook. Override this method in your Component class implementation to listen to unhandled
29998
30002
  * errors.
@@ -30013,6 +30017,9 @@ declare namespace sap {
30013
30017
  ): void;
30014
30018
  /**
30015
30019
  * @SINCE 1.15.1
30020
+ * @deprecated (since 1.108) - (starting with a patch release acc. to the changelog). Newer browser versions
30021
+ * deprecate the browser-native 'unload' event. Therefore, the former API won't reliably work anymore. Please
30022
+ * have a look at the browser-native page lifecycle API, e.g. its events 'pageshow' and 'pagehide'.
30016
30023
  *
30017
30024
  * The window unload hook. Override this method in your Component class implementation, to handle cleanup
30018
30025
  * of the component once the window will be unloaded (e.g. closed).
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -6627,14 +6627,14 @@ declare namespace sap {
6627
6627
  getColumns(): sap.ui.table.Column[];
6628
6628
  /**
6629
6629
  * Returns the context of a row by its index. Please note that for server-based models like OData, the supplied
6630
- * index might not have been loaded yet. If the context is not available at the client, the binding will
6630
+ * index might not have been loaded yet. If the context is not available at the client, the binding may
6631
6631
  * trigger a backend request and request this single context. Although this API looks synchronous it may
6632
6632
  * not return a context but load it and fire a change event on the binding.
6633
6633
  *
6634
6634
  * For server-based models you should consider to only make this API call when the index is within the currently
6635
6635
  * visible scroll area.
6636
6636
  *
6637
- * @returns The context at this index or `null`
6637
+ * @returns The context at this index if available
6638
6638
  */
6639
6639
  getContextByIndex(
6640
6640
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.19
1
+ // For Library Version: 1.108.21
2
2
 
3
3
  declare namespace sap {
4
4
  /**