javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-11-06 14:19:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(vue): emit component-specific overlay events (#30688)

Browse Source 
Issue number: resolves #30641

---------

<!-- Please do not submit updates to dependencies unless it fixes an
issue. -->

<!-- Please try to limit your pull request to one type (bugfix, feature,
etc). Submit multiple pull requests if needed. -->

## What is the current behavior?
<!-- Please describe the current behavior that you are modifying. -->

Currently, Vue modals do not emit `ionModal...` events. This happened
due to a change in the way the stencil output targets for Vue changed.
Christian [updated the
overlays](https://github.com/ionic-team/ionic-framework/pull/30227/files#diff-7e46aba01094c4917cd55e8eebd263fc4a297a2d62143f1ae30959ec4e023b6f)
to support the base events, but not the component-specific events.

## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->

With this change, you'll be able to bind to the events as described in
the Ionic documentation.

## Does this introduce a breaking change?

- [ ] Yes
- [X] No

<!--
  If this introduces a breaking change:
1. Describe the impact and migration path for existing applications
below.
  2. Update the BREAKING.md file with the breaking change.
3. Add "BREAKING CHANGE: [...]" to the commit description when merging.
See
https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer
for more information.
-->


## Other information

Current dev build:
```
8.7.5-dev.11758311583.14f4e9d9
```
This commit is contained in:
Shane
2025-09-23 10:22:48 -07:00
committed by GitHub
parent 36c56e71b6
commit 024d090122
3 changed files with 201 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
packages/vue/test/base/src/views/Overlays.vue
View File

@ -64,6 +64,10 @@
Modal onDidPresent: <div id="didPresent">{{ didPresent }}</div><br />
Modal onWillDismiss: <div id="willDismiss">{{ willDismiss }}</div><br />
Modal onDidDismiss: <div id="didDismiss">{{ didDismiss }}</div><br />
Modal ionModalWillPresent: <div id="ionModalWillPresent">{{ ionModalWillPresent }}</div><br />
Modal ionModalDidPresent: <div id="ionModalDidPresent">{{ ionModalDidPresent }}</div><br />
Modal ionModalWillDismiss: <div id="ionModalWillDismiss">{{ ionModalWillDismiss }}</div><br />
Modal ionModalDidDismiss: <div id="ionModalDidDismiss">{{ ionModalDidDismiss }}</div><br />
</div>
<ion-action-sheet
@ -98,6 +102,10 @@
@didPresent="onModalDidPresent"
@willDismiss="onModalWillDismiss"
@didDismiss="onModalDidDismiss"
@ionModalWillPresent="onIonModalWillPresent"
@ionModalDidPresent="onIonModalDidPresent"
@ionModalWillDismiss="onIonModalWillDismiss"
@ionModalDidDismiss="onIonModalDidDismiss"
>
<ModalContent :title="overlayProps.title"></ModalContent>
</ion-modal>
@ -266,6 +274,19 @@ export default defineComponent({
const openModal = async () => {
const modal = await modalController.create({ cssClass: "ion-modal-controller", component: ModalContent, componentProps: overlayProps });
// Attach lifecycle listeners for controller-created modal
modal.addEventListener('willPresent', () => { willPresent.value += 1; });
modal.addEventListener('didPresent', () => { didPresent.value += 1; });
modal.addEventListener('willDismiss', () => { willDismiss.value += 1; });
modal.addEventListener('didDismiss', () => { didDismiss.value += 1; });
// Long-form event names
modal.addEventListener('ionModalWillPresent', () => { ionModalWillPresent.value += 1; });
modal.addEventListener('ionModalDidPresent', () => { ionModalDidPresent.value += 1; });
modal.addEventListener('ionModalWillDismiss', () => { ionModalWillDismiss.value += 1; });
modal.addEventListener('ionModalDidDismiss', () => { ionModalDidDismiss.value += 1; });
await modal.present();
}
@ -335,21 +356,37 @@ export default defineComponent({
const didPresent = ref(0);
const willDismiss = ref(0);
const didDismiss = ref(0);
const ionModalWillPresent = ref(0);
const ionModalDidPresent = ref(0);
const ionModalWillDismiss = ref(0);
const ionModalDidDismiss = ref(0);
const onModalWillPresent = () => willPresent.value += 1;
const onModalDidPresent = () => { didPresent.value += 1; setModalRef(true); }
const onModalWillDismiss = () => willDismiss.value += 1;
const onModalDidDismiss = () => { didDismiss.value += 1; setModalRef(false); }
const onIonModalWillPresent = () => ionModalWillPresent.value += 1;
const onIonModalDidPresent = () => ionModalDidPresent.value += 1;
const onIonModalWillDismiss = () => ionModalWillDismiss.value += 1;
const onIonModalDidDismiss = () => ionModalDidDismiss.value += 1;
return {
onModalWillPresent,
onModalDidPresent,
onModalWillDismiss,
onModalDidDismiss,
onIonModalWillPresent,
onIonModalDidPresent,
onIonModalWillDismiss,
onIonModalDidDismiss,
willPresent,
didPresent,
willDismiss,
didDismiss,
ionModalWillPresent,
ionModalDidPresent,
ionModalWillDismiss,
ionModalDidDismiss,
changeLoadingProps,
overlayProps,
present,

159
packages/vue/test/base/tests/e2e/specs/overlays.cy.js
View File

@ -1,7 +1,11 @@
const testController = (overlay, shadow = false) => {
const selector = `.${overlay}-controller`;
cy.get(`ion-radio#${overlay}`).click();
cy.get('ion-radio#controller').click();
cy.get(`ion-radio#${overlay}`)
.scrollIntoView({ offset: { top: -100, left: 0 } })
.click({ force: true });
cy.get('ion-radio#controller')
.scrollIntoView({ offset: { top: -100, left: 0 } })
.click({ force: true });
cy.get('ion-button#present-overlay').click();
cy.get(selector).should('exist').should('be.visible');
@ -16,8 +20,12 @@ const testController = (overlay, shadow = false) => {
}
const testComponent = (overlay, shadow = false) => {
cy.get(`ion-radio#${overlay}`).click();
cy.get('ion-radio#component').click();
cy.get(`ion-radio#${overlay}`)
.scrollIntoView({ offset: { top: -100, left: 0 } })
.click({ force: true });
cy.get('ion-radio#component')
.scrollIntoView({ offset: { top: -100, left: 0 } })
.click({ force: true });
cy.get('ion-button#present-overlay').click();
cy.get(overlay).should('exist').should('be.visible');
@ -40,8 +48,12 @@ const testComponent = (overlay, shadow = false) => {
}
const testInlineOverlay = (overlay, shadow = false) => {
cy.get(`ion-radio#${overlay}`).click();
cy.get('ion-radio#component').click();
cy.get(`ion-radio#${overlay}`)
.scrollIntoView({ offset: { top: -100, left: 0 } })
.click({ force: true });
cy.get('ion-radio#component')
.scrollIntoView({ offset: { top: -100, left: 0 } })
.click({ force: true });
cy.get('ion-button#present-overlay').click();
cy.get(overlay).should('exist').should('be.visible');
@ -214,6 +226,135 @@ describe('Overlays', () => {
});
});
it('should fire long-form lifecycle events on overlays', () => {
cy.get('ion-radio#ion-modal').click();
cy.get('ion-radio#component').click();
cy.get('ion-button#present-overlay').click();
cy.get('ion-modal').should('exist');
testLongLifecycle('overlays', {
willPresent: 1,
didPresent: 1,
willDismiss: 0,
didDismiss: 0
});
cy.get('ion-modal #dismiss').click();
testLongLifecycle('overlays', {
willPresent: 1,
didPresent: 1,
willDismiss: 1,
didDismiss: 1
});
cy.get('ion-button#present-overlay').click();
cy.get('ion-modal').should('exist');
testLongLifecycle('overlays', {
willPresent: 2,
didPresent: 2,
willDismiss: 1,
didDismiss: 1
});
cy.get('ion-modal #dismiss').click();
testLongLifecycle('overlays', {
willPresent: 2,
didPresent: 2,
willDismiss: 2,
didDismiss: 2
});
});
it('should fire lifecycle events on controller overlays', () => {
cy.get('ion-radio#ion-modal').click();
cy.get('ion-radio#controller').click();
cy.get('ion-button#present-overlay').click();
cy.get('ion-modal').should('exist');
testLifecycle('overlays', {
willPresent: 1,
didPresent: 1,
willDismiss: 0,
didDismiss: 0
});
cy.get('ion-modal #dismiss').click();
testLifecycle('overlays', {
willPresent: 1,
didPresent: 1,
willDismiss: 1,
didDismiss: 1
});
cy.get('ion-button#present-overlay').click();
cy.get('ion-modal').should('exist');
testLifecycle('overlays', {
willPresent: 2,
didPresent: 2,
willDismiss: 1,
didDismiss: 1
});
cy.get('ion-modal #dismiss').click();
testLifecycle('overlays', {
willPresent: 2,
didPresent: 2,
willDismiss: 2,
didDismiss: 2
});
});
it('should fire long-form lifecycle events on controller overlays', () => {
cy.get('ion-radio#ion-modal').click();
cy.get('ion-radio#controller').click();
cy.get('ion-button#present-overlay').click();
cy.get('ion-modal').should('exist');
testLongLifecycle('overlays', {
willPresent: 1,
didPresent: 1,
willDismiss: 0,
didDismiss: 0
});
cy.get('ion-modal #dismiss').click();
testLongLifecycle('overlays', {
willPresent: 1,
didPresent: 1,
willDismiss: 1,
didDismiss: 1
});
cy.get('ion-button#present-overlay').click();
cy.get('ion-modal').should('exist');
testLongLifecycle('overlays', {
willPresent: 2,
didPresent: 2,
willDismiss: 1,
didDismiss: 1
});
cy.get('ion-modal #dismiss').click();
testLongLifecycle('overlays', {
willPresent: 2,
didPresent: 2,
willDismiss: 2,
didDismiss: 2
});
});
it('should unmount modal via component', () => {
cy.get('ion-radio#ion-modal').click();
cy.get('ion-radio#component').click();
@ -260,3 +401,9 @@ const testLifecycle = (selector, expected = {}) => {
cy.get(`[data-pageid=${selector}] #didDismiss`).should('have.text', expected.didDismiss);
}
const testLongLifecycle = (selector, expected = {}) => {
cy.get(`[data-pageid=${selector}] #ionModalWillPresent`).should('have.text', expected.willPresent);
cy.get(`[data-pageid=${selector}] #ionModalDidPresent`).should('have.text', expected.didPresent);
cy.get(`[data-pageid=${selector}] #ionModalWillDismiss`).should('have.text', expected.willDismiss);
cy.get(`[data-pageid=${selector}] #ionModalDidDismiss`).should('have.text', expected.didDismiss);
}