@sapui5/ts-types-esm 1.140.0 → 1.141.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 (70) hide show
  1. package/package.json +1 -1
  2. package/types/{sap.ui.commons.d.ts → commons-1.141.0-esm-d.ts} +1 -1
  3. package/types/{sap.ui.core.d.ts → core-1.141.0-esm-d.ts} +130 -67
  4. package/types/dt-1.141.0-esm-d.ts +208 -0
  5. package/types/index.d.ts +7 -7
  6. package/types/{sap.ui.mdc.d.ts → mdc-1.141.0-esm-d.ts} +4 -4
  7. package/types/{sap.m.d.ts → mobile-1.141.0-esm-d.ts} +78 -9
  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 +2680 -1
  13. package/types/sap.f.d.ts +44 -3
  14. package/types/sap.fe.ariba.d.ts +1 -1
  15. package/types/sap.fe.base.d.ts +1 -1
  16. package/types/sap.fe.controls.d.ts +1 -1
  17. package/types/sap.fe.core.d.ts +84 -1
  18. package/types/sap.fe.ina.d.ts +1 -1
  19. package/types/sap.fe.macros.d.ts +367 -42
  20. package/types/sap.fe.navigation.d.ts +13 -15
  21. package/types/sap.fe.placeholder.d.ts +1 -1
  22. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  23. package/types/sap.fe.templates.d.ts +1 -1
  24. package/types/sap.fe.test.d.ts +1 -1
  25. package/types/sap.fe.tools.d.ts +1 -1
  26. package/types/sap.feedback.ui.d.ts +1 -1
  27. package/types/sap.gantt.d.ts +7 -1
  28. package/types/sap.insights.d.ts +1 -1
  29. package/types/sap.makit.d.ts +1 -1
  30. package/types/sap.me.d.ts +1 -1
  31. package/types/sap.ndc.d.ts +1 -1
  32. package/types/sap.ovp.d.ts +1 -1
  33. package/types/sap.rules.ui.d.ts +1 -1
  34. package/types/sap.sac.df.d.ts +20 -5
  35. package/types/sap.suite.ui.commons.d.ts +1 -1
  36. package/types/sap.suite.ui.generic.template.d.ts +41 -5
  37. package/types/sap.suite.ui.microchart.d.ts +1 -1
  38. package/types/sap.ui.codeeditor.d.ts +1 -1
  39. package/types/sap.ui.comp.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +8 -7
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +1 -1
  45. package/types/sap.ui.layout.d.ts +63 -47
  46. package/types/sap.ui.richtexteditor.d.ts +309 -9
  47. package/types/sap.ui.rta.d.ts +1 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +18 -4
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +55 -3
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +132 -1
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.ui.webc.common.d.ts +1 -1
  57. package/types/sap.ui.webc.fiori.d.ts +1 -1
  58. package/types/sap.ui.webc.main.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +32 -3
  61. package/types/sap.ushell_abap.d.ts +5 -1
  62. package/types/sap.uxap.d.ts +1 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
  68. package/types/{sap.tnt.d.ts → tnt-1.141.0-esm-d.ts} +1 -1
  69. package/types/{sap.ui.ux3.d.ts → ux3-1.141.0-esm-d.ts} +1 -1
  70. package/types/sap.ui.dt.d.ts +0 -7
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.1
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -6516,23 +6516,27 @@ declare module "sap/ui/layout/form/Form" {
6516
6516
  * A `Form` control arranges labels and fields (like input fields) into groups and rows. There are different
6517
6517
  * ways to visualize forms for different screen sizes.
6518
6518
  *
6519
- * A `Form` is structured into `FormContainers`. Each `FormContainer` consists of `FormElements`. The `FormElements`
6520
- * consists of a label and the form fields. A `Form` doesn't render its content by itself. The rendering
6521
- * is done by the assigned `FormLayout`. This is so that the rendering can be adopted to new UI requirements
6522
- * without changing the `Form` itself.
6519
+ * A `Form` is structured into `FormContainers`. Each {@link sap.ui.layout.form.FormContainer FormContainer }
6520
+ * consists of `FormElements`. The {@link sap.ui.layout.form.FormElement FormElement} consists of a label
6521
+ * and the form fields. A `Form` doesn't render its content on its own. The rendering is done by the assigned
6522
+ * {@link sap.ui.layout.form.FormLayout FormLayout}. This is so that the rendering can be adopted to new
6523
+ * UI requirements without changing the `Form` itself.
6523
6524
  *
6524
- * For the content of a `Form`, `VariantLayoutData` are supported to allow simple switching of the `FormLayout`.
6525
- * `LayoutData` on the content can be used to overwrite the default layout of the `Form`.
6525
+ * For the content of a `Form`, {@link sap.ui.core.VariantLayoutData VariantLayoutData} are supported to
6526
+ * allow simple switching of the `FormLayout`. `LayoutData` on the content can be used to overwrite the
6527
+ * default layout of the `Form`.
6526
6528
  *
6527
6529
  * The `Form` (and its sub-controls) automatically add label and field assignment to enable screen reader
6528
6530
  * support. It also adds keyboard support to navigate between the fields and groups inside the form.
6529
6531
  *
6530
- * **Warning:** Do not put any layout or other container controls into the `FormElement`. Views are also
6531
- * not supported. This could damage the visual layout, keyboard support and screen-reader support.
6532
+ * **Warning:** Do not put any layout or other container controls into the {@link sap.ui.layout.form.FormElement FormElement}.
6533
+ * Views are also not supported. This could damage the visual layout, keyboard support and screen-reader
6534
+ * support.
6532
6535
  *
6533
6536
  * If editable controls are used as content, the `editable` property must be set to `true`, otherwise to
6534
6537
  * `false`. If the `editable` property is set incorrectly, there will be visual issues like wrong label
6535
- * alignment or wrong spacing between the controls.
6538
+ * alignment or wrong spacing between the controls. In addition to that, wrong screen reader announcements
6539
+ * might occur.
6536
6540
  *
6537
6541
  * @since 1.16.0
6538
6542
  */
@@ -6673,7 +6677,8 @@ declare module "sap/ui/layout/form/Form" {
6673
6677
  *
6674
6678
  * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
6675
6679
  * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
6676
- * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
6680
+ * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly. In addition
6681
+ * to that, wrong screen reader announcements might occur.
6677
6682
  *
6678
6683
  * Default value is `false`.
6679
6684
  *
@@ -6817,7 +6822,8 @@ declare module "sap/ui/layout/form/Form" {
6817
6822
  *
6818
6823
  * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
6819
6824
  * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
6820
- * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
6825
+ * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly. In addition
6826
+ * to that, wrong screen reader announcements might occur.
6821
6827
  *
6822
6828
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6823
6829
  *
@@ -6908,7 +6914,8 @@ declare module "sap/ui/layout/form/Form" {
6908
6914
  *
6909
6915
  * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
6910
6916
  * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
6911
- * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
6917
+ * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly. In addition
6918
+ * to that, wrong screen reader announcements might occur.
6912
6919
  *
6913
6920
  * @since 1.20.0
6914
6921
  */
@@ -9528,7 +9535,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
9528
9535
  * a `{@link sap.ui.layout.form.Form Form}` control is created along with its `{@link sap.ui.layout.form.FormContainer FormContainer}`
9529
9536
  * elements and `{@link sap.ui.layout.form.FormElement FormElement}` elements, but the complexity in the
9530
9537
  * API is not exposed to the user.
9531
- * - A new `sap.ui.core.Title` element or `Toolbar` control starts a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`)
9538
+ * - A new {@link sap.ui.core.Title Title} element or `Toolbar` control starts a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`)
9532
9539
  * in the form.
9533
9540
  * - A new `Label` control starts a new row (`{@link sap.ui.layout.form.FormElement FormElement}`) in
9534
9541
  * the form.
@@ -9784,7 +9791,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
9784
9791
  * Gets content of aggregation {@link #getContent content}.
9785
9792
  *
9786
9793
  * The content of the form is structured in the following way:
9787
- * - Add a `sap.ui.core.Title` element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
9794
+ * - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
9788
9795
  *
9789
9796
  * - Add a `Label` control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
9790
9797
  *
@@ -9792,26 +9799,28 @@ declare module "sap/ui/layout/form/SimpleForm" {
9792
9799
  * - Use `LayoutData` to influence the layout for special cases in the single controls. For example, if
9793
9800
  * a `ColumnLayout` is used as a layout, the form content is weighted using 4 cells for the labels and 8
9794
9801
  * cells for the field part, for large size. If there is only little space, the labels are above the fields
9795
- * and each field uses 12 cells. If your input controls should influence their width, you can add `sap.ui.layout.ColumnElementData`
9796
- * to them via `setLayoutData` method. Ensure that the sum of the weights in the `ColumnElementData` is
9797
- * not more than 12, as this is the total width of the input control part of each form row. Example
9798
- * for a row where the `Input` uses 6 cells and the second `Input` uses 2 cells (using `ColumnElementData`):
9802
+ * and each field uses 12 cells. If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
9803
+ * to them via the {@link #setLayoutData setLayoutData} method. Ensure that the sum of the weights in the
9804
+ * {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12, as this is the total
9805
+ * width of the input control part of each form row. Example for a row where the {@link sap.m.Input Input }
9806
+ * uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
9799
9807
  *
9800
9808
  * ```javascript
9801
9809
  *
9802
9810
  * new sap.m.Label({text:"Label"});
9803
- * new sap.m.Input({value:"6 cells", layoutData: new sap.ui.layout.ColumnElementData({cellsLarge: 6, cellsSmall: 8})}),
9804
- * new sap.m.Input({value:"2 cells", layoutData: new sap.ui.layout.ColumnElementData({cellsLarge: 2, cellsSmall: 4})}),
9811
+ * new sap.m.Input({value:"6 cells", layoutData: new sap.ui.layout.form.ColumnElementData({cellsLarge: 6, cellsSmall: 8})}),
9812
+ * new sap.m.Input({value:"2 cells", layoutData: new sap.ui.layout.form.ColumnElementData({cellsLarge: 2, cellsSmall: 4})}),
9805
9813
  * ```
9806
9814
  *
9807
9815
  *
9808
- * For example, if a `ResponsiveGridLayout` is used as a layout, there are 12 cells in one row. Depending
9809
- * on the screen size the labels use the defined `labelSpan`. The remaining cells are used for the fields
9810
- * (and `emptySpan` if defined). The available cells are distributed to all fields in the row. If one field
9811
- * should use a fixed number of cells you can add `sap.ui.layout.GridData` to them via `setLayoutData` method.
9812
- * If there are additional fields in the row they will get the remaining cells. Example for a row
9813
- * with two `Input` controls where one uses four cells on small screens, one cell on medium screens and
9814
- * 2 cells on larger screens (using `ResponsiveGridLayout`):
9816
+ * For example, if a {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout} is used as a layout,
9817
+ * there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
9818
+ * remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
9819
+ * to all fields in the row. If one field should use a fixed number of cells you can add {@link sap.ui.layout.GridData GridData }
9820
+ * to them via the {@link #setLayoutData setLayoutData} method. If there are additional fields in the row
9821
+ * they will get the remaining cells. Example for a row with two {@link sap.m.Input Input} controls
9822
+ * where one uses four cells on small screens, one cell on medium screens and 2 cells on larger screens
9823
+ * (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
9815
9824
  * ```javascript
9816
9825
  *
9817
9826
  * new sap.m.Label({text:"Label"});
@@ -9826,7 +9835,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
9826
9835
  *
9827
9836
  * If editable controls are used as content, the `editable` property must be set to `true`, otherwise to
9828
9837
  * `false`. If the `editable` property is set incorrectly, there will be visual issues like wrong label
9829
- * alignment or wrong spacing between the controls.
9838
+ * alignment or wrong spacing between the controls. In addition to that, wrong screen reader announcements
9839
+ * might occur.
9830
9840
  */
9831
9841
  getContent(): UI5Element[];
9832
9842
  /**
@@ -9843,7 +9853,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
9843
9853
  *
9844
9854
  * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
9845
9855
  * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
9846
- * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
9856
+ * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly. In addition
9857
+ * to that, wrong screen reader announcements might occur.
9847
9858
  *
9848
9859
  * Default value is `false`.
9849
9860
  *
@@ -10364,7 +10375,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
10364
10375
  *
10365
10376
  * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
10366
10377
  * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
10367
- * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
10378
+ * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly. In addition
10379
+ * to that, wrong screen reader announcements might occur.
10368
10380
  *
10369
10381
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10370
10382
  *
@@ -10771,7 +10783,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
10771
10783
  *
10772
10784
  * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
10773
10785
  * might be misaligned, the labels might be rendered in the wrong mode, and the spacing between the single
10774
- * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly.
10786
+ * controls might be wrong. Also, controls that do not fit the mode might be rendered incorrectly. In addition
10787
+ * to that, wrong screen reader announcements might occur.
10775
10788
  */
10776
10789
  editable?: boolean | PropertyBindingInfo | `{${string}}`;
10777
10790
 
@@ -10987,7 +11000,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
10987
11000
 
10988
11001
  /**
10989
11002
  * The content of the form is structured in the following way:
10990
- * - Add a `sap.ui.core.Title` element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
11003
+ * - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
10991
11004
  *
10992
11005
  * - Add a `Label` control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
10993
11006
  *
@@ -10995,26 +11008,28 @@ declare module "sap/ui/layout/form/SimpleForm" {
10995
11008
  * - Use `LayoutData` to influence the layout for special cases in the single controls. For example, if
10996
11009
  * a `ColumnLayout` is used as a layout, the form content is weighted using 4 cells for the labels and 8
10997
11010
  * cells for the field part, for large size. If there is only little space, the labels are above the fields
10998
- * and each field uses 12 cells. If your input controls should influence their width, you can add `sap.ui.layout.ColumnElementData`
10999
- * to them via `setLayoutData` method. Ensure that the sum of the weights in the `ColumnElementData` is
11000
- * not more than 12, as this is the total width of the input control part of each form row. Example
11001
- * for a row where the `Input` uses 6 cells and the second `Input` uses 2 cells (using `ColumnElementData`):
11011
+ * and each field uses 12 cells. If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
11012
+ * to them via the {@link #setLayoutData setLayoutData} method. Ensure that the sum of the weights in the
11013
+ * {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12, as this is the total
11014
+ * width of the input control part of each form row. Example for a row where the {@link sap.m.Input Input }
11015
+ * uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
11002
11016
  *
11003
11017
  * ```javascript
11004
11018
  *
11005
11019
  * new sap.m.Label({text:"Label"});
11006
- * new sap.m.Input({value:"6 cells", layoutData: new sap.ui.layout.ColumnElementData({cellsLarge: 6, cellsSmall: 8})}),
11007
- * new sap.m.Input({value:"2 cells", layoutData: new sap.ui.layout.ColumnElementData({cellsLarge: 2, cellsSmall: 4})}),
11020
+ * new sap.m.Input({value:"6 cells", layoutData: new sap.ui.layout.form.ColumnElementData({cellsLarge: 6, cellsSmall: 8})}),
11021
+ * new sap.m.Input({value:"2 cells", layoutData: new sap.ui.layout.form.ColumnElementData({cellsLarge: 2, cellsSmall: 4})}),
11008
11022
  * ```
11009
11023
  *
11010
11024
  *
11011
- * For example, if a `ResponsiveGridLayout` is used as a layout, there are 12 cells in one row. Depending
11012
- * on the screen size the labels use the defined `labelSpan`. The remaining cells are used for the fields
11013
- * (and `emptySpan` if defined). The available cells are distributed to all fields in the row. If one field
11014
- * should use a fixed number of cells you can add `sap.ui.layout.GridData` to them via `setLayoutData` method.
11015
- * If there are additional fields in the row they will get the remaining cells. Example for a row
11016
- * with two `Input` controls where one uses four cells on small screens, one cell on medium screens and
11017
- * 2 cells on larger screens (using `ResponsiveGridLayout`):
11025
+ * For example, if a {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout} is used as a layout,
11026
+ * there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
11027
+ * remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
11028
+ * to all fields in the row. If one field should use a fixed number of cells you can add {@link sap.ui.layout.GridData GridData }
11029
+ * to them via the {@link #setLayoutData setLayoutData} method. If there are additional fields in the row
11030
+ * they will get the remaining cells. Example for a row with two {@link sap.m.Input Input} controls
11031
+ * where one uses four cells on small screens, one cell on medium screens and 2 cells on larger screens
11032
+ * (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
11018
11033
  * ```javascript
11019
11034
  *
11020
11035
  * new sap.m.Label({text:"Label"});
@@ -11029,7 +11044,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
11029
11044
  *
11030
11045
  * If editable controls are used as content, the `editable` property must be set to `true`, otherwise to
11031
11046
  * `false`. If the `editable` property is set incorrectly, there will be visual issues like wrong label
11032
- * alignment or wrong spacing between the controls.
11047
+ * alignment or wrong spacing between the controls. In addition to that, wrong screen reader announcements
11048
+ * might occur.
11033
11049
  */
11034
11050
  content?:
11035
11051
  | UI5Element[]
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.1
2
2
 
3
3
  declare module "sap/ui/richtexteditor/library" {
4
4
  /**
@@ -12,10 +12,6 @@ declare module "sap/ui/richtexteditor/library" {
12
12
  * Uses latest recommended TinyMCE version Current one is TinyMCE 7
13
13
  */
14
14
  TinyMCE = "TinyMCE",
15
- /**
16
- * Uses TinyMCE version 6 as editor
17
- */
18
- TinyMCE6 = "TinyMCE6",
19
15
  /**
20
16
  * Uses TinyMCE version 7 as editor
21
17
  */
@@ -36,6 +32,8 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
36
32
 
37
33
  import { ID, CSSSize, TextDirection } from "sap/ui/core/library";
38
34
 
35
+ import RichTextEditorFontFamily from "sap/ui/richtexteditor/RichTextEditorFontFamily";
36
+
39
37
  import Event from "sap/ui/base/Event";
40
38
 
41
39
  import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -263,6 +261,19 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
263
261
  */
264
262
  oCustomButton: Control
265
263
  ): this;
264
+ /**
265
+ * Adds some customFont to the aggregation {@link #getCustomFonts customFonts}.
266
+ *
267
+ * @since 1.141
268
+ *
269
+ * @returns Reference to `this` in order to allow method chaining
270
+ */
271
+ addCustomFont(
272
+ /**
273
+ * The customFont to add; if empty, nothing is inserted
274
+ */
275
+ oCustomFont: RichTextEditorFontFamily
276
+ ): this;
266
277
  /**
267
278
  * Allows to add a plugin (that must already be installed on the server) to the RichTextEditor.
268
279
  *
@@ -497,6 +508,14 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
497
508
  * @returns Reference to `this` in order to allow method chaining
498
509
  */
499
510
  destroyCustomButtons(): this;
511
+ /**
512
+ * Destroys all the customFonts in the aggregation {@link #getCustomFonts customFonts}.
513
+ *
514
+ * @since 1.141
515
+ *
516
+ * @returns Reference to `this` in order to allow method chaining
517
+ */
518
+ destroyCustomFonts(): this;
500
519
  /**
501
520
  * Destroys the footer in the aggregation {@link #getFooter footer}.
502
521
  *
@@ -659,12 +678,21 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
659
678
  * Gets content of aggregation {@link #getCustomButtons customButtons}.
660
679
  *
661
680
  * Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
662
- * only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is enabled
663
- * and all the requirements are fulfilled.
681
+ * only sap.m.Button is allowed. **Note:** customButtons are available only when the `customToolbar` is
682
+ * enabled and all the requirements are fulfilled.
664
683
  *
665
684
  * @since 1.48
666
685
  */
667
686
  getCustomButtons(): Control[];
687
+ /**
688
+ * Gets content of aggregation {@link #getCustomFonts customFonts}.
689
+ *
690
+ * Custom font families that can be used in the `RichTextEditor`. **Note:** Custom fonts are available only
691
+ * when the `customToolbar` is enabled.
692
+ *
693
+ * @since 1.141
694
+ */
695
+ getCustomFonts(): RichTextEditorFontFamily[];
668
696
  /**
669
697
  * Gets current value of property {@link #getCustomToolbar customToolbar}.
670
698
  *
@@ -996,6 +1024,20 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
996
1024
  */
997
1025
  oCustomButton: Control
998
1026
  ): int;
1027
+ /**
1028
+ * Checks for the provided `sap.ui.richtexteditor.RichTextEditorFontFamily` in the aggregation {@link #getCustomFonts customFonts}.
1029
+ * and returns its index if found or -1 otherwise.
1030
+ *
1031
+ * @since 1.141
1032
+ *
1033
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1034
+ */
1035
+ indexOfCustomFont(
1036
+ /**
1037
+ * The customFont whose index is looked for
1038
+ */
1039
+ oCustomFont: RichTextEditorFontFamily
1040
+ ): int;
999
1041
  /**
1000
1042
  * Inserts a customButton into the aggregation {@link #getCustomButtons customButtons}.
1001
1043
  *
@@ -1015,6 +1057,25 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
1015
1057
  */
1016
1058
  iIndex: int
1017
1059
  ): this;
1060
+ /**
1061
+ * Inserts a customFont into the aggregation {@link #getCustomFonts customFonts}.
1062
+ *
1063
+ * @since 1.141
1064
+ *
1065
+ * @returns Reference to `this` in order to allow method chaining
1066
+ */
1067
+ insertCustomFont(
1068
+ /**
1069
+ * The customFont to insert; if empty, nothing is inserted
1070
+ */
1071
+ oCustomFont: RichTextEditorFontFamily,
1072
+ /**
1073
+ * The `0`-based index the customFont should be inserted at; for a negative value of `iIndex`, the customFont
1074
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the customFont
1075
+ * is inserted at the last position
1076
+ */
1077
+ iIndex: int
1078
+ ): this;
1018
1079
  /**
1019
1080
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
1020
1081
  *
@@ -1033,6 +1094,16 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
1033
1094
  * @returns An array of the removed elements (might be empty)
1034
1095
  */
1035
1096
  removeAllCustomButtons(): Control[];
1097
+ /**
1098
+ * Removes all the controls from the aggregation {@link #getCustomFonts customFonts}.
1099
+ *
1100
+ * Additionally, it unregisters them from the hosting UIArea.
1101
+ *
1102
+ * @since 1.141
1103
+ *
1104
+ * @returns An array of the removed elements (might be empty)
1105
+ */
1106
+ removeAllCustomFonts(): RichTextEditorFontFamily[];
1036
1107
  /**
1037
1108
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
1038
1109
  *
@@ -1071,6 +1142,19 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
1071
1142
  */
1072
1143
  vCustomButton: int | string | Control
1073
1144
  ): Control | null;
1145
+ /**
1146
+ * Removes a customFont from the aggregation {@link #getCustomFonts customFonts}.
1147
+ *
1148
+ * @since 1.141
1149
+ *
1150
+ * @returns The removed customFont or `null`
1151
+ */
1152
+ removeCustomFont(
1153
+ /**
1154
+ * The customFont to remove or its index or id
1155
+ */
1156
+ vCustomFont: int | string | RichTextEditorFontFamily
1157
+ ): RichTextEditorFontFamily | null;
1074
1158
  /**
1075
1159
  * Removes the plugin with the given name/ID from the list of plugins to load
1076
1160
  *
@@ -1737,8 +1821,8 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
1737
1821
 
1738
1822
  /**
1739
1823
  * Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
1740
- * only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is enabled
1741
- * and all the requirements are fulfilled.
1824
+ * only sap.m.Button is allowed. **Note:** customButtons are available only when the `customToolbar` is
1825
+ * enabled and all the requirements are fulfilled.
1742
1826
  *
1743
1827
  * @since 1.48
1744
1828
  */
@@ -1748,6 +1832,18 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
1748
1832
  | AggregationBindingInfo
1749
1833
  | `{${string}}`;
1750
1834
 
1835
+ /**
1836
+ * Custom font families that can be used in the `RichTextEditor`. **Note:** Custom fonts are available only
1837
+ * when the `customToolbar` is enabled.
1838
+ *
1839
+ * @since 1.141
1840
+ */
1841
+ customFonts?:
1842
+ | RichTextEditorFontFamily[]
1843
+ | RichTextEditorFontFamily
1844
+ | AggregationBindingInfo
1845
+ | `{${string}}`;
1846
+
1751
1847
  /**
1752
1848
  * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
1753
1849
  *
@@ -1841,10 +1937,214 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
1841
1937
  >;
1842
1938
  }
1843
1939
 
1940
+ declare module "sap/ui/richtexteditor/RichTextEditorFontFamily" {
1941
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
1942
+
1943
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1944
+
1945
+ import { URI } from "sap/ui/core/library";
1946
+
1947
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1948
+
1949
+ /**
1950
+ * Represents a font family option for `RichTextEditor`.
1951
+ */
1952
+ export default class RichTextEditorFontFamily extends UI5Element {
1953
+ /**
1954
+ * Constructor for a new `RichTextEditorFontFamily`.
1955
+ *
1956
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1957
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1958
+ * of the syntax of the settings object.
1959
+ */
1960
+ constructor(
1961
+ /**
1962
+ * initial settings for the new control
1963
+ */
1964
+ mSettings?: $RichTextEditorFontFamilySettings
1965
+ );
1966
+ /**
1967
+ * Constructor for a new `RichTextEditorFontFamily`.
1968
+ *
1969
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1970
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1971
+ * of the syntax of the settings object.
1972
+ */
1973
+ constructor(
1974
+ /**
1975
+ * id for the new control, generated automatically if no id is given
1976
+ */
1977
+ sId?: string,
1978
+ /**
1979
+ * initial settings for the new control
1980
+ */
1981
+ mSettings?: $RichTextEditorFontFamilySettings
1982
+ );
1983
+
1984
+ /**
1985
+ * Creates a new subclass of class sap.ui.richtexteditor.RichTextEditorFontFamily with name `sClassName`
1986
+ * and enriches it with the information contained in `oClassInfo`.
1987
+ *
1988
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1989
+ *
1990
+ *
1991
+ * @returns Created class / constructor function
1992
+ */
1993
+ static extend<T extends Record<string, unknown>>(
1994
+ /**
1995
+ * Name of the class being created
1996
+ */
1997
+ sClassName: string,
1998
+ /**
1999
+ * Object literal with information about the class
2000
+ */
2001
+ oClassInfo?: sap.ClassInfo<T, RichTextEditorFontFamily>,
2002
+ /**
2003
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2004
+ * used by this class
2005
+ */
2006
+ FNMetaImpl?: Function
2007
+ ): Function;
2008
+ /**
2009
+ * Returns a metadata object for class sap.ui.richtexteditor.RichTextEditorFontFamily.
2010
+ *
2011
+ *
2012
+ * @returns Metadata object describing this class
2013
+ */
2014
+ static getMetadata(): ElementMetadata;
2015
+ /**
2016
+ * Gets current value of property {@link #getName name}.
2017
+ *
2018
+ * Used to identify the font in the editor. Names should be unique and descriptive.
2019
+ *
2020
+ *
2021
+ * @returns Value of property `name`
2022
+ */
2023
+ getName(): string;
2024
+ /**
2025
+ * Gets current value of property {@link #getText text}.
2026
+ *
2027
+ * The text displayed in the font family dropdown.
2028
+ *
2029
+ *
2030
+ * @returns Value of property `text`
2031
+ */
2032
+ getText(): string;
2033
+ /**
2034
+ * Gets current value of property {@link #getUrl url}.
2035
+ *
2036
+ * Used to load the font. The URL should point to a CSS file that defines the font-face.
2037
+ *
2038
+ *
2039
+ * @returns Value of property `url`
2040
+ */
2041
+ getUrl(): URI;
2042
+ /**
2043
+ * Gets current value of property {@link #getValue value}.
2044
+ *
2045
+ * The value of the font family. CSS font-family value that will be applied to the text.
2046
+ *
2047
+ *
2048
+ * @returns Value of property `value`
2049
+ */
2050
+ getValue(): string;
2051
+ /**
2052
+ * Sets a new value for property {@link #getName name}.
2053
+ *
2054
+ * Used to identify the font in the editor. Names should be unique and descriptive.
2055
+ *
2056
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2057
+ *
2058
+ *
2059
+ * @returns Reference to `this` in order to allow method chaining
2060
+ */
2061
+ setName(
2062
+ /**
2063
+ * New value for property `name`
2064
+ */
2065
+ sName?: string
2066
+ ): this;
2067
+ /**
2068
+ * Sets a new value for property {@link #getText text}.
2069
+ *
2070
+ * The text displayed in the font family dropdown.
2071
+ *
2072
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2073
+ *
2074
+ *
2075
+ * @returns Reference to `this` in order to allow method chaining
2076
+ */
2077
+ setText(
2078
+ /**
2079
+ * New value for property `text`
2080
+ */
2081
+ sText?: string
2082
+ ): this;
2083
+ /**
2084
+ * Sets a new value for property {@link #getUrl url}.
2085
+ *
2086
+ * Used to load the font. The URL should point to a CSS file that defines the font-face.
2087
+ *
2088
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2089
+ *
2090
+ *
2091
+ * @returns Reference to `this` in order to allow method chaining
2092
+ */
2093
+ setUrl(
2094
+ /**
2095
+ * New value for property `url`
2096
+ */
2097
+ sUrl?: URI
2098
+ ): this;
2099
+ /**
2100
+ * Sets a new value for property {@link #getValue value}.
2101
+ *
2102
+ * The value of the font family. CSS font-family value that will be applied to the text.
2103
+ *
2104
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2105
+ *
2106
+ *
2107
+ * @returns Reference to `this` in order to allow method chaining
2108
+ */
2109
+ setValue(
2110
+ /**
2111
+ * New value for property `value`
2112
+ */
2113
+ sValue?: string
2114
+ ): this;
2115
+ }
2116
+ /**
2117
+ * Describes the settings that can be provided to the RichTextEditorFontFamily constructor.
2118
+ */
2119
+ export interface $RichTextEditorFontFamilySettings extends $ElementSettings {
2120
+ /**
2121
+ * Used to identify the font in the editor. Names should be unique and descriptive.
2122
+ */
2123
+ name?: string | PropertyBindingInfo;
2124
+
2125
+ /**
2126
+ * The text displayed in the font family dropdown.
2127
+ */
2128
+ text?: string | PropertyBindingInfo;
2129
+
2130
+ /**
2131
+ * The value of the font family. CSS font-family value that will be applied to the text.
2132
+ */
2133
+ value?: string | PropertyBindingInfo;
2134
+
2135
+ /**
2136
+ * Used to load the font. The URL should point to a CSS file that defines the font-face.
2137
+ */
2138
+ url?: URI | PropertyBindingInfo | `{${string}}`;
2139
+ }
2140
+ }
2141
+
1844
2142
  declare namespace sap {
1845
2143
  interface IUI5DefineDependencyNames {
1846
2144
  "sap/ui/richtexteditor/library": undefined;
1847
2145
 
1848
2146
  "sap/ui/richtexteditor/RichTextEditor": undefined;
2147
+
2148
+ "sap/ui/richtexteditor/RichTextEditorFontFamily": undefined;
1849
2149
  }
1850
2150
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.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.140.0
1
+ // For Library Version: 1.141.1
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.1
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**