diff --git a/core/package-lock.json b/core/package-lock.json index c423936dd77..6da9b2450e6 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" @@ -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" @@ -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": { @@ -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" 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", 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 { 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 { 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[]) { diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index 71a9512e560..ff52cf477ec 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 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 parent overlay. Defaults to `false`. */ @Method() async cancel(closeOverlay = false) { 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); 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 { diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 0fee7bda169..0eedce7bdde 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 { @@ -393,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 { 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 { 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 { 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); }); 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. * 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) { 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. * 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 {