@ionic/core 8.2.1 → 8.2.2-dev.11717790867.100c8d5e

package/dist/types/global/ionic-global.d.ts

@@ -1,4 +1,27 @@
-import type { IonicConfig, Mode } from '../interface';
-export declare const getIonMode: (ref?: any) => Mode;
+import type { IonicConfig, Mode, Theme } from '../interface';
+/**
+ * Validates if a mode is accepted for a theme configuration.
+ * @param mode The mode to validate.
+ * @param theme The theme the mode is being used with.
+ * @returns `true` if the mode is valid for the theme, `false` if invalid.
+ */
+export declare const isModeValidForTheme: (mode: Mode, theme: Theme) => boolean;
+/**
+ * Returns the mode value of the element reference or the closest
+ * parent with a valid mode.
+ * @param ref The element reference to look up the mode for.
+ * @param theme Optionally can provide the theme to avoid an additional look-up.
+ * @returns The mode value for the element reference.
+ */
+export declare const getIonMode: (ref?: any, theme?: Theme) => Mode;
+/**
+ * Returns the theme value of the element reference or the closest
+ * parent with a valid theme.
+ *
+ * @param ref The element reference to look up the theme for.
+ * @returns The theme value for the element reference, defaults to
+ * the default theme if it cannot be determined.
+ */
+export declare const getIonTheme: (ref?: any) => Theme;
 export declare const initialize: (userConfig?: IonicConfig) => void;
 export default initialize;

package/dist/types/interface.d.ts

@@ -134,6 +134,9 @@ export type PredefinedColors =
 export type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
 
 export type Color = LiteralUnion<PredefinedColors, string>;
+
+export type Theme = 'ios' | 'md' | 'ionic';
+
 export type Mode = 'ios' | 'md';
 export type ComponentTags = string;
 // eslint-disable-next-line

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

@@ -1,6 +1,6 @@
 import type { SpinnerTypes } from '../components/spinner/spinner-configs';
 import type { TabButtonLayout } from '../components/tab-bar/tab-bar-interface';
