@openui5/ts-types-esm 1.108.1 → 1.109.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types-esm",
3
- "version": "1.108.1",
3
+ "version": "1.109.0",
4
4
  "description": "OpenUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
@@ -2446,6 +2446,18 @@ declare module "sap/f/cards/NumericHeader" {
2446
2446
  * @returns Value of property `number`
2447
2447
  */
2448
2448
  getNumber(): string;
2449
+ /**
2450
+ * @SINCE 1.109
2451
+ *
2452
+ * Gets current value of property {@link #getNumberVisible numberVisible}.
2453
+ *
2454
+ * Whether the main numeric indicator is visible or not
2455
+ *
2456
+ * Default value is `true`.
2457
+ *
2458
+ * @returns Value of property `numberVisible`
2459
+ */
2460
+ getNumberVisible(): boolean;
2449
2461
  /**
2450
2462
  * Gets current value of property {@link #getScale scale}.
2451
2463
  *
@@ -2654,6 +2666,25 @@ declare module "sap/f/cards/NumericHeader" {
2654
2666
  */
2655
2667
  sNumber: string
2656
2668
  ): this;
2669
+ /**
2670
+ * @SINCE 1.109
2671
+ *
2672
+ * Sets a new value for property {@link #getNumberVisible numberVisible}.
2673
+ *
2674
+ * Whether the main numeric indicator is visible or not
2675
+ *
2676
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2677
+ *
2678
+ * Default value is `true`.
2679
+ *
2680
+ * @returns Reference to `this` in order to allow method chaining
2681
+ */
2682
+ setNumberVisible(
2683
+ /**
2684
+ * New value for property `numberVisible`
2685
+ */
2686
+ bNumberVisible?: boolean
2687
+ ): this;
2657
2688
  /**
2658
2689
  * Sets a new value for property {@link #getScale scale}.
2659
2690
  *
@@ -2870,6 +2901,13 @@ declare module "sap/f/cards/NumericHeader" {
2870
2901
  */
2871
2902
  number?: string | PropertyBindingInfo;
2872
2903
 
