@sapui5/ts-types 1.152.1 → 1.154.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 (69) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +7 -6
  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 +90 -45
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +68 -1
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +214 -21
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +33 -12
  19. package/types/sap.fe.test.d.ts +15 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +290 -24
  23. package/types/sap.html.d.ts +1495 -0
  24. package/types/sap.insights.d.ts +1 -1
  25. package/types/{mobile-1.152.0-d.ts → sap.m.d.ts} +1374 -41
  26. package/types/sap.makit.d.ts +1 -1
  27. package/types/sap.me.d.ts +1 -1
  28. package/types/sap.ndc.d.ts +1 -1
  29. package/types/sap.ovp.d.ts +1 -1
  30. package/types/sap.rules.ui.d.ts +1 -1
  31. package/types/sap.sac.df.d.ts +1 -1
  32. package/types/sap.suite.ui.commons.d.ts +14 -14
  33. package/types/sap.suite.ui.generic.template.d.ts +31 -1
  34. package/types/sap.suite.ui.microchart.d.ts +1 -1
  35. package/types/sap.tnt.d.ts +1 -1
  36. package/types/sap.ui.codeeditor.d.ts +1 -1
  37. package/types/{commons-1.152.0-d.ts → sap.ui.commons.d.ts} +1 -1
  38. package/types/sap.ui.comp.d.ts +41 -5
  39. package/types/{core-1.152.0-d.ts → sap.ui.core.d.ts} +1096 -422
  40. package/types/{dt-1.152.0-d.ts → sap.ui.dt.d.ts} +1 -1
  41. package/types/sap.ui.export.d.ts +14 -2
  42. package/types/sap.ui.fl.d.ts +1 -1
  43. package/types/sap.ui.generic.app.d.ts +1 -1
  44. package/types/sap.ui.generic.template.d.ts +1 -1
  45. package/types/sap.ui.geomap.d.ts +1 -1
  46. package/types/sap.ui.integration.d.ts +1 -1
  47. package/types/sap.ui.joule.frontend.d.ts +4 -296
  48. package/types/sap.ui.layout.d.ts +14 -7
  49. package/types/{mdc-1.152.0-d.ts → sap.ui.mdc.d.ts} +6960 -5788
  50. package/types/sap.ui.richtexteditor.d.ts +1 -1
  51. package/types/sap.ui.rta.d.ts +9 -1
  52. package/types/sap.ui.suite.d.ts +1 -1
  53. package/types/sap.ui.support.d.ts +1 -1
  54. package/types/sap.ui.table.d.ts +63 -1
  55. package/types/sap.ui.testrecorder.d.ts +1 -1
  56. package/types/sap.ui.unified.d.ts +1 -1
  57. package/types/{ux3-1.152.0-d.ts → sap.ui.ux3.d.ts} +1 -1
  58. package/types/sap.ui.vbm.d.ts +1 -1
  59. package/types/sap.ui.vk.d.ts +1 -1
  60. package/types/sap.ui.vtm.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +127 -17
  63. package/types/sap.ushell_abap.d.ts +3 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.152.0
282
+ // For Library Version: 1.154.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -2614,6 +2614,204 @@ declare module "sap/base/security/URLListValidator" {
2614
2614
  }
2615
2615
 
