@ionic/core 7.5.8 → 7.6.1-dev.11701921257.1d512d3c

package/dist/types/components.d.ts

@@ -27,7 +27,7 @@ import { PickerButton, PickerColumn } from "./components/picker/picker-interface
 import { PickerColumnItem } from "./components/picker-column-internal/picker-column-internal-interfaces";
 import { PickerInternalChangeEventDetail } from "./components/picker-internal/picker-internal-interfaces";
 import { PopoverSize, PositionAlign, PositionReference, PositionSide, TriggerAction } from "./components/popover/popover-interface";
-import { RadioGroupChangeEventDetail } from "./components/radio-group/radio-group-interface";
+import { RadioGroupChangeEventDetail, RadioGroupCompareFn } from "./components/radio-group/radio-group-interface";
 import { PinFormatter, RangeChangeEventDetail, RangeKnobMoveEndEventDetail, RangeKnobMoveStartEventDetail, RangeValue } from "./components/range/range-interface";
 import { RefresherEventDetail } from "./components/refresher/refresher-interface";
 import { ItemReorderEventDetail } from "./components/reorder-group/reorder-group-interface";
@@ -39,7 +39,7 @@ import { SelectChangeEventDetail, SelectCompareFn, SelectInterface } from "./com
 import { SelectPopoverOption } from "./components/select-popover/select-popover-interface";
 import { TabBarChangedEventDetail, TabButtonClickEventDetail, TabButtonLayout } from "./components/tab-bar/tab-bar-interface";
 import { TextareaChangeEventDetail, TextareaInputEventDetail } from "./components/textarea/textarea-interface";
-import { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions } from "./components/toast/toast-interface";
+import { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions, ToastSwipeGestureDirection } from "./components/toast/toast-interface";
 import { ToggleChangeEventDetail } from "./components/toggle/toggle-interface";
 export { AccordionGroupChangeEventDetail } from "./components/accordion-group/accordion-group-interface";
 export { AnimationBuilder, AutocompleteTypes, Color, ComponentProps, ComponentRef, FrameworkDelegate, StyleEventDetail, TextFieldTypes } from "./interface";
@@ -63,7 +63,7 @@ export { PickerButton, PickerColumn } from "./components/picker/picker-interface
 export { PickerColumnItem } from "./components/picker-column-internal/picker-column-internal-interfaces";
 export { PickerInternalChangeEventDetail } from "./components/picker-internal/picker-internal-interfaces";
 export { PopoverSize, PositionAlign, PositionReference, PositionSide, TriggerAction } from "./components/popover/popover-interface";
-export { RadioGroupChangeEventDetail } from "./components/radio-group/radio-group-interface";
+export { RadioGroupChangeEventDetail, RadioGroupCompareFn } from "./components/radio-group/radio-group-interface";
 export { PinFormatter, RangeChangeEventDetail, RangeKnobMoveEndEventDetail, RangeKnobMoveStartEventDetail, RangeValue } from "./components/range/range-interface";
 export { RefresherEventDetail } from "./components/refresher/refresher-interface";
 export { ItemReorderEventDetail } from "./components/reorder-group/reorder-group-interface";
@@ -75,7 +75,7 @@ export { SelectChangeEventDetail, SelectCompareFn, SelectInterface } from "./com
 export { SelectPopoverOption } from "./components/select-popover/select-popover-interface";
 export { TabBarChangedEventDetail, TabButtonClickEventDetail, TabButtonLayout } from "./components/tab-bar/tab-bar-interface";
 export { TextareaChangeEventDetail, TextareaInputEventDetail } from "./components/textarea/textarea-interface";
