@sapui5/ts-types-esm 1.130.2 → 1.131.1

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.
Files changed (68) hide show
  1. package/package.json +1 -1
  2. package/types/{sap.ui.commons.d.ts → commons-1.131.0-esm-d.ts} +1 -1
  3. package/types/{core-1.130.0-esm-d.ts → core-1.131.0-esm-d.ts} +295 -300
  4. package/types/{sap.ui.dt.d.ts → dt-1.131.0-esm-d.ts} +1 -1
  5. package/types/index.d.ts +7 -7
  6. package/types/{mdc-1.130.0-esm-d.ts → mdc-1.131.0-esm-d.ts} +220 -103
  7. package/types/{mobile-1.130.0-esm-d.ts → mobile-1.131.0-esm-d.ts} +355 -25
  8. package/types/sap.apf.d.ts +1 -1
  9. package/types/sap.ca.ui.d.ts +1 -1
  10. package/types/sap.chart.d.ts +1 -1
  11. package/types/sap.collaboration.d.ts +1 -1
  12. package/types/sap.esh.search.ui.d.ts +47 -9
  13. package/types/sap.f.d.ts +238 -12
  14. package/types/sap.fe.base.d.ts +24 -1
  15. package/types/sap.fe.controls.d.ts +1 -1
  16. package/types/sap.fe.core.d.ts +10 -7
  17. package/types/sap.fe.ina.d.ts +1 -1
  18. package/types/sap.fe.macros.d.ts +203 -145
  19. package/types/sap.fe.navigation.d.ts +3 -3
  20. package/types/sap.fe.placeholder.d.ts +1 -1
  21. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  22. package/types/sap.fe.templates.d.ts +1 -1
  23. package/types/sap.fe.test.d.ts +1 -1
  24. package/types/sap.fe.tools.d.ts +1 -1
  25. package/types/sap.feedback.ui.d.ts +1 -1
  26. package/types/sap.gantt.d.ts +96 -9
  27. package/types/sap.insights.d.ts +1 -1
  28. package/types/sap.makit.d.ts +1 -1
  29. package/types/sap.me.d.ts +1 -1
  30. package/types/sap.ndc.d.ts +1 -1
  31. package/types/sap.ovp.d.ts +1 -1
  32. package/types/sap.rules.ui.d.ts +1 -1
  33. package/types/sap.sac.df.d.ts +1 -1
  34. package/types/sap.suite.ui.commons.d.ts +1 -1
  35. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  36. package/types/sap.suite.ui.microchart.d.ts +1 -1
  37. package/types/sap.ui.codeeditor.d.ts +1 -1
  38. package/types/sap.ui.comp.d.ts +143 -55
  39. package/types/sap.ui.export.d.ts +6 -6
  40. package/types/sap.ui.fl.d.ts +1 -1
  41. package/types/sap.ui.generic.app.d.ts +2 -2
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +142 -2
  44. package/types/sap.ui.layout.d.ts +18 -21
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +1 -1
  49. package/types/sap.ui.table.d.ts +7 -4
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +263 -9
  52. package/types/sap.ui.vbm.d.ts +1 -1
  53. package/types/sap.ui.vk.d.ts +28 -1
  54. package/types/sap.ui.vtm.d.ts +1 -1
  55. package/types/sap.ui.webc.common.d.ts +1 -1
  56. package/types/sap.ui.webc.fiori.d.ts +1 -1
  57. package/types/sap.ui.webc.main.d.ts +1 -1
  58. package/types/sap.uiext.inbox.d.ts +1 -1
  59. package/types/sap.ushell.d.ts +7 -4
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +1 -1
  62. package/types/sap.viz.d.ts +1 -1
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +1 -1
  65. package/types/sap.zen.crosstab.d.ts +1 -1
  66. package/types/sap.zen.dsh.d.ts +1 -1
  67. package/types/{sap.tnt.d.ts → tnt-1.131.0-esm-d.ts} +1 -1
  68. package/types/{sap.ui.ux3.d.ts → ux3-1.131.0-esm-d.ts} +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -251,6 +251,14 @@ declare module "sap/ui/integration/library" {
251
251
  * The parameters of the action.
252
252
  */
253
253
  parameters: object;
254
+ /**
255
+ * If visual separator should be rendered before the item.
256
+ */
257
+ startsSection: boolean;
258
+ /**
259
+ * The nested actions.
260
+ */
261
+ actions: any[];
254
262
  };
