@ui5/webcomponents-fiori 2.23.0-rc.1 → 2.23.0

package/dist/custom-elements-internal.json

@@ -1565,6 +1565,214 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "dist/HeroBanner.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-hero-banner` is a flexible, full-width banner designed for placement at the top of a page.\nIt provides a personalized greeting and quick access to key information or actions.\n\n### Structure\n\nThe HeroBanner consists of the following building blocks:\n\n- **Banner Canvas** - the visual base with a background color, optional background image and shadow.\n- **Overline** (optional) - contextual text at the top, e.g. the current date or a status message.\n- **Header** (optional) - the main greeting header below the overline, e.g. \"Hello, John\".\n- **Free Slots** (optional) - customizable content areas that can contain KPI cards, search components, text, buttons, etc.\n\nThe banner is not sticky — it scrolls away with the page content when the user scrolls down.\n\n### Usage\n\nPlace the `ui5-hero-banner` at the top of a page to welcome the user and surface relevant\ninformation or shortcuts at a glance.\n\nThe hero banner itself is non-interactive. However, interactive elements such as buttons, cards,\nor search fields can be placed inside the free content slots and will follow their own\ninteractive states.\n\n### Responsive Behavior\n\nThe hero banner adapts to different screen sizes:\n- On smaller screens, split layouts (Equal, FirstWider) collapse to a single stacked column.\n- The heading text wraps to multiple lines as needed.\n- Buttons in the headerAction slot will wrap.\n- On screens ≤1024px, the header text is wrapped to a maximum of 3 lines.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-fiori/dist/HeroBanner.js\";`",
+          "name": "HeroBanner",
+          "cssParts": [
+            {
+              "description": "Used to style the banner canvas container",
+              "name": "canvas"
+            },
+            {
+              "description": "Used to style the content area of the banner",
+              "name": "content"
+            },
+            {
+              "description": "Used to style the end content block",
+              "name": "endContent"
+            },
+            {
+              "description": "Used to style the header area (salutation, date, header actions)",
+              "name": "header"
+            },
+            {
+              "description": "Used to style the start (default) content block",
+              "name": "startContent"
+            }
+          ],
+          "slots": [
+            {
+              "name": "actions",
+              "description": "Defines action buttons displayed to the right of the header area.\nTypically used to display actions buttons in the top right corner.\n\nCan contain buttons, links, or other interactive elements that provide\nquick access to relevant actions directly from the hero banner header.",
+              "_ui5type": {
+                "text": "Array<HTMLElement>"
+              },
+              "_ui5privacy": "public"
+            },
+            {
+              "name": "default",
+              "description": "Defines the first (default) free content block of the hero banner.\n\nThis is the default slot — content placed directly inside `<ui5-hero-banner>`\nwithout a slot attribute lands here.\nCan contain KPI cards, search input fields, text, buttons, and more.",
+              "_ui5propertyName": "startContent",
+              "_ui5type": {
+                "text": "Array<HTMLElement>"
+              },
+              "_ui5privacy": "public"
+            },
+            {
+              "name": "endContent",
+              "description": "Defines the second free content block of the hero banner.\n\nUsed alongside `startContent` when `columnsRatio` is set (`Equal`, `FirstWider`).\nCan contain cards, buttons, and other interactive elements.",
+              "_ui5type": {
+                "text": "Array<HTMLElement>"
+              },
+              "_ui5privacy": "public"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "actionsPlacement",
+              "type": {
+                "text": "HeroBannerActionsPlacement",
+                "references": [
+                  {
+                    "name": "HeroBannerActionsPlacement",
+                    "package": "@ui5/webcomponents-fiori",
+                    "module": "dist/types/HeroBannerActionsPlacement.js"
+                  }
+                ]
+              },
+              "default": "\"TopEnd\"",
+              "description": "Defines the placement of the actions slot within the hero banner header.\n\n- **TopEnd** (default) - Actions are displayed to the right of the header text, at the top of the header row.\n- **BottomStart** - Actions are displayed below the header text, left-aligned, regardless of `columnsRatio` or slot usage.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "columnsRatio",
+              "type": {
+                "text": "HeroBannerColumnsRatio",
+                "references": [
+                  {
+                    "name": "HeroBannerColumnsRatio",
+                    "package": "@ui5/webcomponents-fiori",
+                    "module": "dist/types/HeroBannerColumnsRatio.js"
+                  }
+                ]
+              },
+              "default": "\"FirstWider\"",
+              "description": "Defines the ratio between the two content columns inside the hero banner.\n\nTakes effect only when `endContent` is provided. When no `endContent` is present, the content spans the full width (single column).\n\n- **Equal** - Two equal columns. Both content blocks share the available width equally.\n  On smaller screens, both slots stack vertically.\n- **FirstWider** - Two unequal columns. The start content takes two-thirds of the width, the end content one-third.\n  On smaller screens, both slots stack vertically.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "headerBlockPlacement",
+              "type": {
+                "text": "HeroBannerHeaderBlockPlacement",
+                "references": [
+                  {
+                    "name": "HeroBannerHeaderBlockPlacement",
+                    "package": "@ui5/webcomponents-fiori",
+                    "module": "dist/types/HeroBannerHeaderBlockPlacement.js"
+                  }
+                ]
+              },
+              "default": "\"Top\"",
+              "description": "Defines the vertical placement of the header block within the content area.\n\n- **Top** (default) - Header block is placed at the top of the content area.\n- **Bottom** - Header block is pushed to the bottom of column 1. Only takes effect when `columnsRatio`\n  is `Equal` or `FirstWider` and only `endContent` is provided (no default slot content).\n  When `actionsPlacement` is also `BottomStart`, the `endContent` slot spans the full height.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "headerText",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Defines the header text displayed in the hero banner.\n\nThis is the main greeting header, typically a personalized message\nsuch as \"Hello, John\".",
+              "default": "undefined",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "overlineText",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Defines text displayed above the heading as an overline.\nCan be used to show the current date, a status message, or any other relevant contextual information.",
+              "default": "undefined",
+              "privacy": "public"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the placement of the actions slot within the hero banner header.\n\n- **TopEnd** (default) - Actions are displayed to the right of the header text, at the top of the header row.\n- **BottomStart** - Actions are displayed below the header text, left-aligned, regardless of `columnsRatio` or slot usage.",
+              "name": "actions-placement",
+              "default": "\"TopEnd\"",
+              "fieldName": "actionsPlacement",
+              "type": {
+                "text": "\"TopEnd\" | \"BottomStart\""
+              }
+            },
+            {
+              "description": "Defines the ratio between the two content columns inside the hero banner.\n\nTakes effect only when `endContent` is provided. When no `endContent` is present, the content spans the full width (single column).\n\n- **Equal** - Two equal columns. Both content blocks share the available width equally.\n  On smaller screens, both slots stack vertically.\n- **FirstWider** - Two unequal columns. The start content takes two-thirds of the width, the end content one-third.\n  On smaller screens, both slots stack vertically.",
+              "name": "columns-ratio",
+              "default": "\"FirstWider\"",
+              "fieldName": "columnsRatio",
+              "type": {
+                "text": "\"Equal\" | \"FirstWider\""
+              }
+            },
+            {
+              "description": "Defines the vertical placement of the header block within the content area.\n\n- **Top** (default) - Header block is placed at the top of the content area.\n- **Bottom** - Header block is pushed to the bottom of column 1. Only takes effect when `columnsRatio`\n  is `Equal` or `FirstWider` and only `endContent` is provided (no default slot content).\n  When `actionsPlacement` is also `BottomStart`, the `endContent` slot spans the full height.",
+              "name": "header-block-placement",
+              "default": "\"Top\"",
+              "fieldName": "headerBlockPlacement",
+              "type": {
+                "text": "\"Top\" | \"Bottom\""
+              }
+            },
+            {
+              "description": "Defines the header text displayed in the hero banner.\n\nThis is the main greeting header, typically a personalized message\nsuch as \"Hello, John\".",
+              "name": "header-text",
+              "default": "undefined",
+              "fieldName": "headerText",
+              "type": {
+                "text": "string | undefined"
+              }
+            },
+            {
+              "description": "Defines text displayed above the heading as an overline.\nCan be used to show the current date, a status message, or any other relevant contextual information.",
+              "name": "overline-text",
+              "default": "undefined",
+              "fieldName": "overlineText",
+              "type": {
+                "text": "string | undefined"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "UI5Element",
+            "package": "@ui5/webcomponents-base",
+            "module": "dist/UI5Element.js"
+          },
+          "tagName": "ui5-hero-banner",
+          "customElement": true,
+          "_ui5experimental": true,
+          "_ui5since": "2.23.0",
+          "_ui5privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "HeroBanner",
+            "module": "dist/HeroBanner.js"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-hero-banner",
+          "declaration": {
+            "name": "HeroBanner",
+            "module": "dist/HeroBanner.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "dist/IllustratedMessage.js",
@@ -2648,12 +2856,19 @@
               "kind": "field",
               "name": "accessibleRole",
               "type": {
-                "text": "Exclude<ListItemAccessibleRole, ListItemAccessibleRole.Group> | undefined"
+                "text": "ListItemAccessibleRole | undefined",
+                "references": [
+                  {
+                    "name": "ListItemAccessibleRole",
+                    "package": "@ui5/webcomponents",
+                    "module": "dist/types/ListItemAccessibleRole.js"
+                  }
+                ]
               },
               "description": "Used to define the role of the list item.\n\n**Note:** If not set, the role is automatically inherited from the parent `ui5-list` based on its `accessible-role` property\n(e.g. `Menu` -> `MenuItem`, `Tree` -> `TreeItem`, `ListBox` -> `Option`).\nAn explicitly set `accessible-role` on the list item takes precedence over the inherited role.",
               "default": "undefined",
               "privacy": "public",
-              "_ui5since": "1.3.0"
+              "_ui5since": "2.23.0"
             },
             {
               "kind": "field",
@@ -3092,23 +3307,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -3478,23 +3678,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -5198,23 +5383,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "NotificationListItem",
-                    "references": [
-                      {
-                        "name": "NotificationListItem",
-                        "package": "@ui5/webcomponents-fiori",
-                        "module": "dist/NotificationListItem.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -5473,23 +5643,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -6687,23 +6842,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -11321,12 +11461,19 @@
               "kind": "field",
               "name": "accessibleRole",
               "type": {
-                "text": "Exclude<ListItemAccessibleRole, ListItemAccessibleRole.Group> | undefined"
+                "text": "ListItemAccessibleRole | undefined",
+                "references": [
+                  {
+                    "name": "ListItemAccessibleRole",
+                    "package": "@ui5/webcomponents",
+                    "module": "dist/types/ListItemAccessibleRole.js"
+                  }
+                ]
               },
               "description": "Used to define the role of the list item.\n\n**Note:** If not set, the role is automatically inherited from the parent `ui5-list` based on its `accessible-role` property\n(e.g. `Menu` -> `MenuItem`, `Tree` -> `TreeItem`, `ListBox` -> `Option`).\nAn explicitly set `accessible-role` on the list item takes precedence over the inherited role.",
               "default": "undefined",
               "privacy": "public",
-              "_ui5since": "1.3.0"
+              "_ui5since": "2.23.0"
             },
             {
               "kind": "field",
@@ -11458,23 +11605,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -12345,12 +12477,19 @@
               "kind": "field",
               "name": "accessibleRole",
               "type": {
-                "text": "Exclude<ListItemAccessibleRole, ListItemAccessibleRole.Group> | undefined"
+                "text": "ListItemAccessibleRole | undefined",
+                "references": [
+                  {
+                    "name": "ListItemAccessibleRole",
+                    "package": "@ui5/webcomponents",
+                    "module": "dist/types/ListItemAccessibleRole.js"
+                  }
+                ]
               },
               "description": "Used to define the role of the list item.\n\n**Note:** If not set, the role is automatically inherited from the parent `ui5-list` based on its `accessible-role` property\n(e.g. `Menu` -> `MenuItem`, `Tree` -> `TreeItem`, `ListBox` -> `Option`).\nAn explicitly set `accessible-role` on the list item takes precedence over the inherited role.",
               "default": "undefined",
               "privacy": "public",
-              "_ui5since": "1.3.0"
+              "_ui5since": "2.23.0"
             },
             {
               "kind": "field",
@@ -12737,23 +12876,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -13537,12 +13661,19 @@
               "kind": "field",
               "name": "accessibleRole",
               "type": {
-                "text": "Exclude<ListItemAccessibleRole, ListItemAccessibleRole.Group> | undefined"
+                "text": "ListItemAccessibleRole | undefined",
+                "references": [
+                  {
+                    "name": "ListItemAccessibleRole",
+                    "package": "@ui5/webcomponents",
+                    "module": "dist/types/ListItemAccessibleRole.js"
+                  }
+                ]
               },
               "description": "Used to define the role of the list item.\n\n**Note:** If not set, the role is automatically inherited from the parent `ui5-list` based on its `accessible-role` property\n(e.g. `Menu` -> `MenuItem`, `Tree` -> `TreeItem`, `ListBox` -> `Option`).\nAn explicitly set `accessible-role` on the list item takes precedence over the inherited role.",
               "default": "undefined",
               "privacy": "public",
-              "_ui5since": "1.3.0"
+              "_ui5since": "2.23.0"
             },
             {
               "kind": "field",
@@ -13821,23 +13952,8 @@
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
               "_ui5Bubbles": true,
-              "_ui5since": "2.22.0",
+              "_ui5since": "2.23.0",
               "_ui5parameters": [
-                {
-                  "type": {
-                    "text": "ListItemBase",
-                    "references": [
-                      {
-                        "name": "ListItemBase",
-                        "package": "@ui5/webcomponents",
-                        "module": "dist/ListItemBase.js"
-                      }
-                    ]
-                  },
-                  "name": "item",
-                  "_ui5privacy": "public",
-                  "description": "The activated item."
-                },
                 {
                   "type": {
                     "text": "Event"
@@ -15661,6 +15777,135 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "dist/types/HeroBannerActionsPlacement.js",
+      "declarations": [
+        {
+          "kind": "enum",
+          "name": "HeroBannerActionsPlacement",
+          "description": "Available HeroBanner actions placement options.\n\nDefines where the actions slot is rendered within the hero banner header area.",
+          "_ui5privacy": "public",
+          "_ui5since": "2.23.0",
+          "members": [
+            {
+              "kind": "field",
+              "static": true,
+              "privacy": "public",
+              "description": "Places the actions below the header text, aligned to the start.",
+              "default": "BottomStart",
+              "name": "BottomStart",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "static": true,
+              "privacy": "public",
+              "description": "Places the actions to the right of the header text, aligned to the top of the header row.",
+              "default": "TopEnd",
+              "name": "TopEnd",
+              "readonly": true
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "HeroBannerActionsPlacement",
+            "module": "dist/types/HeroBannerActionsPlacement.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "dist/types/HeroBannerColumnsRatio.js",
+      "declarations": [
+        {
+          "kind": "enum",
+          "name": "HeroBannerColumnsRatio",
+          "description": "Available HeroBanner columns ratio options.\n\nDefines how the two content blocks are sized relative to each other within the hero banner.\nWhen no value is set, the content renders in a single column.",
+          "_ui5privacy": "public",
+          "_ui5since": "2.23.0",
+          "members": [
+            {
+              "kind": "field",
+              "static": true,
+              "privacy": "public",
+              "description": "Two equal columns. Both content blocks share the available width equally.",
+              "default": "Equal",
+              "name": "Equal",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "static": true,
+              "privacy": "public",
+              "description": "Two unequal columns. The first content block takes two-thirds of the width, the second takes one-third.",
+              "default": "FirstWider",
+              "name": "FirstWider",
+              "readonly": true
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "HeroBannerColumnsRatio",
+            "module": "dist/types/HeroBannerColumnsRatio.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "dist/types/HeroBannerHeaderBlockPlacement.js",
+      "declarations": [
+        {
+          "kind": "enum",
+          "name": "HeroBannerHeaderBlockPlacement",
+          "description": "Available HeroBanner header text block placement options.\n\nDefines the vertical placement of the header text block within the banner header area.",
+          "_ui5privacy": "public",
+          "_ui5since": "2.23.0",
+          "members": [
+            {
+              "kind": "field",
+              "static": true,
+              "privacy": "public",
+              "description": "Places the header text block at the bottom of the header area.",
+              "default": "Bottom",
+              "name": "Bottom",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "static": true,
+              "privacy": "public",
+              "description": "Places the header text block at the top of the header area.",
+              "default": "Top",
+              "name": "Top",
+              "readonly": true
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "HeroBannerHeaderBlockPlacement",
+            "module": "dist/types/HeroBannerHeaderBlockPlacement.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "dist/types/IllustrationMessageDesign.js",