Skip to content

Commit

Permalink
refactor(ui5-toast): rename event after-close to close (#8967)
Browse files Browse the repository at this point in the history
Rename Toast `after-close` event to `close`

BREAKING CHANGE: The `after-close`  event has been renamed to `close`. If you previously used it like:
```ts
toast.addEventListener("after-close", (event) => {
});
```
Now you have to use it like:
```ts
toast.addEventListener("close", (event) => {
});
```

Related to: #8461
  • Loading branch information
ilhan007 committed May 15, 2024
1 parent 11f5cd6 commit d05839d
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 11 deletions.
38 changes: 38 additions & 0 deletions docs/Migrating to version 2.0 guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,9 @@ it will no longer work for the component. Instead, do not render disabled option
| Property | `horizontalAlign` | values have changed, f.e. `Left` to `Start` |
| Property | `placementType` | `placement` |
| `placement` type enumeration | `PopoverPlacementType` | `PopoverPlacement` |
| Event | after-open | open |
| Event | after-close | close |


- The `Left` and `Right` options have been renamed. If you previously used them to set the placement or the alignment of the popover:
```html
Expand All @@ -626,6 +629,23 @@ Now use `placement` instead:
import PopoverPlacement from "@ui5/webcomponents/dist/types/PopoverPlacement.js";
```

- The events `after-close` and `after-open` have been renamed to `open` and `close` respectively.
If you previously used the events like:

```ts
poover.addEventListener("after-open", (event) => {
});
poover.addEventListener("after-close", (event) => {
});
```
Now you have to use it like:
```ts
poover.addEventListener("open", (event) => {
});
poover.addEventListener("close", (event) => {
});
```

### ui5-progress-indicator

| Changed item | Old | New |
Expand Down Expand Up @@ -976,6 +996,24 @@ Now you have to use it like:
<ui5-tree-item additional-text-state="Success"></ui5-tree-item>
```

### ui5-toast

| Changed item | Old | New |
|--------------|--------------|--------|
| Event | after-close | close |

- The event `after-close` has been renamed to `close`. If you previously used it like:

```ts
toast.addEventListener("after-close", (event) => {
});
```
Now you have to use it like:
```ts
toast.addEventListener("close", (event) => {
});
```


## Fiori package (@ui5/webcomponents-fiori)

Expand Down
8 changes: 4 additions & 4 deletions packages/main/src/Select.ts
Original file line number Diff line number Diff line change
Expand Up @@ -647,8 +647,8 @@ class Select extends UI5Element implements IFormInputElement {
}

attachMenuListeners(menu: HTMLElement) {
menu.addEventListener("ui5-after-close", this._onMenuClose);
menu.addEventListener("ui5-after-open", this._onMenuOpen);
menu.addEventListener("ui5-close", this._onMenuClose);
menu.addEventListener("ui5-open", this._onMenuOpen);
menu.addEventListener("ui5-before-open", this._onMenuBeforeOpen);
// @ts-ignore
menu.addEventListener("ui5-option-click", this._onMenuClick);
Expand All @@ -657,8 +657,8 @@ class Select extends UI5Element implements IFormInputElement {
}

detachMenuListeners(menu: HTMLElement) {
menu.removeEventListener("ui5-after-close", this._onMenuClose);
menu.removeEventListener("ui5-after-open", this._onMenuOpen);
menu.removeEventListener("ui5-close", this._onMenuClose);
menu.removeEventListener("ui5-open", this._onMenuOpen);
menu.removeEventListener("ui5-before-open", this._onMenuBeforeOpen);
// @ts-ignore
menu.removeEventListener("ui5-option-click", this._onMenuClick);
Expand Down
8 changes: 4 additions & 4 deletions packages/main/src/SelectMenu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ type SelectMenuChange = {
},
})
@event("before-open")
@event("after-open")
@event("after-close")
@event("open")
@event("close")
@event<SelectMenuChange>("menu-change", {
detail: {
text: { type: String },
Expand Down Expand Up @@ -222,11 +222,11 @@ class SelectMenu extends UI5Element {
}

_onAfterOpen() {
this.fireEvent<CustomEvent>("after-open");
this.fireEvent<CustomEvent>("open");
}

_onAfterClose() {
this.fireEvent<CustomEvent>("after-close");
this.fireEvent<CustomEvent>("close");
}

_onCloseBtnClick() {
Expand Down
4 changes: 2 additions & 2 deletions packages/main/src/Toast.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ const handleGlobalKeydown = (e: KeyboardEvent) => {
* @public
* @since 2.0.0
*/
@event("after-close")
@event("close")

class Toast extends UI5Element {
/**
Expand Down Expand Up @@ -226,7 +226,7 @@ class Toast extends UI5Element {
this.open = false;
this.focusable = false;
this.focused = false;
this.fireEvent("after-close");
this.fireEvent("close");
}

_onmouseover() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ OpeningMenu.decorators = [
}
});
menu.addEventListener("after-close", function() {
menu.addEventListener("close", function() {
splitBtn.activeArrowButton = false;
});
</script>`;}
Expand Down

0 comments on commit d05839d

Please sign in to comment.