255
263
 
256
264
  /**
@@ -331,7 +339,10 @@ declare module "sap/ui/integration/ActionDefinition" {
331
339
 
332
340
  import { CardActionType } from "sap/ui/integration/library";
333
341
 
334
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
342
+ import {
343
+ PropertyBindingInfo,
344
+ AggregationBindingInfo,
345
+ } from "sap/ui/base/ManagedObject";
335
346
 
336
347
  /**
337
348
  * Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
@@ -404,6 +415,18 @@ declare module "sap/ui/integration/ActionDefinition" {
404
415
  * @returns Metadata object describing this class
405
416
  */
406
417
  static getMetadata(): ElementMetadata;
418
+ /**
419
+ * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
420
+ *
421
+ *
422
+ * @returns Reference to `this` in order to allow method chaining
423
+ */
424
+ addActionDefinition(
425
+ /**
426
+ * The actionDefinition to add; if empty, nothing is inserted
427
+ */
428
+ oActionDefinition: ActionDefinition
429
+ ): this;
407
430
  /**
408
431
  * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
409
432
  *
@@ -453,6 +476,13 @@ declare module "sap/ui/integration/ActionDefinition" {
453
476
  */
454
477
  oListener?: object
455
478
  ): this;
479
+ /**
480
+ * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
481
+ *
482
+ *
483
+ * @returns Reference to `this` in order to allow method chaining
484
+ */
485
+ destroyActionDefinitions(): this;
456
486
  /**
457
487
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
458
488
  *
@@ -484,6 +514,13 @@ declare module "sap/ui/integration/ActionDefinition" {
484
514
  */
485
515
  mParameters?: object
486
516
  ): this;
517
+ /**
518
+ * Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
519
+ *
520
+ * Action Definitions which will appear as nested items in the menu. **Note**: The parent action definition
521
+ * will not fire a press anymore, it will only be used to hold the subitem.
522
+ */
523
+ getActionDefinitions(): ActionDefinition[];
487
524
  /**
488
525
  * Gets current value of property {@link #getButtonType buttonType}.
489
526
  *
@@ -491,6 +528,7 @@ declare module "sap/ui/integration/ActionDefinition" {
491
528
  *
492
529
  * Default value is `Transparent`.
493
530
  *
531
+ * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
494
532
  *
495
533
  * @returns Value of property `buttonType`
496
534
  */