-export { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions } from "./components/toast/toast-interface";
+export { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions, ToastSwipeGestureDirection } from "./components/toast/toast-interface";
 export { ToggleChangeEventDetail } from "./components/toggle/toggle-interface";
 export namespace Components {
     interface IonAccordion {
@@ -2269,6 +2269,10 @@ export namespace Components {
           * If `true`, the radios can be deselected.
          */
         "allowEmptySelection": boolean;
+        /**
+          * This property allows developers to specify a custom function or property name for comparing objects when determining the selected option in the ion-radio-group. When not specified, the default behavior will use strict equality (===) for comparison.
+         */
+        "compareWith"?: string | RadioGroupCompareFn | null;
         /**
           * The name of the control, which is submitted with the form data.
          */
@@ -2688,7 +2692,7 @@ export namespace Components {
          */
         "color"?: Color;
         /**
-          * A property name or function used to compare object values
+          * This property allows developers to specify a custom function or property name for comparing objects when determining the selected option in the ion-select. When not specified, the default behavior will use strict equality (===) for comparison.
          */
         "compareWith"?: string | SelectCompareFn | null;
         /**
@@ -3172,6 +3176,10 @@ export namespace Components {
           * Present the toast overlay after it has been created.
          */
         "present": () => Promise<void>;
+        /**
+          * If set to 'vertical', the Toast can be dismissed with a swipe gesture. The swipe direction is determined by the value of the `position` property: `top`: The Toast can be swiped up to dismiss. `bottom`: The Toast can be swiped down to dismiss. `middle`: The Toast can be swiped up or down to dismiss.
+         */
+        "swipeGesture"?: ToastSwipeGestureDirection;
         /**
           * If `true`, the toast will be translucent. Only applies when the mode is `"ios"` and the device supports [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
          */
@@ -3390,6 +3398,10 @@ export interface IonSelectCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLIonSelectElement;
 }
+export interface IonSkeletonTextCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLIonSkeletonTextElement;
+}
 export interface IonSplitPaneCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLIonSplitPaneElement;
@@ -4404,7 +4416,18 @@ declare global {
         prototype: HTMLIonSelectPopoverElement;
         new (): HTMLIonSelectPopoverElement;
     };
+    interface HTMLIonSkeletonTextElementEventMap {
+        "ionStyle": StyleEventDetail;
+    }
     interface HTMLIonSkeletonTextElement extends Components.IonSkeletonText, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLIonSkeletonTextElementEventMap>(type: K, listener: (this: HTMLIonSkeletonTextElement, ev: IonSkeletonTextCustomEvent<HTMLIonSkeletonTextElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLIonSkeletonTextElementEventMap>(type: K, listener: (this: HTMLIonSkeletonTextElement, ev: IonSkeletonTextCustomEvent<HTMLIonSkeletonTextElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     }
     var HTMLIonSkeletonTextElement: {
         prototype: HTMLIonSkeletonTextElement;
@@ -6831,6 +6854,10 @@ declare namespace LocalJSX {
           * If `true`, the radios can be deselected.
          */
         "allowEmptySelection"?: boolean;
+        /**
+          * This property allows developers to specify a custom function or property name for comparing objects when determining the selected option in the ion-radio-group. When not specified, the default behavior will use strict equality (===) for comparison.
+         */
+        "compareWith"?: string | RadioGroupCompareFn | null;
         /**
           * The name of the control, which is submitted with the form data.
          */
@@ -7288,7 +7315,7 @@ declare namespace LocalJSX {
          */
         "color"?: Color;
         /**
-          * A property name or function used to compare object values
+          * This property allows developers to specify a custom function or property name for comparing objects when determining the selected option in the ion-select. When not specified, the default behavior will use strict equality (===) for comparison.
          */
         "compareWith"?: string | SelectCompareFn | null;
         /**
@@ -7795,6 +7822,10 @@ declare namespace LocalJSX {
           * The element to anchor the toast's position to. Can be set as a direct reference or the ID of the element. With `position="bottom"`, the toast will sit above the chosen element. With `position="top"`, the toast will sit below the chosen element. With `position="middle"`, the value of `positionAnchor` is ignored.
          */
         "positionAnchor"?: HTMLElement | string;
+        /**
+          * If set to 'vertical', the Toast can be dismissed with a swipe gesture. The swipe direction is determined by the value of the `position` property: `top`: The Toast can be swiped up to dismiss. `bottom`: The Toast can be swiped down to dismiss. `middle`: The Toast can be swiped up or down to dismiss.
+         */
+        "swipeGesture"?: ToastSwipeGestureDirection;
         /**
           * If `true`, the toast will be translucent. Only applies when the mode is `"ios"` and the device supports [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
          */

package/dist/types/interface.d.ts

@@ -32,6 +32,7 @@ export { TabsCustomEvent } from './components/tabs/tabs-interface';
 export { TextareaCustomEvent } from './components/textarea/textarea-interface';
 export { ToastOptions } from './components/toast/toast-interface';
 export { ToggleCustomEvent } from './components/toggle/toggle-interface';
+export { BackButtonEvent, BackButtonEventDetail } from './utils/hardware-back-button';
 
 // Types from utils
 export {
@@ -140,17 +141,12 @@ export type ComponentRef = Function | HTMLElement | string | null;
 // eslint-disable-next-line
 export type ComponentProps<T = null> = { [key: string]: any };
 export type CssClassMap = { [className: string]: boolean };
-export type BackButtonEvent = CustomEvent<BackButtonEventDetail>;
 
 export interface FrameworkDelegate {
   attachViewToDom(container: any, component: any, propsOrDataObj?: any, cssClasses?: string[]): Promise<HTMLElement>;
   removeViewFromDom(container: any, component: any): Promise<void>;
 }
 
-export interface BackButtonEventDetail {
-  register(priority: number, handler: (processNextHandler: () => void) => Promise<any> | void): void;
-}
-
 export interface KeyboardEventDetail {
   keyboardHeight: number;
 }

package/dist/types/jest.d.ts

@@ -0,0 +1,5 @@
+declare namespace jest {
+  interface Matchers<R> {
+    toHaveShadowPart(part: string): R;
+  }
+}

package/dist/types/utils/animation/animation-interface.d.ts

@@ -27,9 +27,9 @@ export interface Animation {
     progressStart(forceLinearEasing?: boolean, step?: number): Animation;
     progressStep(step: number): Animation;
     progressEnd(playTo: 0 | 1 | undefined, step: number, dur?: number): Animation;
-    from(property: string, value: any): Animation;
-    to(property: string, value: any): Animation;
-    fromTo(property: string, fromValue: any, toValue: any): Animation;
+    from(property: string, value: string | number): Animation;
+    to(property: string, value: string | number): Animation;
+    fromTo(property: string, fromValue: string | number, toValue: string | number): Animation;
     /**
      * Set the keyframes for the animation.
      */
@@ -106,7 +106,7 @@ export interface Animation {
      * browsers that do not support
      * the Web Animations API.
      */
-    getWebAnimations(): any[];
+    getWebAnimations(): globalThis.Animation[];
     /**
      * Add a function that performs a
      * DOM read to be run after the

package/dist/types/utils/browser/index.d.ts

@@ -1,3 +1,4 @@
+import type { BackButtonEvent } from "../hardware-back-button";
 /**
  * When accessing the document or window, it is important
  * to account for SSR applications where the
@@ -26,14 +27,22 @@
  * on the window for certain CustomEvent types you can add that definition
  * here as long as you are using the "win" utility below.
  */
-type IonicWindow = Window & {
+type IonicEvents = {
     addEventListener(type: 'ionKeyboardDidShow', listener: (ev: CustomEvent<{
         keyboardHeight: number;
     }>) => void, options?: boolean | AddEventListenerOptions): void;
     removeEventListener(type: 'ionKeyboardDidShow', listener: (ev: CustomEvent<{
         keyboardHeight: number;
     }>) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: 'ionInputDidLoad', listener: (ev: CustomEvent<HTMLIonInputElement | HTMLIonTextareaElement>) => void, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: 'ionInputDidLoad', listener: (ev: CustomEvent<HTMLIonInputElement | HTMLIonTextareaElement>) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: 'ionInputDidUnload', listener: (ev: CustomEvent<HTMLIonInputElement | HTMLIonTextareaElement>) => void, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: 'ionInputDidUnload', listener: (ev: CustomEvent<HTMLIonInputElement | HTMLIonTextareaElement>) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: 'ionBackButton', listener: (ev: BackButtonEvent) => void, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: 'ionBackButton', listener: (ev: BackButtonEvent) => void, options?: boolean | AddEventListenerOptions): void;
 };
+type IonicWindow = Window & IonicEvents;
+type IonicDocument = Document & IonicEvents;
 export declare const win: IonicWindow | undefined;
-export declare const doc: Document | undefined;
+export declare const doc: IonicDocument | undefined;
 export {};

package/dist/types/utils/forms/compare-with-utils.d.ts

@@ -0,0 +1,18 @@
+type CompareFn = (currentValue: any, compareValue: any) => boolean;
+/**
+ * Uses the compareWith param to compare two values to determine if they are equal.
+ *
+ * @param currentValue The current value of the control.
+ * @param compareValue The value to compare against.
+ * @param compareWith The function or property name to use to compare values.
+ */
+export declare const compareOptions: (currentValue: any, compareValue: any, compareWith?: string | CompareFn | null) => boolean;
+/**
+ * Compares a value against the current value(s) to determine if it is selected.
+ *
+ * @param currentValue The current value of the control.
+ * @param compareValue The value to compare against.
+ * @param compareWith The function or property name to use to compare values.
+ */
+export declare const isOptionSelected: (currentValue: any[] | any, compareValue: any, compareWith?: string | CompareFn | null) => boolean;
+export {};

package/dist/types/utils/forms/index.d.ts

@@ -1,2 +1,3 @@
 export * from './form-controller';
 export * from './notch-controller';
+export * from './compare-with-utils';

package/dist/types/utils/hardware-back-button.d.ts

@@ -1,3 +1,7 @@
+export interface BackButtonEventDetail {
+    register(priority: number, handler: (processNextHandler: () => void) => Promise<any> | void): void;
+}
+export type BackButtonEvent = CustomEvent<BackButtonEventDetail>;
 /**
  * When hardwareBackButton: false in config,
  * we need to make sure we also block the default

package/dist/types/utils/overlays.d.ts

@@ -99,6 +99,7 @@ export declare const isCancel: (role: string | undefined) => boolean;
 export declare const safeCall: (handler: any, arg?: any) => any;
 export declare const BACKDROP = "backdrop";
 export declare const GESTURE = "gesture";
+export declare const OVERLAY_GESTURE_PRIORITY = 39;
 /**
  * Creates a delegate controller.
  *

package/dist/types/utils/slot-mutation-controller.d.ts

@@ -4,10 +4,10 @@
  * This is not needed for components using native slots in the Shadow DOM.
  * @internal
  * @param el The host element to observe
- * @param slotName mutationCallback will fire when nodes on this slot change
+ * @param slotName mutationCallback will fire when nodes on these slot(s) change
  * @param mutationCallback The callback to fire whenever the slotted content changes
  */
-export declare const createSlotMutationController: (el: HTMLElement, slotName: string, mutationCallback: () => void) => SlotMutationController;
+export declare const createSlotMutationController: (el: HTMLElement, slotName: string | string[], mutationCallback: () => void) => SlotMutationController;
 export type SlotMutationController = {
     destroy: () => void;
 };