-import type { AnimationBuilder, Mode } from '../interface';
+import type { AnimationBuilder, Mode, Theme } from '../interface';
 import type { PlatformConfig } from './platform';
 export interface IonicConfig {
     /**
@@ -14,9 +14,24 @@ export interface IonicConfig {
      */
     rippleEffect?: boolean;
     /**
-     * The mode determines which platform styles to use for the whole application.
+     * The mode determines the platform behaviors to use for the entire application,
+     * such as rubber-band scrolling on iOS or Android page transitions.
+     *
+     * Possible values are: `"ios"` or `"md"`.
+     *
+     * Without a specified theme, the mode will be used to determine which platform
+     * styles to use throughout the application. This is legacy behavior to prevent
+     * breaking changes, but we recommend the use of a specific theme to opt in to
+     * the new styles.
      */
     mode?: Mode;
+    /**
+     * The theme determines the visual appearance of components.
+     * - `"ios"` - iOS components aligning to the Cupertino guidelines
+     * - `"md"` - Material Design components aligning to Material Design 2 guidelines
+     * - `"ionic"` - **EXPERIMENTAL** Ionic's upcoming new design system
+     */
+    theme?: Theme;
     /**
      * Wherever ionic will respond to hardware go back buttons in an Android device.
      * Defaults to `true` when ionic runs in a mobile device.
@@ -87,6 +102,88 @@ export interface IonicConfig {
      * Overrides the default `duration` for all `ion-toast` components.
      */
     toastDuration?: number;
+    /**
+     * Overrides the toggle icon for all `ion-accordion` components.
+     */
+    accordionToggleIcon?: string;
+    /**
+     * Overrides the separator icon for all `ion-breadcrumb` components,
+     * only when mode is set to `ios`.
+     */
+    breadcrumbSeparatorIcon?: string;
+    /**
+     * Overrides the collapsed icon for all `ion-breadcrumb` components.
+     */
+    breadcrumbCollapsedIcon?: string;
+    /**
+     * Overrides the next icon for all `ion-datetime` components.
+     */
+    datetimeNextIcon?: string;
+    /**
+     * Overrides the previous icon for all `ion-datetime` components.
+     */
+    datetimePreviousIcon?: string;
+    /**
+     * Overrides the show month and year icon for all `ion-datetime` components.
+     */
+    datetimeShowMonthYearIcon?: string;
+    /**
+     * Overrides the hide month and year icon for all `ion-datetime` components.
+     */
+    datetimeHideMonthYearIcon?: string;
+    /**
+     * Overrides the close icon for all `ion-fab-button` components.
+     */
+    fabButtonCloseIcon?: string;
+    /**
+     * Overrides the clear icon for all `ion-input` components.
+     */
+    inputClearIcon?: string;
+    /**
+     * Overrides the show icon for all `ion-input-password` components.
+     */
+    inputPasswordShowIcon?: string;
+    /**
+     * Overrides the hide icon for all `ion-input-password` components.
+     */
+    inputPasswordHideIcon?: string;
+    /**
+     * Overrides the detail icon for all `ion-item` components.
+     */
+    itemDetailIcon?: string;
+    /**
+     * Overrides the handle icon for all `ion-reorder` components.
+     */
+    reorderHandleIcon?: string;
+    /**
+     * Overrides the cancel icon for all `ion-searchbar` components,
+     * only when mode is set to `md`.
+     */
+    searchbarCancelIcon?: string;
+    /**
+     * Overrides the clear icon for all `ion-searchbar` components.
+     */
+    searchbarClearIcon?: string;
+    /**
+     * Overrides the search icon for all `ion-searchbar` components.
+     */
+    searchbarSearchIcon?: string;
+    /**
+     * Overrides the expand icon for all `ion-select` components.
+     */
+    selectExpandIcon?: string;
+    /**
+     * Overrides the collapsed icon for all `ion-select` components.
+     */
+    selectCollapsedIcon?: string;
+    /**
+     * Overrides the checked icon for all `ion-toggle` components.
+     */
+    toggleCheckedIcon?: string;
+    /**
+     * Overrides the unchecked icon for all `ion-toggle` components.
+     */
+    toggleUncheckedIcon?: string;
     /**
      * Overrides the default "animation" of all `ion-nav` and `ion-router-outlet` across the whole application.
      * This prop allows to replace the default transition and provide a custom one that applies to all navigation outlets.

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

@@ -1,9 +1,39 @@
 import type { EventEmitter } from '../stencil-public-runtime';
-import type { AnimationBuilder, HTMLStencilElement } from '../interface';
+import type { AnimationBuilder, HTMLStencilElement, Mode, Theme } from '../interface';
 export interface OverlayEventDetail<T = any> {
     data?: T;
     role?: string;
 }
+/**
+ * The shared configuration options for all overlays.
+ */
+export interface OverlayOptions {
+    /**
+     * To change the default appearance of the overlay, use the `theme` option.
+     * Mode is used to change the platform behavior of the component.
+     */
+    mode?: Mode;
+    /**
+     * The theme determines the visual appearance of components.
+     */
+    theme?: Theme;
+    /**
+     * If `true`, the overlay will be animated when it is presented and dismissed.
+     */
+    animated?: boolean;
+    /**
+     * The `id` of the overlay.
+     */
+    id?: string;
+    /**
+     * The custom enter animation to use for the overlay.
+     */
+    enterAnimation?: AnimationBuilder;
+    /**
+     * The custom leave animation to use for the overlay.
+     */
+    leaveAnimation?: AnimationBuilder;
+}
 export interface OverlayInterface {
     el: HTMLIonOverlayElement;
     animated: boolean;

package/dist/types/utils/test/playwright/generator.d.ts

@@ -1,5 +1,6 @@
-export type Mode = 'ios' | 'md';
+export type Mode = 'ios' | 'md' | 'ionic-ios' | 'ionic-md';
 export type Direction = 'ltr' | 'rtl';
+export type Theme = 'ios' | 'md' | 'ionic';
 /**
  * The theme to use for the playwright test.
  *
@@ -12,9 +13,10 @@ export type Palette = 'light' | 'dark' | 'high-contrast' | 'high-contrast-dark';
 export type TitleFn = (title: string) => string;
 export type ScreenshotFn = (fileName: string) => string;
 export interface TestConfig {
-    mode: Mode;
     direction: Direction;
     palette: Palette;
+    mode: Mode;
+    theme: Theme;
 }
 interface TestUtilities {
     title: TitleFn;
@@ -22,8 +24,35 @@ interface TestUtilities {
     config: TestConfig;
 }
 interface TestConfigOption {
+    /**
+     * The available options to test against.
+     * - "ios": Test against iOS theme on iOS mode.
+     * - "md": Test against Material Design theme on Material Design mode.
+     * - "ionic-ios": Test against Ionic theme on iOS mode.
+     * - "ionic-md": Test against Ionic theme on Material Design mode.
+     *
+     * If unspecified, tests will run against "ios" and "md".
+     */
     modes?: Mode[];
+    /**
+     * The text direction to test against.
+     *
+     * - "ltr": Test against left-to-right direction.
+     * - "rtl": Test against right-to-left direction.
+     *
+     * If unspecified, tests will run against both directions.
+     */
     directions?: Direction[];
+    /**
+     * The color palette to test against.
+     *
+     * - "light": Test against light palette.
+     * - "dark": Test against dark palette.
+     * - "high-contrast": Test against high contrast light palette.
+     * - "high-contrast-dark": Test against high contrast dark palette.
+     *
+     * If unspecified, tests will run against light theme.
+     */
     palettes?: Palette[];
 }
 /**