@@ -525,6 +563,18 @@ declare module "sap/ui/integration/ActionDefinition" {
525
563
  * @returns Value of property `parameters`
526
564
  */
527
565
  getParameters(): object;
566
+ /**
567
+ * Gets current value of property {@link #getStartsSection startsSection}.
568
+ *
569
+ * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
570
+ * its separator is also not displayed.
571
+ *
572
+ * Default value is `false`.
573
+ *
574
+ *
575
+ * @returns Value of property `startsSection`
576
+ */
577
+ getStartsSection(): boolean;
528
578
  /**
529
579
  * Gets current value of property {@link #getText text}.
530
580
  *
@@ -556,6 +606,58 @@ declare module "sap/ui/integration/ActionDefinition" {
556
606
  * @returns Value of property `visible`
557
607
  */
558
608
  getVisible(): boolean;
609
+ /**
610
+ * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
611
+ * and returns its index if found or -1 otherwise.
612
+ *
613
+ *
614
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
615
+ */
616
+ indexOfActionDefinition(
617
+ /**
618
+ * The actionDefinition whose index is looked for
619
+ */
620
+ oActionDefinition: ActionDefinition
621
+ ): int;
622
+ /**
623
+ * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
624
+ *
625
+ *
626
+ * @returns Reference to `this` in order to allow method chaining
627
+ */
628
+ insertActionDefinition(
629
+ /**
630
+ * The actionDefinition to insert; if empty, nothing is inserted
631
+ */
632
+ oActionDefinition: ActionDefinition,
633
+ /**
634
+ * The `0`-based index the actionDefinition should be inserted at; for a negative value of `iIndex`, the
635
+ * actionDefinition is inserted at position 0; for a value greater than the current size of the aggregation,
636
+ * the actionDefinition is inserted at the last position
637
+ */
638
+ iIndex: int
639
+ ): this;
640
+ /**
641
+ * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
642
+ *
643
+ *
644
+ * @returns The removed actionDefinition or `null`
645
+ */
646
+ removeActionDefinition(
647
+ /**
648
+ * The actionDefinition to remove or its index or id
649
+ */
650
+ vActionDefinition: int | string | ActionDefinition
651
+ ): ActionDefinition | null;
652
+ /**
653
+ * Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
654
+ *
655
+ * Additionally, it unregisters them from the hosting UIArea.
656
+ *
657
+ *
658
+ * @returns An array of the removed elements (might be empty)
659
+ */
660
+ removeAllActionDefinitions(): ActionDefinition[];
559
661
  /**
560
662
  * Sets a new value for property {@link #getButtonType buttonType}.
561
663
  *
@@ -565,6 +667,7 @@ declare module "sap/ui/integration/ActionDefinition" {
565
667
  *
566
668
  * Default value is `Transparent`.
567
669
  *
670
+ * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
568
671
  *
569
672
  * @returns Reference to `this` in order to allow method chaining
570
673
  */
@@ -625,6 +728,25 @@ declare module "sap/ui/integration/ActionDefinition" {
625
728
  */
626
729
  oParameters: object
627
730
  ): this;
731
+ /**
732
+ * Sets a new value for property {@link #getStartsSection startsSection}.
733
+ *
734
+ * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
735
+ * its separator is also not displayed.
736
+ *
737
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
738
+ *
739
+ * Default value is `false`.
740
+ *
741
+ *
742
+ * @returns Reference to `this` in order to allow method chaining
743
+ */
744
+ setStartsSection(
745
+ /**
746
+ * New value for property `startsSection`
747
+ */
748
+ bStartsSection?: boolean
749
+ ): this;
628
750
  /**
629
751
  * Sets a new value for property {@link #getText text}.
630
752
  *
@@ -705,6 +827,8 @@ declare module "sap/ui/integration/ActionDefinition" {
705
827
 
706
828
  /**
707
829
  * The type of the action button.
830
+ *
831
+ * @deprecated (since 1.130) - All `ActionDefinitions` are now rendered as menu items and don't have `buttonType`.
708
832
  */
709
833
  buttonType?:
710
834
  | (ButtonType | keyof typeof ButtonType)
@@ -727,6 +851,22 @@ declare module "sap/ui/integration/ActionDefinition" {
727
851
  */
728
852
  parameters?: object | PropertyBindingInfo | `{${string}}`;
729
853
 
854
+ /**
855
+ * Defines whether a visual separator should be rendered before the item. **Note**: If an item is invisible
856
+ * its separator is also not displayed.
857
+ */
858
+ startsSection?: boolean | PropertyBindingInfo | `{${string}}`;
859
+
860
+ /**
861
+ * Action Definitions which will appear as nested items in the menu. **Note**: The parent action definition
862
+ * will not fire a press anymore, it will only be used to hold the subitem.
863
+ */
864
+ actionDefinitions?:
865
+ | ActionDefinition[]
866
+ | ActionDefinition
867
+ | AggregationBindingInfo
868
+ | `{${string}}`;
869
+
730
870
  /**
731
871
  * Fired when the action button is pressed.
732
872
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -9305,15 +9305,18 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
9305
9305
  } from "sap/ui/base/ManagedObject";
9306
9306
 
9307
9307
  /**
9308
- * A `SemanticFormElement` element is a special `FormElement` that contains semantically connected fields.
9309
- * These field controls are divided by delimiter controls. In display mode, they are rendered as one condensed
9310
- * string, in edit mode as separate fields.
9308
+ * A `SemanticFormElement` element is a special {@link sap.ui.layout.form.FormElement FormElement} that
9309
+ * contains semantically connected fields. These field controls are divided by delimiter controls. In display
9310
+ * mode, they are rendered as one condensed string, in edit mode as separate fields.
9311
9311
  *
9312
- * **Note:** Please use the `ColumnLayout` as `layout` of the `Form`. For other layouts, the field arrangement
9313
- * might not be suitable in every case.
9312
+ * Only controls implementing the {@link sap.ui.core.ISemanticFormContent ISemanticFormContent} interface
9313
+ * are supported.
9314
+ *
9315
+ * **Note:** Please use the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.Form#setLayout layout }
9316
+ * of the {@link sap.ui.layout.form.Form Form}. For other layouts, the field arrangement might not be suitable
9317
+ * in every case.
9314
9318
  *
9315
9319
  * @since 1.86.0
9316
- * @experimental (since 1.86)
9317
9320
  */
9318
9321
  export default class SemanticFormElement extends FormElement {
9319
9322
  /**
@@ -9411,13 +9414,11 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
9411
9414
  /**
9412
9415
  * Gets content of aggregation {@link #getFieldLabels fieldLabels}.
9413
9416
  *
9414
- * Labels of the individual fields. Can either be a `Label` control or a string.
9415
- *
9416
- * If a `Label` control is used, the properties of the `Label` can be set.
9417
+ * Labels of the individual fields.
9417
9418
  *
9418
- * These labels are not rendered directly. If the `Label` property of `SemanticFormElement` is not set,
9419
- * the texts of the labels are concatenated into the `Label` property of `SemanticFormElement`. Otherwise
9420
- * the set `Label` is shown.
9419
+ * These labels are not rendered directly. If the {@link #getLabel label} aggregation of `SemanticFormElement`
9420
+ * is not set, the texts of the labels are concatenated into the {@link #setLabel label} aggregation of
9421
+ * `SemanticFormElement`. Otherwise the set `Label` is shown.
9421
9422
  *
9422
9423
  * **Note:** If this aggregation is used, a label is assigned to every single field of `SemanticFormElement`.
9423
9424
  * The order of the labels and the fields must be the same.
@@ -9496,8 +9497,6 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
9496
9497
  }
9497
9498
  /**
9498
9499
  * Describes the settings that can be provided to the SemanticFormElement constructor.
9499
- *
9500
- * @experimental (since 1.86)
9501
9500
  */
9502
9501
  export interface $SemanticFormElementSettings extends $FormElementSettings {
9503
9502
  /**
@@ -9506,13 +9505,11 @@ declare module "sap/ui/layout/form/SemanticFormElement" {
9506
9505
  delimiter?: string | PropertyBindingInfo;
9507
9506
 
9508
9507
  /**
9509
- * Labels of the individual fields. Can either be a `Label` control or a string.
9510
- *
9511
- * If a `Label` control is used, the properties of the `Label` can be set.
9508
+ * Labels of the individual fields.
9512
9509
  *
9513
- * These labels are not rendered directly. If the `Label` property of `SemanticFormElement` is not set,
9514
- * the texts of the labels are concatenated into the `Label` property of `SemanticFormElement`. Otherwise
9515
- * the set `Label` is shown.
9510
+ * These labels are not rendered directly. If the {@link #getLabel label} aggregation of `SemanticFormElement`
9511
+ * is not set, the texts of the labels are concatenated into the {@link #setLabel label} aggregation of
9512
+ * `SemanticFormElement`. Otherwise the set `Label` is shown.
9516
9513
  *
9517
9514
  * **Note:** If this aggregation is used, a label is assigned to every single field of `SemanticFormElement`.
9518
9515
  * The order of the labels and the fields must be the same.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/richtexteditor/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -5476,7 +5476,8 @@ declare module "sap/ui/table/RowSettings" {
5476
5476
  *
5477
5477
  * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
5478
5478
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
5479
- * or {@link sap.ui.core.IndicationColor}.
5479
+ * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
5480
+ * for accessibility contrast reasons).
5480
5481
  *
5481
5482
  * Accessibility support is provided through the associated {@link sap.ui.table.RowSettings#setHighlightText highlightText }
5482
5483
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -5526,7 +5527,8 @@ declare module "sap/ui/table/RowSettings" {
5526
5527
  *
5527
5528
  * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
5528
5529
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
5529
- * or {@link sap.ui.core.IndicationColor}.
5530
+ * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
5531
+ * for accessibility contrast reasons).
5530
5532
  *
5531
5533
  * Accessibility support is provided through the associated {@link sap.ui.table.RowSettings#setHighlightText highlightText }
5532
5534
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -5600,7 +5602,8 @@ declare module "sap/ui/table/RowSettings" {
5600
5602
  *
5601
5603
  * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
5602
5604
  * highlights are visible. Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
5603
- * or {@link sap.ui.core.IndicationColor}.
5605
+ * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
5606
+ * for accessibility contrast reasons).
5604
5607
  *
5605
5608
  * Accessibility support is provided through the associated {@link sap.ui.table.RowSettings#setHighlightText highlightText }
5606
5609
  * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.130.1
1
+ // For Library Version: 1.131.1
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4