From 3503975ccd2d3d128cd6ffb7e98ca83ccfb1fcb8 Mon Sep 17 00:00:00 2001 From: soundproofboot Date: Mon, 9 Jun 2025 14:06:44 -0500 Subject: [PATCH 01/26] 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 02/26] 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 03/26] 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 04/26] 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 05/26] 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 06/26] 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 07/26] 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 08/26] 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 09/26] 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 10/26] 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 11/26] 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 12/26] 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 13/26] 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 14/26] 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 { From 294471a9c35522de9685e3150c9a85cc66eb6a75 Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:32:31 -0500 Subject: [PATCH 15/26] docs(app): end param comment with period Co-authored-by: Brandy Smith --- core/src/components/app/app.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/app/app.tsx b/core/src/components/app/app.tsx index c875ae85166..8440827bcda 100644 --- a/core/src/components/app/app.tsx +++ b/core/src/components/app/app.tsx @@ -69,7 +69,7 @@ export class App implements ComponentInterface { * 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 + * @param elements An array of HTML elements to set focus on. */ @Method() async setFocus(elements: HTMLElement[]) { From 7a52b3868141e2c305dc4585234859b06a76460a Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:33:06 -0500 Subject: [PATCH 16/26] docs(datetime): add clarity to startDate param Co-authored-by: Brandy Smith --- core/src/components/datetime/datetime.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index ff52cf477ec..45954d2d6f4 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -562,7 +562,7 @@ export class Datetime implements ComponentInterface { * 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) + * @param startDate a valid [ISO-8601 string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format) to reset the datetime state to. */ @Method() async reset(startDate?: string) { From 7403acfcc755b3d8025834b3bdacb7890d9eb1ec Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:34:01 -0500 Subject: [PATCH 17/26] docs(menu): word button to menu Co-authored-by: Brandy Smith --- core/src/components/menu/menu.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 0eedce7bdde..1e199134847 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -401,7 +401,7 @@ export class Menu implements ComponentInterface, MenuI { } /** - * Opens or closes the button. + * Opens or closes the menu. * If the operation can't be completed successfully, it returns `false`. * * @param shouldOpen If `true`, attempt to open the menu. From 5328e70a7f425ddbc194b13d6f64f18f71a6a6f0 Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:34:46 -0500 Subject: [PATCH 18/26] docs(menu): clarity in shouldOpen param Co-authored-by: Brandy Smith --- core/src/components/menu/menu.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 1e199134847..bac01727d3f 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -404,7 +404,7 @@ export class Menu implements ComponentInterface, MenuI { * Opens or closes the menu. * If the operation can't be completed successfully, it returns `false`. * - * @param shouldOpen If `true`, attempt to open the menu. + * @param shouldOpen If `true`, the menu will open. If `false`, the menu will close. * @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. */ From e6c7550bc0af307d60d94d5de507dbaca638b12a Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:35:28 -0500 Subject: [PATCH 19/26] docs(menu): clarity in animated param Co-authored-by: Brandy Smith --- core/src/components/menu/menu.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index bac01727d3f..df18076bdb0 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -405,7 +405,7 @@ export class Menu implements ComponentInterface, MenuI { * If the operation can't be completed successfully, it returns `false`. * * @param shouldOpen If `true`, the menu will open. If `false`, the menu will close. - * @param animated If `true`, open or close the menu with animation. Defaults to `true`. + * @param animated If `true`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. * @param role The role of the element that is closing the menu. */ @Method() From c42db7942e0b9b8b4d2ece64e29fdebf0985811b Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:36:03 -0500 Subject: [PATCH 20/26] docs(menu): clarity in animated param Co-authored-by: Brandy Smith --- core/src/components/menu/menu.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index df18076bdb0..64a8fd2cfa1 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -367,7 +367,7 @@ 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`. + * @param animated If `true`, the menu will animate when opening. If `false`, the menu will open instantly without animation. Defaults to `true`. */ @Method() open(animated = true): Promise { From 406b8049629e64cb1dde3f823de088716e492fcc Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:36:28 -0500 Subject: [PATCH 21/26] docs(menu): clarity in animated param Co-authored-by: Brandy Smith --- core/src/components/menu/menu.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 64a8fd2cfa1..9a9d1cff0e9 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -378,7 +378,7 @@ 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 animated If `true`, the menu will animate when closing. If `false`, the menu will close instantly without 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: From b66df1c9ef6ef298eb3820a605c361d949346514 Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:36:51 -0500 Subject: [PATCH 22/26] docs(menu): clarity in animated param Co-authored-by: Brandy Smith --- core/src/components/menu/menu.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 9a9d1cff0e9..83b7956bfaa 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -393,7 +393,7 @@ 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`. + * @param animated If `true`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. Defaults to `true`. */ @Method() toggle(animated = true): Promise { From 62724e10873c4a8052ad81affc8673b7703a60f2 Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:37:30 -0500 Subject: [PATCH 23/26] docs(modal): move note on breakpoints array Co-authored-by: Brandy Smith --- core/src/components/modal/modal.tsx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/core/src/components/modal/modal.tsx b/core/src/components/modal/modal.tsx index 7858a06fdab..759e47277e7 100644 --- a/core/src/components/modal/modal.tsx +++ b/core/src/components/modal/modal.tsx @@ -840,10 +840,9 @@ 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. + * Move a sheet style modal to a specific breakpoint. * - * @param breakpoint A value in the `breakpoints` array + * @param breakpoint The breakpoint value to move the sheet modal to. Must be a value defined in your `breakpoints` array. */ @Method() async setCurrentBreakpoint(breakpoint: number): Promise { From a3788d94584f87ec7c8a652ef23d2a15ba0be210 Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:37:56 -0500 Subject: [PATCH 24/26] docs(popover): language in event param Co-authored-by: Brandy Smith --- core/src/components/popover/popover.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/popover/popover.tsx b/core/src/components/popover/popover.tsx index 55bc320b1f9..8b9ad6230cf 100644 --- a/core/src/components/popover/popover.tsx +++ b/core/src/components/popover/popover.tsx @@ -460,7 +460,7 @@ export class Popover implements ComponentInterface, PopoverInterface { * to position the popover relative to where that event * was dispatched. * - * @param event Event to position popover relative to. + * @param event The event to position the popover relative to. */ @Method() async present(event?: MouseEvent | TouchEvent | PointerEvent | CustomEvent): Promise { From 5629fd31f77e41c1470019acb57069b276bc816c Mon Sep 17 00:00:00 2001 From: Colin Bares Date: Mon, 23 Jun 2025 16:38:20 -0500 Subject: [PATCH 25/26] docs(router): language in animation param Co-authored-by: Brandy Smith --- core/src/components/router/router.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/components/router/router.tsx b/core/src/components/router/router.tsx index a9f262a2b75..a5c0c67bf0e 100644 --- a/core/src/components/router/router.tsx +++ b/core/src/components/router/router.tsx @@ -124,7 +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. + * @param animation A custom animation to use for the transition. */ @Method() async push(path: string, direction: RouterDirection = 'forward', animation?: AnimationBuilder) { From 3d87651626a5db38d03dd92cb796159014cc2dc2 Mon Sep 17 00:00:00 2001 From: Brandy Smith <6577830+brandyscarney@users.noreply.github.com> Date: Mon, 23 Jun 2025 18:10:00 -0400 Subject: [PATCH 26/26] chore(): build & lint --- core/src/components.d.ts | 50 +++++++++++++++-------- core/src/components/app/app.tsx | 2 +- core/src/components/datetime/datetime.tsx | 6 +-- core/src/components/menu/menu.tsx | 28 ++++++++----- core/src/components/modal/modal.tsx | 8 ++-- core/src/components/popover/popover.tsx | 2 +- 6 files changed, 60 insertions(+), 36 deletions(-) diff --git a/core/src/components.d.ts b/core/src/components.d.ts index 3fc70d62b02..b5e0d7c5b70 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -174,9 +174,9 @@ export namespace Components { "cssClass"?: string | string[]; "delegate"?: FrameworkDelegate; /** - * Dismiss the action sheet overlay after it has been presented. + * 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. + * @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"`. */ "dismiss": (data?: any, role?: string) => Promise; /** @@ -262,9 +262,9 @@ export namespace Components { "cssClass"?: string | string[]; "delegate"?: FrameworkDelegate; /** - * Dismiss the alert overlay after it has been presented. + * 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. + * @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"`. */ "dismiss": (data?: any, role?: string) => Promise; /** @@ -340,6 +340,7 @@ export namespace Components { interface IonApp { /** * Used to set focus on an element that uses `ion-focusable`. Do not use this if focusing the element as a result of a keyboard event as the focus utility should handle this for us. This method should be used when we want to programmatically focus an element as 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. */ "setFocus": (elements: HTMLElement[]) => Promise; } @@ -910,6 +911,7 @@ export namespace Components { interface IonDatetime { /** * Emits the ionCancel event and optionally closes the popover or modal that the datetime was presented in. + * @param closeOverlay If `true`, closes the parent overlay. Defaults to `false`. */ "cancel": (closeOverlay?: boolean) => Promise; /** @@ -929,6 +931,7 @@ export namespace Components { "color"?: Color; /** * 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`. */ "confirm": (closeOverlay?: boolean) => Promise; /** @@ -1022,6 +1025,7 @@ export namespace Components { "readonly": boolean; /** * 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) to reset the datetime state to. */ "reset": (startDate?: string) => Promise; /** @@ -1749,9 +1753,9 @@ export namespace Components { "cssClass"?: string | string[]; "delegate"?: FrameworkDelegate; /** - * Dismiss the loading overlay after it has been presented. + * 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. + * @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"`. */ "dismiss": (data?: any, role?: string) => Promise; /** @@ -1828,6 +1832,8 @@ export namespace Components { interface IonMenu { /** * Closes the menu. If the menu is already closed or it can't be closed, it returns `false`. + * @param animated If `true`, the menu will animate when closing. If `false`, the menu will close instantly without 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"`. */ "close": (animated?: boolean, role?: string) => Promise; /** @@ -1840,7 +1846,7 @@ export namespace Components { */ "disabled": boolean; /** - * Returns `true` is 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`. + * 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`. */ "isActive": () => Promise; /** @@ -1858,10 +1864,14 @@ export namespace Components { "menuId"?: string; /** * Opens the menu. If the menu is already open or it can't be opened, it returns `false`. + * @param animated If `true`, the menu will animate when opening. If `false`, the menu will open instantly without animation. Defaults to `true`. */ "open": (animated?: boolean) => Promise; /** - * Opens or closes the button. If the operation can't be completed successfully, it returns `false`. + * Opens or closes the menu. If the operation can't be completed successfully, it returns `false`. + * @param shouldOpen If `true`, the menu will open. If `false`, the menu will close. + * @param animated If `true`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. + * @param role The role of the element that is closing the menu. */ "setOpen": (shouldOpen: boolean, animated?: boolean, role?: string) => Promise; /** @@ -1876,6 +1886,7 @@ export namespace Components { "swipeGesture": boolean; /** * 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`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. Defaults to `true`. */ "toggle": (animated?: boolean) => Promise; /** @@ -1962,9 +1973,9 @@ export namespace Components { "cssClass"?: string | string[]; "delegate"?: FrameworkDelegate; /** - * Dismiss the modal overlay after it has been presented. + * Dismiss the modal 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 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 role The role of the element that is dismissing the modal. For example, `cancel` or `backdrop`. */ "dismiss": (data?: any, role?: string) => Promise; /** @@ -2047,7 +2058,8 @@ export namespace Components { */ "presentingElement"?: HTMLElement; /** - * Move a sheet style modal to a specific breakpoint. The breakpoint value must be a value defined in your `breakpoints` array. + * Move a sheet style modal to a specific breakpoint. + * @param breakpoint The breakpoint value to move the sheet modal to. Must be a value defined in your `breakpoints` array. */ "setCurrentBreakpoint": (breakpoint: number) => Promise; /** @@ -2408,10 +2420,10 @@ export namespace Components { "cssClass"?: string | string[]; "delegate"?: FrameworkDelegate; /** - * Dismiss the popover overlay after it has been presented. + * 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 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. + * @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`. */ "dismiss": (data?: any, role?: string, dismissParentPopover?: boolean) => Promise; /** @@ -2479,6 +2491,7 @@ export namespace Components { "overlayIndex": number; /** * Present the popover overlay after it has been created. Developers can pass a mouse, touch, or pointer event to position the popover relative to where that event was dispatched. + * @param event The event to position the popover relative to. */ "present": (event?: MouseEvent | TouchEvent | PointerEvent | CustomEvent) => Promise; /** @@ -2770,7 +2783,7 @@ export namespace Components { } interface IonReorderGroup { /** - * 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. If no parameters are passed or if `true` is passed in, the reorder will complete and the item will remain in the position it was dragged to. If `false` is passed, the reorder will complete and the item will bounce back to its original position. + * 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. If no parameters are passed or if `true` is passed in, the reorder will complete and the item will remain in the position it was dragged to. If `false` is passed, the reorder will complete and the item will bounce back to its original position. * @param listOrReorder A list of items to be sorted and returned in the new order or a boolean of whether or not the reorder should reposition the item. */ "complete": (listOrReorder?: boolean | any[]) => Promise; @@ -2838,6 +2851,7 @@ export namespace Components { * Navigate to the specified path. * @param path The path to navigate to. * @param direction The direction of the animation. Defaults to `"forward"`. + * @param animation A custom animation to use for the transition. */ "push": (path: string, direction?: RouterDirection, animation?: AnimationBuilder) => Promise; /** @@ -2988,7 +3002,7 @@ export namespace Components { */ "searchIcon"?: string; /** - * 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. See [managing focus](/docs/developing/managing-focus) for more information. + * 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. See [managing focus](/docs/developing/managing-focus) for more information. */ "setFocus": () => Promise; /** @@ -3569,9 +3583,9 @@ export namespace Components { "cssClass"?: string | string[]; "delegate"?: FrameworkDelegate; /** - * Dismiss the toast overlay after it has been presented. + * 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. + * @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"`. */ "dismiss": (data?: any, role?: string) => Promise; /** diff --git a/core/src/components/app/app.tsx b/core/src/components/app/app.tsx index 8440827bcda..f7aba5fb152 100644 --- a/core/src/components/app/app.tsx +++ b/core/src/components/app/app.tsx @@ -68,7 +68,7 @@ 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() diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index 45954d2d6f4..7011cf4b14d 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -524,7 +524,7 @@ 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() @@ -561,7 +561,7 @@ 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) to reset the datetime state to. */ @Method() @@ -574,7 +574,7 @@ 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() diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index 83b7956bfaa..6306801ce50 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -366,8 +366,10 @@ 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`, the menu will animate when opening. If `false`, the menu will open instantly without animation. Defaults to `true`. + * + * @param animated If `true`, the menu will animate when opening. + * If `false`, the menu will open instantly without animation. + * Defaults to `true`. */ @Method() open(animated = true): Promise { @@ -377,8 +379,9 @@ 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`, the menu will animate when closing. If `false`, the menu will close instantly without animation. Defaults to `true`. + * + * @param animated If `true`, the menu will animate when closing. If `false`, + * the menu will close instantly without 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: @@ -390,10 +393,13 @@ 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. + * 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`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. Defaults to `true`. + * + * @param animated If `true`, the menu will animate when opening/closing. + * If `false`, the menu will open/close instantly without animation. + * Defaults to `true`. */ @Method() toggle(animated = true): Promise { @@ -403,9 +409,11 @@ export class Menu implements ComponentInterface, MenuI { /** * Opens or closes the menu. * If the operation can't be completed successfully, it returns `false`. - * - * @param shouldOpen If `true`, the menu will open. If `false`, the menu will close. - * @param animated If `true`, the menu will animate when opening/closing. If `false`, the menu will open/close instantly without animation. + * + * @param shouldOpen If `true`, the menu will open. If `false`, the menu + * will close. + * @param animated If `true`, the menu will animate when opening/closing. + * If `false`, the menu will open/close instantly without animation. * @param role The role of the element that is closing the menu. */ @Method() diff --git a/core/src/components/modal/modal.tsx b/core/src/components/modal/modal.tsx index 759e47277e7..eb56d50e73f 100644 --- a/core/src/components/modal/modal.tsx +++ b/core/src/components/modal/modal.tsx @@ -744,7 +744,8 @@ export class Modal implements ComponentInterface, OverlayInterface { * [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`. + * @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 { @@ -841,8 +842,9 @@ export class Modal implements ComponentInterface, OverlayInterface { /** * Move a sheet style modal to a specific breakpoint. - * - * @param breakpoint The breakpoint value to move the sheet modal to. Must be a value defined in your `breakpoints` array. + * + * @param breakpoint The breakpoint value to move the sheet modal to. + * Must be a value defined in your `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 8b9ad6230cf..9b07ab2f275 100644 --- a/core/src/components/popover/popover.tsx +++ b/core/src/components/popover/popover.tsx @@ -459,7 +459,7 @@ 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 The event to position the popover relative to. */ @Method()