2904
+ /**
2905
+ * @SINCE 1.109
2906
+ *
2907
+ * Whether the main numeric indicator is visible or not
2908
+ */
2909
+ numberVisible?: boolean | PropertyBindingInfo | `{${string}}`;
2910
+
2873
2911
  /**
2874
2912
  * Defines the unit of measurement (scaling prefix) for the main indicator. Financial characters can be
2875
2913
  * used for currencies and counters. The International System of Units (SI) prefixes can be used. If the
@@ -18950,12 +18988,10 @@ declare module "sap/f/SidePanel" {
18950
18988
 
18951
18989
  /**
18952
18990
  * @SINCE 1.107
18953
- * @EXPERIMENTAL (since 1.107) - This class is experimental and provides only limited functionality. Also
18954
- * the API might be changed in future.
18955
18991
  *
18956
18992
  * Overview:
18957
18993
  *
18958
- * `SidePanel` is a layout control that allows primary and additional content to be displayed by clicking/tapping
18994
+ * `SidePanel` is a layout control that allows primary and additional content to be displayed by choosing
18959
18995
  * the action items from its action bar.
18960
18996
  *
18961
18997
  * Usage:
@@ -18963,8 +18999,8 @@ declare module "sap/f/SidePanel" {
18963
18999
  * Action bar with action items have two states - collapsed and expanded. In collapsed state only icons
18964
19000
  * are displayed, and in expanded state both icons and titles are displayed.
18965
19001
  *
18966
- * Each action item can have a content and click/tap on action item toggles the display of its content.
18967
- * The content can be added to the action item's `content` aggregation, or can be added or changed later.
19002
+ * Each action item can have a content and choose an action item toggles the display of its content. The
19003
+ * content can be added to the action item's `content` aggregation, or can be added or changed later.
18968
19004
  *
18969
19005
  * Each click/tap fires an event, and in the event handler specific content can be added/changed to the
18970
19006
  * `content` aggregation of the clicked/tapped action item or data can be retreived from the same aggregation
@@ -18983,15 +19019,7 @@ declare module "sap/f/SidePanel" {
18983
19019
  * an overflow icon is displayed, and it toggles ON/OFF an overflow menu with the rest of the action items
18984
19020
  * that are not visible at the moment.
18985
19021
  *
18986
- * Screen width > 1440 px
18987
- *
18988
- *
18989
- * - When expanded, the side content shrinks the main content.
18990
- *
18991
- * Screen width <= 1440 px
18992
- *
18993
- *
18994
- * - When expanded, the side content is placed over the main content.
19022
+ * When expanded, the side content shrinks the main content.
18995
19023
  *
18996
19024
  * **On mobile device**
18997
19025
  *
@@ -18999,6 +19027,14 @@ declare module "sap/f/SidePanel" {
18999
19027
  * and when expanded, the side content is displayed above the action bar. If there is not enough room for
19000
19028
  * all action items, the action bar can be swiped to access the rest of the action items.
19001
19029
  *
19030
+ * Resizing:
19031
+ *
19032
+ * Resizing functionality only affects desktop or tablet devices.
19033
+ *
19034
+ * By setting the `sidePanelResizable` property, the expanded side panel can be resized by mouse (by drag
19035
+ * or by double click on resize splitter), by keyboard or by choosing one of three predefined positions
19036
+ * in the side panel's context menu (min, max and default widths)
19037
+ *
19002
19038
  * Keyboard shortcuts:
19003
19039
  *
19004
19040
  *
@@ -19012,6 +19048,22 @@ declare module "sap/f/SidePanel" {
19012
19048
  * opened side content panel to the action items
19013
19049
  * - [F6] / [Shift] + [F6] - Navigate back and forth between main content, side panel and side content
19014
19050
  * groups [Esc] - Close the opened side content panel and set focus back to main content
19051
+ *
19052
+ * If the side panel's `sidePanelResizable` property is set, there is an action item chosen, and the resize
19053
+ * splitter is focused:
19054
+ *
19055
+ *
19056
+ * - [Home] - set the expanded side panel width to the minimum value defined in `sidePanelMinWidth` property
19057
+ *
19058
+ * - [End] - set the expanded side panel width to the maximum value defined in `sidePanelMaxWidth` property
19059
+ *
19060
+ * - [Enter] - set the expanded side panel width to the default value defined in `sidePanelWidth` property
19061
+ *
19062
+ * - [Shift]+[F10] or [Context menu] - show the resize context menu
19063
+ * - [Arrow Left] / [Arrow Right] - increase/decrease the width of the expanded side panel with the regular
19064
+ * step
19065
+ * - [Shift] + [Arrow Left] / [Arrow Right] - increase/decrease the width of the expanded side panel with
19066
+ * the larger step
19015
19067
  */
