@openui5/ts-types-esm 1.146.0 → 1.147.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types-esm",
3
- "version": "1.146.0",
3
+ "version": "1.147.1",
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/index.d.ts CHANGED
@@ -45,6 +45,3 @@
45
45
  /// <reference path="./sap.ui.unified.d.ts"/>
46
46
  /// <reference path="./sap.ui.ux3.d.ts"/>
47
47
  /// <reference path="./sap.uxap.d.ts"/>
48
- /// <reference path="./sap.ui.webc.common.d.ts"/>
49
- /// <reference path="./sap.ui.webc.fiori.d.ts"/>
50
- /// <reference path="./sap.ui.webc.main.d.ts"/>
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.1
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
@@ -113,6 +113,31 @@ declare module "sap/f/library" {
113
113
  */
114
114
  Persist = "Persist",
115
115
  }
116
+ /**
117
+ * Defines the media breakpoints for DynamicPage.
118
+ *
119
+ * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'DynamicPageMediaRange'.
120
+ *
121
+ * @since 1.147
122
+ */
123
+ export enum DynamicPageMediaRange {
124
+ /**
125
+ * Desktop breakpoint (1025px to 1439px).
126
+ */
127
+ Desktop = "Desktop",
128
+ /**
129
+ * Desktop Extra Large breakpoint (1440px and above).
130
+ */
131
+ DesktopExtraLarge = "DesktopExtraLarge",
132
+ /**
133
+ * Phone breakpoint (up to 600px).
134
+ */
135
+ Phone = "Phone",
136
+ /**
137
+ * Tablet breakpoint (601px to 1024px).
138
+ */
139
+ Tablet = "Tablet",
140
+ }
116
141
  /**
117
142
  * Defines the areas within the `sap.f.DynamicPageTitle` control.
118
143
  *
@@ -4507,7 +4532,10 @@ declare module "sap/f/DynamicPage" {
4507
4532
 
4508
4533
  import DynamicPageTitle from "sap/f/DynamicPageTitle";
4509
4534
 
4510
- import { IDynamicPageStickyContent } from "sap/f/library";
4535
+ import {
4536
+ IDynamicPageStickyContent,
4537
+ DynamicPageMediaRange,
4538
+ } from "sap/f/library";
4511
4539
 
4512
4540
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
4513
4541
 
@@ -4631,6 +4659,59 @@ declare module "sap/f/DynamicPage" {
4631
4659
  * @returns Metadata object describing this class
4632
4660
  */
4633
4661
  static getMetadata(): ElementMetadata;
4662
+ /**
4663
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
4664
+ * this `sap.f.DynamicPage`.
4665
+ *
4666
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4667
+ * otherwise it will be bound to this `sap.f.DynamicPage` itself.
4668
+ *
4669
+ * The event is fired when the media breakpoint changes. Applications can use this event to adjust content
4670
+ * based on the current screen size.
4671
+ *
4672
+ * @since 1.147
4673
+ *
4674
+ * @returns Reference to `this` in order to allow method chaining
4675
+ */
4676
+ attachBreakpointChange(
4677
+ /**
4678
+ * An application-specific payload object that will be passed to the event handler along with the event
4679
+ * object when firing the event
4680
+ */
4681
+ oData: object,
4682
+ /**
4683
+ * The function to be called when the event occurs
4684
+ */
4685
+ fnFunction: (p1: DynamicPage$BreakpointChangeEvent) => void,
4686
+ /**
4687
+ * Context object to call the event handler with. Defaults to this `sap.f.DynamicPage` itself
4688
+ */
4689
+ oListener?: object
4690
+ ): this;
4691
+ /**
4692
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
4693
+ * this `sap.f.DynamicPage`.
4694
+ *
4695
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4696
+ * otherwise it will be bound to this `sap.f.DynamicPage` itself.
4697
+ *
4698
+ * The event is fired when the media breakpoint changes. Applications can use this event to adjust content
4699
+ * based on the current screen size.
4700
+ *
4701
+ * @since 1.147
4702
+ *
4703
+ * @returns Reference to `this` in order to allow method chaining
4704
+ */
4705
+ attachBreakpointChange(
4706
+ /**
4707
+ * The function to be called when the event occurs
4708
+ */
4709
+ fnFunction: (p1: DynamicPage$BreakpointChangeEvent) => void,
4710
+ /**
4711
+ * Context object to call the event handler with. Defaults to this `sap.f.DynamicPage` itself
4712
+ */
4713
+ oListener?: object
4714
+ ): this;
4634
4715
  /**
4635
4716
  * Attaches event handler `fnFunction` to the {@link #event:pinnedStateChange pinnedStateChange} event of
4636
4717
  * this `sap.f.DynamicPage`.
@@ -4718,6 +4799,26 @@ declare module "sap/f/DynamicPage" {
4718
4799
  * @returns Reference to `this` in order to allow method chaining
4719
4800
  */
