@sapui5/ts-types 1.122.2 → 1.123.1

package/types/sap.ui.layout.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.1
+// For Library Version: 1.123.0
 
 declare namespace sap {
   namespace ui {
@@ -46,6 +46,9 @@ declare namespace sap {
           __implements__sap_ui_layout_cssgrid_IGridItemLayoutData: boolean;
         }
 
+        /**
+         * Describes the settings that can be provided to the CSSGrid constructor.
+         */
         interface $CSSGridSettings extends sap.ui.core.$ControlSettings {
           /**
            * The width of the control
@@ -136,6 +139,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridBasicLayout constructor.
+         */
         interface $GridBasicLayoutSettings
           extends sap.ui.layout.cssgrid.$GridLayoutBaseSettings {
           /**
@@ -203,6 +209,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridBoxLayout constructor.
+         */
         interface $GridBoxLayoutSettings
           extends sap.ui.layout.cssgrid.$GridLayoutBaseSettings {
           /**
@@ -232,6 +241,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridItemLayoutData constructor.
+         */
         interface $GridItemLayoutDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
@@ -283,9 +295,15 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridLayoutBase constructor.
+         */
         interface $GridLayoutBaseSettings
           extends sap.ui.base.$ManagedObjectSettings {}
 
+        /**
+         * Describes the settings that can be provided to the GridResponsiveLayout constructor.
+         */
         interface $GridResponsiveLayoutSettings
           extends sap.ui.layout.cssgrid.$GridLayoutBaseSettings {
           /**
@@ -330,6 +348,9 @@ declare namespace sap {
           ) => void;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridSettings constructor.
+         */
         interface $GridSettingsSettings
           extends sap.ui.base.$ManagedObjectSettings {
           /**
@@ -397,6 +418,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the ResponsiveColumnItemLayoutData constructor.
+         */
         interface $ResponsiveColumnItemLayoutDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
@@ -416,6 +440,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the ResponsiveColumnLayout constructor.
+         */
         interface $ResponsiveColumnLayoutSettings
           extends sap.ui.layout.cssgrid.$GridLayoutBaseSettings {
           /**
@@ -426,6 +453,9 @@ declare namespace sap {
           ) => void;
         }
 
+        /**
+         * Parameters of the GridResponsiveLayout#layoutChange event.
+         */
         interface GridResponsiveLayout$LayoutChangeEventParameters {
           /**
            * The name of the newly active layout aggregation
@@ -433,6 +463,9 @@ declare namespace sap {
           layout?: string;
         }
 
+        /**
+         * Parameters of the ResponsiveColumnLayout#layoutChange event.
+         */
         interface ResponsiveColumnLayout$LayoutChangeEventParameters {
           /**
            * The name of the newly active layout - "S", "M", "ML", "L", "XL", "XXL" or "XXXL".
@@ -2814,11 +2847,17 @@ declare namespace sap {
          */
         type CSSGridTrack = string;
 
+        /**
+         * Event object of the GridResponsiveLayout#layoutChange event.
+         */
         type GridResponsiveLayout$LayoutChangeEvent = sap.ui.base.Event<
           GridResponsiveLayout$LayoutChangeEventParameters,
           GridResponsiveLayout
         >;
 
+        /**
+         * Event object of the ResponsiveColumnLayout#layoutChange event.
+         */
         type ResponsiveColumnLayout$LayoutChangeEvent = sap.ui.base.Event<
           ResponsiveColumnLayout$LayoutChangeEventParameters,
           ResponsiveColumnLayout
@@ -2826,6 +2865,9 @@ declare namespace sap {
       }
 
       namespace form {
+        /**
+         * Describes the settings that can be provided to the ColumnContainerData constructor.
+         */
         interface $ColumnContainerDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
@@ -2857,6 +2899,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the ColumnElementData constructor.
+         */
         interface $ColumnElementDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
@@ -2882,6 +2927,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the ColumnLayout constructor.
+         */
         interface $ColumnLayoutSettings
           extends sap.ui.layout.form.$FormLayoutSettings {
           /**
@@ -2930,6 +2978,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the Form constructor.
+         */
         interface $FormSettings extends sap.ui.core.$ControlSettings {
           /**
            * Width of the `Form`.
@@ -3010,6 +3061,9 @@ declare namespace sap {
           ariaLabelledBy?: Array<sap.ui.core.Control | string>;
         }
 
+        /**
+         * Describes the settings that can be provided to the FormContainer constructor.
+         */
         interface $FormContainerSettings extends sap.ui.core.$ElementSettings {
           /**
            * Container is expanded.
@@ -3086,6 +3140,9 @@ declare namespace sap {
           ariaLabelledBy?: Array<sap.ui.core.Control | string>;
         }
 
+        /**
+         * Describes the settings that can be provided to the FormElement constructor.
+         */
         interface $FormElementSettings extends sap.ui.core.$ElementSettings {
           /**
            * If set to `false`, the `FormElement` is not rendered.
@@ -3120,6 +3177,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the FormLayout constructor.
+         */
         interface $FormLayoutSettings extends sap.ui.core.$ControlSettings {
           /**
            * Specifies the background color of the `Form` content.
@@ -3134,6 +3194,12 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridContainerData constructor.
+         *
+         * @deprecated (since 1.67.0) - as `sap.ui.commons` library is deprecated and the `GridLayout` must not
+         * be used in responsive applications. Please use `ResponsiveGridLayout` or `ColumnLayout` instead.
+         */
         interface $GridContainerDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
@@ -3147,6 +3213,12 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridElementData constructor.
+         *
+         * @deprecated (since 1.67.0) - as `sap.ui.commons` library is deprecated and the `GridLayout` must not
+         * be used in responsive applications. Please use `ResponsiveGridLayout` or `ColumnLayout` instead.
+         */
         interface $GridElementDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
@@ -3176,6 +3248,12 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the GridLayout constructor.
+         *
+         * @deprecated (since 1.67.0) - as `sap.ui.commons` library is deprecated and the `GridLayout` must not
+         * be used in responsive applications. Please use `ResponsiveGridLayout` or `ColumnLayout` instead.
+         */
         interface $GridLayoutSettings
           extends sap.ui.layout.form.$FormLayoutSettings {
           /**
@@ -3191,6 +3269,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the ResponsiveGridLayout constructor.
+         */
         interface $ResponsiveGridLayoutSettings
           extends sap.ui.layout.form.$FormLayoutSettings {
           /**
@@ -3388,9 +3469,19 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the ResponsiveLayout constructor.
+         *
+         * @deprecated (since 1.93) - replaced by {@link sap.ui.layout.form.ColumnLayout ColumnLayout}
+         */
         interface $ResponsiveLayoutSettings
           extends sap.ui.layout.form.$FormLayoutSettings {}
 
+        /**
+         * Describes the settings that can be provided to the SemanticFormElement constructor.
+         *
+         * @experimental (since 1.86)
+         */
         interface $SemanticFormElementSettings
           extends sap.ui.layout.form.$FormElementSettings {
           /**
@@ -3417,6 +3508,9 @@ declare namespace sap {
             | `{${string}}`;
         }
 
+        /**
+         * Describes the settings that can be provided to the SimpleForm constructor.
+         */
         interface $SimpleFormSettings extends sap.ui.core.$ControlSettings {
           /**
            * The maximum amount of groups (`{@link sap.ui.layout.form.FormContainer FormContainers}`) per row that
@@ -8130,7 +8224,9 @@ declare namespace sap {
          */
         type GridElementCells = string;
       }
-
+      /**
+       * Describes the settings that can be provided to the BlockLayout constructor.
+       */
       interface $BlockLayoutSettings extends sap.ui.core.$ControlSettings {
         /**
          * Determines the background used for the Layout
@@ -8162,6 +8258,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the BlockLayoutCell constructor.
+       */
       interface $BlockLayoutCellSettings extends sap.ui.core.$ControlSettings {
         /**
          * Defines the title of the cell. **Note:** When the `titleLink` aggregation is provided, the title of the
@@ -8243,6 +8342,9 @@ declare namespace sap {
         titleLink?: sap.ui.core.Control;
       }
 
+      /**
+       * Describes the settings that can be provided to the BlockLayoutCellData constructor.
+       */
       interface $BlockLayoutCellDataSettings
         extends sap.ui.core.$LayoutDataSettings {
         /**
@@ -8278,6 +8380,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the BlockLayoutRow constructor.
+       */
       interface $BlockLayoutRowSettings extends sap.ui.core.$ControlSettings {
         /**
          * Sets the rendering mode of the BlockLayoutRow to scrollable. In scrollable mode, the cells get aligned
@@ -8320,6 +8425,9 @@ declare namespace sap {
         accentCells?: Array<sap.ui.layout.BlockLayoutCell | string>;
       }
 
+      /**
+       * Describes the settings that can be provided to the DynamicSideContent constructor.
+       */
       interface $DynamicSideContentSettings
         extends sap.ui.core.$ControlSettings {
         /**
@@ -8455,6 +8563,9 @@ declare namespace sap {
         ) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the FixFlex constructor.
+       */
       interface $FixFlexSettings extends sap.ui.core.$ControlSettings {
         /**
          * Determines the direction of the layout of child elements. True for vertical and false for horizontal
@@ -8512,6 +8623,9 @@ declare namespace sap {
         flexContent?: sap.ui.core.Control;
       }
 
+      /**
+       * Describes the settings that can be provided to the Grid constructor.
+       */
       interface $GridSettings extends sap.ui.core.$ControlSettings {
         /**
          * Optional. Defines the width of the `Grid`. If not specified, then 100%.
@@ -8598,6 +8712,9 @@ declare namespace sap {
         ariaLabelledBy?: Array<sap.ui.core.Control | string>;
       }
 
+      /**
+       * Describes the settings that can be provided to the GridData constructor.
+       */
       interface $GridDataSettings extends sap.ui.core.$LayoutDataSettings {
         /**
          * A string type that represents the span values of the `Grid` for large, medium and small screens.
@@ -8887,6 +9004,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the HorizontalLayout constructor.
+       */
       interface $HorizontalLayoutSettings extends sap.ui.core.$ControlSettings {
         /**
          * Specifies whether the content inside the Layout shall be line-wrapped in the case that there is less
@@ -8907,6 +9027,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the PaneContainer constructor.
+       */
       interface $PaneContainerSettings extends sap.ui.core.$ElementSettings {
         /**
          * The orientation of the Splitter
@@ -8931,6 +9054,9 @@ declare namespace sap {
         resize?: (oEvent: PaneContainer$ResizeEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ResponsiveFlowLayout constructor.
+       */
       interface $ResponsiveFlowLayoutSettings
         extends sap.ui.core.$ControlSettings {
         /**
@@ -8960,6 +9086,9 @@ declare namespace sap {
         ariaLabelledBy?: Array<sap.ui.core.Control | string>;
       }
 
+      /**
+       * Describes the settings that can be provided to the ResponsiveFlowLayoutData constructor.
+       */
       interface $ResponsiveFlowLayoutDataSettings
         extends sap.ui.core.$LayoutDataSettings {
         /**
@@ -9008,6 +9137,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the ResponsiveSplitter constructor.
+       */
       interface $ResponsiveSplitterSettings
         extends sap.ui.core.$ControlSettings {
         /**
@@ -9038,6 +9170,9 @@ declare namespace sap {
         defaultPane?: sap.ui.layout.SplitPane | string;
       }
 
+      /**
+       * Describes the settings that can be provided to the SplitPane constructor.
+       */
       interface $SplitPaneSettings extends sap.ui.core.$ElementSettings {
         /**
          * Determines whether the pane will be moved to the pagination
@@ -9065,6 +9200,9 @@ declare namespace sap {
         content?: sap.ui.core.Control;
       }
 
+      /**
+       * Describes the settings that can be provided to the Splitter constructor.
+       */
       interface $SplitterSettings extends sap.ui.core.$ControlSettings {
         /**
          * Whether to split the contents horizontally (default) or vertically.
@@ -9105,6 +9243,9 @@ declare namespace sap {
         resize?: (oEvent: Splitter$ResizeEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the SplitterLayoutData constructor.
+       */
       interface $SplitterLayoutDataSettings
         extends sap.ui.core.$LayoutDataSettings {
         /**
@@ -9116,7 +9257,8 @@ declare namespace sap {
           | `{${string}}`;
 
         /**
-         * The size of the splitter content. This property is updated when the area is resized by the user.
+         * The size of the splitter content. This property is updated when the area is resized by the user. Allowed
+         * size values are numeric values ending in "px", "rem", "%" and "auto".
          */
         size?:
           | sap.ui.core.CSSSize
@@ -9132,6 +9274,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the VerticalLayout constructor.
+       */
       interface $VerticalLayoutSettings extends sap.ui.core.$ControlSettings {
         /**
          * Width of the `VerticalLayout`. If no width is set, the width of the content is used. If the content of
@@ -9160,10 +9305,16 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Parameters of the DynamicSideContent#breakpointChanged event.
+       */
       interface DynamicSideContent$BreakpointChangedEventParameters {
         currentBreakpoint?: string;
       }
 
+      /**
+       * Parameters of the PaneContainer#resize event.
+       */
       interface PaneContainer$ResizeEventParameters {
         /**
          * An array of values representing the old (pixel)sizes of the split panes, which are inside the pane container.
@@ -9176,6 +9327,9 @@ declare namespace sap {
         newSizes?: float[];
       }
 
+      /**
+       * Parameters of the Splitter#resize event.
+       */
       interface Splitter$ResizeEventParameters {
         /**
          * The ID of the splitter control. The splitter control can also be accessed by calling getSource() on the
@@ -14325,11 +14479,9 @@ declare namespace sap {
         ): void;
       }
       /**
-       * Holds layout data for the splitter contents. Allowed size values are numeric values ending in "px", "rem",
-       * "%" and "auto".
+       * Holds layout data for the splitter contents.
        *
        * @since 1.22.0
-       * @experimental (since 1.22.0) - API is not yet finished and might change completely
        */
       class SplitterLayoutData extends sap.ui.core.LayoutData {
         /**
@@ -14419,7 +14571,8 @@ declare namespace sap {
         /**
          * Gets current value of property {@link #getSize size}.
          *
-         * The size of the splitter content. This property is updated when the area is resized by the user.
+         * The size of the splitter content. This property is updated when the area is resized by the user. Allowed
+         * size values are numeric values ending in "px", "rem", "%" and "auto".
          *
          * Default value is `'auto'`.
          *
@@ -14466,7 +14619,8 @@ declare namespace sap {
         /**
          * Sets a new value for property {@link #getSize size}.
          *
-         * The size of the splitter content. This property is updated when the area is resized by the user.
+         * The size of the splitter content. This property is updated when the area is resized by the user. Allowed
+         * size values are numeric values ending in "px", "rem", "%" and "auto".
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
@@ -14985,16 +15139,25 @@ declare namespace sap {
        */
       type GridSpan = string;
 
+      /**
+       * Event object of the DynamicSideContent#breakpointChanged event.
+       */
       type DynamicSideContent$BreakpointChangedEvent = sap.ui.base.Event<
         DynamicSideContent$BreakpointChangedEventParameters,
         DynamicSideContent
       >;
 
+      /**
+       * Event object of the PaneContainer#resize event.
+       */
       type PaneContainer$ResizeEvent = sap.ui.base.Event<
         PaneContainer$ResizeEventParameters,
         PaneContainer
       >;
 
+      /**
+       * Event object of the Splitter#resize event.
+       */
       type Splitter$ResizeEvent = sap.ui.base.Event<
         Splitter$ResizeEventParameters,
         Splitter