2616
2616
  declare module "sap/base/security/URLWhitelist" {
2617
+ /**
2618
+ * Registry to manage allowed URLs and validate against them.
2619
+ *
2620
+ * @since 1.58
2621
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator} instead. SAP strives
2622
+ * to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately removed
2623
+ * for compatibility reasons, this API has been deprecated.
2624
+ */
2625
+ interface URLWhitelist {
2626
+ /**
2627
+ * Adds an entry.
2628
+ *
2629
+ * Note: Adding the first entry to the list of allowed entries will disallow all URLs but the ones matching
2630
+ * the newly added entry.
2631
+ *
2632
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator.add} instead.
2633
+ */
2634
+ add(
2635
+ /**
2636
+ * The protocol of the URL
2637
+ */
2638
+ protocol: string,
2639
+ /**
2640
+ * The host of the URL
2641
+ */
2642
+ host: string,
2643
+ /**
2644
+ * The port of the URL
2645
+ */
2646
+ port: string,
2647
+ /**
2648
+ * the path of the URL
2649
+ */
2650
+ path: string
2651
+ ): void;
2652
+ /**
2653
+ * Clears the entries in the list.
2654
+ *
2655
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator.clear} instead.
2656
+ */
2657
+ clear(): void;
2658
+ /**
2659
+ * Deletes an entry from the list.
2660
+ *
2661
+ * Note: Deleting the last entry from the list of allowed entries will allow all URLs.
2662
+ *
2663
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator.clear} and {@link module:sap/base/security/URLListValidator.add }
2664
+ * instead.
2665
+ */
2666
+ delete(
2667
+ /**
2668
+ * The entry to be deleted
2669
+ */
2670
+ oEntry: Entry
2671
+ ): void;
2672
+ /**
2673
+ * Gets the list of allowed entries.
2674
+ *
2675
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator.entries} instead.
2676
+ *
2677
+ * @returns The allowed entries
2678
+ */
2679
+ entries(): Entry[];
2680
+ /**
2681
+ * Validates a URL. Check if it's not a script or other security issue.
2682
+ *
2683
+ * Split URL into components and check for allowed characters according to RFC 3986:
2684
+ *
2685
+ *
2686
+ * ```javascript
2687
+ *
2688
+ * authority = [ userinfo "@" ] host [ ":" port ]
2689
+ * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
2690
+ * host = IP-literal / IPv4address / reg-name
2691
+ *
2692
+ * IP-literal = "[" ( IPv6address / IPvFuture ) "]"
2693
+ * IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" )
2694
+ * IPv6address = 6( h16 ":" ) ls32
2695
+ * / "::" 5( h16 ":" ) ls32
2696
+ * / [ h16 ] "::" 4( h16 ":" ) ls32
2697
+ * / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32
2698
+ * / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32
2699
+ * / [ *3( h16 ":" ) h16 ] "::" h16 ":" ls32
2700
+ * / [ *4( h16 ":" ) h16 ] "::" ls32
2701
+ * / [ *5( h16 ":" ) h16 ] "::" h16
2702
+ * / [ *6( h16 ":" ) h16 ] "::"
2703
+ * ls32 = ( h16 ":" h16 ) / IPv4address
2704
+ * ; least-significant 32 bits of address
2705
+ * h16 = 1*4HEXDIG
2706
+ * ; 16 bits of address represented in hexadecimal
2707
+ *
2708
+ * IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet
2709
+ * dec-octet = DIGIT ; 0-9
2710
+ * / %x31-39 DIGIT ; 10-99
2711
+ * / "1" 2DIGIT ; 100-199
2712
+ * / "2" %x30-34 DIGIT ; 200-249
2713
+ * / "25" %x30-35 ; 250-255
2714
+ *
2715
+ * reg-name = *( unreserved / pct-encoded / sub-delims )
2716
+ *
2717
+ * pct-encoded = "%" HEXDIG HEXDIG
2718
+ * reserved = gen-delims / sub-delims
2719
+ * gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
2720
+ * sub-delims = "!" / "$" / "&" / "'" / "(" / ")"
2721
+ * / "*" / "+" / "," / ";" / "="
2722
+ * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
2723
+ * pchar = unreserved / pct-encoded / sub-delims / ":" / "@"
2724
+ *
2725
+ * path = path-abempty ; begins with "/" or is empty
2726
+ * / path-absolute ; begins with "/" but not "//"
2727
+ * / path-noscheme ; begins with a non-colon segment
2728
+ * / path-rootless ; begins with a segment
2729
+ * / path-empty ; zero characters
2730
+ *
2731
+ * path-abempty = *( "/" segment )
2732
+ * path-absolute = "/" [ segment-nz *( "/" segment ) ]
2733
+ * path-noscheme = segment-nz-nc *( "/" segment )
2734
+ * path-rootless = segment-nz *( "/" segment )
2735
+ * path-empty = 0
2736
+ * segment = *pchar
2737
+ * segment-nz = 1*pchar
2738
+ * segment-nz-nc = 1*( unreserved / pct-encoded / sub-delims / "@" )
2739
+ * ; non-zero-length segment without any colon ":"
2740
+ *
2741
+ * query = *( pchar / "/" / "?" )
2742
+ *
2743
+ * fragment = *( pchar / "/" / "?" )
2744
+ * ```
2745
+ *
2746
+ *
2747
+ * For the hostname component, we are checking for valid DNS hostnames according to RFC 952 / RFC 1123:
2748
+ *
2749
+ *
2750
+ * ```javascript
2751
+ *
2752
+ * hname = name *("." name)
2753
+ * name = let-or-digit ( *( let-or-digit-or-hyphen ) let-or-digit )
2754
+ * ```
2755
+ *
2756
+ *
2757
+ * When the URI uses the protocol 'mailto:', the address part is additionally checked against the most commonly
2758
+ * used parts of RFC 6068:
2759
+ *
2760
+ *
2761
+ * ```javascript
2762
+ *
2763
+ * mailtoURI = "mailto:" [ to ] [ hfields ]
2764
+ * to = addr-spec *("," addr-spec )
2765
+ * hfields = "?" hfield *( "&" hfield )
2766
+ * hfield = hfname "=" hfvalue
2767
+ * hfname = *qchar
2768
+ * hfvalue = *qchar
2769
+ * addr-spec = local-part "@" domain
2770
+ * local-part = dot-atom-text // not accepted: quoted-string
2771
+ * domain = dot-atom-text // not accepted: "[" *dtext-no-obs "]"
2772
+ * dtext-no-obs = %d33-90 / ; Printable US-ASCII
2773
+ * %d94-126 ; characters not including
2774
+ * ; "[", "]", or "\"
2775
+ * qchar = unreserved / pct-encoded / some-delims
2776
+ * some-delims = "!" / "$" / "'" / "(" / ")" / "*"
2777
+ * / "+" / "," / ";" / ":" / "@"
2778
+ *
2779
+ * Note:
2780
+ * A number of characters that can appear in <addr-spec> MUST be
2781
+ * percent-encoded. These are the characters that cannot appear in
2782
+ * a URI according to [STD66] as well as "%" (because it is used for
2783
+ * percent-encoding) and all the characters in gen-delims except "@"
2784
+ * and ":" (i.e., "/", "?", "#", "[", and "]"). Of the characters
2785
+ * in sub-delims, at least the following also have to be percent-
2786
+ * encoded: "&", ";", and "=". Care has to be taken both when
2787
+ * encoding as well as when decoding to make sure these operations
2788
+ * are applied only once.
2789
+ *
2790
+ * ```
2791
+ *
2792
+ *
2793
+ * When an allowlist has been configured using {@link #add} and {@link #delete}, any URL that passes the
2794
+ * syntactic checks above, additionally will be tested against the content of the allowlist.
2795
+ *
2796
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator.validate} instead
2797
+ *
2798
+ * @returns true if valid, false if not valid
2799
+ */
2800
+ validate(
2801
+ /**
2802
+ * URL to be validated
2803
+ */
2804
+ sUrl: string
2805
+ ): boolean;
2806
+ }
2807
+ const URLWhitelist: URLWhitelist;
2808
+ /**
2809
+ * @deprecated As of version 1.85. use {@link module:sap/base/security/URLListValidator} instead. SAP strives
2810
+ * to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately removed
2811
+ * for compatibility reasons, this API has been deprecated.
2812
+ */
2813
+ export default URLWhitelist;
2814
+
2617
2815
  /**
2618
2816
  * Entry object of the URLWhitelist.
2619
2817
  *
@@ -3653,87 +3851,6 @@ declare module "sap/base/util/Version" {
3653
3851
  }
3654
3852
  }
3655
3853
 
3656
- declare module "sap/ui/util/XMLHelper" {
3657
- /**
3658
- * Error information as provided by the `DOMParser`.
3659
- *
3660
- * Note that the set of properties with meaningful content differs between browsers.
3661
- */
3662
- export type XMLParseErrorInfo = {
3663
- errorCode?: int;
3664
-
3665
- url?: sap.ui.core.URI;
3666
-
3667
- reason?: string;
3668
-
3669
- srcText?: string;
3670
-
3671
- line?: int;
3672
-
3673
- linepos?: int;
3674
-
3675
- filepos?: int;
3676
-
3677
- type?: "error" | "warning";
3678
- };
3679
-
3680
- /**
3681
- * Provides functionality for parsing XML formatted strings and serializing XML documents.
3682
- *
3683
- * @since 1.58
3684
- */
3685
- interface XMLHelper {
3686
- /**
3687
- * Extracts parse error information from the specified document (if any).
3688
- *
3689
- * If an error was found, the returned object contains a browser-specific subset of the properties described
3690
- * in {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo XMLParseErrorInfo}. Otherwise, it just contains
3691
- * an `errorCode` property with value 0.
3692
- *
3693
- *
3694
- * @returns A browser-specific error info object if errors were found, or an object with an errorCode
3695
- * of 0 only
3696
- */
3697
- getParseError(
3698
- /**
3699
- * The parsed XML document
3700
- */
3701
- oDocument: XMLDocument
3702
- ): XMLParseErrorInfo;
3703
- /**
3704
- * Parses the specified XML string into an XML document, using the native parsing functionality of the browser.
3705
- * If an error occurs during parsing, a {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo parse error info object }
3706
- * is attached as the `parseError` property of the returned document.
3707
- *
3708
- *
3709
- * @returns the parsed XML document with a `parseError` property as described in {@link #getParseError}.
3710
- * An error occurred if the `errorCode` property of the `parseError` is not 0.
3711
- */
3712
- parse(
3713
- /**
3714
- * An XML string
3715
- */
3716
- sXMLText: string
3717
- ): XMLDocument;
3718
- /**
3719
- * Serializes the specified DOM tree into a string representation.
3720
- * See:
3721
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer/serializeToString}
3722
- *
3723
- *
3724
- * @returns the serialized XML string
3725
- */
3726
- serialize(
3727
- /**
3728
- * the XML document object to be serialized as string
3729
- */
3730
- oXMLDocument: Node | Attr
3731
- ): string;
3732
- }
3733
- const XMLHelper: XMLHelper;
3734
- export default XMLHelper;
3735
- }
3736
-
3737
3854
  declare module "sap/ui/core/AnimationMode" {
3738
3855
  /**
3739
3856
  * Enumerable list with available animation modes.
@@ -7504,6 +7621,13 @@ declare module "sap/ui/test/opaQunit" {
7504
7621
  }
7505
7622
 
7506
7623
  declare module "sap/ui/test/starter/config" {
7624
+ /**
7625
+ * Namespace containing test starter configuration types.
7626
+ */
7627
+ interface config {}
7628
+ const config: config;
7629
+ export default config;
7630
+
7507
7631
  /**
7508
7632
  * Code coverage options.
7509
7633
  *
@@ -8441,6 +8565,87 @@ declare module "sap/ui/util/Storage" {
8441
8565
  }
8442
8566
  }
8443
8567
 
8568
+ declare module "sap/ui/util/XMLHelper" {
8569
+ /**
8570
+ * Provides functionality for parsing XML formatted strings and serializing XML documents.
8571
+ *
8572
+ * @since 1.58
8573
+ */
8574
+ interface XMLHelper {
8575
+ /**
8576
+ * Extracts parse error information from the specified document (if any).
8577
+ *
8578
+ * If an error was found, the returned object contains a browser-specific subset of the properties described
8579
+ * in {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo XMLParseErrorInfo}. Otherwise, it just contains
8580
+ * an `errorCode` property with value 0.
8581
+ *
8582
+ *
8583
+ * @returns A browser-specific error info object if errors were found, or an object with an errorCode
8584
+ * of 0 only
8585
+ */
8586
+ getParseError(
8587
+ /**
8588
+ * The parsed XML document
8589
+ */
8590
+ oDocument: XMLDocument
8591
+ ): XMLParseErrorInfo;
8592
+ /**
8593
+ * Parses the specified XML string into an XML document, using the native parsing functionality of the browser.
8594
+ * If an error occurs during parsing, a {@link module:sap/ui/util/XMLHelper.XMLParseErrorInfo parse error info object }
8595
+ * is attached as the `parseError` property of the returned document.
8596
+ *
8597
+ *
8598
+ * @returns the parsed XML document with a `parseError` property as described in {@link #getParseError}.
8599
+ * An error occurred if the `errorCode` property of the `parseError` is not 0.
8600
+ */
8601
+ parse(
8602
+ /**
8603
+ * An XML string
8604
+ */
8605
+ sXMLText: string
8606
+ ): XMLDocument;
8607
+ /**
8608
+ * Serializes the specified DOM tree into a string representation.
8609
+ * See:
8610
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer/serializeToString}
8611
+ *
8612
+ *
8613
+ * @returns the serialized XML string
8614
+ */
8615
+ serialize(
8616
+ /**
8617
+ * the XML document object to be serialized as string
8618
+ */
8619
+ oXMLDocument: Node | Attr
8620
+ ): string;
8621
+ }
8622
+ const XMLHelper: XMLHelper;
8623
+ export default XMLHelper;
8624
+
8625
+ /**
8626
+ * Error information as provided by the `DOMParser`.
8627
+ *
8628
+ * Note that the set of properties with meaningful content differs between browsers.
8629
+ */
8630
+ export type XMLParseErrorInfo = {
8631
+ errorCode?: int;
8632
+
8633
+ url?: sap.ui.core.URI;
8634
+
8635
+ reason?: string;
8636
+
8637
+ srcText?: string;
8638
+
8639
+ line?: int;
8640
+
8641
+ linepos?: int;
8642
+
8643
+ filepos?: int;
8644
+
8645
+ type?: "error" | "warning";
8646
+ };
8647
+ }
8648
+
8444
8649
  declare module "sap/ui/VersionInfo" {
8445
8650
  /**
8446
8651
  * @since 1.56.0
@@ -8581,6 +8786,12 @@ declare namespace sap {
8581
8786
  * @since 1.37.0
8582
8787
  */
8583
8788
  waitFor?: Promise<any> | Array<Promise<any>>;
8789
+ /**
8790
+ * a marker to indicate that the Component is a launcher, e.g. the fiori launchpad (experimental setting)
8791
+ *
8792
+ * @since 1.153.0
8793
+ */
8794
+ isLauncher?: boolean;
8584
8795
  };