19016
19068
  export default class SidePanel extends Control {
19017
19069
  /**
@@ -19248,6 +19300,73 @@ declare module "sap/f/SidePanel" {
19248
19300
  * or `null`.
19249
19301
  */
19250
19302
  getSelectedItem(): ID;
19303
+ /**
19304
+ * @SINCE 1.109.0
19305
+ *
19306
+ * Gets current value of property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
19307
+ *
19308
+ * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
19309
+ * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
19310
+ * otherwise it's calculated in absolute units.
19311
+ *
19312
+ * Default value is `"90%"`.
19313
+ *
19314
+ * @returns Value of property `sidePanelMaxWidth`
19315
+ */
19316
+ getSidePanelMaxWidth(): CSSSize;
19317
+ /**
19318
+ * @SINCE 1.109.0
19319
+ *
19320
+ * Gets current value of property {@link #getSidePanelMinWidth sidePanelMinWidth}.
19321
+ *
19322
+ * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
19323
+ * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
19324
+ * otherwise it's calculated in absolute units.
19325
+ *
19326
+ * Default value is `"15rem"`.
19327
+ *
19328
+ * @returns Value of property `sidePanelMinWidth`
19329
+ */
19330
+ getSidePanelMinWidth(): CSSSize;
19331
+ /**
19332
+ * Gets current value of property {@link #getSidePanelResizable sidePanelResizable}.
19333
+ *
19334
+ * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
19335
+ * desktop or tablet devices.
19336
+ *
19337
+ * Default value is `false`.
19338
+ *
19339
+ * @returns Value of property `sidePanelResizable`
19340
+ */
19341
+ getSidePanelResizable(): boolean;
19342
+ /**
19343
+ * @SINCE 1.109.0
19344
+ *
19345
+ * Gets current value of property {@link #getSidePanelResizeLargerStep sidePanelResizeLargerStep}.
19346
+ *
19347
+ * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
19348
+ * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
19349
+ * the resize splitter is focused.
19350
+ *
19351
+ * Default value is `100`.
19352
+ *
19353
+ * @returns Value of property `sidePanelResizeLargerStep`
19354
+ */
19355
+ getSidePanelResizeLargerStep(): int;
19356
+ /**
19357
+ * @SINCE 1.109.0
19358
+ *
19359
+ * Gets current value of property {@link #getSidePanelResizeStep sidePanelResizeStep}.
19360
+ *
19361
+ * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
19362
+ * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
19363
+ * is focused.
19364
+ *
19365
+ * Default value is `10`.
19366
+ *
19367
+ * @returns Value of property `sidePanelResizeStep`
19368
+ */
19369
+ getSidePanelResizeStep(): int;
19251
19370
  /**
19252
19371
  * Gets current value of property {@link #getSidePanelWidth sidePanelWidth}.
19253
19372
  *
@@ -19391,23 +19510,106 @@ declare module "sap/f/SidePanel" {
19391
19510
  sAriaLabel?: string
19392
19511
  ): this;
19393
19512
  /**
19394
- * Sets a new value for property {@link #getSidePanelWidth sidePanelWidth}.
19513
+ * @SINCE 1.109.0
19395
19514
  *
19396
- * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
19397
- * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
19398
- * it's calculated in absolute units.
19515
+ * Sets a new value for property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
19516
+ *
19517
+ * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
19518
+ * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
19519
+ * otherwise it's calculated in absolute units.
19399
19520
  *
19400
19521
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19401
19522
  *
19402
- * Default value is `"20rem"`.
19523
+ * Default value is `"90%"`.
19524
+ *
19525
+ * @returns Reference to `this` in order to allow method chaining
19526
+ */
19527
+ setSidePanelMaxWidth(
19528
+ /**
19529
+ * New value for property `sidePanelMaxWidth`
19530
+ */
19531
+ sSidePanelMaxWidth?: CSSSize
19532
+ ): this;
19533
+ /**
19534
+ * @SINCE 1.109.0
19535
+ *
19536
+ * Sets a new value for property {@link #getSidePanelMinWidth sidePanelMinWidth}.
19537
+ *
19538
+ * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
19539
+ * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
19540
+ * otherwise it's calculated in absolute units.
19541
+ *
19542
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19543
+ *
19544
+ * Default value is `"15rem"`.
19545
+ *
19546
+ * @returns Reference to `this` in order to allow method chaining
19547
+ */
19548
+ setSidePanelMinWidth(
19549
+ /**
19550
+ * New value for property `sidePanelMinWidth`
19551
+ */
19552
+ sSidePanelMinWidth?: CSSSize
19553
+ ): this;
19554
+ /**
19555
+ * Sets a new value for property {@link #getSidePanelResizable sidePanelResizable}.
19556
+ *
19557
+ * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
19558
+ * desktop or tablet devices.
19559
+ *
19560
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19561
+ *
19562
+ * Default value is `false`.
19403
19563
  *
19404
19564
  * @returns Reference to `this` in order to allow method chaining
19405
19565
  */
19406
- setSidePanelWidth(
19566
+ setSidePanelResizable(
19407
19567
  /**
19408
- * New value for property `sidePanelWidth`
19568
+ * New value for property `sidePanelResizable`
19409
19569
  */
19410
- sSidePanelWidth?: CSSSize
19570
+ bSidePanelResizable?: boolean
19571
+ ): this;
19572
+ /**
19573
+ * @SINCE 1.109.0
19574
+ *
19575
+ * Sets a new value for property {@link #getSidePanelResizeLargerStep sidePanelResizeLargerStep}.
19576
+ *
19577
+ * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
19578
+ * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
19579
+ * the resize splitter is focused.
19580
+ *
19581
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19582
+ *
19583
+ * Default value is `100`.
19584
+ *
19585
+ * @returns Reference to `this` in order to allow method chaining
19586
+ */
19587
+ setSidePanelResizeLargerStep(
19588
+ /**
19589
+ * New value for property `sidePanelResizeLargerStep`
19590
+ */
19591
+ iSidePanelResizeLargerStep?: int
19592
+ ): this;
19593
+ /**
19594
+ * @SINCE 1.109.0
19595
+ *
19596
+ * Sets a new value for property {@link #getSidePanelResizeStep sidePanelResizeStep}.
19597
+ *
19598
+ * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
19599
+ * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
19600
+ * is focused.
19601
+ *
19602
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
19603
+ *
19604
+ * Default value is `10`.
19605
+ *
19606
+ * @returns Reference to `this` in order to allow method chaining
19607
+ */
19608
+ setSidePanelResizeStep(
19609
+ /**
19610
+ * New value for property `sidePanelResizeStep`
19611
+ */
19612
+ iSidePanelResizeStep?: int
19411
19613
  ): this;
19412
19614
  }
19413
19615
 
@@ -19422,6 +19624,12 @@ declare module "sap/f/SidePanel" {
19422
19624
  */
19423
19625
  ariaLabel?: string | PropertyBindingInfo;
19424
19626
 
19627
+ /**
19628
+ * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
19629
+ * desktop or tablet devices.
19630
+ */
19631
+ sidePanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
19632
+
19425
19633
  /**
19426
19634
  * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
19427
19635
  * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
@@ -19429,6 +19637,42 @@ declare module "sap/f/SidePanel" {
19429
19637
  */
19430
19638
  sidePanelWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
19431
19639
 
19640
+ /**
19641
+ * @SINCE 1.109.0
19642
+ *
19643
+ * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
19644
+ * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
19645
+ * otherwise it's calculated in absolute units.
19646
+ */
19647
+ sidePanelMinWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
19648
+
19649
+ /**
19650
+ * @SINCE 1.109.0
19651
+ *
19652
+ * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
19653
+ * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
19654
+ * otherwise it's calculated in absolute units.
19655
+ */
19656
+ sidePanelMaxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
19657
+
19658
+ /**
19659
+ * @SINCE 1.109.0
19660
+ *
19661
+ * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
19662
+ * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
19663
+ * is focused.
19664
+ */
19665
+ sidePanelResizeStep?: int | PropertyBindingInfo | `{${string}}`;
19666
+
19667
+ /**
19668
+ * @SINCE 1.109.0
19669
+ *
19670
+ * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
19671
+ * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
19672
+ * the resize splitter is focused.
19673
+ */
19674
+ sidePanelResizeLargerStep?: int | PropertyBindingInfo | `{${string}}`;
19675
+
19432
19676
  /**
19433
19677
  * The list of controls for the main content.
19434
19678
  */
@@ -19480,8 +19724,6 @@ declare module "sap/f/SidePanelItem" {
19480
19724
 
19481
19725
  /**
19482
19726
  * @SINCE 1.107
19483
- * @EXPERIMENTAL (since 1.107) - This class is experimental and provides only limited functionality. Also
19484
- * the API might be changed in future.
19485
19727
  *
19486
19728
  * Overview:
19487
19729
  *