4720
4801
  destroyTitle(): this;
4802
+ /**
4803
+ * Detaches event handler `fnFunction` from the {@link #event:breakpointChange breakpointChange} event of
4804
+ * this `sap.f.DynamicPage`.
4805
+ *
4806
+ * The passed function and listener object must match the ones used for event registration.
4807
+ *
4808
+ * @since 1.147
4809
+ *
4810
+ * @returns Reference to `this` in order to allow method chaining
4811
+ */
4812
+ detachBreakpointChange(
4813
+ /**
4814
+ * The function to be called, when the event occurs
4815
+ */
4816
+ fnFunction: (p1: DynamicPage$BreakpointChangeEvent) => void,
4817
+ /**
4818
+ * Context object on which the given function had to be called
4819
+ */
4820
+ oListener?: object
4821
+ ): this;
4721
4822
  /**
4722
4823
  * Detaches event handler `fnFunction` from the {@link #event:pinnedStateChange pinnedStateChange} event
4723
4824
  * of this `sap.f.DynamicPage`.
@@ -4738,6 +4839,20 @@ declare module "sap/f/DynamicPage" {
4738
4839
  */
4739
4840
  oListener?: object
4740
4841
  ): this;
4842
+ /**
4843
+ * Fires event {@link #event:breakpointChange breakpointChange} to attached listeners.
4844
+ *
4845
+ * @since 1.147
4846
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
4847
+ *
4848
+ * @returns Reference to `this` in order to allow method chaining
4849
+ */
4850
+ fireBreakpointChange(
4851
+ /**
4852
+ * Parameters to pass along with the event
4853
+ */
4854
+ mParameters?: DynamicPage$BreakpointChangeEventParameters
4855
+ ): this;
4741
4856
  /**
4742
4857
  * Fires event {@link #event:pinnedStateChange pinnedStateChange} to attached listeners.
4743
4858
  *
@@ -5334,8 +5449,39 @@ declare module "sap/f/DynamicPage" {
5334
5449
  * @since 1.93
5335
5450
  */
5336
5451
  pinnedStateChange?: (oEvent: DynamicPage$PinnedStateChangeEvent) => void;
5452
+
5453
+ /**
5454
+ * The event is fired when the media breakpoint changes. Applications can use this event to adjust content
5455
+ * based on the current screen size.
5456
+ *
5457
+ * @since 1.147
5458
+ */
5459
+ breakpointChange?: (oEvent: DynamicPage$BreakpointChangeEvent) => void;
5337
5460
  }
5338
5461
 
5462
+ /**
5463
+ * Parameters of the DynamicPage#breakpointChange event.
5464
+ */
5465
+ export interface DynamicPage$BreakpointChangeEventParameters {
5466
+ /**
5467
+ * The current media range as defined by {@link sap.f.DynamicPageMediaRange}.
5468
+ */
5469
+ currentRange?: DynamicPageMediaRange | keyof typeof DynamicPageMediaRange;
5470
+
5471
+ /**
5472
+ * The current width of the control in pixels.
5473
+ */
5474
+ currentWidth?: int;
5475
+ }
5476
+
5477
+ /**
5478
+ * Event object of the DynamicPage#breakpointChange event.
5479
+ */
5480
+ export type DynamicPage$BreakpointChangeEvent = Event<
5481
+ DynamicPage$BreakpointChangeEventParameters,
5482
+ DynamicPage
5483
+ >;
5484
+
5339
5485
  /**
5340
5486
  * Parameters of the DynamicPage#pinnedStateChange event.
5341
5487
  */