8585
8796
  /**
8586
8797
  * Controls when and from where to load the manifest for the Component. When set to any truthy value, the
@@ -18829,6 +19040,151 @@ declare namespace sap {
18829
19040
  ]
18830
19041
  | null;
18831
19042
  }
19043
+
19044
+ /**
19045
+ * The format options type for date formats.
19046
+ */
19047
+ type DateFormatOptions =
19048
+ sap.ui.core.format.DateFormat.IntervalFormatOptions & {
19049
+ /**
19050
+ * A date pattern in {@link https://unicode.org/reports/tr35/tr35-dates.html#table-date-field-symbol-table LDML format}.
19051
+ * It is not verified whether the pattern represents only a date.
19052
+ */
19053
+ pattern?: string;
19054
+ /**
19055
+ * The locale-dependent formatting style for the date, used if no `pattern` is provided.
19056
+ */
19057
+ style?: "short" | "medium" | "long" | "full";
19058
+ };
19059
+
19060
+ /**
19061
+ * The base format options for date formats.
19062
+ */
19063
+ type FormatOptions = {
19064
+ /**
19065
+ * The calendar type used to format and parse the date. By default, this value is taken from the configuration
19066
+ * (see {@link module:sap/base/i18n/Formatting.setCalendarType Formatting.setCalendarType}), or - if not
19067
+ * set - calculated based on the current locale, see {@link module:sap/base/i18n/Formatting.getCalendarType Formatting.getCalendarType}.
19068
+ */
19069
+ calendarType?: import("sap/base/i18n/date/CalendarType").default;
19070
+ /**
19071
+ * Specifies the calendar week numbering. If specified, this overwrites `firstDayOfWeek` and `minimalDaysInFirstWeek`.
19072
+ *
19073
+ * @since 1.108.0
19074
+ */
19075
+ calendarWeekNumbering?: import("sap/base/i18n/date/CalendarWeekNumbering").default;
19076
+ /**
19077
+ * Specifies the first day of the week starting with `0` (which is Sunday). If not defined, the value is
19078
+ * taken from the locale, see {@link sap.ui.core.LocaleData.getFirstDayOfWeek LocaleData.getFirstDayOfWeek}.
19079
+ *
19080
+ * @since 1.105.0
19081
+ */
19082
+ firstDayOfWeek?: int;
19083
+ /**
19084
+ * Contains pattern symbols (for example, "yMMMd" or "Hms") that are converted into the pattern in the used
19085
+ * locale which matches the wanted symbols best. The symbols must be in canonical order: Era (G), Year (y/Y),
19086
+ * Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J), Minute (m), Second
19087
+ * (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
19088
+ *
19089
+ * @since 1.34.0
19090
+ */
19091
+ format?: string;
19092
+ /**
19093
+ * Minimal days at the beginning of the year that define the first calendar week. If not defined, the value
19094
+ * is taken from the locale, see {@link sap.ui.core.LocaleData.getMinimalDaysInFirstWeek LocaleData.getMinimalDaysInFirstWeek}.
19095
+ *
19096
+ * @since 1.105.0
19097
+ */
19098
+ minimalDaysInFirstWeek?: int;
19099
+ /**
19100
+ * If `true`, the date is formatted relatively to today's date if it is within the given `relativeRange`.
19101
+ * **Example:**
19102
+ * - Today is the **2026-01-05**
19103
+ * - `relative` is set to `true`
19104
+ * - `relativeRange` is set to `[-2, 2]`
19105
+ * - This means that only dates two days prior or after **2026-01-05** are formatted in the relative format
19106
+ *
19107
+ * - For example, date **2026-01-07** would be formatted to `"in 2 days"` for the English locale
19108
+ * - Whereas, the **2026-01-08** would be formatted in the non-relative format as it is out of the `relativeRange`
19109
+ */
19110
+ relative?: boolean;
19111
+ /**
19112
+ * The date range in which the relative formatting is applied. It depends on the `relativeScale`. For example,
19113
+ * `relativeScale="day"` and `relativeRange=[-2, 2]` means only dates that are 2 **days** before or 2 **days**
19114
+ * after today's date are formatted relatively. If no range given, the range is determined depending on
19115
+ * the `relativeScale`. This is the list of defaults depending on the `relativeScale`:
19116
+ * - `relativeScale="second"`, `relativeRange=[-60, 60]`
19117
+ * - `relativeScale="minute"`, `relativeRange=[-60, 60]`
19118
+ * - `relativeScale="hour"`, `relativeRange=[-24, 24]`
19119
+ * - `relativeScale="day"`, `relativeRange=[-6, 6]`
19120
+ * - `relativeScale="week"`, `relativeRange=[-4, 4]`
19121
+ * - `relativeScale="month"`, `relativeRange=[-12, 12]`
19122
+ * - `relativeScale="year"`, `relativeRange=[-10, 10]` Otherwise, when `relativeScale` is set to
19123
+ * `auto`, all dates are formatted relatively.
19124
+ */
19125
+ relativeRange?: int[];
19126
+ /**
19127
+ * If `auto` is set, a new relative time format is switched on for all Date/Time instances. The relative
19128
+ * scale is chosen depending on the difference between the given date and now.
19129
+ */
19130
+ relativeScale?:
19131
+ | "auto"
19132
+ | "year"
19133
+ | "month"
19134
+ | "week"
19135
+ | "day"
19136
+ | "hour"
19137
+ | "minute"
19138
+ | "second";
19139
+ /**
19140
+ * The style of the relative format.
19141
+ *
19142
+ * @since 1.34.4
19143
+ */
19144
+ relativeStyle?: "narrow" | "short" | "wide";
19145
+ /**
19146
+ * If `true`, parsing validates that the value is a valid date. For example, the parsing of an overflowing
19147
+ * value like **2026-01-32** returns `null` instead of **2026-02-01**.
19148
+ */
19149
+ strictParsing?: boolean;
19150
+ /**
19151
+ * If `true`, the date is formatted and parsed as UTC instead of the local timezone.
19152
+ */
19153
+ UTC?: boolean;
19154
+ };
19155
+
19156
+ /**
19157
+ * Extends the format options for a single date, time, or date and time to include interval-related settings.
19158
+ */
19159
+ type IntervalFormatOptions =
19160
+ sap.ui.core.format.DateFormat.FormatOptions & {
19161
+ /**
19162
+ * If `true`, the {@link sap.ui.core.format.DateFormat#format format} method expects an array with two dates
19163
+ * as the first argument and formats them as an interval. For example, the interval "Jan 10, 2008 - Jan
19164
+ * 12, 2008" is formatted as "Jan 10-12, 2008" if the `format` option is set to `"yMMMd"`. If no `format`
19165
+ * is set, the two dates are formatted separately and concatenated with a locale-dependent pattern.
19166
+ *
19167
+ * @since 1.48.0
19168
+ */
19169
+ interval?: boolean;
19170
+ /**
19171
+ * A delimiter for intervals. A specific interval format is created with a given delimiter.
19172
+ * **Example:** If `oFormatOptions.intervalDelimiter` is set to "...", the formatted result would be "Jan
19173
+ * 10, 2008...Feb 12, 2008". **Note:** If this format option is set, the locale-specific interval notation
19174
+ * is overridden. For example, "Jan 10 – Feb 12, 2008" becomes "Jan 10, 2008...Feb 12, 2008".
19175
+ *
19176
+ * @since 1.113.0
19177
+ */
19178
+ intervalDelimiter?: string;
19179
+ /**
19180
+ * Only relevant if `interval` is set to `true`. This allows you to pass an array with only one date object
19181
+ * to the {@link sap.ui.core.format.DateFormat#format format} method, which is then formatted as a single
19182
+ * value. For example, the value `[UI5Date.getInstance("2026-01-20")]` is formatted to `"Jan 20, 2026"`
19183
+ * in the English locale. If the `pattern` format option is set to an interval pattern, the formatted result
19184
+ * displays the value as an interval, but the dates of this interval are the same.
19185
+ */
19186
+ singleIntervalValue?: boolean;
19187
+ };
18832
19188
  }
18833
19189
 
