@openui5/sap.f 1.141.2 → 1.143.0

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

@@ -0,0 +1,279 @@
+/*!
+ * 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/UserMenu"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * ### Overview
+     *
+     * The `ui5-user-menu` is an SAP Fiori specific web component that is used in `ui5-shellbar`
+     * and allows the user to easily see information and settings for the current user and all other logged in accounts.
+     *
+     * ### ES6 Module Import
+     * `import "@ui5/webcomponents-fiori/dist/UserMenu.js";`
+     *
+     * `import "@ui5/webcomponents-fiori/dist/UserMenuItem.js";` (for `ui5-user-menu-item`)
+     *
+     * @extends sap.ui.core.webc.WebComponent
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/UserMenu
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenu",
+      {
+        metadata: {
+          tag: "ui5-user-menu-cc48984a",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime: "sap/f/gen/ui5/webcomponents_fiori/designtime/UserMenu.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "menuItems",
+
+          properties: {
+            /**
+             * Defines if the User Menu is opened.
+             */
+            open: { type: "boolean", mapping: "property", defaultValue: false },
+            /**
+             * Defines if the User Menu shows the Manage Account option.
+             */
+            showManageAccount: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines if the User Menu shows the Other Accounts option.
+             */
+            showOtherAccounts: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines if the User Menu shows the Edit Accounts option.
+             */
+            showEditAccounts: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Defines if the User menu shows edit button.
+             */
+            showEditButton: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * 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 menu items.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuItem
+             */
+            menuItems: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuItem",
+              multiple: true
+            },
+            /**
+             * Defines the user accounts.
+             *
+             * **Note:** If one item is used, it will be shown as the selected one. If more than one item is used, the first one will be shown as selected unless
+             * there is an item with `selected` property set to `true`.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuAccount
+             */
+            accounts: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuAccount",
+              multiple: true,
+              slot: "accounts"
+            }
+          },
+
+          associations: {
+            /**
+             * Defines the ID or DOM Reference of the element at which the user menu is shown.
+             * When using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the popover.
+             * You can only set the `opener` attribute to a DOM Reference when using JavaScript.
+             */
+            opener: { mapping: { type: "property", to: "opener" } }
+          },
+
+          events: {
+            /**
+             * Fired when the account avatar is selected.
+             */
+            avatarClick: {
+              parameters: {}
+            },
+
+            /**
+             * Fired when the "Manage Account" button is selected.
+             */
+            manageAccountClick: {
+              parameters: {}
+            },
+
+            /**
+             * Fired when the "Edit Accounts" button is selected.
+             */
+            editAccountsClick: {
+              parameters: {}
+            },
+
+            /**
+             * Fired when the account is switched to a different one.
+             */
+            changeAccount: {
+              allowPreventDefault: true,
+              parameters: {
+                /**
+                 * The previously selected account.
+                 */
+                prevSelectedAccount: {
+                  type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuAccount",
+                  types: [
+                    {
+                      origType: "UserMenuAccount",
+                      multiple: false,
+                      dedicatedTypes: [
+                        {
+                          dtsType: "UserMenuAccount",
+                          ui5Type:
+                            "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuAccount",
+                          moduleType:
+                            "module:@ui5/webcomponents-fiori/dist/UserMenuAccount",
+                          packageName:
+                            "sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuAccount",
+                          isClass: true
+                        }
+                      ]
+                    }
+                  ],
+                  dtsParamDescription: "The previously selected account."
+                },
+                /**
+                 * The selected account.
+                 */
+                selectedAccount: {
+                  type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuAccount",
+                  types: [
+                    {
+                      origType: "UserMenuAccount",
+                      multiple: false,
+                      dedicatedTypes: [
+                        {
+                          dtsType: "UserMenuAccount",
+                          ui5Type:
+                            "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuAccount",
+                          moduleType:
+                            "module:@ui5/webcomponents-fiori/dist/UserMenuAccount",
+                          packageName:
+                            "sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuAccount",
+                          isClass: true
+                        }
+                      ]
+                    }
+                  ],
+                  dtsParamDescription: "The selected account."
+                }
+              }
+            },
+
+            /**
+             * Fired when a menu item is selected.
+             */
+            itemClick: {
+              allowPreventDefault: true,
+              parameters: {
+                /**
+                 * The selected `user menu item`.
+                 */
+                item: {
+                  type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuItem",
+                  types: [
+                    {
+                      origType: "UserMenuItem",
+                      multiple: false,
+                      dedicatedTypes: [
+                        {
+                          dtsType: "UserMenuItem",
+                          ui5Type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuItem",
+                          moduleType:
+                            "module:@ui5/webcomponents-fiori/dist/UserMenuItem",
+                          packageName:
+                            "sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuItem",
+                          isClass: true
+                        }
+                      ]
+                    }
+                  ],
+                  dtsParamDescription: "The selected `user menu item`."
+                }
+              }
+            },
+
+            /**
+             * Fired when a user menu is open.
+             */
+            onOpen: {
+              mapping: "open",
+              parameters: {}
+            },
+
+            /**
+             * Fired when a user menu is close.
+             */
+            close: {
+              parameters: {}
+            },
+
+            /**
+             * Fired when the "Sign Out" button is selected.
+             */
+            signOutClick: {
+              allowPreventDefault: true,
+              parameters: {}
+            }
+          },
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);

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

