vue-snotify/interfaces/SnotifyToastConfig.interface.d.ts

A Vue.js toast notifications

import { SnotifyButton, SnotifyAnimate } from '.';
import { SnotifyType } from '../types';
import { SnotifyPosition } from '../enums/';
/**
 * Toast configuration object
 */
export interface SnotifyToastConfig {
    /**
     * Toast custom id.
     */
    id?: number | string;
    /**
     * Toast timeout in milliseconds.
     * Disable timeout = 0
     * @type {number}
     * @default: 2000
     */
    timeout?: number;
    /**
     * Enable/Disable progress bar.
     * Disabled if timeout is 0.
     * @type {boolean}
     * @default true
     */
    showProgressBar?: boolean;
    /**
     * Type of toast, affects toast style.
     * It's not recommended to change it.
     * Depends on toast type.
     * @type {SnotifyType}
     * @default SnotifyStyle.SIMPLE | SnotifyStyle.SUCCESS | SnotifyStyle. ERROR | SnotifyStyle.WARNING etc..
     */
    type?: SnotifyType;
    /**
     * Should toast close on click?
     * @type {boolean}
     * @default true
     */
    closeOnClick?: boolean;
    /**
     * Should timeout pause on hover?
     * @type {boolean}
     * @default true
     */
    pauseOnHover?: boolean;
    /**
     * Buttons config.
     * @type {SnotifyButton[]}
     * @default Look snotify button description
     */
    buttons?: SnotifyButton[];
    /**
     * Placeholder for Prompt toast
     * @type {string}
     * @default 'Enter answer here...'
     */
    placeholder?: string;
    /**
     * Toast title maximum length
     * @type {number}
     * @default 16
     */
    titleMaxLength?: number;
    /**
     * Toast body maximum length
     * @type {number}
     * @default 150
     */
    bodyMaxLength?: number;
    /**
     * Activate custom icon. | false - disable
     * You should provide full tag, e.g.
     * ```html
     * <img src="assets/custom-icon.png"/>
     * ```
     * ```html
     * <svg x="0px" y="0px" viewBox="0 0 512 512" style="enable-background:new 0 0 48 48;" xml:space="preserve" width="48px" height="48px">
     *     <g><path....../></g>
     * </svg>
     * ```
     * @type {string}
     * @default undefined
     */
    icon?: string;
    /**
     * Backdrop opacity.
     * * **Range:** `0.0 - 1.0`.
     * * **Disabled:** `-1`
     * @type {number}
     * @default -1
     */
    backdrop?: number;
    /**
     * Animation config
     * @type {SnotifyAnimate}
     * @default -1
     */
    animation?: SnotifyAnimate;
    /**
     * Html string witch overrides toast content
     * @type {string}
     * @default null
     */
    html?: string;
    /**
     * Toasts position on screen
     * @type {SnotifyPosition}
     * @default SnotifyPosition.rightBottom
     */
    position?: SnotifyPosition;
}