Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: use fireDecoratorEvent over fireEvent #10247

Merged
merged 6 commits into from
Jan 9, 2025
Merged

chore: use fireDecoratorEvent over fireEvent #10247

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7fa1908
chore: use fireDecoratorEvent over fireEvent
tsanislavgatev Nov 25, 2024
1c14d04
docs(ui5-menu): remove notes
tsanislavgatev Nov 26, 2024
b121aaa
fix(ui5-menu): align events
tsanislavgatev Nov 29, 2024
5b44e5f
fix(ui5-menu): merge main
tsanislavgatev Dec 20, 2024
56f7d13
fix(ui50menu): align events declaration
tsanislavgatev Dec 20, 2024
52aada2
docs(ui5-menu): remove allowPreventDefault
tsanislavgatev Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 36 additions & 18 deletions packages/main/src/Menu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
import type { UI5CustomEvent } from "@ui5/webcomponents-base";
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
import property from "@ui5/webcomponents-base/dist/decorators/property.js";
import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
Expand Down Expand Up @@ -118,37 +117,55 @@ type MenuBeforeCloseEventDetail = { escPressed: boolean };
* @param { string } text The text of the currently clicked menu item.
* @public
*/
@event("item-click")
@event("item-click", {
cancelable: true,
})

/**
* Fired before the menu is opened. This event can be cancelled, which will prevent the menu from opening. **This event does not bubble.**
* Fired before the menu is opened. This event can be cancelled, which will prevent the menu from opening.
*
* **Note:** Since 1.14.0 the event is also fired before a sub-menu opens.
* @public
* @allowPreventDefault
* @since 1.10.0
* @param { HTMLElement } item The `ui5-menu-item` that triggers opening of the sub-menu or undefined when fired upon root menu opening.
*/
@event("before-open")
@event("before-open", {
bubbles: true,
cancelable: true,
})

/**
* Fired after the menu is opened. **This event does not bubble.**
* Fired after the menu is opened.
* @public
* @since 1.10.0
*/
@event("open")
@event("open", {
bubbles: true,
})

/**
* Fired before the menu is closed. This event can be cancelled, which will prevent the menu from closing. **This event does not bubble.**
* Fired when the menu is being closed.
* @private
*/
@event("close-menu", {
bubbles: true,
})

/**
* Fired before the menu is closed. This event can be cancelled, which will prevent the menu from closing.
* @public
* @allowPreventDefault
* @param {boolean} escPressed Indicates that `ESC` key has triggered the event.
* @since 1.10.0
*/
@event("before-close")
@event("before-close", {
bubbles: true,
cancelable: true,
})

/**
* Fired after the menu is closed. **This event does not bubble.**
* Fired after the menu is closed.
* @public
* @since 1.10.0
*/
Expand All @@ -161,6 +178,7 @@ class Menu extends UI5Element {
"open": void,
"before-close": MenuBeforeCloseEventDetail,
"close": void,
"close-menu": void,
}
/**
* Defines the header text of the menu (displayed on mobile).
Expand Down Expand Up @@ -264,9 +282,9 @@ class Menu extends UI5Element {
return;
}

this.fireEvent<MenuBeforeOpenEventDetail>("before-open", {
this.fireDecoratorEvent("before-open", {
item,
}, false, false);
});
item._popover.opener = item;
item._popover.open = true;
item.selected = true;
Expand Down Expand Up @@ -327,13 +345,13 @@ class Menu extends UI5Element {
const item = e.detail.item as MenuItem;

if (!item._popover) {
const prevented = !this.fireEvent<MenuItemClickEventDetail>("item-click", {
const prevented = !this.fireDecoratorEvent("item-click", {
"item": item,
"text": item.text || "",
}, true, false);
});

if (!prevented && this._popover) {
item.fireEvent("close-menu", {});
item.fireDecoratorEvent("close-menu");
}
} else {
this._openItemSubMenu(item);
Expand Down Expand Up @@ -363,7 +381,7 @@ class Menu extends UI5Element {
}

_beforePopoverOpen(e: CustomEvent) {
const prevented = !this.fireEvent<MenuBeforeOpenEventDetail>("before-open", {}, true, true);
const prevented = !this.fireDecoratorEvent("before-open", {});

if (prevented) {
this.open = false;
Expand All @@ -373,11 +391,11 @@ class Menu extends UI5Element {

_afterPopoverOpen() {
this._menuItems[0]?.focus();
this.fireEvent("open", {}, false, true);
this.fireDecoratorEvent("open");
}

_beforePopoverClose(e: UI5CustomEvent<ResponsivePopover, "before-close">) {
const prevented = !this.fireEvent<MenuBeforeCloseEventDetail>("before-close", { escPressed: e.detail.escPressed }, true, true);
_beforePopoverClose(e: CustomEvent) {
const prevented = !this.fireDecoratorEvent("before-close", { escPressed: e.detail.escPressed });

if (prevented) {
this.open = true;
Expand Down
69 changes: 61 additions & 8 deletions packages/main/src/MenuItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import jsxRenderer from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
import property from "@ui5/webcomponents-base/dist/decorators/property.js";
import type { AccessibilityAttributes, UI5CustomEvent } from "@ui5/webcomponents-base";
import type { AccessibilityAttributes } from "@ui5/webcomponents-base";
import event from "@ui5/webcomponents-base/dist/decorators/event-strict.js";
import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
import i18n from "@ui5/webcomponents-base/dist/decorators/i18n.js";
import { isPhone } from "@ui5/webcomponents-base/dist/Device.js";
Expand Down Expand Up @@ -61,7 +62,59 @@ type MenuItemAccessibilityAttributes = Pick<AccessibilityAttributes, "ariaKeySho
styles: [ListItem.styles, menuItemCss],
dependencies: [...ListItem.dependencies, ResponsivePopover, List, BusyIndicator, Icon],
})

/**
* Fired before the menu is opened. This event can be cancelled, which will prevent the menu from opening.
*
* **Note:** Since 1.14.0 the event is also fired before a sub-menu opens.
* @public
* @allowPreventDefault
tsanislavgatev marked this conversation as resolved.
Show resolved Hide resolved
* @since 1.10.0
* @param { HTMLElement } item The `ui5-menu-item` that triggers opening of the sub-menu or undefined when fired upon root menu opening.
*/
@event("before-open", {
cancelable: true,
})

