@ixon-cdk/types 1.13.0-next.3 → 1.13.1

package/dist/types/component-context/index.d.ts

@@ -8,11 +8,13 @@ import type { ComponentContextAppData } from './app-data';
 import type { ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
 import type { AlertDialogOptions, ConfirmDialogOptions, ContentDialogOptions, FormDialogOptions, FormDialogResult } from './dialog';
 import type { ActionMenuOptions, ActionMenuResult } from './menu';
+import type { ToastOptions } from './toast';
 import type { Tooltip, TooltipOptions } from './tooltip';
 export type { ComponentContextAppData } from './app-data';
 export type { ActionBottomSheetAction, ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
 export type { AlertDialogOptions, ConfirmDialogOptions, ContentDialogOptions, FormDialogOptions, FormDialogResult, } from './dialog';
 export type { ActionMenuAction, ActionMenuOptions, ActionMenuResult } from './menu';
+export type { ToastOptions } from './toast';
 export type { Tooltip, TooltipOptions } from './tooltip';
 export * from './input';
 /**
@@ -175,6 +177,41 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      * @param options configures the form dialog
      */
     openFormDialog(options: FormDialogOptions): Promise<FormDialogResult | false | undefined>;
+    /**
+     * Opens a toast notification.
+     *
+     * @param options - Options to configure the toast.
+     * @returns A promise that resolves to `true` if the action was triggered, or `undefined` otherwise.
+     *
+     * @example
+     * // Default auto-close behavior (true)
+     * context.openToast({ message: 'Changes saved' });
+     *
+     * // Default auto-close behavior when actionButtonText is set (false)
+     * context.openToast({ message: 'Connection timed out', actionButtonText: 'Retry' });
+     *
+     * // Overrides default auto-close behavior, despite actionButtonText being set.
+     * context.openToast({ message: 'Email archived', actionButtonText: 'Undo', autoClose: true });
+     */
+    openToast(options: ToastOptions): Promise<true | undefined>;
+    /**
+     * Opens a toast notification with a simple message and additional options.
+     *
+     * @param message - The message to display in the toast.
+     * @param options - Additional options to configure the toast.
+     * @returns A promise that resolves to `true` if the action was triggered, or `undefined` otherwise.
+     *
+     * @example
+     * // Default auto-close behavior (true)
+     * context.openToast('Changes saved');
+     *
+     * // Default auto-close behavior when actionButtonText is set (false)
+     * context.openToast('Connection timed out', { actionButtonText: 'Retry' });
+     *
+     * // Overrides default auto-close behavior, despite actionButtonText being set.
+     * context.openToast('Email archived', { actionButtonText: 'Undo', autoClose: true });
+     */
+    openToast(message: string, options?: Omit<ToastOptions, 'message'>): Promise<true | undefined>;
     /**
      * Helps preventing Cross Site Scripting Security bugs (XSS) by sanitizing the passed HTML, removing any potentially unsafe content.
      *
@@ -223,9 +260,9 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      * @param interpolateParams
      * @param options
      */
-    translate(key: string, interpolateParams?: Object, options?: TranslateOptions): string;
-    translate<T extends string>(key: T[], interpolateParams?: Object, options?: TranslateOptions): Record<T, string>;
-    translate<T extends string>(key: string | T[], interpolateParams?: Object, options?: TranslateOptions): string | Record<T, string>;
+    translate(key: string, interpolateParams?: object, options?: TranslateOptions): string;
+    translate<T extends string>(key: T[], interpolateParams?: object, options?: TranslateOptions): Record<T, string>;
+    translate<T extends string>(key: string | T[], interpolateParams?: object, options?: TranslateOptions): string | Record<T, string>;
 }
 export interface TranslateOptions {
     /**

package/dist/types/component-context/toast.d.ts

@@ -0,0 +1,14 @@
+export interface ToastOptions {
+    /**
+     * Text for an optional action button. If provided, `autoClose` defaults to false.
+     */
+    actionButtonText?: string;
+    /**
+     * Whether the toast automatically closes. Defaults to true, unless `actionButtonText` is set.
+     */
+    autoClose?: boolean;
+    /**
+     * The message to display in the toast.
+     */
+    message: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixon-cdk/types",
-  "version": "1.13.0-next.3",
+  "version": "1.13.1",
   "description": "",
   "main": "./dist/component-devkit/src/types/src/index.d.ts",
   "author": "",