18834
19190
  namespace NumberFormat {
@@ -18899,7 +19255,7 @@ declare namespace sap {
18899
19255
  currencyCode?: boolean;
18900
19256
  /**
18901
19257
  * Can be set either to 'standard' (the default value) or to 'accounting' for an accounting-specific currency
18902
- * display
19258
+ * display.
18903
19259
  */
18904
19260
  currencyContext?:
18905
19261
  | "standard"
@@ -18960,18 +19316,17 @@ declare namespace sap {
18960
19316
  */
18961
19317
  preserveDecimals?: boolean;
18962
19318
  /**
18963
- * Defines whether the currency code/symbol is shown in the formatted string, e.g. true: "1.00 EUR", false:
18964
- * "1.00" for locale "en" If both `showMeasure` and `showNumber` are false, an empty string is returned
19319
+ * Defines whether the currency code/symbol is shown in the formatted string, for example, `1 EUR` for locale
19320
+ * `"en"`. `NumberFormat.getCurrencyInstance({showMeasure: true}).format(1, "EUR"); // "1.00 EUR"` `NumberFormat.getCurrencyInstance({showMeasure:
19321
+ * false}).format(1, "EUR"); // "1.00"` If both `showMeasure` and `showNumber` are false, an empty string
19322
+ * is returned.
18965
19323
  */
18966
19324
  showMeasure?: boolean;
18967
19325
  /**
18968
- * Defines whether the number is shown as part of the result string, e.g. 1 EUR for locale "en"
18969
- * ```javascript
18970
- * `NumberFormat.getCurrencyInstance({showNumber: true}).format(1, "EUR"); // "1.00 EUR"````
18971
- *
18972
- * ```javascript
18973
- * `NumberFormat.getCurrencyInstance({showNumber: false}).format(1, "EUR"); // "EUR"````
18974
- * If both `showMeasure` and `showNumber` are false, an empty string is returned
19326
+ * Defines whether the number is shown as part of the result string, for example, `1 EUR` for locale `"en"`.
19327
+ * `NumberFormat.getCurrencyInstance({showNumber: true}).format(1, "EUR"); // "1.00 EUR"` `NumberFormat.getCurrencyInstance({showNumber:
19328
+ * false}).format(1, "EUR"); // "EUR"` If both `showMeasure` and `showNumber` are false, an empty string
19329
+ * is returned.
18975
19330
  */
18976
19331
  showNumber?: boolean;
18977
19332
  /**
@@ -19201,6 +19556,7 @@ declare namespace sap {
19201
19556
  /**
19202
19557
  * Defines a set of custom units, for example:
19203
19558
  * ```javascript
19559
+ *
19204
19560
  * {"electric-inductance": {
19205
19561
  * "displayName": "henry",
19206
19562
  * "unitPattern-count-one": "{0} H",
@@ -19209,7 +19565,8 @@ declare namespace sap {
19209
19565
  * "decimals": 2,
19210
19566
  * "precision": 4
19211
19567
  * }
19212
- * }```
19568
+ * }
19569
+ * ```
19213
19570
  */
19214
19571
  customUnits?: Record<string, object>;
19215
19572
  /**
@@ -19257,29 +19614,17 @@ declare namespace sap {
19257
19614
  */
19258
19615
  preserveDecimals?: boolean;
19259
19616
  /**
19260
- * Defines whether the unit of measure is shown in the formatted string, for example 1 day for locale "en"
19261
- *
19262
- * ```javascript
19263
- * NumberFormat.getUnitInstance({showMeasure: true})
19264
- * .format(1, "duration-day"); // "1 day"```
19265
- *
19266
- * ```javascript
19267
- * NumberFormat.getUnitInstance({showMeasure: false})
19268
- * .format(1, "duration-day"); // "1"```
19269
- * If both `showMeasure` and `showNumber` are set to false, an empty string is returned.
19617
+ * Defines whether the unit of measure is shown in the formatted string, for example, `1 day` for locale
19618
+ * `"en"`. `NumberFormat.getUnitInstance({showMeasure: true}).format(1, "duration-day"); // "1 day"` `NumberFormat.getUnitInstance({showMeasure:
19619
+ * false}).format(1, "duration-day"); // "1"` If both `showMeasure` and `showNumber` are set to false, an
19620
+ * empty string is returned.
19270
19621
  */
19271
19622
  showMeasure?: boolean;
19272
19623
  /**
19273
- * Defines whether the number is shown as part of the formatted string, for example 1 day for locale "en"
19274
- *
19275
- * ```javascript
19276
- * NumberFormat.getUnitInstance({showNumber: true})
19277
- * .format(1, "duration-day"); // "1 day"```
19278
- *
19279
- * ```javascript
19280
- * NumberFormat.getUnitInstance({showNumber: false})
19281
- * .format(1, "duration-day"); // "day"```
19282
- * If both `showMeasure` and `showNumber` are false, an empty string is returned
19624
+ * Defines whether the number is shown as part of the formatted string, for example, `1 day` for locale
19625
+ * `"en"`. `NumberFormat.getUnitInstance({showNumber: true}).format(1, "duration-day"); // "1 day"` `NumberFormat.getUnitInstance({showNumber:
19626
+ * false}).format(1, "duration-day"); // "day"` If both `showMeasure` and `showNumber` are false, an empty
19627
+ * string is returned.
19283
19628
  */
19284
19629
  showNumber?: boolean;
19285
19630
  /**
@@ -19319,6 +19664,34 @@ declare namespace sap {
19319
19664
  * @returns date instance of the DateFormat
19320
19665
  */
19321
19666
  static getDateInstance(
19667
+ /**
19668
+ * Object which defines the format options
19669
+ */
19670
+ oFormatOptions?: sap.ui.core.format.DateFormat.DateFormatOptions,
19671
+ /**
19672
+ * Locale to ask for locale specific texts/settings
19673
+ */
19674
+ oLocale?: sap.ui.core.Locale
19675
+ ): sap.ui.core.format.DateFormat;
19676
+ /**
19677
+ * Get a date instance of the DateFormat, which can be used for formatting.
19678
+ *
19679
+ *
19680
+ * @returns date instance of the DateFormat
19681
+ */
19682
+ static getDateInstance(
19683
+ /**
19684
+ * Locale to ask for locale specific texts/settings
19685
+ */
19686
+ oLocale?: sap.ui.core.Locale
19687
+ ): sap.ui.core.format.DateFormat;
19688
+ /**
19689
+ * Get a datetime instance of the DateFormat, which can be used for formatting.
19690
+ *
19691
+ *
19692
+ * @returns datetime instance of the DateFormat
19693
+ */
19694
+ static getDateTimeInstance(
19322
19695
  /**
19323
19696
  * Object which defines the format options
19324
19697
  */
@@ -19346,28 +19719,30 @@ declare namespace sap {
19346
19719
  */
19347
19720
  format?: string;
19348
19721
  /**
19349
- * a data pattern in LDML format. It is not verified whether the pattern represents only a date.
19722
+ * a datetime pattern in LDML format. It is not verified whether the pattern represents a full datetime.
19350
19723
  */
19351
19724
  pattern?: string;
19352
19725
  /**
19353
- * can be either 'short, 'medium', 'long' or 'full'. If no pattern is given, a locale dependent default
19354
- * date pattern of that style is used from the LocaleData class.
19726
+ * can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
19727
+ * with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
19728
+ * If no pattern is given, a locale dependent default datetime pattern of that style is used from the LocaleData
19729
+ * class.
19355
19730
  */
19356
19731
  style?: string;
19357
19732
  /**
19358
- * if true, by parsing it is checked if the value is a valid date
19733
+ * if true, by parsing it is checked if the value is a valid datetime
19359
19734
  */
19360
19735
  strictParsing?: boolean;
19361
19736
  /**
19362
- * if true, the date is formatted relatively to todays date if it is within the given day range, e.g. "today",
19737
+ * if true, the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
19363
19738
  * "1 day ago", "in 5 days"
19364
19739
  */
19365
19740
  relative?: boolean;
19366
19741
  /**
19367
- * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to default value
19368
- * 'day', the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next
19369
- * 6 days are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all
19370
- * dates are formatted relatively.
19742
+ * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to value 'day',
19743
+ * the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next 6 days
19744
+ * are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all dates are
19745
+ * formatted relatively.
19371
19746
  */
19372
19747
  relativeRange?: int[];
19373
19748
  /**
@@ -19389,8 +19764,9 @@ declare namespace sap {
19389
19764
  /**
19390
19765
  * Since 1.113.0, a delimiter for intervals. With a given interval delimiter a specific interval format
19391
19766
  * is created. **Example:** If `oFormatOptions.intervalDelimiter` is set to "...", an interval would be
19392
- * given as "Jan 10, 2008...Feb 12, 2008". **Note:** If this format option is set, the locale-specific interval
19393
- * notation is overruled, for example "Jan 10 – Feb 12, 2008" becomes "Jan 10, 2008...Feb 12, 2008".
19767
+ * given as "Jan 10, 2008, 9:15:00 AM...Jan 10, 2008, 11:45:00 AM". **Note:** If this format option is set,
19768
+ * the locale-specific interval notation is overruled, for example "Jan 10, 2008, 9:15 – 11:45 AM" becomes
19769
+ * "Jan 10, 2008, 9:15 AM...Jan 10, 2008, 11:45 AM".
19394
19770
  */
19395
19771
  intervalDelimiter?: string;
19396
19772
  /**
@@ -19414,249 +19790,133 @@ declare namespace sap {
19414
19790
  oLocale?: sap.ui.core.Locale
19415
19791
  ): sap.ui.core.format.DateFormat;
19416
19792
  /**
19417
- * Get a date instance of the DateFormat, which can be used for formatting.
19793
+ * Get a datetime instance of the DateFormat, which can be used for formatting.
19418
19794
  *
19419
19795
  *
19420
- * @returns date instance of the DateFormat
19796
+ * @returns datetime instance of the DateFormat
19421
19797
  */
19422
- static getDateInstance(
19798
+ static getDateTimeInstance(
19423
19799
  /**
19424
19800
  * Locale to ask for locale specific texts/settings
19425
19801
  */
19426
19802
  oLocale?: sap.ui.core.Locale
19427
19803
  ): sap.ui.core.format.DateFormat;
19428
19804
  /**
19429
- * Get a datetime instance of the DateFormat, which can be used for formatting.
19805
+ * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
19430
19806
  *
19807
+ * @since 1.99.0
19431
19808
  *
19432
- * @returns datetime instance of the DateFormat
19809
+ * @returns dateTimeWithTimezone instance of the DateFormat
19433
19810
  */
19434
- static getDateTimeInstance(
19435
- /**
19436
- * Object which defines the format options
19437
- */
19438
- oFormatOptions?: {
19439
- /**
19440
- * since 1.108.0 specifies the calendar week numbering. If specified, this overwrites `oFormatOptions.firstDayOfWeek`
19441
- * and `oFormatOptions.minimalDaysInFirstWeek`.
19442
- */
19443
- calendarWeekNumbering?: import("sap/base/i18n/date/CalendarWeekNumbering").default;
19444
- /**
19445
- * since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
19446
- * the value taken from the locale is used
19447
- */
19448
- firstDayOfWeek?: int;
19449
- /**
19450
- * since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
19451
- * defined, the value taken from the locale is used
19452
- */
19453
- minimalDaysInFirstWeek?: int;
19454
- /**
19455
- * since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
19456
- * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
19457
- * is: Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
19458
- * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
19459
- */
19460
- format?: string;
19461
- /**
19462
- * a datetime pattern in LDML format. It is not verified whether the pattern represents a full datetime.
19463
- */
19464
- pattern?: string;
19465
- /**
19466
- * can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
19467
- * with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
19468
- * If no pattern is given, a locale dependent default datetime pattern of that style is used from the LocaleData
19469
- * class.
19470
- */
19471
- style?: string;
19472
- /**
19473
- * if true, by parsing it is checked if the value is a valid datetime
19474
- */
19475
- strictParsing?: boolean;
19476
- /**
19477
- * if true, the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
19478
- * "1 day ago", "in 5 days"
19479
- */
19480
- relative?: boolean;
19481
- /**
19482
- * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to value 'day',
19483
- * the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next 6 days
19484
- * are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all dates are
19485
- * formatted relatively.
19486
- */
19487
- relativeRange?: int[];
19488
- /**
19489
- * if 'auto' is set, new relative time format is switched on for all Date/Time Instances. The relative scale
19490
- * is chosen depending on the difference between the given date and now.
19491
- */
19492
- relativeScale?: string;
19493
- /**
19494
- * since 1.32.10, 1.34.4 the style of the relative format. The valid values are "wide", "short", "narrow"
19495
- */
19496
- relativeStyle?: string;
19497
- /**
19498
- * since 1.48.0 if true, the {@link sap.ui.core.format.DateFormat#format format} method expects an array
19499
- * with two dates as the first argument and formats them as interval. Further interval "Jan 10, 2008 - Jan
19500
- * 12, 2008" will be formatted as "Jan 10-12, 2008" if the 'format' option is set with necessary symbols.
19501
- * Otherwise the two given dates are formatted separately and concatenated with local dependent pattern.
19502
- */
19503
- interval?: boolean;
19504
- /**
19505
- * Since 1.113.0, a delimiter for intervals. With a given interval delimiter a specific interval format
19506
- * is created. **Example:** If `oFormatOptions.intervalDelimiter` is set to "...", an interval would be
19507
- * given as "Jan 10, 2008, 9:15:00 AM...Jan 10, 2008, 11:45:00 AM". **Note:** If this format option is set,
19508
- * the locale-specific interval notation is overruled, for example "Jan 10, 2008, 9:15 – 11:45 AM" becomes
19509
- * "Jan 10, 2008, 9:15 AM...Jan 10, 2008, 11:45 AM".
19510
- */
19511
- intervalDelimiter?: string;
19512
- /**
19513
- * Only relevant if oFormatOptions.interval is set to 'true'. This allows to pass an array with only one
19514
- * date object to the {@link sap.ui.core.format.DateFormat#format format} method.
19515
- */
19516
- singleIntervalValue?: boolean;
19517
- /**
19518
- * if true, the date is formatted and parsed as UTC instead of the local timezone
19519
- */
19520
- UTC?: boolean;
19521
- /**
19522
- * The calender type which is used to format and parse the date. This value is by default either set in
19523
- * configuration or calculated based on current locale.
19524
- */
19525
- calendarType?: import("sap/base/i18n/date/CalendarType").default;
19526
- },
19527
- /**
19528
- * Locale to ask for locale specific texts/settings
19529
- */
19530
- oLocale?: sap.ui.core.Locale
19531
- ): sap.ui.core.format.DateFormat;
19532
- /**
19533
- * Get a datetime instance of the DateFormat, which can be used for formatting.
19534
- *
19535
- *
19536
- * @returns datetime instance of the DateFormat
19537
- */
19538
- static getDateTimeInstance(
19539
- /**
19540
- * Locale to ask for locale specific texts/settings
19541
- */
19542
- oLocale?: sap.ui.core.Locale
19543
- ): sap.ui.core.format.DateFormat;
19544
- /**
19545
- * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
19546
- *
19547
- * @since 1.99.0
19548
- *
19549
- * @returns dateTimeWithTimezone instance of the DateFormat
19550
- */
19551
- static getDateTimeWithTimezoneInstance(
19552
- /**
19553
- * An object which defines the format options
19554
- */
19555
- oFormatOptions?: {
19556
- /**
19557
- * since 1.108.0 specifies the calendar week numbering. If specified, this overwrites `oFormatOptions.firstDayOfWeek`
19558
- * and `oFormatOptions.minimalDaysInFirstWeek`.
19559
- */
19560
- calendarWeekNumbering?: import("sap/base/i18n/date/CalendarWeekNumbering").default;
19561
- /**
19562
- * since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
19563
- * the value taken from the locale is used
19564
- */
19565
- firstDayOfWeek?: int;
19566
- /**
19567
- * since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
19568
- * defined, the value taken from the locale is used
19569
- */
19570
- minimalDaysInFirstWeek?: int;
19571
- /**
19572
- * A string containing pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into a pattern for
19573
- * the used locale that matches the wanted symbols best. The symbols must be in canonical order, that is:
19574
- * Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
19575
- * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
19576
- */
19577
- format?: string;
19578
- /**
19579
- * a datetime pattern in LDML format. It is not verified whether the pattern represents a full datetime.
19580
- */
19581
- pattern?: string;
19582
- /**
19583
- * Specifies if the date should be displayed. It is ignored for formatting when an options pattern or a
19584
- * format are supplied.
19585
- */
19586
- showDate?: boolean;
19587
- /**
19588
- * Specifies if the time should be displayed. It is ignored for formatting when an options pattern or a
19589
- * format are supplied.
19590
- */
19591
- showTime?: boolean;
19592
- /**
19593
- * Specifies if the timezone should be displayed. It is ignored for formatting when an options pattern or
19594
- * a format are supplied.
19595
- */
19596
- showTimezone?: boolean;
19597
- /**
19598
- * Can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
19599
- * with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
19600
- * If no pattern is given, a locale-dependent default datetime pattern of that style from the LocaleData
19601
- * class is used.
19602
- */
19603
- style?: string;
19604
- /**
19605
- * Whether to check by parsing if the value is a valid datetime
19606
- */
19607
- strictParsing?: boolean;
19608
- /**
19609
- * Whether the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
19610
- * "1 day ago", "in 5 days"
19611
- */
19612
- relative?: boolean;
19613
- /**
19614
- * The day range used for relative formatting. If `oFormatOptions.relativeScale` is set to the default value
19615
- * 'day', the `relativeRange is by default [-6, 6], which means that only the previous 6 and the following
19616
- * 6 days are formatted relatively. If oFormatOptions.relativeScale` is set to 'auto', all dates are
19617
- * formatted relatively.
19618
- */
19619
- relativeRange?: int[];
19620
- /**
19621
- * If 'auto' is set, a new relative time format is switched on for all Date/Time instances. The default
19622
- * value depends on `showDate` and `showTime` options.
19623
- */
19624
- relativeScale?: string;
19625
- /**
19626
- * The style of the relative format. The valid values are "wide", "short", "narrow"
19627
- */
19628
- relativeStyle?: string;
19629
- /**
19630
- * The calendar type which is used to format and parse the date. This value is by default either set in
19631
- * the configuration or calculated based on the current locale.
19632
- */
19633
- calendarType?: import("sap/base/i18n/date/CalendarType").default;
19634
- },
19635
- /**
19636
- * Locale to ask for locale-specific texts/settings
19637
- */
19638
- oLocale?: sap.ui.core.Locale
19639
- ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
19640
- /**
19641
- * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
19642
- *
19643
- * @since 1.99.0
19644
- *
19645
- * @returns dateTimeWithTimezone instance of the DateFormat
19646
- */
19647
- static getDateTimeWithTimezoneInstance(
19648
- /**
19649
- * Locale to ask for locale-specific texts/settings
19650
- */
19651
- oLocale?: sap.ui.core.Locale
19652
- ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
19653
- /**
19654
- * Get a time instance of the DateFormat, which can be used for formatting.
19655
- *
19656
- *
19657
- * @returns time instance of the DateFormat
19658
- */
19659
- static getTimeInstance(
19811
+ static getDateTimeWithTimezoneInstance(
19812
+ /**
19813
+ * An object which defines the format options
19814
+ */
19815
+ oFormatOptions?: {
19816
+ /**
19817
+ * since 1.108.0 specifies the calendar week numbering. If specified, this overwrites `oFormatOptions.firstDayOfWeek`
19818
+ * and `oFormatOptions.minimalDaysInFirstWeek`.
19819
+ */
19820
+ calendarWeekNumbering?: import("sap/base/i18n/date/CalendarWeekNumbering").default;
19821
+ /**
19822
+ * since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
19823
+ * the value taken from the locale is used
19824
+ */
19825
+ firstDayOfWeek?: int;
19826
+ /**
19827
+ * since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
19828
+ * defined, the value taken from the locale is used
19829
+ */
19830
+ minimalDaysInFirstWeek?: int;
19831
+ /**
19832
+ * A string containing pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into a pattern for
19833
+ * the used locale that matches the wanted symbols best. The symbols must be in canonical order, that is:
19834
+ * Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
19835
+ * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
19836
+ */
19837
+ format?: string;
19838
+ /**
19839
+ * a datetime pattern in LDML format. It is not verified whether the pattern represents a full datetime.
19840
+ */
19841
+ pattern?: string;
19842
+ /**
19843
+ * Specifies if the date should be displayed. It is ignored for formatting when an options pattern or a
19844
+ * format are supplied.
19845
+ */
19846
+ showDate?: boolean;
19847
+ /**
19848
+ * Specifies if the time should be displayed. It is ignored for formatting when an options pattern or a
19849
+ * format are supplied.
19850
+ */
19851
+ showTime?: boolean;
19852
+ /**
19853
+ * Specifies if the timezone should be displayed. It is ignored for formatting when an options pattern or
19854
+ * a format are supplied.
19855
+ */
19856
+ showTimezone?: boolean;
19857
+ /**
19858
+ * Can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
19859
+ * with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
19860
+ * If no pattern is given, a locale-dependent default datetime pattern of that style from the LocaleData
19861
+ * class is used.
19862
+ */
19863
+ style?: string;
19864
+ /**
19865
+ * Whether to check by parsing if the value is a valid datetime
19866
+ */
19867
+ strictParsing?: boolean;
19868
+ /**
19869
+ * Whether the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
19870
+ * "1 day ago", "in 5 days"
19871
+ */
19872
+ relative?: boolean;
19873
+ /**
19874
+ * The day range used for relative formatting. If `oFormatOptions.relativeScale` is set to the default value
19875
+ * 'day', the `relativeRange is by default [-6, 6], which means that only the previous 6 and the following
19876
+ * 6 days are formatted relatively. If oFormatOptions.relativeScale` is set to 'auto', all dates are
19877
+ * formatted relatively.
19878
+ */
19879
+ relativeRange?: int[];
19880
+ /**
19881
+ * If 'auto' is set, a new relative time format is switched on for all Date/Time instances. The default
19882
+ * value depends on `showDate` and `showTime` options.
19883
+ */
19884
+ relativeScale?: string;
19885
+ /**
19886
+ * The style of the relative format. The valid values are "wide", "short", "narrow"
19887
+ */
19888
+ relativeStyle?: string;
19889
+ /**
19890
+ * The calendar type which is used to format and parse the date. This value is by default either set in
19891
+ * the configuration or calculated based on the current locale.
19892
+ */
19893
+ calendarType?: import("sap/base/i18n/date/CalendarType").default;
19894
+ },
19895
+ /**
19896
+ * Locale to ask for locale-specific texts/settings
19897
+ */
19898
+ oLocale?: sap.ui.core.Locale
19899
+ ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
19900
+ /**
19901
+ * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
19902
+ *
19903
+ * @since 1.99.0
19904
+ *
19905
+ * @returns dateTimeWithTimezone instance of the DateFormat
19906
+ */
19907
+ static getDateTimeWithTimezoneInstance(
19908
+ /**
19909
+ * Locale to ask for locale-specific texts/settings
19910
+ */
19911
+ oLocale?: sap.ui.core.Locale
19912
+ ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
19913
+ /**
19914
+ * Get a time instance of the DateFormat, which can be used for formatting.
19915
+ *
19916
+ *
19917
+ * @returns time instance of the DateFormat
19918
+ */
19919
+ static getTimeInstance(
19660
19920
  /**
19661
19921
  * Object which defines the format options
19662
19922
  */
@@ -24674,6 +24934,406 @@ declare namespace sap {
24674
24934
  };
24675
24935
  }
24676
24936
 
24937
+ namespace html {
24938
+ namespace HTMLElement {
24939
+ namespace MetadataOptions {
24940
+ namespace Association {
24941
+ /**
24942
+ * An object literal describing the mapping of an association as property of a class derived from `sap.ui.core.html.HTMLElement`.
24943
+ */
24944
+ type Mapping = {
24945
+ /**
24946
+ * Defines the mapping of the association which defaults to "property". Associations are forwarded to the
24947
+ * corresponding mutator of the HTMLElement.
24948
+ */
24949
+ type?: "property";
24950
+ /**
24951
+ * Defines the target of the mapping of the association to which property it will be mapped to.
24952
+ */
24953
+ to?: string;
24954
+ /**
24955
+ * Defines the name of the formatter function on the HTMLElement instance to format the value before its
24956
+ * being mapped.
24957
+ */
24958
+ formatter?: string;
24959
+ };
24960
+ }
24961
+
24962
+ namespace Property {
24963
+ /**
24964
+ * An object literal describing the mapping of a property of a class derived from `sap.ui.core.html.HTMLElement`.
24965
+ */
24966
+ type Mapping = {
24967
+ /**
24968
+ * Defines the mapping of the property to be either "property", "style", "textContent", "slot", or "none".
24969
+ * The default mapping of a property is "property" which either renders the value of the property into an
24970
+ * attribute of the custom tag or forwards object properties to the mutator in the onAfterRendering phase.
24971
+ */
24972
+ type?: "property" | "style" | "textContent" | "slot" | "none";
24973
+ /**
24974
+ * Defines the target of the mapping of the property (e.g. the name of the attribute/property).
24975
+ */
24976
+ to?: string;
24977
+ /**
24978
+ * Defines the name of the formatter function on the HTMLElement instance to format the value before its
24979
+ * being mapped.
24980
+ */
24981
+ formatter?: string;
24982
+ };
24983
+ }
24984
+
24985
+ /**
24986
+ * An object literal describing a property of a class derived from `sap.ui.core.html.HTMLElement`. See {@link sap.ui.core.html.HTMLElement.MetadataOptions MetadataOptions }
24987
+ * for details on its usage.
24988
+ */
24989
+ type Aggregation =
24990
+ sap.ui.base.ManagedObject.MetadataOptions.Aggregation & {
24991
+ /**
24992
+ * Flag that marks the property as deprecated (defaults to false). May lead to an additional warning log
24993
+ * message at runtime when the property is still used. For the documentation, also add a `@deprecated` tag
24994
+ * in the JSDoc, describing since when it is deprecated and what any alternatives are.
24995
+ */
24996
+ slot?: string;
24997
+ };
24998
+
24999
+ /**
25000
+ * An object literal describing an association of a class derived from `sap.ui.core.html.HTMLElement`. See
25001
+ * {@link sap.ui.core.html.HTMLElement.MetadataOptions MetadataOptions} for details on its usage.
25002
+ */
25003
+ type Association =
25004
+ sap.ui.base.ManagedObject.MetadataOptions.Association & {
25005
+ /**
25006
+ * Defines the mapping of the association which defaults to "property". Associations are forwarded to the
25007
+ * corresponding mutator of the HTMLElement.
25008
+ */
25009
+ mapping?:
25010
+ | "property"
25011
+ | sap.ui.core.html.HTMLElement.MetadataOptions.Association.Mapping;
25012
+ };
25013
+
25014
+ /**
25015
+ * An object literal describing a property of a class derived from `sap.ui.core.html.HTMLElement`. See {@link sap.ui.core.html.HTMLElement.MetadataOptions MetadataOptions }
25016
+ * for details on its usage.
25017
+ */
25018
+ type Property =
25019
+ sap.ui.base.ManagedObject.MetadataOptions.Property & {
25020
+ /**
25021
+ * Defines the mapping of the property to be either "property", "style", "textContent", "slot", or "none".
25022
+ * The default mapping of a property is "property" which either renders the value of the property into an
25023
+ * attribute of the custom tag or forwards object properties to the mutator in the onAfterRendering phase.
25024
+ */
25025
+ mapping?:
25026
+ | "property"
25027
+ | "style"
25028
+ | "textContent"
25029
+ | "slot"
25030
+ | "none"
25031
+ | sap.ui.core.html.HTMLElement.MetadataOptions.Property.Mapping;
25032
+ };
25033
+ }
25034
+
25035
+ /**
25036
+ * The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
25037
+ * its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
25038
+ */
25039
+ type MetadataOptions = sap.ui.core.Element.MetadataOptions & {
25040
+ /**
25041
+ * Tag name of the HTMLElement to be used in the renderer to render the HTML.
25042
+ */
25043
+ tag: string;
25044
+ /**
25045
+ * An object literal whose properties each define a new managed property in the HTMLElement subclass. See
25046
+ * {@link sap.ui.base.ManagedObject.MetadataOptions.Property Property} for more details.
25047
+ */
25048
+ properties?: Record<
25049
+ string,
25050
+ string | sap.ui.core.html.HTMLElement.MetadataOptions.Property
25051
+ >;
25052
+ /**
25053
+ * An object literal whose properties each define a new aggregation in the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
25054
+ * for more details.
25055
+ */
25056
+ aggregations?: Record<
25057
+ string,
25058
+ string | sap.ui.core.html.HTMLElement.MetadataOptions.Aggregation
25059
+ >;
25060
+ /**
25061
+ * An object literal whose properties each define a new association in the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Association Association }
25062
+ * for more details.
25063
+ */
25064
+ associations?: Record<
25065
+ string,
25066
+ string | sap.ui.core.html.HTMLElement.MetadataOptions.Association
25067
+ >;
25068
+ /**
25069
+ * Proxied public getters of the HTMLElement which are directly accessible on the wrapper Control.
25070
+ */
25071
+ getters?: string[];
25072
+ /**
25073
+ * Proxied public methods of the HTMLElement which are directly accessible on the wrapper Control.
25074
+ */
25075
+ methods?: string[];
25076
+ };
25077
+ }
25078
+ /**
25079
+ * Describes the settings that can be provided to the HTMLElement constructor.
25080
+ */
25081
+ interface $HTMLElementSettings extends sap.ui.core.$ControlSettings {
25082
+ /**
25083
+ * The text content of the HTMLElement. Natively rendered as the "textContent". Note: For void HTML elements
25084
+ * (e.g. `<br>`, `<input>`), this property has no effect as these elements cannot have text
25085
+ * content.
25086
+ */
25087
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
25088
+
25089
+ /**
25090
+ * Generic aggregation for child controls of HTMLElements. Every native HTMLElement can theoretically have
25091
+ * children.
25092
+ */
25093
+ children?:
25094
+ | sap.ui.core.Control[]
25095
+ | sap.ui.core.Control
25096
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
25097
+ | `{${string}}`;
25098
+ }
25099
+
25100
+ /**
25101
+ * Base Class for HTMLElements. HTMLElements are native HTML elements which can be integrated into the UI5
25102
+ * programming model by using this wrapper control. This wrapper control takes care to propagate the properties,
25103
+ * the aggregations and the events. It also ensures to render the control and put the aggregated controls
25104
+ * in the dedicated slots of the HTMLElement.
25105
+ *
25106
+ * @since 1.154.0
25107
+ */
25108
+ class HTMLElement extends sap.ui.core.Control {
25109
+ /**
25110
+ * Constructs and initializes a HTMLElement Wrapper with the given `sId` and settings.
25111
+ *
25112
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
25113
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
25114
+ * of the syntax of the settings object.
25115
+ */
25116
+ constructor(
25117
+ /**
25118
+ * Object with initial settings for the new control
25119
+ */
25120
+ mSettings?: sap.ui.core.html.$HTMLElementSettings
25121
+ );
25122
+ /**
25123
+ * Constructs and initializes a HTMLElement Wrapper with the given `sId` and settings.
25124
+ *
25125
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
25126
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
25127
+ * of the syntax of the settings object.
25128
+ */
25129
+ constructor(
25130
+ /**
25131
+ * Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be
25132
+ * omitted, no matter whether `mSettings` will be given or not!
25133
+ */
25134
+ sId?: string,
25135
+ /**
25136
+ * Object with initial settings for the new control
25137
+ */
25138
+ mSettings?: sap.ui.core.html.$HTMLElementSettings
25139
+ );
25140
+
25141
+ /**
25142
+ * Defines a new subclass of HTMLElement with the name `sClassName` and enriches it with the information
25143
+ * contained in `oClassInfo`.
25144
+ *
25145
+ * **Note:** This class should not be extended manually. SAPUI5 provides a full set of predefined HTMLElements
25146
+ * that can be used directly! For custom Web Components, use a dedicated class that extends {@link sap.ui.core.webc.WebComponent }
25147
+ * instead.
25148
+ *
25149
+ * `oClassInfo` can contain the same information that {@link sap.ui.base.ManagedObject.extend} already accepts,
25150
+ * plus the `dnd` property in the metadata object literal to configure drag-and-drop behavior (see {@link sap.ui.core.html.HTMLElement.MetadataOptions MetadataOptions }
25151
+ * for details). Objects describing aggregations can also have a `dnd` property when used for a class extending
25152
+ * `HTMLElement` (see {@link sap.ui.base.ManagedObject.MetadataOptions.AggregationDnD AggregationDnD}).
25153
+ *
25154
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
25155
+ *
25156
+ * @returns Created class / constructor function
25157
+ */
25158
+ static extend<T extends Record<string, unknown>>(
25159
+ /**
25160
+ * Name of the class to be created
25161
+ */
25162
+ sClassName: string,
25163
+ /**
25164
+ * Object literal with information about the class
25165
+ */
25166
+ oClassInfo?: sap.ClassInfo<T, sap.ui.core.html.HTMLElement>,
25167
+ /**
25168
+ * Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
25169
+ */
25170
+ FNMetaImpl?: Function
25171
+ ): Function;
25172
+ /**
25173
+ * Returns a metadata object for class sap.ui.core.html.HTMLElement.
25174
+ *
25175
+ *
25176
+ * @returns Metadata object describing this class
25177
+ */
25178
+ static getMetadata(): sap.ui.core.html.HTMLElementMetadata;
25179
+ /**
25180
+ * Adds some child to the aggregation {@link #getChildren children}.
25181
+ *
25182
+ *
25183
+ * @returns Reference to `this` in order to allow method chaining
25184
+ */
25185
+ addChild(
25186
+ /**
25187
+ * The child to add; if empty, nothing is inserted
25188
+ */
25189
+ oChild: sap.ui.core.Control
25190
+ ): this;
25191
+ /**
25192
+ * Destroys all the children in the aggregation {@link #getChildren children}.
25193
+ *
25194
+ *
25195
+ * @returns Reference to `this` in order to allow method chaining
25196
+ */
25197
+ destroyChildren(): this;
25198
+ /**
25199
+ * Gets content of aggregation {@link #getChildren children}.
25200
+ *
25201
+ * Generic aggregation for child controls of HTMLElements. Every native HTMLElement can theoretically have
25202
+ * children.
25203
+ */
25204
+ getChildren(): sap.ui.core.Control[];
25205
+ /**
25206
+ * Gets current value of property {@link #getText text}.
25207
+ *
25208
+ * The text content of the HTMLElement. Natively rendered as the "textContent". Note: For void HTML elements
25209
+ * (e.g. `<br>`, `<input>`), this property has no effect as these elements cannot have text
25210
+ * content.
25211
+ *
25212
+ *
25213
+ * @returns Value of property `text`
25214
+ */
25215
+ getText(): string;
25216
+ /**
25217
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getChildren children}. and returns
25218
+ * its index if found or -1 otherwise.
25219
+ *
25220
+ *
25221
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
25222
+ */
25223
+ indexOfChild(
25224
+ /**
25225
+ * The child whose index is looked for
25226
+ */
25227
+ oChild: sap.ui.core.Control
25228
+ ): int;
25229
+ /**
25230
+ * Inserts a child into the aggregation {@link #getChildren children}.
25231
+ *
25232
+ *
25233
+ * @returns Reference to `this` in order to allow method chaining
25234
+ */
25235
+ insertChild(
25236
+ /**
25237
+ * The child to insert; if empty, nothing is inserted
25238
+ */
25239
+ oChild: sap.ui.core.Control,
25240
+ /**
25241
+ * The `0`-based index the child should be inserted at; for a negative value of `iIndex`, the child is inserted
25242
+ * at position 0; for a value greater than the current size of the aggregation, the child is inserted at
25243
+ * the last position
25244
+ */
25245
+ iIndex: int
25246
+ ): this;
25247
+ /**
25248
+ * Removes all the controls from the aggregation {@link #getChildren children}.
25249
+ *
25250
+ * Additionally, it unregisters them from the hosting UIArea.
25251
+ *
25252
+ *
25253
+ * @returns An array of the removed elements (might be empty)
25254
+ */
25255
+ removeAllChildren(): sap.ui.core.Control[];
25256
+ /**
25257
+ * Removes a child from the aggregation {@link #getChildren children}.
25258
+ *
25259
+ *
25260
+ * @returns The removed child or `null`
25261
+ */
25262
+ removeChild(
25263
+ /**
25264
+ * The child to remove or its index or id
25265
+ */
25266
+ vChild: int | string | sap.ui.core.Control
25267
+ ): sap.ui.core.Control | null;
25268
+ /**
25269
+ * Sets a new value for property {@link #getText text}.
25270
+ *
25271
+ * The text content of the HTMLElement. Natively rendered as the "textContent". Note: For void HTML elements
25272
+ * (e.g. `<br>`, `<input>`), this property has no effect as these elements cannot have text
25273
+ * content.
25274
+ *
25275
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
25276
+ *
25277
+ *
25278
+ * @returns Reference to `this` in order to allow method chaining
25279
+ */
25280
+ setText(
25281
+ /**
25282
+ * New value for property `text`
25283
+ */
25284
+ sText: string
25285
+ ): this;
25286
+ }
25287
+ /**
25288
+ * @since 1.154.0
25289
+ */
25290
+ class HTMLElementMetadata extends sap.ui.core.ElementMetadata {
25291
+ /**
25292
+ * Creates a new metadata object for a HTMLElement subclass.
25293
+ */
25294
+ constructor(
25295
+ /**
25296
+ * fully qualified name of the class that is described by this metadata object
25297
+ */
25298
+ sClassName: string,
25299
+ /**
25300
+ * static info to construct the metadata from
25301
+ */
25302
+ oClassInfo: object
25303
+ );
25304
+
25305
+ /**
25306
+ * Returns the list of public getters proxied by the Component Wrapper to the component itself.
25307
+ *
25308
+ *
25309
+ * @returns Array of getter names.
25310
+ */
25311
+ getGetters(): string[];
25312
+ /**
25313
+ * Returns the list of public methods proxied by the Component Wrapper to the component itself.
25314
+ *
25315
+ *
25316
+ * @returns Array of method names.
25317
+ */
25318
+ getMethods(): string[];
25319
+ /**
25320
+ * Retrieves the renderer for the described HTMLElement subclasses or web component class. **Note:** HTMLElement
25321
+ * subclasses or Web Component wrappers must not define custom renderers. Returns the default HTMLElementRenderer.
25322
+ *
25323
+ *
25324
+ * @returns The default renderer instance.
25325
+ */
25326
+ getRenderer(): object;
25327
+ /**
25328
+ * Returns the tag used to render the Component Wrapper.
25329
+ *
25330
+ *
25331
+ * @returns The HTML tag name.
25332
+ */
25333
+ getTag(): string;
25334
+ }
25335
+ }
25336
+
24677
25337
  namespace hyphenation {
24678
25338
  /**
24679
25339
  * Describes the settings that can be provided to the Hyphenation constructor.
@@ -32904,7 +33564,7 @@ declare namespace sap {
32904
33564
  | "textContent"
32905
33565
  | "slot"
32906
33566
  | "none"
32907
- | sap.ui.core.webc.WebComponent.MetadataOptionsPropertyMapping;
33567
+ | /* was: sap.ui.core.webc.WebComponent.MetadataOptionsPropertyMapping */ any;
32908
33568
  };
32909
33569
  }
32910
33570
 
@@ -32964,14 +33624,12 @@ declare namespace sap {
32964
33624
 
32965
33625
  type MetadataOptionsEventMapping =
32966
33626
  sap.ui.core.webc.WebComponent.MetadataOptions.Event.Mapping;
32967
-
32968
- type MetadataOptionsPropertyMapping =
32969
- sap.ui.core.webc.WebComponent.MetadataOptions.Property.Mapping;
32970
33627
  }
32971
33628
  /**
32972
33629
  * Describes the settings that can be provided to the WebComponent constructor.
32973
33630
  */
32974
- interface $WebComponentSettings extends sap.ui.core.$ControlSettings {}
33631
+ interface $WebComponentSettings
33632
+ extends sap.ui.core.html.$HTMLElementSettings {}
32975
33633
 
32976
33634
  /**
32977
33635
  * Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
@@ -32979,9 +33637,11 @@ declare namespace sap {
32979
33637
  * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
32980
33638
  * controls in the dedicated slots of the Web Component.
32981
33639
  *
33640
+ * **Note:** This class is abstract and must not be instantiated directly.
33641
+ *
32982
33642
  * @since 1.138.0
32983
33643
  */
32984
- class WebComponent extends sap.ui.core.Control {
33644
+ abstract class WebComponent extends sap.ui.core.html.HTMLElement {
32985
33645
  /**
32986
33646
  * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
32987
33647
  *
@@ -33078,23 +33738,13 @@ declare namespace sap {
33078
33738
  * @returns Metadata object describing this class
33079
33739
  */
33080
33740
  static getMetadata(): sap.ui.core.webc.WebComponentMetadata;
33081
- /**
33082
- * Sets the Web Components busy state
33083
- *
33084
- *
33085
- * @returns `this` to allow method chaining
33086
- */
33087
- setBusy(
33088
- /**
33089
- * The new busy state to be set
33090
- */
33091
- bBusy: boolean
33092
- ): this;
33093
33741
  }
33094
33742
  /**
33095
33743
  * @since 1.138.0
33096
33744
  */
33097
- class WebComponentMetadata extends sap.ui.core.ElementMetadata {
33745
+ class WebComponentMetadata
33746
+ extends sap.ui.core.html.HTMLElementMetadata
33747
+ {
33098
33748
  /**
33099
33749
  * Creates a new metadata object for a WebComponent Wrapper subclass.
33100
33750
  */
@@ -33110,22 +33760,14 @@ declare namespace sap {
33110
33760
  );
33111
33761
 
33112
33762
  /**
33113
- * Returns the list of public getters, proxied by the Component Wrapper to the component itself
33114
- */
33115
- getGetters(): any[];
33116
- /**
33117
- * Returns the list of public methods, proxied by the Component Wrapper to the component itself
33118
- */
33119
- getMethods(): any[];
33120
- /**
33121
- * Retrieves the renderer for the described web component class. Note: this is always the default renderer
33122
- * and Web Component wrappers should not define their own renderers.
33123
- */
33124
- getRenderer(): void;
33125
- /**
33126
- * Returns the tag, used to render the Component Wrapper
33763
+ * Returns the renderer for the described web component class.
33764
+ *
33765
+ * **Note:** This always returns the default renderer. Web Component wrappers must not define custom renderers.
33766
+ *
33767
+ *
33768
+ * @returns The default renderer instance.
33127
33769
  */
33128
- getTag(): string;
33770
+ getRenderer(): object;
33129
33771
  }
33130
33772
  }
33131
33773
 
@@ -33754,27 +34396,31 @@ declare namespace sap {
33754
34396
  /**
33755
34397
  * Implementing this interface allows a control to be accessible via access keys.
33756
34398
  *
34399
+ * @deprecated As of version 1.154. The concept has been abandoned.
33757
34400
  * @experimental As of version 1.104.
33758
34401
  */
33759
34402
  interface IAccessKeySupport {
33760
34403
  __implements__sap_ui_core_IAccessKeySupport: boolean;
33761
34404
 
33762
34405
  /**
33763
- * Returns a refence to DOM element to be focused during Access key navigation. If not implemented getFocusDomRef()
34406
+ * Returns a reference to DOM element to be focused during Access key navigation. If not implemented getFocusDomRef()
33764
34407
  * method is used.
33765
34408
  *
34409
+ * @deprecated As of version 1.154. The concept has been abandoned.
33766
34410
  * @experimental As of version 1.104.
33767
34411
  */
33768
34412
  getAccessKeysFocusTarget?(): void;
33769
34413
  /**
33770
34414
  * If implemented called when access keys feature is enabled and highlighting is over
33771
34415
  *
34416
+ * @deprecated As of version 1.154. The concept has been abandoned.
33772
34417
  * @experimental As of version 1.104.
33773
34418
  */
33774
34419
  onAccKeysHighlightEnd?(): void;
33775
34420
  /**
33776
34421
  * If implemented called when access keys feature is enabled and highlighting is ongoing
33777
34422
  *
34423
+ * @deprecated As of version 1.154. The concept has been abandoned.
33778
34424
  * @experimental As of version 1.104.
33779
34425
  */
33780
34426
  onAccKeysHighlightStart?(): void;
@@ -56870,9 +57516,9 @@ declare namespace sap {
56870
57516
  */
56871
57517
  constructor(
56872
57518
  /**
56873
- * Format options as defined in {@link sap.ui.core.format.DateFormat.getDateInstance}
57519
+ * The format options
56874
57520
  */
56875
- oFormatOptions?: object,
57521
+ oFormatOptions?: sap.ui.core.format.DateFormat.DateFormatOptions,
56876
57522
  /**
56877
57523
  * constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
56878
57524
  */
@@ -65503,7 +66149,8 @@ declare namespace sap {
65503
66149
  * Such a deletion is not a pending change.
65504
66150
  *
65505
66151
  * When using data aggregation without `groupLevels`, single entities can be deleted (since 1.151.0, see
65506
- * {@link #isAggregated}). The group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
66152
+ * {@link #isAggregated}). The group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}. Since
66153
+ * 1.154.0, `groupLevels` are supported.
65507
66154
  * See:
65508
66155
  * #hasPendingChanges
65509
66156
  * #resetChanges
@@ -65906,7 +66553,7 @@ declare namespace sap {
65906
66553
  *
65907
66554
  * When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}),
65908
66555
  * single entities (see {@link #isAggregated}) can be refreshed and the grand total is updated accordingly
65909
- * (@experimental as of version 1.145.0).
66556
+ * (@experimental as of version 1.145.0). Since 1.154.0, `groupLevels` are supported.
65910
66557
  *
65911
66558
  * @since 1.53.0
65912
66559
  */
@@ -66083,7 +66730,7 @@ declare namespace sap {
66083
66730
  *
66084
66731
  * When using data aggregation but no recursive hierarchy, and without `groupLevels` or `"grandTotal like
66085
66732
  * 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}), this context can also represent
66086
- * a single entity (see {@link #isAggregated}, since 1.151.0).
66733
+ * a single entity (see {@link #isAggregated}, since 1.151.0). Since 1.154.0, `groupLevels` are supported.
66087
66734
  * See:
66088
66735
  * sap.ui.model.odata.v4.ODataContextBinding#getBoundContext
66089
66736
  * sap.ui.model.odata.v4.ODataContextBinding#invoke
@@ -66099,8 +66746,8 @@ declare namespace sap {
66099
66746
  * The promise is rejected if
66100
66747
  * the call attempts to refresh an entire list binding (via header context or an absolute path) while
66101
66748
  * the deletion of a row context (see {@link #delete}) is pending with a different group ID, this is
66102
- * the row context of a list binding with data aggregation which has `groupLevels` or `"grandTotal like
66103
- * 1.84"`, or this context does not represent a single entity
66749
+ * the row context of a list binding with data aggregation which has `"grandTotal like 1.84"`, or this
66750
+ * context does not represent a single entity
66104
66751
  */
66105
66752
  requestSideEffects(
66106
66753
  /**
@@ -67162,8 +67809,9 @@ declare namespace sap {
67162
67809
  * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
67163
67810
  * which can be used for {@link #getKeepAliveContext}.
67164
67811
  *
67165
- * When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link #setAggregation}),
67166
- * single entities can be created (since 1.151.0, see {@link sap.ui.model.odata.v4.Context#isAggregated}).
67812
+ * When using data aggregation without `"grandTotal like 1.84"` (see {@link #setAggregation}), single entities
67813
+ * can be created (since 1.151.0, see {@link sap.ui.model.odata.v4.Context#isAggregated}). Single entities
67814
+ * can also be created with visual grouping (@experimental as of version 1.154.0).
67167
67815
  *
67168
67816
  * @since 1.43.0
67169
67817
  *
@@ -67870,13 +68518,13 @@ declare namespace sap {
67870
68518
  * shared requests (since 1.108.0). `subtotals`: An optional boolean that tells whether
67871
68519
  * subtotals for this aggregatable property are needed `with`: An optional string that provides the
67872
68520
  * name of the method (for example "sum") used for aggregation of this aggregatable property; see "3.1.2
67873
- * Keyword with". `name`: An optional string that provides the original aggregatable property name
67874
- * in case a different alias is chosen as the name of the dynamic property used for aggregation of this
67875
- * aggregatable property; see "3.1.1 Keyword as" `unit`: An optional string that provides the name
67876
- * of the custom aggregate for a currency or unit of measure corresponding to this aggregatable property
67877
- * (since 1.86.0). The custom aggregate must return the single value of that unit in case there is only
67878
- * one, or `null` otherwise ("multi-unit situation"). (SQL suggestion: `CASE WHEN MIN(Unit) = MAX(Unit)
67879
- * THEN MIN(Unit) END`)
68521
+ * Keyword with"; cannot be combined with `expandTo` `name`: An optional string that provides the original
68522
+ * aggregatable property name in case a different alias is chosen as the name of the dynamic property used
68523
+ * for aggregation of this aggregatable property; see "3.1.1 Keyword as"; cannot be combined with `expandTo`
68524
+ * `unit`: An optional string that provides the name of the custom aggregate for a currency or unit
68525
+ * of measure corresponding to this aggregatable property (since 1.86.0). The custom aggregate must return
68526
+ * the single value of that unit in case there is only one, or `null` otherwise ("multi-unit situation").
68527
+ * (SQL suggestion: `CASE WHEN MIN(Unit) = MAX(Unit) THEN MIN(Unit) END`)
67880
68528
  */
67881
68529
  aggregate?: object;
67882
68530
  /**
@@ -67892,7 +68540,9 @@ declare namespace sap {
67892
68540
  * By default, only root nodes are available; they are not yet expanded. Since 1.120.0, `expandTo >= Number.MAX_SAFE_INTEGER`
67893
68541
  * can be used to expand all levels (`1E16` is recommended inside XML views for simplicity). Since 1.139.0,
67894
68542
  * {@link #getAggregation} returns `expandTo : Number.MAX_SAFE_INTEGER` instead of values greater than this.
67895
- * These differences do not count as changes.
68543
+ * These differences do not count as changes. This parameter is also supported for visual grouping (@experimental
68544
+ * as of version 1.154.0) and requires the "com.sap.vocabularies.Analytics.v1.MultiLevelExpand"
68545
+ * "$apply" transformation.
67896
68546
  */
67897
68547
  expandTo?: number;
67898
68548
  /**
@@ -67947,7 +68597,7 @@ declare namespace sap {
67947
68597
  * aggregated properties while grand totals are needed. Beware that methods like "average" or "countdistinct"
67948
68598
  * are not compatible with this approach, and it cannot be combined with group levels. Since 1.129.0, this
67949
68599
  * property is not needed anymore and filtering by aggregated properties is supported even while grand totals
67950
- * or subtotals are needed.
68600
+ * or subtotals are needed. Must not be combined with `expandTo`.
67951
68601
  */
67952
68602
  "grandTotal like 1.84"?: boolean;
67953
68603
  }
@@ -69238,6 +69888,9 @@ declare namespace sap {
69238
69888
  * typically with string values. $count can also be given as a `boolean` value, $expand can recursively
69239
69889
  * be given as a map, $levels can also be given as a `number` value, and $select can also be given as an
69240
69890
  * array (but without navigation paths). An empty map can also be given as `null` or `true`. See also {@link https://ui5.sap.com/#/topic/1ab4f62de6ab467096a2a98b363a1373 Parameters}.
69891
+ * Since 1.154.0, this option can be combined with pure data aggregation defined via `$$aggregation` and
69892
+ * is then used for requests without `$apply` and for requests with an (implicit or explicit) "identity"
69893
+ * transformation, but silently ignored for others.
69241
69894
  */
69242
69895
  $expand?: string | object;
69243
69896
  /**
@@ -69257,7 +69910,9 @@ declare namespace sap {
69257
69910
  * A comma separated list or an array of items which determine the value for the "5.1.4 System Query Option
69258
69911
  * $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}),
69259
69912
  * paths with navigation properties can be included and will contribute to the "5.1.3 System Query Option
69260
- * $expand".
69913
+ * $expand". Since 1.154.0, this option can be combined with pure data aggregation defined via `$$aggregation`
69914
+ * and is then used for requests without `$apply` and for requests with an (implicit or explicit) "identity"
69915
+ * transformation, but silently ignored for others.
69261
69916
  */
69262
69917
  $select?: string | string[];
69263
69918
  /**
@@ -75775,20 +76430,9 @@ declare namespace sap {
75775
76430
  */
75776
76431
  constructor(
75777
76432
  /**
75778
- * Formatting options. For a list of all available options, see {@link sap.ui.core.format.DateFormat.getDateInstance DateFormat}.
76433
+ * The format options
75779
76434
  */
75780
- oFormatOptions?: {
75781
- /**
75782
- * Additional set of options used to create a second `DateFormat` object for conversions between string
75783
- * values in the data source (e.g. model) and `Date`. This second format object is used to convert from
75784
- * a model `string` to `Date` before converting the `Date` to `string` with the primary format object. Vice
75785
- * versa, this 'source' format is also used to format an already parsed external value (e.g. user input)
75786
- * into the string format that is expected by the data source. For a list of all available options, see
75787
- * {@link sap.ui.core.format.DateFormat.getDateInstance DateFormat}. In case an empty object is given, the
75788
- * default is the ISO date notation (yyyy-MM-dd).
75789
- */
75790
- source?: object;
75791
- },
76435
+ oFormatOptions?: sap.ui.model.type.DateTypeFormatOptions,
75792
76436
  /**
75793
76437
  * Value constraints
75794
76438
  */
@@ -76885,6 +77529,24 @@ declare namespace sap {
76885
77529
  trailingCurrencyCode?: boolean;
76886
77530
  };
76887
77531
 
77532
+ /**
77533
+ * The format options for the `sap.ui.model.type.Date`.
77534
+ */
77535
+ type DateTypeFormatOptions =
77536
+ sap.ui.core.format.DateFormat.DateFormatOptions & {
77537
+ /**
77538
+ * Additional set of format options for a second `DateFormat` object. This object handles conversions between
77539
+ * string values in the data source (for example, model) and `Date` objects. These source options are used
77540
+ * for two-way data binding:
77541
+ * - **Model to View:** Converts a string from the model to a `Date` object. Afterwards the main format
77542
+ * options are used to convert that `Date` object to a string for display.
77543
+ * - **View to Model:** Converts a parsed external value, for example, user input, into the string format
77544
+ * that the data source requires. If an empty object is provided, the default format is the ISO date
77545
+ * notation (yyyy-MM-dd).
77546
+ */
77547
+ source?: sap.ui.core.format.DateFormat.DateFormatOptions;
77548
+ };
77549
+
76888
77550
  /**
76889
77551
  * The format options of the {@link sap.ui.model.type.Float} type.
76890
77552
  */
@@ -88802,6 +89464,12 @@ declare namespace sap {
88802
89464
 
88803
89465
  "sap/ui/core/HTML": undefined;
88804
89466
 
89467
+ "sap/ui/core/html/HTMLElement": undefined;
89468
+
89469
+ "sap/ui/core/html/HTMLElementMetadata": undefined;
89470
+
89471
+ "sap/ui/core/html/TextContent": undefined;
89472
+
88805
89473
  "sap/ui/core/hyphenation/Hyphenation": undefined;
88806
89474
 
88807
89475
  "sap/ui/core/Icon": undefined;
@@ -88880,6 +89548,12 @@ declare namespace sap {
88880
89548
 
88881
89549
  "sap/ui/core/Placeholder": undefined;
88882
89550
 
89551
+ "sap/ui/core/popover/PopoverFlipMode": undefined;
89552
+
89553
+ "sap/ui/core/popover/PopoverPhysicalSide": undefined;
89554
+
89555
+ "sap/ui/core/popover/Positioning": undefined;
89556
+
88883
89557
  "sap/ui/core/Popup": undefined;
88884
89558
 
88885
89559
  "sap/ui/core/postmessage/Bus": undefined;