@sapui5/ts-types 1.106.1 → 1.107.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.
Files changed (65) hide show
  1. package/README.md +6 -2
  2. package/package.json +1 -1
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +63 -25
  8. package/types/sap.f.d.ts +810 -163
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +47 -47
  11. package/types/sap.fe.macros.d.ts +82 -6
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +51 -4
  14. package/types/sap.fe.test.d.ts +1 -1
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +9 -1
  17. package/types/sap.insights.d.ts +1 -1
  18. package/types/sap.landvisz.d.ts +1 -1
  19. package/types/sap.m.d.ts +149 -99
  20. package/types/sap.makit.d.ts +1 -1
  21. package/types/sap.me.d.ts +1 -1
  22. package/types/sap.ndc.d.ts +1 -1
  23. package/types/sap.ovp.d.ts +1 -1
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +301 -1
  26. package/types/sap.sac.grid.d.ts +1 -1
  27. package/types/sap.suite.ui.commons.d.ts +2 -37
  28. package/types/sap.suite.ui.generic.template.d.ts +15 -2
  29. package/types/sap.suite.ui.microchart.d.ts +1 -1
  30. package/types/sap.tnt.d.ts +1 -1
  31. package/types/sap.ui.codeeditor.d.ts +1 -1
  32. package/types/sap.ui.commons.d.ts +1 -1
  33. package/types/sap.ui.comp.d.ts +61 -1
  34. package/types/sap.ui.core.d.ts +443 -147
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +1 -1
  37. package/types/sap.ui.fl.d.ts +3 -1
  38. package/types/sap.ui.generic.app.d.ts +1 -1
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +195 -19
  41. package/types/sap.ui.layout.d.ts +1 -1
  42. package/types/sap.ui.mdc.d.ts +5 -1
  43. package/types/sap.ui.richtexteditor.d.ts +36 -17
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +1 -1
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +7 -7
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1 -1
  50. package/types/sap.ui.ux3.d.ts +1 -1
  51. package/types/sap.ui.vbm.d.ts +1 -1
  52. package/types/sap.ui.vk.d.ts +1 -1
  53. package/types/sap.ui.vtm.d.ts +1 -1
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +1 -1
  56. package/types/sap.ui.webc.main.d.ts +1 -1
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +1 -1
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +36 -1
  61. package/types/sap.viz.d.ts +1 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +1 -1
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.106.0
1
+ // For Library Version: 1.107.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -6804,33 +6804,6 @@ declare namespace sap {
6804
6804
  */
6805
6805
  interface ICard {
6806
6806
  __implements__sap_f_ICard: boolean;
6807
-
6808
- /**
6809
- * @SINCE 1.62
6810
- *
6811
- * The function is used to allow for a common content renderer between different implementations of the
6812
- * {@link sap.f.ICard} interface.
6813
- *
6814
- * @returns The content of the card
6815
- */
6816
- getCardContent(): sap.ui.core.Control;
6817
- /**
6818
- * @SINCE 1.62
6819
- *
6820
- * The function is used to allow for a common header renderer between different implementations of the {@link
6821
- * sap.f.ICard} interface.
6822
- *
6823
- * @returns The header of the card
6824
- */
6825
- getCardHeader(): sap.f.cards.IHeader;
6826
- /**
6827
- * @SINCE 1.65
6828
- *
6829
- * Allows for a common header renderer between different implementations of the {@link sap.f.ICard} interface.
6830
- *
6831
- * @returns The position of the header of the card
6832
- */
6833
- getCardHeaderPosition(): sap.f.cards.HeaderPosition;
6834
6807
  }
6835
6808
 
6836
6809
  /**
@@ -8299,6 +8272,87 @@ declare namespace sap {
8299
8272
  avatarPressed?: (oEvent: sap.ui.base.Event) => void;
8300
8273
  }
8301
8274
 
8275
+ interface $SidePanelSettings extends sap.ui.core.$ControlSettings {
8276
+ /**
8277
+ * Determines whether the action bar is expanded or collapsed.
8278
+ */
8279
+ actionBarExpanded?:
8280
+ | boolean
8281
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
8282
+ | `{${string}}`;
8283
+
8284
+ /**
8285
+ * Description for aria-label.
8286
+ */
8287
+ ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
8288
+
8289
+ /**
8290
+ * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
8291
+ * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
8292
+ * it's calculated in absolute units.
8293
+ */
8294
+ sidePanelWidth?:
8295
+ | sap.ui.core.CSSSize
8296
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
8297
+ | `{${string}}`;
8298
+
8299
+ /**
8300
+ * The list of controls for the main content.
8301
+ */
8302
+ mainContent?:
8303
+ | sap.ui.core.Control[]
8304
+ | sap.ui.core.Control
8305
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
8306
+ | `{${string}}`;
8307
+
8308
+ /**
8309
+ * The list of action items. Each action items can have different side content added to its `content` aggregation.
8310
+ */
8311
+ items?:
8312
+ | sap.f.SidePanelItem[]
8313
+ | sap.f.SidePanelItem
8314
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
8315
+ | `{${string}}`;
8316
+
8317
+ /**
8318
+ * The action item that is currently selected.
8319
+ */
8320
+ selectedItem?: sap.f.SidePanelItem | string;
8321
+
8322
+ /**
8323
+ * Fires on expand and collapse of the side content.
8324
+ *
8325
+ *
8326
+ * - If the event fired as a result of action item selection (`expanded` parameter contains `true`) is
8327
+ * prevented, the display of the side content will be blocked.
8328
+ * - If the event fired as a result of action item deselection, selection of different action item, pressing
8329
+ * the `Close` button, or pressing the `Escape` key (`expanded` parameter contains `false`) is prevented,
8330
+ * this will block closing of the currently displayed side content, and if the event is fired by selection
8331
+ * of a different action item, the selection will be cancelled, and the next event (for expansion of a new
8332
+ * action item) will not be fired and the new side content will not be displayed.
8333
+ */
8334
+ toggle?: (oEvent: sap.ui.base.Event) => void;
8335
+ }
8336
+
8337
+ interface $SidePanelItemSettings extends sap.ui.core.$ItemSettings {
8338
+ /**
8339
+ * Specifies the icon for the item.
8340
+ */
8341
+ icon?:
8342
+ | sap.ui.core.URI
8343
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
8344
+ | `{${string}}`;
8345
+
8346
+ /**
8347
+ * The list of controls for side content of the action item.
8348
+ */
8349
+ content?:
8350
+ | sap.ui.core.Control[]
8351
+ | sap.ui.core.Control
8352
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
8353
+ | `{${string}}`;
8354
+ }
8355
+
8302
8356
  /**
8303
8357
  * @SINCE 1.88
8304
8358
  * @deprecated (since 1.98) - Use the {@link sap.m.IllustrationPool} instead.
@@ -9052,26 +9106,6 @@ declare namespace sap {
9052
9106
  * @returns Reference to `this` in order to allow method chaining
9053
9107
  */
