From 907506b35c99fb81c9b68f22e03d4b10bcaf917c Mon Sep 17 00:00:00 2001 From: Brandy Smith Date: Mon, 9 Jun 2025 10:57:57 -0400 Subject: [PATCH 01/18] test(fab): skip flaky custom size test (#30463) Co-authored-by: Brandy Smith <6577830+brandyscarney@users.noreply.github.com> --- core/src/components/fab/test/custom-size/fab.e2e.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/src/components/fab/test/custom-size/fab.e2e.ts b/core/src/components/fab/test/custom-size/fab.e2e.ts index 1a739944638..0e164a85735 100644 --- a/core/src/components/fab/test/custom-size/fab.e2e.ts +++ b/core/src/components/fab/test/custom-size/fab.e2e.ts @@ -6,7 +6,8 @@ import { configs, test, Viewports } from '@utils/test/playwright'; */ configs({ modes: ['ios'] }).forEach(({ title, config, screenshot }) => { test.describe(title('fab: custom size'), () => { - test('should position fabs correctly with custom sizes', async ({ page }) => { + // TODO(FW-6587): Remove skip once the flaky test is fixed + test.skip('should position fabs correctly with custom sizes', async ({ page }) => { await page.goto(`/src/components/fab/test/custom-size`, config); await page.setViewportSize(Viewports.tablet.landscape); From 8bec16620051e6c9984c4fb65691b9b668291ee5 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 9 Jun 2025 11:19:08 -0400 Subject: [PATCH 02/18] chore(deps): update dependency @axe-core/playwright to ^4.10.2 (#30460) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@axe-core/playwright](https://redirect.github.com/dequelabs/axe-core-npm) | [`^4.10.1` -> `^4.10.2`](https://renovatebot.com/diffs/npm/@axe-core%2fplaywright/4.10.1/4.10.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@axe-core%2fplaywright/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@axe-core%2fplaywright/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@axe-core%2fplaywright/4.10.1/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@axe-core%2fplaywright/4.10.1/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes
dequelabs/axe-core-npm (@​axe-core/playwright) ### [`v4.10.2`](https://redirect.github.com/dequelabs/axe-core-npm/blob/HEAD/CHANGELOG.md#4102-2025-05-12) [Compare Source](https://redirect.github.com/dequelabs/axe-core-npm/compare/v4.10.1...v4.10.2) ##### Bug Fixes - Optimize AxeBuilder memory usage. ([#​1154](https://redirect.github.com/dequelabs/axe-core-npm/issues/1154)) ([e53cd36](https://redirect.github.com/dequelabs/axe-core-npm/commit/e53cd36d0770a8323577946b0438f058b87a0aad)), closes [/github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/axePuppeteer.ts#L59](https://redirect.github.com//github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/axePuppeteer.ts/issues/L59) [/github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/utils.ts#L34](https://redirect.github.com//github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/utils.ts/issues/L34) - Update axe-core to v4.10.3 ([#​1155](https://redirect.github.com/dequelabs/axe-core-npm/issues/1155)) ([f8e3a14](https://redirect.github.com/dequelabs/axe-core-npm/commit/f8e3a14043c7288ca9373a5f1543ffd27cedf256)) - **wdio:** resolve blank navigation issue in WDIO v9 ([#​1169](https://redirect.github.com/dequelabs/axe-core-npm/issues/1169)) ([6505560](https://redirect.github.com/dequelabs/axe-core-npm/commit/6505560d646ddc6db8a9b4cf772af08ff3f08dc3))
--- ### Configuration 📅 **Schedule**: Branch creation - "every weekday before 11am" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/ionic-team/ionic-framework). Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- core/package-lock.json | 18 +++++++++--------- core/package.json | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/core/package-lock.json b/core/package-lock.json index c423936dd77..56c1c511e10 100644 --- a/core/package-lock.json +++ b/core/package-lock.json @@ -14,7 +14,7 @@ "tslib": "^2.1.0" }, "devDependencies": { - "@axe-core/playwright": "^4.10.1", + "@axe-core/playwright": "^4.10.2", "@capacitor/core": "^7.0.0", "@capacitor/haptics": "^7.0.0", "@capacitor/keyboard": "^7.0.0", @@ -57,12 +57,12 @@ "dev": true }, "node_modules/@axe-core/playwright": { - "version": "4.10.1", - "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.10.1.tgz", - "integrity": "sha512-EV5t39VV68kuAfMKqb/RL+YjYKhfuGim9rgIaQ6Vntb2HgaCaau0h98Y3WEUqW1+PbdzxDtDNjFAipbtZuBmEA==", + "version": "4.10.2", + "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.10.2.tgz", + "integrity": "sha512-6/b5BJjG6hDaRNtgzLIfKr5DfwyiLHO4+ByTLB0cJgWSM8Ll7KqtdblIS6bEkwSF642/Ex91vNqIl3GLXGlceg==", "dev": true, "dependencies": { - "axe-core": "~4.10.2" + "axe-core": "~4.10.3" }, "peerDependencies": { "playwright-core": ">= 1.0.0" @@ -10653,12 +10653,12 @@ }, "dependencies": { "@axe-core/playwright": { - "version": "4.10.1", - "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.10.1.tgz", - "integrity": "sha512-EV5t39VV68kuAfMKqb/RL+YjYKhfuGim9rgIaQ6Vntb2HgaCaau0h98Y3WEUqW1+PbdzxDtDNjFAipbtZuBmEA==", + "version": "4.10.2", + "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.10.2.tgz", + "integrity": "sha512-6/b5BJjG6hDaRNtgzLIfKr5DfwyiLHO4+ByTLB0cJgWSM8Ll7KqtdblIS6bEkwSF642/Ex91vNqIl3GLXGlceg==", "dev": true, "requires": { - "axe-core": "~4.10.2" + "axe-core": "~4.10.3" } }, "@babel/code-frame": { diff --git a/core/package.json b/core/package.json index 895054ef2de..9db1937dbbb 100644 --- a/core/package.json +++ b/core/package.json @@ -36,7 +36,7 @@ "tslib": "^2.1.0" }, "devDependencies": { - "@axe-core/playwright": "^4.10.1", + "@axe-core/playwright": "^4.10.2", "@capacitor/core": "^7.0.0", "@capacitor/haptics": "^7.0.0", "@capacitor/keyboard": "^7.0.0", From 7da26d0fd5881faf2e533f4f464e12cf24d2d1c1 Mon Sep 17 00:00:00 2001 From: Brandy Smith Date: Mon, 9 Jun 2025 13:18:32 -0400 Subject: [PATCH 03/18] test(popover): skip flaky no event popover test (#30464) Co-authored-by: Brandy Smith <6577830+brandyscarney@users.noreply.github.com> --- core/src/components/popover/test/basic/popover.e2e.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/src/components/popover/test/basic/popover.e2e.ts b/core/src/components/popover/test/basic/popover.e2e.ts index f05291ee2aa..92adfe7640b 100644 --- a/core/src/components/popover/test/basic/popover.e2e.ts +++ b/core/src/components/popover/test/basic/popover.e2e.ts @@ -29,7 +29,8 @@ configs({ directions: ['ltr'] }).forEach(({ title, screenshot, config }) => { await popoverFixture.open('#long-list-popover'); await popoverFixture.screenshot('basic-long-list-popover', screenshot); }); - test('should render no event popover', async () => { + // TODO(FW-6588): Remove skip once the flaky test is fixed + test.skip('should render no event popover', async () => { await popoverFixture.open('#no-event-popover'); await popoverFixture.screenshot('basic-no-event-popover', screenshot); }); From 5ca8fc85aa7a8c41005cdc47e97e9bf4f0f8dcbf Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 9 Jun 2025 17:28:43 +0000 Subject: [PATCH 04/18] chore(deps): update dependency @capacitor/core to v7.3.0 (#30461) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@capacitor/core](https://capacitorjs.com) ([source](https://redirect.github.com/ionic-team/capacitor)) | [`7.2.0` -> `7.3.0`](https://renovatebot.com/diffs/npm/@capacitor%2fcore/7.2.0/7.3.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@capacitor%2fcore/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@capacitor%2fcore/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@capacitor%2fcore/7.2.0/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@capacitor%2fcore/7.2.0/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes
ionic-team/capacitor (@​capacitor/core) ### [`v7.3.0`](https://redirect.github.com/ionic-team/capacitor/blob/HEAD/CHANGELOG.md#730-2025-06-05) [Compare Source](https://redirect.github.com/ionic-team/capacitor/compare/7.2.0...7.3.0) ##### Bug Fixes - add error code checking to `runPlatformHook` ([#​7994](https://redirect.github.com/ionic-team/capacitor/issues/7994)) ([8717680](https://redirect.github.com/ionic-team/capacitor/commit/871768049187afe9f5d358d3fe08b6f18f70533e)) - **cli:** Don't downgrade deployment target on migrate ([#​7953](https://redirect.github.com/ionic-team/capacitor/issues/7953)) ([46e8792](https://redirect.github.com/ionic-team/capacitor/commit/46e87925b675933b413737854b1376eb1c71a23e)) - **cli:** ensures the execution order of CLI hooks ([#​7947](https://redirect.github.com/ionic-team/capacitor/issues/7947)) ([c3ea809](https://redirect.github.com/ionic-team/capacitor/commit/c3ea8094cdd385ac02a5aae89f8b44b6c53d493a)) - **cli:** unexpected error on target device list ([#​8015](https://redirect.github.com/ionic-team/capacitor/issues/8015)) ([f827c48](https://redirect.github.com/ionic-team/capacitor/commit/f827c48f08b13a265e8671291c24f3506e14a094)) - **cli:** use proper build params ([#​8016](https://redirect.github.com/ionic-team/capacitor/issues/8016)) ([12ce2a4](https://redirect.github.com/ionic-team/capacitor/commit/12ce2a486542011c8d6f4cd89a67464f3f27e28d)) - **core:** Prevent error when hasListeners is empty ([#​7975](https://redirect.github.com/ionic-team/capacitor/issues/7975)) ([a4a0942](https://redirect.github.com/ionic-team/capacitor/commit/a4a0942eddba068e078bd782bb093ed1ecff9e00)) - Remove all plugin listeners in bridge reset ([#​7962](https://redirect.github.com/ionic-team/capacitor/issues/7962)) ([06aeea9](https://redirect.github.com/ionic-team/capacitor/commit/06aeea973aa56ac2fb791f893ebd899253ee65f9)) ##### Features - **cli:** Initial Cordova plugin SPM support ([#​7999](https://redirect.github.com/ionic-team/capacitor/issues/7999)) ([c030354](https://redirect.github.com/ionic-team/capacitor/commit/c03035426343ddc4e303ca3420e476bb7f1e2201)) - expose `appStartPath` on cap config server configuration ([#​8019](https://redirect.github.com/ionic-team/capacitor/issues/8019)) ([a274fef](https://redirect.github.com/ionic-team/capacitor/commit/a274fef069176a8e528a22f4734d1e29a539709c)) - **ios:** Alternative debug config for SPM ([#​7982](https://redirect.github.com/ionic-team/capacitor/issues/7982)) ([a054aa5](https://redirect.github.com/ionic-team/capacitor/commit/a054aa5bb4d5eabe5da5d42a380bd51b8785958c))
--- ### Configuration 📅 **Schedule**: Branch creation - "every weekday before 11am" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/ionic-team/ionic-framework). Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- core/package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/core/package-lock.json b/core/package-lock.json index 56c1c511e10..6da9b2450e6 100644 --- a/core/package-lock.json +++ b/core/package-lock.json @@ -663,9 +663,9 @@ "dev": true }, "node_modules/@capacitor/core": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@capacitor/core/-/core-7.2.0.tgz", - "integrity": "sha512-2zCnA6RJeZ9ec4470o8QMZEQTWpekw9FNoqm5TLc10jeCrhvHVI8MPgxdZVc3mOdFlyieYu4AS1fNxSqbS57Pw==", + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/@capacitor/core/-/core-7.3.0.tgz", + "integrity": "sha512-t/DdTyBchQ2eAZuCmAARlqQsrEm0WyeNwh5zeRuv+cR6gnAsw+86/EWvJ/em5dTnZyaqEy8vlmOMdWarrUbnuQ==", "dev": true, "dependencies": { "tslib": "^2.1.0" @@ -11102,9 +11102,9 @@ "dev": true }, "@capacitor/core": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@capacitor/core/-/core-7.2.0.tgz", - "integrity": "sha512-2zCnA6RJeZ9ec4470o8QMZEQTWpekw9FNoqm5TLc10jeCrhvHVI8MPgxdZVc3mOdFlyieYu4AS1fNxSqbS57Pw==", + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/@capacitor/core/-/core-7.3.0.tgz", + "integrity": "sha512-t/DdTyBchQ2eAZuCmAARlqQsrEm0WyeNwh5zeRuv+cR6gnAsw+86/EWvJ/em5dTnZyaqEy8vlmOMdWarrUbnuQ==", "dev": true, "requires": { "tslib": "^2.1.0" From 3503975ccd2d3d128cd6ffb7e98ca83ccfb1fcb8 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Mon, 9 Jun 2025 14:06:44 -0500 Subject: [PATCH 05/18] docs(app): add param tag to setFocus method --- core/src/components/app/app.tsx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/core/src/components/app/app.tsx b/core/src/components/app/app.tsx index 4f4919667f4..c875ae85166 100644 --- a/core/src/components/app/app.tsx +++ b/core/src/components/app/app.tsx @@ -68,6 +68,8 @@ export class App implements ComponentInterface { * a result of another user action. (Ex: We focus the first element * inside of a popover when the user presents it, but the popover is not always * presented as a result of keyboard action.) + * + * @param elements An array of HTML elements to set focus on */ @Method() async setFocus(elements: HTMLElement[]) { From d677274c06d2ae1ebf408aecb78f8658c950ae6d Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Mon, 9 Jun 2025 14:12:56 -0500 Subject: [PATCH 06/18] docs(action-sheet): refactor documentation for dismiss method --- core/src/components/action-sheet/action-sheet.tsx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/core/src/components/action-sheet/action-sheet.tsx b/core/src/components/action-sheet/action-sheet.tsx index 1b4cfe31410..dcd7c03847b 100644 --- a/core/src/components/action-sheet/action-sheet.tsx +++ b/core/src/components/action-sheet/action-sheet.tsx @@ -210,16 +210,15 @@ export class ActionSheet implements ComponentInterface, OverlayInterface { /** * Dismiss the action sheet overlay after it has been presented. + * This is a no-op if the overlay has not been presented yet. If you want + * to remove an overlay from the DOM that was never presented, use the + * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. * * @param data Any data to emit in the dismiss events. * @param role The role of the element that is dismissing the action sheet. * This can be useful in a button handler for determining which button was - * clicked to dismiss the action sheet. - * Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`. - * - * This is a no-op if the overlay has not been presented yet. If you want - * to remove an overlay from the DOM that was never presented, use the - * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. + * clicked to dismiss the action sheet. Some examples include: + * `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`. */ @Method() async dismiss(data?: any, role?: string): Promise { From 94b7df132fbe345235424727de9cb9df0a7e4eae Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Mon, 9 Jun 2025 14:15:33 -0500 Subject: [PATCH 07/18] docs(alert): refactor documentation for dismiss method --- core/src/components/alert/alert.tsx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/core/src/components/alert/alert.tsx b/core/src/components/alert/alert.tsx index c126d9b0d2a..a29f4e0fe13 100644 --- a/core/src/components/alert/alert.tsx +++ b/core/src/components/alert/alert.tsx @@ -432,16 +432,15 @@ export class Alert implements ComponentInterface, OverlayInterface { /** * Dismiss the alert overlay after it has been presented. + * This is a no-op if the overlay has not been presented yet. If you want + * to remove an overlay from the DOM that was never presented, use the + * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. * * @param data Any data to emit in the dismiss events. * @param role The role of the element that is dismissing the alert. * This can be useful in a button handler for determining which button was - * clicked to dismiss the alert. - * Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`. - * - * This is a no-op if the overlay has not been presented yet. If you want - * to remove an overlay from the DOM that was never presented, use the - * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. + * clicked to dismiss the alert. Some examples include: + * `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`. */ @Method() async dismiss(data?: any, role?: string): Promise { From 160968b8f475bc40b6dc82bbad306b684391a4ab Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Mon, 9 Jun 2025 14:35:38 -0500 Subject: [PATCH 08/18] docs(datetime): add param tags to confirm, reset, and cancel methods --- core/src/components/datetime/datetime.tsx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index 71a9512e560..3f6283d5b7b 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -524,6 +524,8 @@ export class Datetime implements ComponentInterface { * Confirms the selected datetime value, updates the * `value` property, and optionally closes the popover * or modal that the datetime was presented in. + * + * @param closeOverlay If `true`, closes the the parent overlay. Defaults to `false`. */ @Method() async confirm(closeOverlay = false) { @@ -559,6 +561,8 @@ export class Datetime implements ComponentInterface { * Resets the internal state of the datetime but does not update the value. * Passing a valid ISO-8601 string will reset the state of the component to the provided date. * If no value is provided, the internal state will be reset to the clamped value of the min, max and today. + * + * @param startDate a valid [ISO-8601 string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format) */ @Method() async reset(startDate?: string) { @@ -570,6 +574,8 @@ export class Datetime implements ComponentInterface { * optionally closes the popover * or modal that the datetime was * presented in. + * + * @param closeOverlay If `true`, closes the the parent overlay. Defaults to `false`. */ @Method() async cancel(closeOverlay = false) { From 6b0154c44e5dad2cc6b337a11fef6fe9267af17c Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Mon, 9 Jun 2025 14:44:30 -0500 Subject: [PATCH 09/18] docs(loading): refactor documentation for dismiss method --- core/src/components/loading/loading.tsx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/core/src/components/loading/loading.tsx b/core/src/components/loading/loading.tsx index 785f221c208..1666c869639 100644 --- a/core/src/components/loading/loading.tsx +++ b/core/src/components/loading/loading.tsx @@ -264,16 +264,15 @@ export class Loading implements ComponentInterface, OverlayInterface { /** * Dismiss the loading overlay after it has been presented. + * This is a no-op if the overlay has not been presented yet. If you want + * to remove an overlay from the DOM that was never presented, use the + * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. * * @param data Any data to emit in the dismiss events. * @param role The role of the element that is dismissing the loading. * This can be useful in a button handler for determining which button was - * clicked to dismiss the loading. - * Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`. - * - * This is a no-op if the overlay has not been presented yet. If you want - * to remove an overlay from the DOM that was never presented, use the - * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. + * clicked to dismiss the loading. Some examples include: + * `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`. */ @Method() async dismiss(data?: any, role?: string): Promise { From fa0108acc261a4325fa1f76da78f7004e422f3ed Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Tue, 10 Jun 2025 14:38:48 -0500 Subject: [PATCH 10/18] docs(datetime): fix typo in method param tags --- core/src/components/datetime/datetime.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index 3f6283d5b7b..ff52cf477ec 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -525,7 +525,7 @@ export class Datetime implements ComponentInterface { * `value` property, and optionally closes the popover * or modal that the datetime was presented in. * - * @param closeOverlay If `true`, closes the the parent overlay. Defaults to `false`. + * @param closeOverlay If `true`, closes the parent overlay. Defaults to `false`. */ @Method() async confirm(closeOverlay = false) { @@ -575,7 +575,7 @@ export class Datetime implements ComponentInterface { * or modal that the datetime was * presented in. * - * @param closeOverlay If `true`, closes the the parent overlay. Defaults to `false`. + * @param closeOverlay If `true`, closes the parent overlay. Defaults to `false`. */ @Method() async cancel(closeOverlay = false) { From 5cafafce1f5d80eae934b6e3459e51c08c52878b Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Tue, 10 Jun 2025 16:07:14 -0500 Subject: [PATCH 11/18] docs(menu): add param tags to open, close and toggle methods --- core/src/components/menu/menu.tsx | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 0fee7bda169..b91020f5bb2 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -353,7 +353,7 @@ export class Menu implements ComponentInterface, MenuI { } /** - * Returns `true` is the menu is active. + * Returns `true` if the menu is active. * * A menu is active when it can be opened or closed, meaning it's enabled * and it's not part of a `ion-split-pane`. @@ -366,6 +366,8 @@ export class Menu implements ComponentInterface, MenuI { /** * Opens the menu. If the menu is already open or it can't be opened, * it returns `false`. + * + * @param animated If `true`, open the menu with animation. Defaults to `true`. */ @Method() open(animated = true): Promise { @@ -375,6 +377,12 @@ export class Menu implements ComponentInterface, MenuI { /** * Closes the menu. If the menu is already closed or it can't be closed, * it returns `false`. + * + * @param animated If `true`, close the menu with animation. Defaults to `true`. + * @param role The role of the element that is closing the menu. + * This can be useful in a button handler for determining which button was + * clicked to close the menu. Some examples include: + * `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`. */ @Method() close(animated = true, role?: string): Promise { @@ -384,6 +392,8 @@ export class Menu implements ComponentInterface, MenuI { /** * Toggles the menu. If the menu is already open, it will try to close, otherwise it will try to open it. * If the operation can't be completed successfully, it returns `false`. + * + * @param animated If `true`, toggle the menu with animation. Defaults to `true`. */ @Method() toggle(animated = true): Promise { From b9fd8a2c10fab548e9faf1bdc5d53aa56d3e7ec6 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Tue, 10 Jun 2025 16:27:03 -0500 Subject: [PATCH 12/18] docs(modal): add update documenation on setCurrentBreakpoint and dismiss methods --- core/src/components/modal/modal.tsx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/core/src/components/modal/modal.tsx b/core/src/components/modal/modal.tsx index 2ec55fca020..7858a06fdab 100644 --- a/core/src/components/modal/modal.tsx +++ b/core/src/components/modal/modal.tsx @@ -739,13 +739,12 @@ export class Modal implements ComponentInterface, OverlayInterface { /** * Dismiss the modal overlay after it has been presented. - * - * @param data Any data to emit in the dismiss events. - * @param role The role of the element that is dismissing the modal. For example, 'cancel' or 'backdrop'. - * * This is a no-op if the overlay has not been presented yet. If you want * to remove an overlay from the DOM that was never presented, use the * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. + * + * @param data Any data to emit in the dismiss events. + * @param role The role of the element that is dismissing the modal. For example, `cancel` or `backdrop`. */ @Method() async dismiss(data?: any, role?: string): Promise { @@ -843,6 +842,8 @@ export class Modal implements ComponentInterface, OverlayInterface { /** * Move a sheet style modal to a specific breakpoint. The breakpoint value must * be a value defined in your `breakpoints` array. + * + * @param breakpoint A value in the `breakpoints` array */ @Method() async setCurrentBreakpoint(breakpoint: number): Promise { From dd643f91d9e9c1e93a07f2a0219d9042d30f7ee4 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Wed, 11 Jun 2025 11:46:31 -0500 Subject: [PATCH 13/18] docs(menu): add param tags to setOpen method --- core/src/components/menu/menu.tsx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index b91020f5bb2..0eedce7bdde 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -403,6 +403,10 @@ export class Menu implements ComponentInterface, MenuI { /** * Opens or closes the button. * If the operation can't be completed successfully, it returns `false`. + * + * @param shouldOpen If `true`, attempt to open the menu. + * @param animated If `true`, open or close the menu with animation. Defaults to `true`. + * @param role The role of the element that is closing the menu. */ @Method() setOpen(shouldOpen: boolean, animated = true, role?: string): Promise { From 4556bec5ab29471488773ea07984dccc58573a99 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Wed, 11 Jun 2025 12:06:17 -0500 Subject: [PATCH 14/18] docs(popover): update docs for present and dismiss methods --- core/src/components/popover/popover.tsx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/core/src/components/popover/popover.tsx b/core/src/components/popover/popover.tsx index 61d525dff9a..55bc320b1f9 100644 --- a/core/src/components/popover/popover.tsx +++ b/core/src/components/popover/popover.tsx @@ -459,6 +459,8 @@ export class Popover implements ComponentInterface, PopoverInterface { * Developers can pass a mouse, touch, or pointer event * to position the popover relative to where that event * was dispatched. + * + * @param event Event to position popover relative to. */ @Method() async present(event?: MouseEvent | TouchEvent | PointerEvent | CustomEvent): Promise { @@ -540,15 +542,14 @@ export class Popover implements ComponentInterface, PopoverInterface { /** * Dismiss the popover overlay after it has been presented. + * This is a no-op if the overlay has not been presented yet. If you want + * to remove an overlay from the DOM that was never presented, use the + * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. * * @param data Any data to emit in the dismiss events. - * @param role The role of the element that is dismissing the popover. For example, 'cancel' or 'backdrop'. + * @param role The role of the element that is dismissing the popover. For example, `cancel` or `backdrop`. * @param dismissParentPopover If `true`, dismissing this popover will also dismiss * a parent popover if this popover is nested. Defaults to `true`. - * - * This is a no-op if the overlay has not been presented yet. If you want - * to remove an overlay from the DOM that was never presented, use the - * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. */ @Method() async dismiss(data?: any, role?: string, dismissParentPopover = true): Promise { From 4d9743e846964e64c7212eae7437e54a7ab079bd Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Wed, 11 Jun 2025 12:11:13 -0500 Subject: [PATCH 15/18] docs(reorder-group): remove new line from complete method --- core/src/components/reorder-group/reorder-group.tsx | 1 - 1 file changed, 1 deletion(-) diff --git a/core/src/components/reorder-group/reorder-group.tsx b/core/src/components/reorder-group/reorder-group.tsx index 3dba0535b89..fe4d424ba04 100644 --- a/core/src/components/reorder-group/reorder-group.tsx +++ b/core/src/components/reorder-group/reorder-group.tsx @@ -89,7 +89,6 @@ export class ReorderGroup implements ComponentInterface { /** * Completes the reorder operation. Must be called by the `ionItemReorder` event. - * * If a list of items is passed, the list will be reordered and returned in the * proper order. * From 9db7a54c78d6b49952fa59fcb53439fcc461b192 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Wed, 11 Jun 2025 12:15:22 -0500 Subject: [PATCH 16/18] docs(router): add param tag to push method --- core/src/components/router/router.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/core/src/components/router/router.tsx b/core/src/components/router/router.tsx index c68c9c4701c..a9f262a2b75 100644 --- a/core/src/components/router/router.tsx +++ b/core/src/components/router/router.tsx @@ -124,6 +124,7 @@ export class Router implements ComponentInterface { * * @param path The path to navigate to. * @param direction The direction of the animation. Defaults to `"forward"`. + * @param animation The animation to play when navigating. */ @Method() async push(path: string, direction: RouterDirection = 'forward', animation?: AnimationBuilder) { From ad35701e8c8792e3bfc9586d46d345fcf6e6b9f7 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Wed, 11 Jun 2025 12:17:39 -0500 Subject: [PATCH 17/18] docs(searchbar): spacing in setFocus documentation --- core/src/components/searchbar/searchbar.tsx | 2 -- 1 file changed, 2 deletions(-) diff --git a/core/src/components/searchbar/searchbar.tsx b/core/src/components/searchbar/searchbar.tsx index 852567c64a3..0c038962a53 100644 --- a/core/src/components/searchbar/searchbar.tsx +++ b/core/src/components/searchbar/searchbar.tsx @@ -302,10 +302,8 @@ export class Searchbar implements ComponentInterface { /** * Sets focus on the native `input` in `ion-searchbar`. Use this method instead of the global * `input.focus()`. - * * Developers who wish to focus an input when a page enters * should call `setFocus()` in the `ionViewDidEnter()` lifecycle method. - * * Developers who wish to focus an input when an overlay is presented * should call `setFocus` after `didPresent` has resolved. * From a5059693fb904e80bdefa2c16f926ed4da818807 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Wed, 11 Jun 2025 12:27:39 -0500 Subject: [PATCH 18/18] docs(toast): refactor documentation for dismiss method --- core/src/components/toast/toast.tsx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/core/src/components/toast/toast.tsx b/core/src/components/toast/toast.tsx index 45ec9fc0643..4fdcc90f42a 100644 --- a/core/src/components/toast/toast.tsx +++ b/core/src/components/toast/toast.tsx @@ -397,16 +397,15 @@ export class Toast implements ComponentInterface, OverlayInterface { /** * Dismiss the toast overlay after it has been presented. + * This is a no-op if the overlay has not been presented yet. If you want + * to remove an overlay from the DOM that was never presented, use the + * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. * * @param data Any data to emit in the dismiss events. * @param role The role of the element that is dismissing the toast. * This can be useful in a button handler for determining which button was * clicked to dismiss the toast. - * Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`. - * - * This is a no-op if the overlay has not been presented yet. If you want - * to remove an overlay from the DOM that was never presented, use the - * [remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method. + * Some examples include: `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`. */ @Method() async dismiss(data?: any, role?: string): Promise {