@openui5/types 1.126.1 → 1.128.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -1506,12 +1506,20 @@ declare namespace sap {
1506
1506
 
1507
1507
  "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewInbound": undefined;
1508
1508
 
1509
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/AddTechnicalAttributes": undefined;
1510
+
1509
1511
  "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeDataSource": undefined;
1510
1512
 
1511
1513
  "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeInbound": undefined;
1512
1514
 
1515
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeOutbound": undefined;
1516
+
1513
1517
  "sap/ui/fl/apply/_internal/changes/descriptor/app/RemoveAllInboundsExceptOne": undefined;
1514
1518
 
1519
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/SetAch": undefined;
1520
+
1521
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/SetDescription": undefined;
1522
+
1515
1523
  "sap/ui/fl/apply/_internal/changes/descriptor/app/SetTitle": undefined;
1516
1524
 
1517
1525
  "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;
@@ -1552,6 +1560,8 @@ declare namespace sap {
1552
1560
 
1553
1561
  "sap/ui/fl/apply/_internal/extensionPoint/Registry": undefined;
1554
1562
 
1563
+ "sap/ui/fl/apply/_internal/flexObjects/AnnotationChange": undefined;
1564
+
1555
1565
  "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange": undefined;
1556
1566
 
1557
1567
  "sap/ui/fl/apply/_internal/flexObjects/CompVariant": undefined;
@@ -1654,8 +1664,6 @@ declare namespace sap {
1654
1664
 
1655
1665
  "sap/ui/fl/registry/Settings": undefined;
1656
1666
 
1657
- "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
1658
-
1659
1667
  "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
1660
1668
 
1661
1669
  "sap/ui/fl/support/_internal/getFlexSettings": undefined;
@@ -1712,7 +1720,7 @@ declare namespace sap {
1712
1720
 
1713
1721
  "sap/ui/fl/write/_internal/flexState/compVariants/CompVariantState": undefined;
1714
1722
 
1715
- "sap/ui/fl/write/_internal/flexState/FlexObjectState": undefined;
1723
+ "sap/ui/fl/write/_internal/flexState/FlexObjectManager": undefined;
1716
1724
 
1717
1725
  "sap/ui/fl/write/_internal/flexState/UI2Personalization/UI2PersonalizationState": undefined;
1718
1726
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -104,7 +104,7 @@ declare module "sap/ui/integration/library" {
104
104
  */
105
105
  export enum CardBlockingMessageType {
106
106
  /**
107
- * An error ocurred in the card.
107
+ * An error occurred in the card.
108
108
  */
109
109
  Error = "Error",
110
110
  /**
@@ -253,6 +253,45 @@ declare module "sap/ui/integration/library" {
253
253
  parameters: object;
254
254
  };
255
255
 
256
+ /**
257
+ * Card message strip types.
258
+ *
259
+ * This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
260
+ * 'CardMessageType'.
261
+ *
262
+ * @experimental (since 1.128)
263
+ */
264
+ export enum CardMessageType {
265
+ /**
266
+ * Message is an error
267
+ */
268
+ Error = "Error",
269
+ /**
270
+ * Message should be just an information
271
+ */
272
+ Information = "Information",
273
+ /**
274
+ * Informs the user that the content is busy at that moment with a loading operation. Blocks the content
275
+ * from interaction.
276
+ */
277
+ Loading = "Loading",
278
+ /**
279
+ * Message has no specific level
280
+ */
281
+ None = "None",
282
+ /**
283
+ * Message is a success message
284
+ */
285
+ Success = "Success",
286
+ /**
287
+ * Message is an informative brief toast message. For this type the default behavior is to auto close.
288
+ */
289
+ Toast = "Toast",
290
+ /**
291
+ * Message is a warning
292
+ */
293
+ Warning = "Warning",
294
+ }
256
295
  /**
257
296
  * Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
258
297
  * choosing or configuring a card.
@@ -716,6 +755,7 @@ declare module "sap/ui/integration/widgets/Card" {
716
755
  CardDisplayVariant,
717
756
  CardPreviewMode,
718
757
  CardArea,
758
+ CardMessageType,
719
759
  CardActionType,
720
760
  } from "sap/ui/integration/library";
721
761
 
@@ -729,7 +769,7 @@ declare module "sap/ui/integration/widgets/Card" {
729
769
 
730
770
  import Event from "sap/ui/base/Event";
731
771
 
732
- import { URI, ID, MessageType } from "sap/ui/core/library";
772
+ import { URI, ID } from "sap/ui/core/library";
733
773
 
734
774
  import Host from "sap/ui/integration/Host";
735
775
 
@@ -1503,6 +1543,20 @@ declare module "sap/ui/integration/widgets/Card" {
1503
1543
  */
1504
1544
  bIgnoreKeyFallback?: boolean
1505
1545
  ): string;
1546
+ /**
1547
+ * Gets current value of property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
1548
+ *
1549
+ * If the card should change depending on its size. This property is temporary. Should be used to enable
1550
+ * the feature for cards where it is needed.
1551
+ *
1552
+ * Default value is `false`.
1553
+ *
1554
+ * @since 1.127
1555
+ * @experimental (since 1.127)
1556
+ *
1557
+ * @returns Value of property `useProgressiveDisclosure`
1558
+ */
1559
+ getUseProgressiveDisclosure(): boolean;
1506
1560
  /**
1507
1561
  * Hide the blocking message that is shown in the card by `showBlockingMessage` call.
1508
1562
  *
@@ -1878,6 +1932,27 @@ declare module "sap/ui/integration/widgets/Card" {
1878
1932
  */
1879
1933
  sReferenceId?: string
1880
1934
  ): this;
1935
+ /**
1936
+ * Sets a new value for property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
1937
+ *
1938
+ * If the card should change depending on its size. This property is temporary. Should be used to enable
1939
+ * the feature for cards where it is needed.
1940
+ *
1941
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1942
+ *
1943
+ * Default value is `false`.
1944
+ *
1945
+ * @since 1.127
1946
+ * @experimental (since 1.127)
1947
+ *
1948
+ * @returns Reference to `this` in order to allow method chaining
1949
+ */
1950
+ setUseProgressiveDisclosure(
1951
+ /**
1952
+ * New value for property `useProgressiveDisclosure`
1953
+ */
1954
+ bUseProgressiveDisclosure?: boolean
1955
+ ): this;
1881
1956
  /**
1882
1957
  * Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
1883
1958
  * after the `cardReady` lifecycle hook in Component cards and Extensions.
@@ -1916,7 +1991,12 @@ declare module "sap/ui/integration/widgets/Card" {
1916
1991
  /**
1917
1992
  * Type of the message.
1918
1993
  */
1919
- sType: MessageType
1994
+ sType: CardMessageType | keyof typeof CardMessageType,
1995
+ /**
1996
+ * Close the message automatically. Default is `false` for most message types. It is `true` for message
1997
+ * type `Toast`. **Note** This property has no effect for message type `Loading`.
1998
+ */
1999
+ bAutoClose: boolean
1920
2000
  ): void;
1921
2001
  /**
1922
2002
  * Triggers an action inside the card.
@@ -2256,7 +2336,12 @@ declare module "sap/ui/integration/widgets/Card" {
2256
2336
  /**
2257
2337
  * Type of the message.
2258
2338
  */
2259
- sType: MessageType
2339
+ sType: CardMessageType | keyof typeof CardMessageType,
2340
+ /**
2341
+ * Close the message automatically. Default is `false` for most message types. It is `true` for message
2342
+ * type `Toast`. **Note** This property has no effect for message type `Loading`.
2343
+ */
2344
+ bAutoClose: boolean
2260
2345
  ): void;
2261
2346
  /**
2262
2347
  * Triggers an action inside the card.
@@ -2432,6 +2517,15 @@ declare module "sap/ui/integration/widgets/Card" {
2432
2517
  | PropertyBindingInfo
2433
2518
  | `{${string}}`;
2434
2519
 
2520
+ /**
2521
+ * If the card should change depending on its size. This property is temporary. Should be used to enable
2522
+ * the feature for cards where it is needed.
2523
+ *
2524
+ * @since 1.127
2525
+ * @experimental (since 1.127)
2526
+ */
2527
+ useProgressiveDisclosure?: boolean | PropertyBindingInfo | `{${string}}`;
2528
+
2435
2529
  /**
2436
2530
  * Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
2437
2531
  * is destroyed when the property `manifest` changes.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -6718,7 +6718,7 @@ declare module "sap/ui/layout/form/Form" {
6718
6718
  *
6719
6719
  * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
6720
6720
  * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
6721
- * In this case provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
6721
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
6722
6722
  * to the needed value.
6723
6723
  */
6724
6724
  getTitle(): Title | string;
@@ -6728,7 +6728,7 @@ declare module "sap/ui/layout/form/Form" {
6728
6728
  * Toolbar of the `Form`.
6729
6729
  *
6730
6730
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
6731
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
6731
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
6732
6732
  * Use the right title level to meet the visual requirements. This might be theme-dependent.
6733
6733
  *
6734
6734
  * @since 1.36.0
@@ -6944,7 +6944,7 @@ declare module "sap/ui/layout/form/Form" {
6944
6944
  *
6945
6945
  * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
6946
6946
  * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
6947
- * In this case provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
6947
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
6948
6948
  * to the needed value.
6949
6949
  */
6950
6950
  title?: string | Title | PropertyBindingInfo;
@@ -6953,7 +6953,7 @@ declare module "sap/ui/layout/form/Form" {
6953
6953
  * Toolbar of the `Form`.
6954
6954
  *
6955
6955
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
6956
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
6956
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
6957
6957
  * Use the right title level to meet the visual requirements. This might be theme-dependent.
6958
6958
  *
6959
6959
  * @since 1.36.0
@@ -6969,6 +6969,10 @@ declare module "sap/ui/layout/form/Form" {
6969
6969
  /**
6970
6970
  * Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`).
6971
6971
  *
6972
+ * **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
6973
+ * `Title` is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel }
6974
+ * or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
6975
+ *
6972
6976
  * @since 1.28.0
6973
6977
  */
6974
6978
  ariaLabelledBy?: Array<Control | string>;
@@ -7429,6 +7433,10 @@ declare module "sap/ui/layout/form/FormContainer" {
7429
7433
  * **Note:** This attribute is only rendered if the `FormContainer` has it's own DOM representation in the
7430
7434
  * used `FormLayout`.
7431
7435
  *
7436
+ * **Note:** If there is more than one `FormContainers`, every `FormContainer` needs to have some title
7437
+ * or label (at least for screen reader support). If no `Title` is set, a label or title needs to be assigned
7438
+ * using the `ariaLabelledBy` association.
7439
+ *
7432
7440
  * @since 1.36.0
7433
7441
  */
7434
7442
  ariaLabelledBy?: Array<Control | string>;
@@ -8379,13 +8387,13 @@ declare module "sap/ui/layout/form/ResponsiveGridLayout" {
8379
8387
  * and the labels are rendered in the same row as the fields or above the fields. This behavior can be influenced
8380
8388
  * by the properties of this layout control.
8381
8389
  *
8382
- * On the {@link sap.ui.layout.form.FormContainer FormContainers}, labels and content fields, {@link sap.ui.layout.GridGata GridData }
8383
- * can be used to change the default rendering. {@link sap.ui.layout.GridGata GridData} is not supported
8390
+ * On the {@link sap.ui.layout.form.FormContainer FormContainers}, labels and content fields, {@link sap.ui.layout.GridData GridData }
8391
+ * can be used to change the default rendering. {@link sap.ui.layout.GridData GridData} is not supported
8384
8392
  * for {@link sap.ui.layout.form.FormElement FormElements}.
8385
8393
  *
8386
- * **Note:** If {@link sap.ui.layout.GridGata GridData} is used, this may result in a much more complex
8394
+ * **Note:** If {@link sap.ui.layout.GridData GridData} is used, this may result in a much more complex
8387
8395
  * layout than the default one. This means that in some cases, the calculation for the other content may
8388
- * not bring the expected result. In such cases, {@link sap.ui.layout.GridGata GridData} should be used
8396
+ * not bring the expected result. In such cases, {@link sap.ui.layout.GridData GridData} should be used
8389
8397
  * for all content controls to disable the default behavior.
8390
8398
  *
8391
8399
  * This control cannot be used stand-alone, it just renders a {@link sap.ui.layout.form.Form Form}, so it
@@ -10075,6 +10083,13 @@ declare module "sap/ui/layout/form/SimpleForm" {
10075
10083
  *
10076
10084
  * Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
10077
10085
  *
10086
+ * **Note:** If a `Toolbar` is used, the `Title` is ignored.
10087
+ *
10088
+ * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
10089
+ * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
10090
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
10091
+ * to the needed value.
10092
+ *
10078
10093
  * @since 1.16.3
10079
10094
  */
10080
10095
  getTitle(): Title | string;
@@ -10084,7 +10099,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
10084
10099
  * Toolbar of the `SimpleForm`.
10085
10100
  *
10086
10101
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
10087
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
10102
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
10088
10103
  *
10089
10104
  * @since 1.36.0
10090
10105
  */
@@ -11041,6 +11056,13 @@ declare module "sap/ui/layout/form/SimpleForm" {
11041
11056
  /**
11042
11057
  * Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
11043
11058
  *
11059
+ * **Note:** If a `Toolbar` is used, the `Title` is ignored.
11060
+ *
11061
+ * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
11062
+ * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
11063
+ * In this case, provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level }
11064
+ * to the needed value.
11065
+ *
11044
11066
  * @since 1.16.3
11045
11067
  */
11046
11068
  title?: string | Title | PropertyBindingInfo;
@@ -11049,7 +11071,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
11049
11071
  * Toolbar of the `SimpleForm`.
11050
11072
  *
11051
11073
  * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it
11052
- * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association.
11074
+ * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association.
11053
11075
  *
11054
11076
  * @since 1.36.0
11055
11077
  */
@@ -11058,6 +11080,10 @@ declare module "sap/ui/layout/form/SimpleForm" {
11058
11080
  /**
11059
11081
  * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
11060
11082
  *
11083
+ * **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
11084
+ * `Title` is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel }
11085
+ * or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
11086
+ *
11061
11087
  * @since 1.32.0
11062
11088
  */
11063
11089
  ariaLabelledBy?: Array<Control | string>;
@@ -14977,6 +15003,9 @@ declare module "sap/ui/layout/VerticalLayout" {
14977
15003
  /**
14978
15004
  * In this layout the content controls are rendered one below the other.
14979
15005
  *
15006
+ * **Note:** `VerticalLayout` is not a focusable element and therefore the inheritance of the `tooltip`
15007
+ * property isn't supported.
15008
+ *
14980
15009
  * @since 1.16.0
14981
15010
  */
14982
15011
  export default class VerticalLayout extends Control {