@openui5/sap.f 1.141.1 → 1.142.0

package/src/sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItem.js

@@ -0,0 +1,243 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define(
+  [
+    "sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItemBase",
+    "sap/f/gen/ui5/webcomponents_fiori",
+    "sap/f/thirdparty/NotificationListItem"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * ### Overview
+     * The `ui5-li-notification` is a type of list item, meant to display notifications.
+     *
+     * The component has a rich set of various properties that allows the user to set `avatar`, `menu`, `titleText`, descriptive `content`
+     * and `footnotes` to fully describe a notification.
+     *
+     * The user can:
+     *
+     * - display a `Close` button
+     * - can control whether the `titleText` and `description` should wrap or truncate
+     * and display a `ShowMore` button to switch between less and more information
+     * - add actions by using the `ui5-menu` component
+     *
+     * **Note:** Adding custom actions by using the `ui5-notification-action` component is deprecated as of version 2.0!
+     *
+     * ### Usage
+     * The component should be used inside a `ui5-notification-list`.
+     *
+     * ### Keyboard Handling
+     *
+     * #### Basic Navigation
+     * The user can use the following keyboard shortcuts to perform actions (such as select, delete):
+     *
+     * - [Enter] - select an item (trigger "item-click" event)
+     * - [Delete] - close an item (trigger "item-close" event)
+     *
+     * #### Fast Navigation
+     * This component provides a fast navigation using the following keyboard shortcuts:
+     *
+     * - [Shift] + [Enter] - 'More'/'Less' link will be triggered
+     * - [Shift] + [F10] - 'Menu' (Actions) button will be triggered (clicked)
+     *
+     * ### ES6 Module Import
+     *
+     * `import "sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItem.js";`
+     *
+     * @extends module:sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItemBase
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItem
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.NotificationListItem",
+      {
+        metadata: {
+          tag: "ui5-li-notification-87689b96",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime:
+            "sap/f/gen/ui5/webcomponents_fiori/designtime/NotificationListItem.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "description",
+
+          properties: {
+            /**
+             * Defines if the `titleText` and `description` should wrap,
+             * they truncate by default.
+             *
+             * **Note:** by default the `titleText` and `description`,
+             * and a `ShowMore/Less` button would be displayed.
+             * @type module:sap/f/gen/ui5/webcomponents.WrappingType
+             */
+            wrappingType: {
+              type: "sap.f.gen.ui5.webcomponents.WrappingType",
+              mapping: "property",
+              defaultValue: "None"
+            },
+            /**
+             * Defines the status indicator of the item.
+             * @type module:sap/ui/core/ValueState
+             */
+            state: {
+              type: "sap.ui.core.ValueState",
+              mapping: {
+                formatter: "_mapValueState",
+                parser: "_parseValueState"
+              },
+              defaultValue: "None"
+            },
+            /**
+             * Defines if the `Close` button would be displayed.
+             */
+            showClose: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines the `Important` label of the item.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori.NotificationListItemImportance
+             */
+            importance: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.NotificationListItemImportance",
+              mapping: "property",
+              defaultValue: "Standard"
+            },
+            /**
+             * Defines the `titleText` of the item.
+             */
+            titleText: { type: "string", mapping: "property" },
+            /**
+             * Defines if the `notification` is new or has been already read.
+             *
+             * **Note:** if set to `false` the `titleText` has bold font,
+             * if set to true - it has a normal font.
+             */
+            read: { type: "boolean", mapping: "property", defaultValue: false },
+            /**
+             * Defines if a busy indicator would be displayed over the item.
+             */
+            loading: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
+             */
+            loadingDelay: {
+              type: "float",
+              mapping: "property",
+              defaultValue: 1000
+            },
+            /**
+             * The 'width' of the Web Component in <code>sap.ui.core.CSSSize</code>.
+             */
+            width: { type: "sap.ui.core.CSSSize", mapping: "style" },
+            /**
+             * The 'height' of the Web Component in <code>sap.ui.core.CSSSize</code>.
+             */
+            height: { type: "sap.ui.core.CSSSize", mapping: "style" }
+          },
+
+          aggregations: {
+            /**
+             * Defines the avatar, displayed in the `ui5-li-notification`.
+             *
+             * **Note:** Consider using the `ui5-avatar` to display icons, initials or images.
+             *
+             * **Note:** In order to be complaint with the UX guidlines and for best experience,
+             * we recommend using avatars with 2rem X 2rem in size (32px X 32px). In case you are using the `ui5-avatar`
+             * you can set its `size` property to `XS` to get the required size - `<ui5-avatar size="XS"></ui5-avatar>`.
+             * @type module:sap/ui/core/Control
+             */
+            avatar: {
+              type: "sap.ui.core.Control",
+              multiple: true,
+              slot: "avatar"
+            },
+            /**
+             * Defines the menu, displayed in the `ui5-li-notification`.
+             *
+             * **Note:** Use this for implementing actions.
+             *
+             * **Note:** Should be used instead `u5-notification-action`, which is deprecated as of version 2.0.
+             * @type module:sap/ui/core/Control
+             */
+            menu: { type: "sap.ui.core.Control", multiple: true, slot: "menu" },
+            /**
+             * Defines the elements, displayed in the footer of the of the component.
+             * @type module:sap/ui/core/Control
+             */
+            footnotes: {
+              type: "sap.ui.core.Control",
+              multiple: true,
+              slot: "footnotes"
+            },
+            /**
+             * Defines the content of the `ui5-li-notification`,
+             * usually a description of the notification.
+             *
+             * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
+             * @type module:sap/ui/core/Control
+             */
+            description: { type: "sap.ui.core.Control", multiple: true }
+          },
+
+          associations: {},
+
+          events: {
+            /**
+             * Fired when the `Close` button is pressed.
+             */
+            close: {
+              parameters: {
+                /**
+                 * the closed item.
+                 */
+                item: {
+                  type: "sap.ui.core.Control",
+                  types: [
+                    {
+                      origType: "HTMLElement",
+                      multiple: false,
+                      dedicatedTypes: [
+                        {
+                          dtsType: "Control",
+                          packageName: "sap/ui/core/Control",
+                          moduleType: "module:sap/ui/core/Control",
+                          ui5Type: "sap.ui.core.Control",
+                          isClass: true
+                        }
+                      ]
+                    }
+                  ],
+                  dtsParamDescription: "the closed item."
+                }
+              }
+            }
+          },
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);

package/src/sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItemBase.js

@@ -0,0 +1,87 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define(
+  [
+    "sap/f/gen/ui5/webcomponents/dist/ListItemBase",
+    "sap/f/gen/ui5/webcomponents_fiori",
+    "sap/f/thirdparty/NotificationListItem"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * The base class of the `NotificationListItem` and `NotificationListGroupItem`.
+     *
+     * @extends module:sap/f/gen/ui5/webcomponents/dist/ListItemBase
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/NotificationListItemBase
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.NotificationListItemBase",
+      {
+        metadata: {
+          tag: "",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime:
+            "sap/f/gen/ui5/webcomponents_fiori/designtime/NotificationListItemBase.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "",
+
+          properties: {
+            /**
+             * Defines the `titleText` of the item.
+             */
+            titleText: { type: "string", mapping: "property" },
+            /**
+             * Defines if the `notification` is new or has been already read.
+             *
+             * **Note:** if set to `false` the `titleText` has bold font,
+             * if set to true - it has a normal font.
+             */
+            read: { type: "boolean", mapping: "property", defaultValue: false },
+            /**
+             * Defines if a busy indicator would be displayed over the item.
+             */
+            loading: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
+             */
+            loadingDelay: {
+              type: "float",
+              mapping: "property",
+              defaultValue: 1000
+            }
+          },
+
+          aggregations: {},
+
+          associations: {},
+
+          events: {},
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);

package/src/sap/f/gen/ui5/webcomponents_fiori/dist/Search.js

@@ -0,0 +1,248 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define(
+  [
+    "sap/ui/core/webc/WebComponent",
+    "sap/f/gen/ui5/webcomponents_fiori",
+    "sap/f/thirdparty/ShellBarSearch"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * ### Overview
+     *
+     * A `ui5-search` is an input with suggestions, used for user search.
+     *
+     * The `ui5-search` consists of several elements parts:
+     * - Scope - displays a select in the beggining of the component, used for filtering results by their scope.
+     * - Input field - for user input value
+     * - Clear button - gives the possibility for deleting the entered value
+     * - Search button - a primary button for performing search, when the user has entered a search term
+     * - Suggestions - a list with available search suggestions
+     *
+     * ### ES6 Module Import
+     *
+     * `import "sap/f/gen/ui5/webcomponents_fiori/dist/Search.js";`
+     *
+     * @extends sap.ui.core.webc.WebComponent
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/Search
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.Search",
+      {
+        metadata: {
+          tag: "ui5-search-87689b96",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime: "sap/f/gen/ui5/webcomponents_fiori/designtime/Search.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "items",
+
+          properties: {
+            /**
+             * Indicates whether a loading indicator should be shown in the popup.
+             */
+            loading: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines whether the value will be autcompleted to match an item.
+             */
+            noTypeahead: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Indicates whether the items picker is open.
+             */
+            open: { type: "boolean", mapping: "property", defaultValue: false },
+            /**
+             * Defines whether the clear icon of the search will be shown.
+             */
+            showClearIcon: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines the value of the component.
+             *
+             * **Note:** The property is updated upon typing.
+             */
+            value: { type: "string", mapping: "property", defaultValue: "" },
+            /**
+             * Defines a short hint intended to aid the user with data entry when the
+             * component has no value.
+             */
+            placeholder: { type: "string", mapping: "property" },
+            /**
+             * Defines the accessible ARIA name of the component.
+             */
+            accessibleName: { type: "string", mapping: "property" },
+            /**
+             * Defines the accessible ARIA description of the field.
+             */
+            accessibleDescription: { type: "string", mapping: "property" },
+            /**
+             * The text-content of the Web Component.
+             */
+            text: { type: "string", mapping: "textContent" },
+            /**
+             * The 'width' of the Web Component in <code>sap.ui.core.CSSSize</code>.
+             */
+            width: { type: "sap.ui.core.CSSSize", mapping: "style" },
+            /**
+             * The 'height' of the Web Component in <code>sap.ui.core.CSSSize</code>.
+             */
+            height: { type: "sap.ui.core.CSSSize", mapping: "style" }
+          },
+
+          aggregations: {
+            /**
+             * Defines the Search suggestion items.
+             * @type module:sap/ui/core/webc/WebComponent
+             */
+            items: { type: "sap.ui.core.webc.WebComponent", multiple: true },
+            /**
+             * Defines the popup footer action button.
+             * @type module:sap/f/gen/ui5/webcomponents/dist/Button
+             */
+            action: {
+              type: "sap.f.gen.ui5.webcomponents.dist.Button",
+              multiple: true,
+              slot: "action"
+            },
+            /**
+             * Defines the illustrated message to be shown in the popup.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori/dist/IllustratedMessage
+             */
+            illustration: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.dist.IllustratedMessage",
+              multiple: true,
+              slot: "illustration"
+            },
+            /**
+             * Defines the illustrated message to be shown in the popup.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori/dist/SearchMessageArea
+             */
+            messageArea: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.dist.SearchMessageArea",
+              multiple: true,
+              slot: "messageArea"
+            },
+            /**
+             * Defines the component scope options.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori.ISearchScope
+             */
+            scopes: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.ISearchScope",
+              multiple: true,
+              slot: "scopes"
+            },
+            /**
+             * Defines the filter button slot, used to display an additional filtering button.
+             * This slot is intended for passing a `ui5-button` with a filter icon to provide extended filtering options.
+             *
+             * **Note:** Scope button and Filter button are mutually exclusive.
+             * @type module:sap/f/gen/ui5/webcomponents/dist/Button
+             */
+            filterButton: {
+              type: "sap.f.gen.ui5.webcomponents.dist.Button",
+              multiple: true,
+              slot: "filterButton"
+            }
+          },
+
+          associations: {},
+
+          events: {
+            /**
+             * Fired when the popup is opened.
+             */
+            onOpen: {
+              mapping: "open",
+              parameters: {}
+            },
+
+            /**
+             * Fired when the popup is closed.
+             */
+            close: {
+              parameters: {}
+            },
+
+            /**
+             * Fired when typing in input or clear icon is pressed.
+             */
+            input: {
+              enableEventBubbling: true,
+              parameters: {}
+            },
+
+            /**
+             * Fired when the scope has changed.
+             */
+            scopeChange: {
+              enableEventBubbling: true,
+              parameters: {
+                /**
+                 * The newly selected scope
+                 */
+                scope: {
+                  type: "sap.ui.core.Control",
+                  types: [
+                    {
+                      origType: "HTMLElement",
+                      multiple: false,
+                      dedicatedTypes: [
+                        {
+                          dtsType: "Control",
+                          packageName: "sap/ui/core/Control",
+                          moduleType: "module:sap/ui/core/Control",
+                          ui5Type: "sap.ui.core.Control",
+                          isClass: true
+                        }
+                      ]
+                    }
+                  ],
+                  dtsParamDescription: "The newly selected scope"
+                }
+              }
+            },
+
+            /**
+             * Fired when the user has triggered search with Enter key or Search Button press.
+             */
+            search: {
+              allowPreventDefault: true,
+              enableEventBubbling: true,
+              parameters: {}
+            }
+          },
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);

package/src/sap/f/gen/ui5/webcomponents_fiori/dist/SearchItem.js

@@ -0,0 +1,125 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define(
+  [
+    "sap/f/gen/ui5/webcomponents/dist/ListItemBase",
+    "sap/f/gen/ui5/webcomponents_fiori",
+    "sap/f/thirdparty/SearchItem"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * ### Overview
+     *
+     * A `ui5-search-item` is a list item, used for displaying search suggestions
+     *
+     * ### ES6 Module Import
+     *
+     * `import "sap/f/gen/ui5/webcomponents_fiori/dist/SearchItem.js";`
+     *
+     * @extends module:sap/f/gen/ui5/webcomponents/dist/ListItemBase
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/SearchItem
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.SearchItem",
+      {
+        metadata: {
+          tag: "ui5-search-item-87689b96",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime:
+            "sap/f/gen/ui5/webcomponents_fiori/designtime/SearchItem.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "",
+
+          properties: {
+            /**
+             * Defines the heading text of the search item.
+             */
+            text: { type: "string", mapping: "property" },
+            /**
+             * Defines the description that appears right under the item text, if available.
+             */
+            description: { type: "string", mapping: "property" },
+            /**
+             * Defines the icon name of the search item.
+             * **Note:** If provided, the image slot will be ignored.
+             */
+            icon: { type: "string", mapping: "property" },
+            /**
+             * Defines whether the search item is selected.
+             */
+            selected: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines whether the search item is deletable.
+             */
+            deletable: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines the scope of the search item
+             */
+            scopeName: { type: "string", mapping: "property" },
+            /**
+             * The 'width' of the Web Component in <code>sap.ui.core.CSSSize</code>.
+             */
+            width: { type: "sap.ui.core.CSSSize", mapping: "style" },
+            /**
+             * The 'height' of the Web Component in <code>sap.ui.core.CSSSize</code>.
+             */
+            height: { type: "sap.ui.core.CSSSize", mapping: "style" }
+          },
+
+          aggregations: {
+            /**
+             * **Note:** While the slot allows the option of setting a custom avatar, to comply with the
+             * design guidelines, use the `ui5-avatar` with size - XS.
+             * @type module:sap/ui/core/Control
+             */
+            image: {
+              type: "sap.ui.core.Control",
+              multiple: true,
+              slot: "image"
+            }
+          },
+
+          associations: {},
+
+          events: {
+            /**
+             * Fired when delete button is pressed.
+             */
+            delete: {
+              parameters: {}
+            }
+          },
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);