9054
9108
  destroyHeader(): this;
9055
- /**
9056
- * Implements sap.f.ICard interface.
9057
- *
9058
- * @returns The content of the card.
9059
- */
9060
- getCardContent(): sap.ui.core.Control;
9061
- /**
9062
- * Implements sap.f.ICard interface.
9063
- *
9064
- * @returns The header of the card.
9065
- */
9066
- getCardHeader(): sap.f.cards.IHeader;
9067
- /**
9068
- * @SINCE 1.65
9069
- *
9070
- * Implements sap.f.ICard interface.
9071
- *
9072
- * @returns The position of the header of the card.
9073
- */
9074
- getCardHeaderPosition(): sap.f.cards.HeaderPosition;
9075
9109
  /**
9076
9110
  * Gets content of aggregation {@link #getContent content}.
9077
9111
  *
@@ -9206,26 +9240,6 @@ declare namespace sap {
9206
9240
  * @returns Metadata object describing this class
9207
9241
  */
9208
9242
  static getMetadata(): sap.ui.core.ElementMetadata;
9209
- /**
9210
- * Implements sap.f.ICard interface.
9211
- *
9212
- * @returns The content of the card.
9213
- */
9214
- getCardContent(): sap.ui.core.Control;
9215
- /**
9216
- * Implements sap.f.ICard interface.
9217
- *
9218
- * @returns The header of the card.
9219
- */
9220
- getCardHeader(): sap.f.cards.IHeader;
9221
- /**
9222
- * @SINCE 1.65
9223
- *
9224
- * Implements sap.f.ICard interface.
9225
- *
9226
- * @returns The position of the header of the card.
9227
- */
9228
- getCardHeaderPosition(): sap.f.cards.HeaderPosition;
9229
9243
  /**
9230
9244
  * Returns the DOM Element that should get the focus.
9231
9245
  *
@@ -18114,131 +18128,760 @@ declare namespace sap {
18114
18128
  ): this;
18115
18129
  }
18116
18130
  /**
18117
- * @SINCE 1.73
18118
- * @EXPERIMENTAL (since 1.73)
18131
+ * @SINCE 1.107
18132
+ * @EXPERIMENTAL (since 1.107)
18119
18133
  *
18120
- * Group modes for the {@link sap.f.AvatarGroup} control.
18121
- */
18122
- enum AvatarGroupType {
18123
- /**
18124
- * The avatars are displayed as partially overlapped on top of each other and the entire group has one click/tap
18125
- * area.
18126
- */
18127
- Group = "Group",
18128
- /**
18129
- * The avatars are displayed side-by-side and each avatar has its own click/tap area.
18130
- */
18131
- Individual = "Individual",
18132
- }
18133
- /**
18134
- * @SINCE 1.50
18135
- * @deprecated (since 1.54) - Consumers of the {@link sap.f.DynamicPageTitle} control should now use the
18136
- * `areaShrinkRatio` property instead of the `primaryArea` property.
18134
+ * Overview:
18137
18135
  *
18138
- * Defines the areas within the `sap.f.DynamicPageTitle` control.
18139
- */
18140
- enum DynamicPageTitleArea {
18141
- /**
18142
- * The area includes the `heading`, `expandedContent` and `snappedContent` aggregations, positioned in the
18143
- * beginning area of the {@link sap.f.DynamicPageTitle}.
18144
- */
18145
- Begin = "Begin",
18146
- /**
18147
- * The area includes the `content` aggregation, positioned in the middle part of the {@link sap.f.DynamicPageTitle}.
18148
- */
18149
- Middle = "Middle",
18150
- }
18151
- /**
18152
- * @SINCE 1.46
18136
+ * `SidePanel` is a layout control that allows primary and additional content to be displayed by clicking/tapping
18137
+ * the action items from its action bar.
18153
18138
  *
18154
- * Layouts, representing the number of columns to be displayed and their relative widths for a {@link sap.f.FlexibleColumnLayout}
18155
- * control.
18139
+ * Usage:
18156
18140
  *
18157
- * Each layout has a predefined ratio for the three columns, depending on device size. Based on the device
18158
- * and layout, some columns are hidden. For more information, refer to the ratios (in %) for each value,
18159
- * listed below: (dash "-" means non-accessible columns).
18141
+ * Action bar with action items have two states - collapsed and expanded. In collapsed state only icons
18142
+ * are displayed, and in expanded state both icons and titles are displayed.
18160
18143
  *
18161
- * **Note:** Please note that on a phone device, due to the limited screen size, only one column can be
18162
- * displayed at a time. For all two-column layouts, this column is the `Mid` column, and for all three-column
18163
- * layouts - the `End` column, even though the respective column may be hidden on desktop and tablet for
18164
- * that particular layout. Therefore some of the names (such as `ThreeColumnsMidExpandedEndHidden` for example)
18165
- * are representative of the desktop scenario only.
18144
+ * Each action item can have a content and click/tap on action item toggles the display of its content.
18145
+ * The content can be added to the action item's `content` aggregation, or can be added or changed later.
18166
18146
  *
18167
- * For more information, see {@link topic:3b9f760da5b64adf8db7f95247879086 Types of Layout} in the documentation.
18147
+ * Each click/tap fires an event, and in the event handler specific content can be added/changed to the
18148
+ * `content` aggregation of the clicked/tapped action item or data can be retreived from the same aggregation
18149
+ * depending on the state of the action item.
18150
+ *
18151
+ * If the side content is displayed, there is automatically generated header of the side content which contains
18152
+ * the icon and title of the selected action item and a close button that closes the area where side content
18153
+ * is displayed.
18154
+ *
18155
+ * Responsive Behavior:
18156
+ *
18157
+ * **On desktop/tablet device**
18158
+ *
18159
+ * The side panel contains action bar that have action items placed vertically, and when expanded, the side
18160
+ * content is displayed next to the action bar. If there is not enough space for all available action items,
18161
+ * an overflow icon is displayed, and it toggles ON/OFF an overflow menu with the rest of the action items
18162
+ * that are not visible at the moment.
18163
+ *
18164
+ * Screen width > 1440 px
18165
+ *
18166
+ *
18167
+ * - When expanded, the side content shrinks the main content.
18168
+ *
18169
+ * Screen width <= 1440 px
18170
+ *
18171
+ *
18172
+ * - When expanded, the side content is placed over the main content.
18173
+ *
18174
+ * **On mobile device**
18175
+ *
18176
+ * The side panel contains action bar that have action items placed horizontally at the bottom of the display,
18177
+ * and when expanded, the side content is displayed above the action bar. If there is not enough room for
18178
+ * all action items, the action bar can be swiped to access the rest of the action items.
18179
+ *
18180
+ * Keyboard shortcuts:
18181
+ *
18182
+ *
18183
+ * - [Shift] + [Command] + [p] (Mac) / [Shift] + [Control] + [p] (Windows) - Expand/Collapse side panel
18184
+ *
18185
+ * - [Arrow Up], [Arrow Down] - Move to the next or previous action item
18186
+ * - [Enter], [Space] - Choose the selected action item
18187
+ * - [Command] + [Arrow Left] (Mac) / [Control] + [Arrow Left] (Windows) / [Tab]- Move from action items
18188
+ * to the opened side content panel
18189
+ * - [Command] + [Arrow Right] (Mac) / [Control] + [Arrow Right] (Windows) / [Shift] + [Tab]- Move from
18190
+ * opened side content panel to the action items
18191
+ * - [F6] / [Shift] + [F6] - Navigate back and forth between main content, side panel and side content
18192
+ * groups [Esc] - Close the opened side content panel and set focus back to main content
18168
18193
  */
