voyager-ionic-core 7.4.3 → 7.5.0

package/dist/types/components/datetime/utils/data.d.ts

@@ -1,6 +1,6 @@
 import type { Mode } from '../../../interface';
 import type { PickerColumnItem } from '../../picker-column-internal/picker-column-internal-interfaces';
-import type { DatetimeParts } from '../datetime-interface';
+import type { DatetimeParts, DatetimeHourCycle } from '../datetime-interface';
 /**
  * Returns the current date as
  * an ISO string in the user's
@@ -35,7 +35,7 @@ export declare const getDaysOfMonth: (month: number, year: number, firstDayOfWee
  * max/min bound datetime parts, calculate the acceptable
  * hour and minute values according to the bounds and locale.
  */
-export declare const generateTime: (refParts: DatetimeParts, hourCycle?: 'h12' | 'h23', minParts?: DatetimeParts, maxParts?: DatetimeParts, hourValues?: number[], minuteValues?: number[]) => {
+export declare const generateTime: (locale: string, refParts: DatetimeParts, hourCycle?: DatetimeHourCycle, minParts?: DatetimeParts, maxParts?: DatetimeParts, hourValues?: number[], minuteValues?: number[]) => {
   hours: number[];
   minutes: number[];
   am: boolean;
@@ -70,7 +70,7 @@ interface CombinedDateColumnData {
  * Example: "Thu, Jun 2"
  */
 export declare const getCombinedDateColumnData: (locale: string, todayParts: DatetimeParts, minParts: DatetimeParts, maxParts: DatetimeParts, dayValues?: number[], monthValues?: number[]) => CombinedDateColumnData;
-export declare const getTimeColumnsData: (locale: string, refParts: DatetimeParts, hourCycle?: 'h23' | 'h12', minParts?: DatetimeParts, maxParts?: DatetimeParts, allowedHourValues?: number[], allowedMinuteValues?: number[]) => {
+export declare const getTimeColumnsData: (locale: string, refParts: DatetimeParts, hourCycle?: DatetimeHourCycle, minParts?: DatetimeParts, maxParts?: DatetimeParts, allowedHourValues?: number[], allowedMinuteValues?: number[]) => {
   [key: string]: PickerColumnItem[];
 };
 export {};

package/dist/types/components/datetime/utils/format.d.ts

@@ -1,5 +1,5 @@
-import type { DatetimeParts } from '../datetime-interface';
-export declare const getLocalizedTime: (locale: string, refParts: DatetimeParts, use24Hour: boolean) => string;
+import type { DatetimeParts, DatetimeHourCycle } from '../datetime-interface';
+export declare const getLocalizedTime: (locale: string, refParts: DatetimeParts, hourCycle: DatetimeHourCycle) => string;
 /**
  * Adds padding to a time value so
  * that it is always 2 digits.
@@ -11,7 +11,7 @@ export declare const addTimePadding: (value: number) => string;
  * 12 hour times it ensures that
  * hour 0 is formatted as '12'.
  */
-export declare const getFormattedHour: (hour: number, use24Hour: boolean) => string;
+export declare const getFormattedHour: (hour: number, hourCycle: DatetimeHourCycle) => string;
 /**
  * Generates an aria-label to be read by screen readers
  * given a local, a date, and whether or not that date is

package/dist/types/components/datetime/utils/helpers.d.ts

@@ -1,3 +1,4 @@
+import type { DatetimeHourCycle } from '../datetime-interface';
 /**
  * Determines if given year is a
  * leap year. Returns `true` if year
@@ -5,7 +6,20 @@
  * otherwise.
  */
 export declare const isLeapYear: (year: number) => boolean;
-export declare const is24Hour: (locale: string, hourCycle?: 'h23' | 'h12') => boolean;
+/**
+ * Determines the hour cycle for a user.
+ * If the hour cycle is explicitly defined, just use that.
+ * Otherwise, we try to derive it from either the specified
+ * locale extension tags or from Intl.DateTimeFormat directly.
+ */
+export declare const getHourCycle: (locale: string, hourCycle?: DatetimeHourCycle) => DatetimeHourCycle;
+/**
+ * Determine if the hour cycle uses a 24-hour format.
+ * Returns true for h23 and h24. Returns false otherwise.
+ * If you don't know the hourCycle, use getHourCycle above
+ * and pass the result into this function.
+ */
+export declare const is24Hour: (hourCycle: DatetimeHourCycle) => boolean;
 /**
  * Given a date object, returns the number
  * of days in that month.

package/dist/types/components/menu/menu-interface.d.ts

@@ -25,7 +25,6 @@ export interface MenuControllerI {
   _setOpen(menu: MenuI, shouldOpen: boolean, animated: boolean): Promise<boolean>;
   _register(menu: MenuI): void;
   _unregister(menu: MenuI): void;
-  _setActiveMenu(menu: MenuI): void;
   getMenus(): Promise<HTMLIonMenuElement[]>;
   getOpenSync(): HTMLIonMenuElement | undefined;
 }

package/dist/types/components/menu/menu.d.ts

@@ -10,6 +10,14 @@ export declare class Menu implements ComponentInterface, MenuI {
   private gesture?;
   private blocker;
   private didLoad;
+  /**
+   * Flag used to determine if an open/close
+   * operation was cancelled. For example, if
+   * an app calls "menu.open" then disables the menu
+   * part way through the animation, then this would
+   * be considered a cancelled operation.
+   */
+  private operationCancelled;
   isAnimating: boolean;
   width: number;
   _isOpen: boolean;
@@ -136,6 +144,5 @@ export declare class Menu implements ComponentInterface, MenuI {
   private beforeAnimation;
   private afterAnimation;
   private updateState;
-  private forceClosing;
   render(): any;
 }

package/dist/types/components/toast/animations/ios.enter.d.ts

@@ -1,5 +1,6 @@
 import type { Animation } from '../../../interface';
+import type { ToastPresentOptions } from '../toast-interface';
 /**
  * iOS Toast Enter Animation
  */
-export declare const iosEnterAnimation: (baseEl: HTMLElement, position: string) => Animation;
+export declare const iosEnterAnimation: (baseEl: HTMLElement, opts: ToastPresentOptions) => Animation;

package/dist/types/components/toast/animations/ios.leave.d.ts

@@ -1,5 +1,5 @@
-import type { Animation } from '../../../interface';
+import type { Animation, ToastDismissOptions } from '../../../interface';
 /**
  * iOS Toast Leave Animation
  */
-export declare const iosLeaveAnimation: (baseEl: HTMLElement, position: string) => Animation;
+export declare const iosLeaveAnimation: (baseEl: HTMLElement, opts: ToastDismissOptions) => Animation;

package/dist/types/components/toast/animations/md.enter.d.ts

@@ -1,5 +1,6 @@
 import type { Animation } from '../../../interface';
+import type { ToastPresentOptions } from '../toast-interface';
 /**
  * MD Toast Enter Animation
  */
-export declare const mdEnterAnimation: (baseEl: HTMLElement, position: string) => Animation;
+export declare const mdEnterAnimation: (baseEl: HTMLElement, opts: ToastPresentOptions) => Animation;

package/dist/types/components/toast/animations/utils.d.ts

@@ -0,0 +1,18 @@
+import type { Mode } from "../../../interface";
+import type { ToastAnimationPosition, ToastPosition } from '../toast-interface';
+/**
+ * Calculate the CSS top and bottom position of the toast, to be used
+ * as starting points for the animation keyframes.
+ *
+ * Note that MD animates bottom-positioned toasts using style.bottom,
+ * which calculates from the bottom edge of the screen, while iOS uses
+ * translateY, which calculates from the top edge of the screen. This
+ * is why the bottom calculates differ slightly between modes.
+ *
+ * @param position The value of the toast's position prop.
+ * @param positionAnchor The element the toast should be anchored to,
+ * if applicable.
+ * @param mode The toast component's mode (md, ios, etc).
+ * @param toast A reference to the toast element itself.
+ */
+export declare function getAnimationPosition(position: ToastPosition, positionAnchor: HTMLElement | undefined, mode: Mode, toast: HTMLElement): ToastAnimationPosition;

package/dist/types/components/toast/toast-interface.d.ts

@@ -7,6 +7,7 @@ export interface ToastOptions {
   duration?: number;
   buttons?: (ToastButton | string)[];
   position?: 'top' | 'bottom' | 'middle';
+  positionAnchor?: HTMLElement | string;
   translucent?: boolean;
   animated?: boolean;
   icon?: string;
@@ -37,3 +38,13 @@ export interface ToastButton {
   handler?: () => boolean | void | Promise<boolean | void>;
 }
 export type ToastPosition = 'top' | 'bottom' | 'middle';
+interface ToastPositionAlias {
+  position: ToastPosition;
+}
+export interface ToastAnimationPosition {
+  top: string;
+  bottom: string;
+}
+export type ToastPresentOptions = ToastPositionAlias & ToastAnimationPosition;
+export type ToastDismissOptions = ToastPositionAlias & ToastAnimationPosition;
+export {};

package/dist/types/components/toast/toast.d.ts

@@ -19,6 +19,12 @@ export declare class Toast implements ComponentInterface, OverlayInterface {
   private readonly triggerController;
   private customHTMLEnabled;
   private durationTimeout?;
+  /**
+   * Holds the position of the toast calculated in the present
+   * animation, to be passed along to the dismiss animation so
+   * we don't have to calculate the position twice.
+   */
+  private lastPresentedPosition?;
   presented: boolean;
   /**
    * When `true`, content inside of .toast-content
@@ -84,9 +90,17 @@ export declare class Toast implements ComponentInterface, OverlayInterface {
    */
   keyboardClose: boolean;
   /**
-   * The position of the toast on the screen.
+   * The starting position of the toast on the screen. Can be tweaked further
+   * using the `positionAnchor` property.
    */
   position: ToastPosition;
+  /**
+   * 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;
   /**
    * An array of buttons for the toast.
    */
@@ -190,6 +204,12 @@ export declare class Toast implements ComponentInterface, OverlayInterface {
    */
   onWillDismiss<T = any>(): Promise<OverlayEventDetail<T>>;
   private getButtons;
+  /**
+   * Returns the element specified by the positionAnchor prop,
+   * or undefined if prop's value is an ID string and the element
+   * is not found in the DOM.
+   */
+  private getAnchorElement;
   private buttonClick;
   private callButtonHandler;
   private dispatchCancelHandler;

package/dist/types/components.d.ts

@@ -15,7 +15,7 @@ import { RouteID, RouterDirection, RouterEventDetail, RouteWrite } from "./compo
 import { BreadcrumbCollapsedClickEventDetail } from "./components/breadcrumb/breadcrumb-interface";
 import { CheckboxChangeEventDetail } from "./components/checkbox/checkbox-interface";
 import { ScrollBaseDetail, ScrollDetail } from "./components/content/content-interface";
-import { DatetimeChangeEventDetail, DatetimeHighlight, DatetimeHighlightCallback, DatetimePresentation, TitleSelectedDatesFormatter } from "./components/datetime/datetime-interface";
+import { DatetimeChangeEventDetail, DatetimeHighlight, DatetimeHighlightCallback, DatetimeHourCycle, DatetimePresentation, TitleSelectedDatesFormatter } from "./components/datetime/datetime-interface";
 import { SpinnerTypes } from "./components/spinner/spinner-configs";
 import { InputChangeEventDetail, InputInputEventDetail } from "./components/input/input-interface";
 import { CounterFormatter } from "./components/item/item-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, ToastLayout, ToastPosition } from "./components/toast/toast-interface";
+import { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions } 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";
@@ -51,7 +51,7 @@ export { RouteID, RouterDirection, RouterEventDetail, RouteWrite } from "./compo
 export { BreadcrumbCollapsedClickEventDetail } from "./components/breadcrumb/breadcrumb-interface";
 export { CheckboxChangeEventDetail } from "./components/checkbox/checkbox-interface";
 export { ScrollBaseDetail, ScrollDetail } from "./components/content/content-interface";
-export { DatetimeChangeEventDetail, DatetimeHighlight, DatetimeHighlightCallback, DatetimePresentation, TitleSelectedDatesFormatter } from "./components/datetime/datetime-interface";
+export { DatetimeChangeEventDetail, DatetimeHighlight, DatetimeHighlightCallback, DatetimeHourCycle, DatetimePresentation, TitleSelectedDatesFormatter } from "./components/datetime/datetime-interface";
 export { SpinnerTypes } from "./components/spinner/spinner-configs";
 export { InputChangeEventDetail, InputInputEventDetail } from "./components/input/input-interface";
 export { CounterFormatter } from "./components/item/item-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, ToastLayout, ToastPosition } from "./components/toast/toast-interface";
+export { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions } from "./components/toast/toast-interface";
 export { ToggleChangeEventDetail } from "./components/toggle/toggle-interface";
 export namespace Components {
     interface IonAccordion {
@@ -865,7 +865,7 @@ export namespace Components {
         /**
           * The hour cycle of the `ion-datetime`. If no value is set, this is specified by the current locale.
          */
-        "hourCycle"?: 'h23' | 'h12';
+        "hourCycle"?: DatetimeHourCycle;
         /**
           * Values used to create the list of selectable hours. By default the hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However, to control exactly which hours to display, the `hourValues` input can take a number, an array of numbers, or a string of comma separated numbers.
          */
@@ -3157,9 +3157,13 @@ export namespace Components {
         "onWillDismiss": <T = any>() => Promise<OverlayEventDetail<T>>;
         "overlayIndex": number;
         /**
-          * The position of the toast on the screen.
+          * The starting position of the toast on the screen. Can be tweaked further using the `positionAnchor` property.
          */
         "position": ToastPosition;
+        /**
+          * 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;
         /**
           * Present the toast overlay after it has been created.
          */
@@ -4868,7 +4872,7 @@ declare namespace LocalJSX {
         /**
           * The hour cycle of the `ion-datetime`. If no value is set, this is specified by the current locale.
          */
-        "hourCycle"?: 'h23' | 'h12';
+        "hourCycle"?: DatetimeHourCycle;
         /**
           * Values used to create the list of selectable hours. By default the hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However, to control exactly which hours to display, the `hourValues` input can take a number, an array of numbers, or a string of comma separated numbers.
          */
@@ -7152,9 +7156,13 @@ declare namespace LocalJSX {
          */
         "onWillPresent"?: (event: IonToastCustomEvent<void>) => void;
         /**
-          * The position of the toast on the screen.
+          * The starting position of the toast on the screen. Can be tweaked further using the `positionAnchor` property.
          */
         "position"?: ToastPosition;
+        /**
+          * 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 `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/index.d.ts

@@ -10,6 +10,7 @@ export { componentOnReady } from './utils/helpers';
 export { isPlatform, Platforms, PlatformConfig, getPlatforms } from './utils/platform';
 export { IonicSafeString } from './utils/sanitization';
 export { IonicConfig, getMode, setupConfig } from './utils/config';
+export { openURL } from './utils/theme';
 export { LIFECYCLE_WILL_ENTER, LIFECYCLE_DID_ENTER, LIFECYCLE_WILL_LEAVE, LIFECYCLE_DID_LEAVE, LIFECYCLE_WILL_UNLOAD, } from './components/nav/constants';
 export { menuController } from './utils/menu-controller';
 export { alertController, actionSheetController, modalController, loadingController, pickerController, popoverController, toastController, } from './utils/overlays';

package/dist/types/utils/menu-controller/index.d.ts

@@ -2,7 +2,7 @@ import type { MenuI } from '../../components/menu/menu-interface';
 import type { AnimationBuilder } from '../../interface';
 export declare const menuController: {
   registerAnimation: (name: string, animation: AnimationBuilder) => void;
-  get: (menu?: string | null) => Promise<HTMLIonMenuElement | undefined>;
+  get: (menu?: string | null, logOnMultipleSideMenus?: boolean) => Promise<HTMLIonMenuElement | undefined>;
   getMenus: () => Promise<HTMLIonMenuElement[]>;
   getOpen: () => Promise<HTMLIonMenuElement | undefined>;
   isEnabled: (menu?: string | null) => Promise<boolean>;
@@ -18,5 +18,4 @@ export declare const menuController: {
   _register: (menu: MenuI) => void;
   _unregister: (menu: MenuI) => void;
   _setOpen: (menu: MenuI, shouldOpen: boolean, animated: boolean) => Promise<boolean>;
-  _setActiveMenu: (menu: MenuI) => void;
 };