@@ -0,0 +1,129 @@
+/*!
+ * 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/UserMenuAccount"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * ### Overview
+     *
+     * The `ui5-user-menu-account` represents an account in the `ui5-user-menu`.
+     *
+     * ### ES6 Module Import
+     * `import "@ui5/webcomponents-fiori/dist/UserMenuAccount.js";`
+     *
+     * @extends sap.ui.core.webc.WebComponent
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuAccount
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuAccount",
+      {
+        metadata: {
+          tag: "ui5-user-menu-account-cc48984a",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime:
+            "sap/f/gen/ui5/webcomponents_fiori/designtime/UserMenuAccount.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "",
+
+          properties: {
+            /**
+             * Defines the avatar image url of the user.
+             */
+            avatarSrc: {
+              type: "string",
+              mapping: "property",
+              defaultValue: ""
+            },
+            /**
+             * Defines the avatar initials of the user.
+             */
+            avatarInitials: { type: "string", mapping: "property" },
+            /**
+             * Defines the title text of the user.
+             */
+            titleText: {
+              type: "string",
+              mapping: "property",
+              defaultValue: ""
+            },
+            /**
+             * Defines additional text of the user.
+             */
+            subtitleText: {
+              type: "string",
+              mapping: "property",
+              defaultValue: ""
+            },
+            /**
+             * Defines description of the user.
+             */
+            description: {
+              type: "string",
+              mapping: "property",
+              defaultValue: ""
+            },
+            /**
+             * Defines if the user is selected.
+             */
+            selected: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * Indicates whether a loading indicator should be shown.
+             */
+            loading: {
+              type: "boolean",
+              mapping: "property",
+              defaultValue: false
+            },
+            /**
+             * 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: {},
+
+          associations: {},
+
+          events: {},
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);

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

@@ -0,0 +1,83 @@
+/*!
+ * 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/MenuItem",
+    "sap/f/gen/ui5/webcomponents_fiori",
+    "sap/f/thirdparty/UserMenuItem"
+  ],
+  function (WebComponentBaseClass) {
+    "use strict";
+
+    /**
+     * @class
+     * ### Overview
+     *
+     * `ui5-user-menu-item` is the item to use inside a `ui5-user-menu`.
+     * An arbitrary hierarchy structure can be represented by recursively nesting menu items.
+     *
+     * ### Usage
+     *
+     * `ui5-user-menu-item` represents a node in a `ui5-user-menu`. The user menu itself is rendered as a list,
+     * and each `ui5-menu-item` is represented by a menu item in that menu. Therefore, you should only use
+     * `ui5-user-menu-item` directly in your apps. The `ui5-menu` menu item is internal for the menu, and not intended for public use.
+     *
+     * ### ES6 Module Import
+     *
+     * `import "@ui5/webcomponents-fiori/dist/UserMenuItem.js";`
+     *
+     * @extends module:sap/f/gen/ui5/webcomponents/dist/MenuItem
+     * @constructor
+     * @private
+     * @alias module:sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuItem
+     */
+
+    const WrapperClass = WebComponentBaseClass.extend(
+      "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuItem",
+      {
+        metadata: {
+          tag: "ui5-user-menu-item-cc48984a",
+
+          namespace: "sap.f.gen.ui5.webcomponents_fiori",
+
+          library: "sap.f",
+
+          designtime:
+            "sap/f/gen/ui5/webcomponents_fiori/designtime/UserMenuItem.designtime",
+
+          interfaces: [],
+
+          defaultAggregation: "items",
+
+          properties: {},
+
+          aggregations: {
+            /**
+             * Defines the items of this component.
+             *
+             * **Note:** Use `ui5-user-menu-item` for the intended design.
+             * @type module:sap/f/gen/ui5/webcomponents_fiori/dist/UserMenuItem
+             */
+            items: {
+              type: "sap.f.gen.ui5.webcomponents_fiori.dist.UserMenuItem",
+              multiple: true
+            }
+          },
+
+          associations: {},
+
+          events: {},
+
+          getters: [],
+
+          methods: []
+        }
+      }
+    );
+
+    return WrapperClass;
+  }
+);