/**
* Fired after the menu is opened.
* @public
*/
@event("open")

/**
* Fired when the menu is being closed.
* @private
*/
@event("close-menu", {
bubbles: true,
})

/**
* Fired before the menu is closed. This event can be cancelled, which will prevent the menu from closing.
* @public
* @allowPreventDefault
tsanislavgatev marked this conversation as resolved.
Show resolved Hide resolved
* @param {boolean} escPressed Indicates that `ESC` key has triggered the event.
* @since 1.10.0
*/
@event("before-close", {
cancelable: true,
})

/**
* Fired after the menu is closed.
* @public
* @since 1.10.0
*/
@event("close")
class MenuItem extends ListItem implements IMenuItem {
eventDetails!: ListItem["eventDetails"] & {
"before-open": MenuBeforeOpenEventDetail
"open": void
"before-close": MenuBeforeCloseEventDetail
"close": void
"close-menu": void
}
/**
* Defines the text of the tree item.
* @default undefined
Expand Down Expand Up @@ -301,7 +354,7 @@ class MenuItem extends ListItem implements IMenuItem {
this._popover.open = false;
}
this.selected = false;
this.fireEvent("close-menu", {});
this.fireDecoratorEvent("close-menu");
}

_close() {
Expand All @@ -312,7 +365,7 @@ class MenuItem extends ListItem implements IMenuItem {
}

_beforePopoverOpen(e: CustomEvent) {
const prevented = !this.fireEvent<MenuBeforeOpenEventDetail>("before-open", {}, true, false);
const prevented = !this.fireDecoratorEvent("before-open", {});

if (prevented) {
e.preventDefault();
Expand All @@ -321,11 +374,11 @@ class MenuItem extends ListItem implements IMenuItem {

_afterPopoverOpen() {
this.items[0]?.focus();
this.fireEvent("open", {}, false, false);
this.fireDecoratorEvent("open");
}

_beforePopoverClose(e: UI5CustomEvent<ResponsivePopover, "before-close">) {
const prevented = !this.fireEvent<MenuBeforeCloseEventDetail>("before-close", { escPressed: e.detail.escPressed }, true, false);
_beforePopoverClose(e: CustomEvent) {
const prevented = !this.fireDecoratorEvent("before-close", { escPressed: e.detail.escPressed });

if (prevented) {
e.preventDefault();
Expand All @@ -336,13 +389,13 @@ class MenuItem extends ListItem implements IMenuItem {
if (e.detail.escPressed) {
this.focus();
if (isPhone()) {
this.fireEvent("close-menu", {});
this.fireDecoratorEvent("close-menu");
}
}
}

_afterPopoverClose() {
this.fireEvent("close", {}, false, false);
this.fireDecoratorEvent("close");
}
}

Expand Down
Loading