18169
- enum LayoutType {
18194
+ class SidePanel extends sap.ui.core.Control {
18170
18195
  /**
18171
- * Desktop: -/-/100 only the End column is displayed
18172
- *
18173
- * Tablet: -/-/100 only the End column is displayed
18174
- *
18175
- * Phone: -/-/100 only the End column is displayed
18196
+ * Constructor for a new `SidePanel`.
18176
18197
  *
18177
- * Use to display a detail-detail page only, when the user should focus entirely on it.
18198
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
18199
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
18200
+ * of the syntax of the settings object.
18178
18201
  */
18179
- EndColumnFullScreen = "EndColumnFullScreen",
18202
+ constructor(
18203
+ /**
18204
+ * Initial settings for the new control
18205
+ */
18206
+ mSettings?: sap.f.$SidePanelSettings
18207
+ );
18180
18208
  /**
18181
- * Desktop: -/100/- only the Mid column is displayed
18182
- *
18183
- * Tablet: -/100/- only the Mid column is displayed
18184
- *
18185
- * Phone: -/100/- only the Mid column is displayed
18209
+ * Constructor for a new `SidePanel`.
18186
18210
  *
18187
- * Use to display a detail page only, when the user should focus entirely on it.
18211
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
18212
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
18213
+ * of the syntax of the settings object.
18188
18214
  */
18189
- MidColumnFullScreen = "MidColumnFullScreen",
18215
+ constructor(
18216
+ /**
18217
+ * ID for the new control, generated automatically if no ID is given
18218
+ */
18219
+ sId?: string,
18220
+ /**
18221
+ * Initial settings for the new control
18222
+ */
18223
+ mSettings?: sap.f.$SidePanelSettings
18224
+ );
18225
+
18190
18226
  /**
18191
- * Desktop: 100/-/- only the Begin column is displayed
18192
- *
18193
- * Tablet: 100/-/- only the Begin column is displayed
18227
+ * Creates a new subclass of class sap.f.SidePanel with name `sClassName` and enriches it with the information
18228
+ * contained in `oClassInfo`.
18194
18229
  *
18195
- * Phone: 100/-/- only the Begin column is displayed
18230
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
18196
18231
  *
18197
- * Use to start with a master page.
18232
+ * @returns Created class / constructor function
18198
18233
  */
18199
- OneColumn = "OneColumn",
18234
+ static extend<T extends Record<string, unknown>>(
18235
+ /**
18236
+ * Name of the class being created
18237
+ */
18238
+ sClassName: string,
18239
+ /**
18240
+ * Object literal with information about the class
18241
+ */
18242
+ oClassInfo?: sap.ClassInfo<T, sap.f.SidePanel>,
18243
+ /**
18244
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
18245
+ * used by this class
18246
+ */
18247
+ FNMetaImpl?: Function
18248
+ ): Function;
18200
18249
  /**
18201
- * Desktop: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
18202
- *
18203
- * Tablet: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
18250
+ * Returns a metadata object for class sap.f.SidePanel.
18204
18251
  *
18205
- * Phone: -/-/100 only the End column is displayed
18206
- *
18207
- * Use to display the master and detail pages when the user should focus on the master. The detail-detail
18208
- * is still loaded and easily accessible with layout arrows.
18252
+ * @returns Metadata object describing this class
18209
18253
  */
18210
- ThreeColumnsBeginExpandedEndHidden = "ThreeColumnsBeginExpandedEndHidden",
18254
+ static getMetadata(): sap.ui.core.ElementMetadata;
18211
18255
  /**
18212
- * Desktop: 25/25/50 Begin, Mid and End (expanded) columns are displayed
18213
- *
18214
- * Tablet: 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by layout arrows
18215
- *
18216
- * Phone: -/-/100 (only the End column is displayed)
18256
+ * Adds some item to the aggregation {@link #getItems items}.
18217
18257
  *
18218
- * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail-detail.
18258
+ * @returns Reference to `this` in order to allow method chaining
18219
18259
  */
18220
- ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",
18260
+ addItem(
18261
+ /**
18262
+ * The item to add; if empty, nothing is inserted
18263
+ */
18264
+ oItem: sap.f.SidePanelItem
18265
+ ): this;
18221
18266
  /**
18222
- * Desktop: 25/50/25 Begin, Mid (expanded) and End columns are displayed
18223
- *
18224
- * Tablet: 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by a layout arrow
18267
+ * Adds some mainContent to the aggregation {@link #getMainContent mainContent}.
18225
18268
  *
18226
- * Phone: -/-/100 only the End column is displayed
18227
- *
18228
- * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail.
18269
+ * @returns Reference to `this` in order to allow method chaining
18229
18270
  */
18230
- ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",
18271
+ addMainContent(
18272
+ /**
18273
+ * The mainContent to add; if empty, nothing is inserted
18274
+ */
18275
+ oMainContent: sap.ui.core.Control
18276
+ ): this;
18231
18277
  /**
18232
- * Desktop: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
18278
+ * Attaches event handler `fnFunction` to the {@link #event:toggle toggle} event of this `sap.f.SidePanel`.
18233
18279
  *
18234
- * Tablet: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
18280
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18281
+ * otherwise it will be bound to this `sap.f.SidePanel` itself.
18235
18282
  *
18236
- * Phone: -/-/100 only the End column is displayed
18283
+ * Fires on expand and collapse of the side content.
18237
18284
  *
18238
- * Use to display the master and detail pages when the user should focus on the detail. The detail-detail
18239
- * is still loaded and easily accessible with a layout arrow.
18240
- */
18241
- ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",
18285
+ *
18286
+ * - If the event fired as a result of action item selection (`expanded` parameter contains `true`) is
18287
+ * prevented, the display of the side content will be blocked.
18288
+ * - If the event fired as a result of action item deselection, selection of different action item, pressing
18289
+ * the `Close` button, or pressing the `Escape` key (`expanded` parameter contains `false`) is prevented,
18290
+ * this will block closing of the currently displayed side content, and if the event is fired by selection
18291
+ * of a different action item, the selection will be cancelled, and the next event (for expansion of a new
18292
+ * action item) will not be fired and the new side content will not be displayed.
18293
+ *
18294
+ * @returns Reference to `this` in order to allow method chaining
18295
+ */
18296
+ attachToggle(
18297
+ /**
18298
+ * An application-specific payload object that will be passed to the event handler along with the event
18299
+ * object when firing the event
18300
+ */
18301
+ oData: object,
18302
+ /**
18303
+ * The function to be called when the event occurs
18304
+ */
18305
+ fnFunction: (p1: sap.ui.base.Event) => void,
18306
+ /**
18307
+ * Context object to call the event handler with. Defaults to this `sap.f.SidePanel` itself
18308
+ */
18309
+ oListener?: object
18310
+ ): this;
18311
+ /**
18312
+ * Attaches event handler `fnFunction` to the {@link #event:toggle toggle} event of this `sap.f.SidePanel`.
18313
+ *
18314
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18315
+ * otherwise it will be bound to this `sap.f.SidePanel` itself.
18316
+ *
18317
+ * Fires on expand and collapse of the side content.
18318
+ *
18319
+ *
18320
+ * - If the event fired as a result of action item selection (`expanded` parameter contains `true`) is
18321
+ * prevented, the display of the side content will be blocked.
18322
+ * - If the event fired as a result of action item deselection, selection of different action item, pressing
18323
+ * the `Close` button, or pressing the `Escape` key (`expanded` parameter contains `false`) is prevented,
18324
+ * this will block closing of the currently displayed side content, and if the event is fired by selection
18325
+ * of a different action item, the selection will be cancelled, and the next event (for expansion of a new
18326
+ * action item) will not be fired and the new side content will not be displayed.
18327
+ *
18328
+ * @returns Reference to `this` in order to allow method chaining
18329
+ */
18330
+ attachToggle(
18331
+ /**
18332
+ * The function to be called when the event occurs
18333
+ */
18334
+ fnFunction: (p1: sap.ui.base.Event) => void,
18335
+ /**
18336
+ * Context object to call the event handler with. Defaults to this `sap.f.SidePanel` itself
18337
+ */
18338
+ oListener?: object
18339
+ ): this;
18340
+ /**
18341
+ * Destroys all the items in the aggregation {@link #getItems items}.
18342
+ *
18343
+ * @returns Reference to `this` in order to allow method chaining
18344
+ */
18345
+ destroyItems(): this;
18346
+ /**
18347
+ * Destroys all the mainContent in the aggregation {@link #getMainContent mainContent}.
18348
+ *
18349
+ * @returns Reference to `this` in order to allow method chaining
18350
+ */
18351
+ destroyMainContent(): this;
18352
+ /**
18353
+ * Detaches event handler `fnFunction` from the {@link #event:toggle toggle} event of this `sap.f.SidePanel`.
18354
+ *
18355
+ * The passed function and listener object must match the ones used for event registration.
18356
+ *
18357
+ * @returns Reference to `this` in order to allow method chaining
18358
+ */
18359
+ detachToggle(
18360
+ /**
18361
+ * The function to be called, when the event occurs
18362
+ */
18363
+ fnFunction: (p1: sap.ui.base.Event) => void,
18364
+ /**
18365
+ * Context object on which the given function had to be called
18366
+ */
18367
+ oListener?: object
18368
+ ): this;
18369
+ /**
18370
+ * Fires event {@link #event:toggle toggle} to attached listeners.
18371
+ *
18372
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
18373
+ * event object. The return value of this method indicates whether the default action should be executed.
18374
+ *
18375
+ * @returns Whether or not to prevent the default action
18376
+ */
18377
+ fireToggle(
18378
+ /**
18379
+ * Parameters to pass along with the event
18380
+ */
18381
+ mParameters?: {
18382
+ /**
18383
+ * The action item that triggers the event.
18384
+ */
18385
+ item?: sap.f.SidePanelItem;
18386
+ /**
18387
+ * State of the action item.
18388
+ */
18389
+ expanded?: boolean;
18390
+ }
18391
+ ): boolean;
18392
+ /**
18393
+ * Gets current value of property {@link #getActionBarExpanded actionBarExpanded}.
18394
+ *
18395
+ * Determines whether the action bar is expanded or collapsed.
18396
+ *
18397
+ * Default value is `false`.
18398
+ *
18399
+ * @returns Value of property `actionBarExpanded`
18400
+ */
18401
+ getActionBarExpanded(): boolean;
18402
+ /**
18403
+ * Gets current value of property {@link #getAriaLabel ariaLabel}.
18404
+ *
18405
+ * Description for aria-label.
18406
+ *
18407
+ * Default value is `"Side Panel"`.
18408
+ *
18409
+ * @returns Value of property `ariaLabel`
18410
+ */
18411
+ getAriaLabel(): string;
18412
+ /**
18413
+ * Gets content of aggregation {@link #getItems items}.
18414
+ *
18415
+ * The list of action items. Each action items can have different side content added to its `content` aggregation.
18416
+ */
18417
+ getItems(): sap.f.SidePanelItem[];
18418
+ /**
18419
+ * Gets content of aggregation {@link #getMainContent mainContent}.
18420
+ *
18421
+ * The list of controls for the main content.
18422
+ */
18423
+ getMainContent(): sap.ui.core.Control[];
18424
+ /**
18425
+ * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
18426
+ * or `null`.
18427
+ */
18428
+ getSelectedItem(): sap.ui.core.ID;
18429
+ /**
18430
+ * Gets current value of property {@link #getSidePanelWidth sidePanelWidth}.
18431
+ *
18432
+ * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
18433
+ * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
18434
+ * it's calculated in absolute units.
18435
+ *
18436
+ * Default value is `"20rem"`.
18437
+ *
18438
+ * @returns Value of property `sidePanelWidth`
18439
+ */
18440
+ getSidePanelWidth(): sap.ui.core.CSSSize;
18441
+ /**
18442
+ * Checks for the provided `sap.f.SidePanelItem` in the aggregation {@link #getItems items}. and returns
18443
+ * its index if found or -1 otherwise.
18444
+ *
18445
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
18446
+ */
18447
+ indexOfItem(
18448
+ /**
18449
+ * The item whose index is looked for
18450
+ */
18451
+ oItem: sap.f.SidePanelItem
18452
+ ): int;
18453
+ /**
18454
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContent mainContent}.
18455
+ * and returns its index if found or -1 otherwise.
18456
+ *
18457
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
18458
+ */
18459
+ indexOfMainContent(
18460
+ /**
18461
+ * The mainContent whose index is looked for
18462
+ */
18463
+ oMainContent: sap.ui.core.Control
18464
+ ): int;
18465
+ /**
18466
+ * Inserts a item into the aggregation {@link #getItems items}.
18467
+ *
18468
+ * @returns Reference to `this` in order to allow method chaining
18469
+ */
18470
+ insertItem(
18471
+ /**
18472
+ * The item to insert; if empty, nothing is inserted
18473
+ */
18474
+ oItem: sap.f.SidePanelItem,
18475
+ /**
18476
+ * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
18477
+ * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
18478
+ * the last position
18479
+ */
18480
+ iIndex: int
18481
+ ): this;
18482
+ /**
18483
+ * Inserts a mainContent into the aggregation {@link #getMainContent mainContent}.
18484
+ *
18485
+ * @returns Reference to `this` in order to allow method chaining
18486
+ */
18487
+ insertMainContent(
18488
+ /**
18489
+ * The mainContent to insert; if empty, nothing is inserted
18490
+ */
18491
+ oMainContent: sap.ui.core.Control,
18492
+ /**
18493
+ * The `0`-based index the mainContent should be inserted at; for a negative value of `iIndex`, the mainContent
18494
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the mainContent
18495
+ * is inserted at the last position
18496
+ */
18497
+ iIndex: int
18498
+ ): this;
18499
+ /**
18500
+ * Removes all the controls from the aggregation {@link #getItems items}.
18501
+ *
18502
+ * Additionally, it unregisters them from the hosting UIArea.
18503
+ *
18504
+ * @returns An array of the removed elements (might be empty)
18505
+ */
18506
+ removeAllItems(): sap.f.SidePanelItem[];
18507
+ /**
18508
+ * Removes all the controls from the aggregation {@link #getMainContent mainContent}.
18509
+ *
18510
+ * Additionally, it unregisters them from the hosting UIArea.
18511
+ *
18512
+ * @returns An array of the removed elements (might be empty)
18513
+ */
18514
+ removeAllMainContent(): sap.ui.core.Control[];
18515
+ /**
18516
+ * Removes a item from the aggregation {@link #getItems items}.
18517
+ *
18518
+ * @returns The removed item or `null`
18519
+ */
18520
+ removeItem(
18521
+ /**
18522
+ * The item to remove or its index or id
18523
+ */
18524
+ vItem: int | string | sap.f.SidePanelItem
18525
+ ): sap.f.SidePanelItem | null;
18526
+ /**
18527
+ * Removes a mainContent from the aggregation {@link #getMainContent mainContent}.
18528
+ *
18529
+ * @returns The removed mainContent or `null`
18530
+ */
18531
+ removeMainContent(
18532
+ /**
18533
+ * The mainContent to remove or its index or id
18534
+ */
18535
+ vMainContent: int | string | sap.ui.core.Control
18536
+ ): sap.ui.core.Control | null;
18537
+ /**
18538
+ * Sets a new value for property {@link #getActionBarExpanded actionBarExpanded}.
18539
+ *
18540
+ * Determines whether the action bar is expanded or collapsed.
18541
+ *
18542
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
18543
+ *
18544
+ * Default value is `false`.
18545
+ *
18546
+ * @returns Reference to `this` in order to allow method chaining
18547
+ */
18548
+ setActionBarExpanded(
18549
+ /**
18550
+ * New value for property `actionBarExpanded`
18551
+ */
18552
+ bActionBarExpanded?: boolean
18553
+ ): this;
18554
+ /**
18555
+ * Sets a new value for property {@link #getAriaLabel ariaLabel}.
18556
+ *
18557
+ * Description for aria-label.
18558
+ *
18559
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
18560
+ *
18561
+ * Default value is `"Side Panel"`.
18562
+ *
18563
+ * @returns Reference to `this` in order to allow method chaining
18564
+ */
18565
+ setAriaLabel(
18566
+ /**
18567
+ * New value for property `ariaLabel`
18568
+ */
18569
+ sAriaLabel?: string
18570
+ ): this;
18571
+ /**
18572
+ * Sets a new value for property {@link #getSidePanelWidth sidePanelWidth}.
18573
+ *
18574
+ * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
18575
+ * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
18576
+ * it's calculated in absolute units.
18577
+ *
18578
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
18579
+ *
18580
+ * Default value is `"20rem"`.
18581
+ *
18582
+ * @returns Reference to `this` in order to allow method chaining
18583
+ */
18584
+ setSidePanelWidth(
18585
+ /**
18586
+ * New value for property `sidePanelWidth`
18587
+ */
18588
+ sSidePanelWidth?: sap.ui.core.CSSSize
18589
+ ): this;
18590
+ }
18591
+ /**
18592
+ * @SINCE 1.107
18593
+ * @EXPERIMENTAL (since 1.107)
18594
+ *
18595
+ * Overview:
18596
+ *
18597
+ * The SidePanel Action Item.
18598
+ */
18599
+ class SidePanelItem extends sap.ui.core.Item {
18600
+ /**
18601
+ * Constructor for a new `SidePanelItem`.
18602
+ *
18603
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
18604
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
18605
+ * of the syntax of the settings object.
18606
+ */
18607
+ constructor(
18608
+ /**
18609
+ * Initial settings for the new control
18610
+ */
18611
+ mSettings?: sap.f.$SidePanelItemSettings
18612
+ );
18613
+ /**
18614
+ * Constructor for a new `SidePanelItem`.
18615
+ *
18616
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
18617
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
18618
+ * of the syntax of the settings object.
18619
+ */
18620
+ constructor(
18621
+ /**
18622
+ * ID for the new control, generated automatically if no ID is given
18623
+ */
18624
+ sId?: string,
18625
+ /**
18626
+ * Initial settings for the new control
18627
+ */
18628
+ mSettings?: sap.f.$SidePanelItemSettings
18629
+ );
18630
+
18631
+ /**
18632
+ * Creates a new subclass of class sap.f.SidePanelItem with name `sClassName` and enriches it with the information
18633
+ * contained in `oClassInfo`.
18634
+ *
18635
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
18636
+ *
18637
+ * @returns Created class / constructor function
18638
+ */
18639
+ static extend<T extends Record<string, unknown>>(
18640
+ /**
18641
+ * Name of the class being created
18642
+ */
18643
+ sClassName: string,
18644
+ /**
18645
+ * Object literal with information about the class
18646
+ */
18647
+ oClassInfo?: sap.ClassInfo<T, sap.f.SidePanelItem>,
18648
+ /**
18649
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
18650
+ * used by this class
18651
+ */
18652
+ FNMetaImpl?: Function
18653
+ ): Function;
18654
+ /**
18655
+ * Returns a metadata object for class sap.f.SidePanelItem.
18656
+ *
18657
+ * @returns Metadata object describing this class
18658
+ */
18659
+ static getMetadata(): sap.ui.core.ElementMetadata;
18660
+ /**
18661
+ * Adds some content to the aggregation {@link #getContent content}.
18662
+ *
18663
+ * @returns Reference to `this` in order to allow method chaining
18664
+ */
18665
+ addContent(
18666
+ /**
18667
+ * The content to add; if empty, nothing is inserted
18668
+ */
18669
+ oContent: sap.ui.core.Control
18670
+ ): this;
18671
+ /**
18672
+ * Destroys all the content in the aggregation {@link #getContent content}.
18673
+ *
18674
+ * @returns Reference to `this` in order to allow method chaining
18675
+ */
18676
+ destroyContent(): this;
18677
+ /**
18678
+ * Gets content of aggregation {@link #getContent content}.
18679
+ *
18680
+ * The list of controls for side content of the action item.
18681
+ */
18682
+ getContent(): sap.ui.core.Control[];
18683
+ /**
18684
+ * Gets current value of property {@link #getIcon icon}.
18685
+ *
18686
+ * Specifies the icon for the item.
18687
+ *
18688
+ * Default value is `empty string`.
18689
+ *
18690
+ * @returns Value of property `icon`
18691
+ */
18692
+ getIcon(): sap.ui.core.URI;
18693
+ /**
18694
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
18695
+ * its index if found or -1 otherwise.
18696
+ *
18697
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
18698
+ */
18699
+ indexOfContent(
18700
+ /**
18701
+ * The content whose index is looked for
18702
+ */
18703
+ oContent: sap.ui.core.Control
18704
+ ): int;
18705
+ /**
18706
+ * Inserts a content into the aggregation {@link #getContent content}.
18707
+ *
18708
+ * @returns Reference to `this` in order to allow method chaining
18709
+ */
18710
+ insertContent(
18711
+ /**
18712
+ * The content to insert; if empty, nothing is inserted
18713
+ */
18714
+ oContent: sap.ui.core.Control,
18715
+ /**
18716
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
18717
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
18718
+ * is inserted at the last position
18719
+ */
18720
+ iIndex: int
18721
+ ): this;
18722
+ /**
18723
+ * Removes all the controls from the aggregation {@link #getContent content}.
18724
+ *
18725
+ * Additionally, it unregisters them from the hosting UIArea.
18726
+ *
18727
+ * @returns An array of the removed elements (might be empty)
18728
+ */
18729
+ removeAllContent(): sap.ui.core.Control[];
18730
+ /**
18731
+ * Removes a content from the aggregation {@link #getContent content}.
18732
+ *
18733
+ * @returns The removed content or `null`
18734
+ */
18735
+ removeContent(
18736
+ /**
18737
+ * The content to remove or its index or id
18738
+ */
18739
+ vContent: int | string | sap.ui.core.Control
18740
+ ): sap.ui.core.Control | null;
18741
+ /**
18742
+ * Sets a new value for property {@link #getIcon icon}.
18743
+ *
18744
+ * Specifies the icon for the item.
18745
+ *
18746
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
18747
+ *
18748
+ * Default value is `empty string`.
18749
+ *
18750
+ * @returns Reference to `this` in order to allow method chaining
18751
+ */
18752
+ setIcon(
18753
+ /**
18754
+ * New value for property `icon`
18755
+ */
18756
+ sIcon?: sap.ui.core.URI
18757
+ ): this;
18758
+ }
18759
+ /**
18760
+ * @SINCE 1.73
18761
+ * @EXPERIMENTAL (since 1.73)
18762
+ *
18763
+ * Group modes for the {@link sap.f.AvatarGroup} control.
18764
+ */
18765
+ enum AvatarGroupType {
18766
+ /**
18767
+ * The avatars are displayed as partially overlapped on top of each other and the entire group has one click/tap
18768
+ * area.
18769
+ */
18770
+ Group = "Group",
18771
+ /**
18772
+ * The avatars are displayed side-by-side and each avatar has its own click/tap area.
18773
+ */
18774
+ Individual = "Individual",
18775
+ }
18776
+ /**
18777
+ * @SINCE 1.50
18778
+ * @deprecated (since 1.54) - Consumers of the {@link sap.f.DynamicPageTitle} control should now use the
18779
+ * `areaShrinkRatio` property instead of the `primaryArea` property.
18780
+ *
18781
+ * Defines the areas within the `sap.f.DynamicPageTitle` control.
18782
+ */
18783
+ enum DynamicPageTitleArea {
18784
+ /**
18785
+ * The area includes the `heading`, `expandedContent` and `snappedContent` aggregations, positioned in the
18786
+ * beginning area of the {@link sap.f.DynamicPageTitle}.
18787
+ */
18788
+ Begin = "Begin",
18789
+ /**
18790
+ * The area includes the `content` aggregation, positioned in the middle part of the {@link sap.f.DynamicPageTitle}.
18791
+ */
18792
+ Middle = "Middle",
18793
+ }
18794
+ /**
18795
+ * @SINCE 1.46
18796
+ *
18797
+ * Layouts, representing the number of columns to be displayed and their relative widths for a {@link sap.f.FlexibleColumnLayout}
18798
+ * control.
18799
+ *
18800
+ * Each layout has a predefined ratio for the three columns, depending on device size. Based on the device
18801
+ * and layout, some columns are hidden. For more information, refer to the ratios (in %) for each value,
18802
+ * listed below: (dash "-" means non-accessible columns).
18803
+ *
18804
+ * **Note:** Please note that on a phone device, due to the limited screen size, only one column can be
18805
+ * displayed at a time. For all two-column layouts, this column is the `Mid` column, and for all three-column
18806
+ * layouts - the `End` column, even though the respective column may be hidden on desktop and tablet for
18807
+ * that particular layout. Therefore some of the names (such as `ThreeColumnsMidExpandedEndHidden` for example)
18808
+ * are representative of the desktop scenario only.
18809
+ *
18810
+ * For more information, see {@link topic:3b9f760da5b64adf8db7f95247879086 Types of Layout} in the documentation.
18811
+ */
18812
+ enum LayoutType {
18813
+ /**
18814
+ * Desktop: -/-/100 only the End column is displayed
18815
+ *
18816
+ * Tablet: -/-/100 only the End column is displayed
18817
+ *
18818
+ * Phone: -/-/100 only the End column is displayed
18819
+ *
18820
+ * Use to display a detail-detail page only, when the user should focus entirely on it.
18821
+ */
18822
+ EndColumnFullScreen = "EndColumnFullScreen",
18823
+ /**
18824
+ * Desktop: -/100/- only the Mid column is displayed
18825
+ *
18826
+ * Tablet: -/100/- only the Mid column is displayed
18827
+ *
18828
+ * Phone: -/100/- only the Mid column is displayed
18829
+ *
18830
+ * Use to display a detail page only, when the user should focus entirely on it.
18831
+ */
18832
+ MidColumnFullScreen = "MidColumnFullScreen",
18833
+ /**
18834
+ * Desktop: 100/-/- only the Begin column is displayed
18835
+ *
18836
+ * Tablet: 100/-/- only the Begin column is displayed
18837
+ *
18838
+ * Phone: 100/-/- only the Begin column is displayed
18839
+ *
18840
+ * Use to start with a master page.
18841
+ */
18842
+ OneColumn = "OneColumn",
18843
+ /**
18844
+ * Desktop: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
18845
+ *
18846
+ * Tablet: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
18847
+ *
18848
+ * Phone: -/-/100 only the End column is displayed
18849
+ *
18850
+ * Use to display the master and detail pages when the user should focus on the master. The detail-detail
18851
+ * is still loaded and easily accessible with layout arrows.
18852
+ */
18853
+ ThreeColumnsBeginExpandedEndHidden = "ThreeColumnsBeginExpandedEndHidden",
18854
+ /**
18855
+ * Desktop: 25/25/50 Begin, Mid and End (expanded) columns are displayed
18856
+ *
18857
+ * Tablet: 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by layout arrows
18858
+ *
18859
+ * Phone: -/-/100 (only the End column is displayed)
18860
+ *
18861
+ * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail-detail.
18862
+ */
18863
+ ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",
18864
+ /**
18865
+ * Desktop: 25/50/25 Begin, Mid (expanded) and End columns are displayed
18866
+ *
18867
+ * Tablet: 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by a layout arrow
18868
+ *
18869
+ * Phone: -/-/100 only the End column is displayed
18870
+ *
18871
+ * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail.
18872
+ */
18873
+ ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",
18874
+ /**
18875
+ * Desktop: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
18876
+ *
18877
+ * Tablet: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
18878
+ *
18879
+ * Phone: -/-/100 only the End column is displayed
18880
+ *
18881
+ * Use to display the master and detail pages when the user should focus on the detail. The detail-detail
18882
+ * is still loaded and easily accessible with a layout arrow.
18883
+ */
18884
+ ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",
18242
18885
  /**
18243
18886
  * Desktop: 67/33/- Begin (expanded) and Mid columns are displayed
18244
18887
  *
@@ -18489,6 +19132,10 @@ declare namespace sap {
18489
19132
 
18490
19133
  "sap/f/ShellBar": undefined;
18491
19134
 
19135
+ "sap/f/SidePanel": undefined;
19136
+
19137
+ "sap/f/SidePanelItem": undefined;
19138
+
18492
19139
  "sap/tnt/library": undefined;
18493
19140
  }
18494
19141
  }