@warp-ds/elements 2.2.0-next.7 → 2.2.0-next.9

package/dist/packages/toast/api.d.ts

@@ -1,54 +1,13 @@
-/**
- * Toast helper function options
- * @typedef    {Object}                         ToastOptions
- * @property   {(number|string)}                [id]        Custom identifier
- * @property   {('success'|'error'|'warning')}  [type]      Type of toast
- * @property   {String}                         [text]      The toast message. Only needed when updating text on existing toast
- * @property   {(number|string)}                [duration]  Duration of toast in milliseconds. Defaults to 5000. For accessibility reasons, toasts should never be interactive and therefore need to auto remove. If you must disable auto remove, set duration to Number.POSITIVE_INFINITY.
- * @property   {Boolean}                        [canclose]  Whether the toast can be dismissed. Defaults to false. WARNING! For accessibility reasons, toasts should not be interactive and canclose should always be false. If the toast absolutely must be dismissable, set this to true.
- */
+import type { ToastOptions, ToastInternal } from './types';
 /**
  * Creates a new toast
- * @param {String}        message  Message
- * @param {ToastOptions?} options  Toast options
- * @returns {ToastOptions} Toast details
  */
-export function toast(message: string, options: ToastOptions | null): ToastOptions;
+export declare function toast(message: string, options?: ToastOptions): ToastOptions;
 /**
  * Remove an existing toast
- * @param {String|Number} id Toast identifier
- * @return {Promise<Boolean>} Resolves to true if deleted, false if not found
  */
-export function removeToast(id: string | number): Promise<boolean>;
+export declare function removeToast(id: string | number): Promise<boolean> | undefined;
 /**
  * Update an existing toast
- * @param {String|Number}           id      Toast identifier
- * @param {ToastOptions?}           options Toast options
- * @returns {WarpToastContainer}          Toast details
- */
-export function updateToast(id: string | number, options: ToastOptions | null): WarpToastContainer;
-/**
- * Toast helper function options
  */
-export type ToastOptions = {
-    /**
-     * Custom identifier
-     */
-    id?: (number | string);
-    /**
-     * Type of toast
-     */
-    type?: ("success" | "error" | "warning");
-    /**
-     * The toast message. Only needed when updating text on existing toast
-     */
-    text?: string;
-    /**
-     * Duration of toast in milliseconds. Defaults to 5000. For accessibility reasons, toasts should never be interactive and therefore need to auto remove. If you must disable auto remove, set duration to Number.POSITIVE_INFINITY.
-     */
-    duration?: (number | string);
-    /**
-     * Whether the toast can be dismissed. Defaults to false. WARNING! For accessibility reasons, toasts should not be interactive and canclose should always be false. If the toast absolutely must be dismissable, set this to true.
-     */
-    canclose?: boolean;
-};
+export declare function updateToast(id: string | number, options?: ToastOptions): ToastInternal | undefined;

package/dist/packages/toast/index.d.ts

@@ -1,3 +1,3 @@
-export { WarpToast } from "./toast";
-export { WarpToastContainer } from "./toast-container";
-export { toast, updateToast, removeToast } from "./api";
+export { WarpToast } from './toast';
+export { WarpToastContainer } from './toast-container';
+export { toast, updateToast, removeToast } from './api';