Add definitions for angular-toasty

2026-09-10 11:40:16 +08:00 · 2015-08-12 12:37:15 +02:00
parent 71d072b735
commit b41162d7fc
2 changed files with 376 additions and 0 deletions
@@ -0,0 +1,255 @@
+// Type definitions for Angular Toasty v1.0.2
+// Project: https://github.com/invertase/angular-toasty
+// Definitions by: Dominik Muench <https://github.com/muenchdo>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module toasty {
+
+    interface IToastyService {
+        /**
+         * Create a toast with the given options and type.
+         * @param options
+         * @param type
+         */
+        (options: IToastyConfig, type?: string): void;
+
+        /**
+         * Create a default "quick toast" with the given title.
+         * @param title
+         */
+        (title: string|number): void;
+
+        /**
+         * Create a default toast with the given options.
+         * @param options
+         */
+        default(options: IToastyConfig): void;
+
+        /**
+         * Create a default "quick toast" with the given title.
+         * @param title
+         */
+        default(title: string|number): void;
+
+        /**
+         * Create an info toast with the given options.
+         * @param options
+         */
+        info(options: IToastyConfig): void;
+
+        /**
+         * Create an info "quick toast" with the given title.
+         * @param title
+         */
+        info(title: string|number): void;
+
+        /**
+         * Create a wait toast with the given options.
+         * @param options
+         */
+        wait(options: IToastyConfig): void;
+
+        /**
+         * Create a wait "quick toast" with the given title.
+         * @param title
+         */
+        wait(title: string|number): void;
+
+        /**
+         * Create a success toast with the given options.
+         * @param options
+         */
+        success(options: IToastyConfig): void;
+
+        /**
+         * Create a success "quick toast" with the given title.
+         * @param title
+         */
+        success(title: string|number): void;
+
+        /**
+         * Create an error toast with the given options.
+         * @param options
+         */
+        error(options: IToastyConfig): void;
+
+        /**
+         * Create an error "quick toast" with the given title.
+         * @param title
+         */
+        error(title: string|number): void;
+
+        /**
+         * Create a warning toast with the given options.
+         * @param options
+         */
+        warning(options: IToastyConfig): void;
+
+        /**
+         * Create a warning "quick toast" with the given title.
+         * @param title
+         */
+        warning(title: string|number): void;
+
+        /**
+         * Clear toast(s).
+         * @param id Optional ID to clear a specific toast.
+         */
+        clear(id?): void;
+
+        /**
+         * Get the global config.
+         */
+        getGlobalConfig(): IGlobalConfig;
+
+    }
+
+    interface IToastyConfig {
+        /**
+         * The toast's title.
+         */
+        title: string;
+
+        /**
+         * The toast's message.
+         */
+        msg?: string;
+
+        /**
+         * Whether to show the 'X' icon to close the toast.
+         */
+        showClose?: boolean;
+
+        /**
+         * Whether clicking the toast closes it.
+         */
+        clickToClose?: boolean;
+
+        /**
+         * How long (in milliseconds) the toast shows before it's removed. Set to false to disable.
+         */
+        timeout?: number;
+
+        /**
+         * Whether to play a sound when a toast is added.
+         */
+        sound?: boolean;
+
+        /**
+         * Whether HTML is allowed in toasts.
+         */
+        html?: boolean;
+
+        /**
+         * Whether to shake the toasts.
+         */
+        shake?: boolean;
+
+        /**
+         * What theme to use.
+         * - 'default'
+         * - 'material'
+         * - 'bootstrap'
+         */
+        theme?: string;
+
+        /**
+         * The toast's type:
+         * - 'default'
+         * - 'info'
+         * - 'success'
+         * - 'wait'
+         * - 'error'
+         * - 'warning'
+         */
+        type?: string;
+
+        /**
+         * Add event handler.
+         */
+        onAdd?: Function;
+
+        /**
+         * Remove event handler.
+         */
+        onRemove?: Function;
+
+        /**
+         * Click event handler.
+         */
+        onClick?: Function;
+    }
+
+    interface IGlobalConfig {
+
+        /**
+         * Maximum number of toasts to show at once.
+         */
+        limit?: number;
+
+        /**
+         * The toast's title.
+         */
+        title?: string;
+
+        /**
+         * The toast's message.
+         */
+        msg?: string;
+
+        /**
+         * Whether to show the 'X' icon to close the toast.
+         */
+        showClose?: boolean;
+
+        /**
+         * Whether clicking the toast closes it.
+         */
+        clickToClose?: boolean;
+
+        /**
+         * The window position where the toast pops up.
+         *
+         */
+        position?: string;
+
+        /**
+         * How long (in miliseconds) the toast shows before it's removed. Set to false to disable.
+         */
+        timeout?: number|boolean;
+
+        /**
+         * Whether to play a sound when a toast is added.
+         */
+        sound?: boolean;
+
+        /**
+         * Whether HTML is allowed in toast.
+         */
+        html?: boolean;
+
+        /**
+         * Whether to shake the toast.
+         */
+        shake?: boolean;
+
+        /**
+         * What theme to use.
+         * - 'default'
+         * - 'material'
+         * - 'bootstrap'
+         */
+        theme?: string;
+    }
+
+    interface IToastyConfigProvider {
+        /**
+         *
+         * @param override
+         */
+        setConfig(override: IGlobalConfig);
+        $get(): IGlobalConfig;
+    }
+}