mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-05 07:17:04 +00:00
Merge pull request #14998 from larvanitis/patch-1
Toastr: Fix and update according to version 2.1.3
This commit is contained in:
Paul van Brenk
Vendored
+269
-112
@@ -8,214 +8,371 @@
|
||||
|
||||
interface ToastrOptions {
|
||||
/**
|
||||
* Optionally override the animation easing to show or hide the toasts. Default is swing. swing and linear are built into jQuery.
|
||||
*/
|
||||
* Optionally override the animation easing to show or hide the toasts.
|
||||
* swing and linear are built into jQuery.
|
||||
* @default swing
|
||||
*/
|
||||
showEasing?: string;
|
||||
/**
|
||||
* Optionally override the animation easing to show or hide the toasts. Default is swing. swing and linear are built into jQuery.
|
||||
*/
|
||||
* Optionally override the animation easing to show or hide the toasts.
|
||||
* swing and linear are built into jQuery.
|
||||
* @default swing
|
||||
*/
|
||||
hideEasing?: string;
|
||||
/**
|
||||
* Use the jQuery show/hide method of your choice. These default to fadeIn/fadeOut. The methods fadeIn/fadeOut, slideDown/slideUp, and show/hide are built into jQuery.
|
||||
*/
|
||||
* Use the jQuery show method of your choice.
|
||||
* The methods fadeIn/fadeOut, slideDown/slideUp, and show/hide are built into jQuery.
|
||||
* @default fadeIn
|
||||
*/
|
||||
showMethod?: string;
|
||||
/**
|
||||
* Use the jQuery show/hide method of your choice. These default to fadeIn/fadeOut. The methods fadeIn/fadeOut, slideDown/slideUp, and show/hide are built into jQuery.
|
||||
*/
|
||||
* Use the jQuery hide method of your choice.
|
||||
* The methods fadeIn/fadeOut, slideDown/slideUp, and show/hide are built into jQuery.
|
||||
* @default fadeOut
|
||||
*/
|
||||
hideMethod?: string;
|
||||
/**
|
||||
* Should a close button be shown
|
||||
*/
|
||||
* Should a close button be shown?
|
||||
* @default undefined
|
||||
*/
|
||||
closeButton?: boolean;
|
||||
/**
|
||||
* Html for the close button
|
||||
*/
|
||||
* CSS class the close button will be given.
|
||||
* @default toast-close-button
|
||||
*/
|
||||
closeClass?: string;
|
||||
/**
|
||||
* Time in milliseconds the toast should take to hide, when the close button is clicked.
|
||||
* Falls back to hide configuration.
|
||||
* @default false
|
||||
*/
|
||||
closeDuration?: number;
|
||||
/**
|
||||
* The animation easing while hiding the toast, when the close button is clicked.
|
||||
* Falls back to hide configuration.
|
||||
* swing and linear are built into jQuery.
|
||||
* @default false
|
||||
*/
|
||||
closeEasing?: string;
|
||||
/**
|
||||
* Use the jQuery show/hide method of your choice, when the close button is clicked.
|
||||
* Falls back to hide configuration.
|
||||
* The methods fadeIn/fadeOut, slideDown/slideUp, and show/hide are built into jQuery.
|
||||
* @default false
|
||||
*/
|
||||
closeMethod?: string;
|
||||
/**
|
||||
* Set to false so that the toast hides event if hovered.
|
||||
* @default true
|
||||
*/
|
||||
closeOnHover?: boolean;
|
||||
/**
|
||||
* Html for the close button.
|
||||
*/
|
||||
closeHtml?: string;
|
||||
/**
|
||||
* Should clicking on toast dismiss it?
|
||||
*/
|
||||
* onCloseClick function callback, fired when the close button is clicked.
|
||||
* Closing cannot be prevented by ev.stopPropagation() etc.
|
||||
* @default undefined
|
||||
*/
|
||||
onCloseClick?: (ev: JQueryMouseEventObject) => void;
|
||||
/**
|
||||
* Should clicking on toast dismiss it?
|
||||
* @default true
|
||||
*/
|
||||
tapToDismiss?: boolean;
|
||||
/**
|
||||
* CSS class the toast element will be given
|
||||
*/
|
||||
* CSS class the toast element will be given.
|
||||
* @default toast
|
||||
*/
|
||||
toastClass?: string;
|
||||
/**
|
||||
* Id toast container will be given
|
||||
*/
|
||||
* Id toast container will be given.
|
||||
* @default toast-container
|
||||
*/
|
||||
containerId?: string;
|
||||
/**
|
||||
* Should debug details be outputted to the console
|
||||
*/
|
||||
* Should debug details be outputted to the console?
|
||||
* @default false
|
||||
*/
|
||||
debug?: boolean;
|
||||
/**
|
||||
* Time in milliseconds the toast should take to show
|
||||
*/
|
||||
* Time in milliseconds the toast should take to show.
|
||||
* @default 300
|
||||
*/
|
||||
showDuration?: number;
|
||||
/**
|
||||
* onShown function callback
|
||||
**/
|
||||
* onShown function callback.
|
||||
* @default undefined
|
||||
*/
|
||||
onShown?: () => void;
|
||||
/**
|
||||
* Time in milliseconds the toast should take to hide
|
||||
*/
|
||||
* Time in milliseconds the toast should take to hide.
|
||||
* @default 1000
|
||||
*/
|
||||
hideDuration?: number;
|
||||
/**
|
||||
* onHidden function callback
|
||||
**/
|
||||
* onHidden function callback.
|
||||
* @default undefined
|
||||
*/
|
||||
onHidden?: () => void;
|
||||
/**
|
||||
* Time in milliseconds the toast should be displayed after mouse over
|
||||
*/
|
||||
* Time in milliseconds the toast should be displayed after leaving mouse over.
|
||||
* Set timeOut and extendedTimeOut to 0 to make it sticky.
|
||||
* @default 1000
|
||||
*/
|
||||
extendedTimeOut?: number;
|
||||
/**
|
||||
* If specified, you must provide all classes.
|
||||
*/
|
||||
iconClasses?: {
|
||||
/**
|
||||
* Icon to use on error toasts
|
||||
*/
|
||||
* Icon to use on error toasts.
|
||||
* @default toast-error
|
||||
*/
|
||||
error: string;
|
||||
/**
|
||||
* Icon to use on info toasts
|
||||
*/
|
||||
* Icon to use on info toasts.
|
||||
* @default toast-info
|
||||
*/
|
||||
info: string;
|
||||
/**
|
||||
* Icon to use on success toasts
|
||||
*/
|
||||
* Icon to use on success toasts.
|
||||
* @default toast-success
|
||||
*/
|
||||
success: string;
|
||||
/**
|
||||
* Icon to use on warning toasts
|
||||
*/
|
||||
* Icon to use on warning toasts.
|
||||
* @default toast-warning
|
||||
*/
|
||||
warning: string;
|
||||
};
|
||||
/**
|
||||
* Icon to use for toast
|
||||
*/
|
||||
* Icon to use for toast.
|
||||
* @default toast-info
|
||||
*/
|
||||
iconClass?: string;
|
||||
/**
|
||||
* Where toast should be displayed
|
||||
*/
|
||||
* Where toast should be displayed.
|
||||
* The default stylesheet covers:
|
||||
* toast-top-left, toast-top-center, toast-top-right, toast-top-full-width,
|
||||
* toast-bottom-left, toast-bottom-center, toast-bottom-right, toast-bottom-full-width
|
||||
* @default toast-top-right
|
||||
*/
|
||||
positionClass?: string;
|
||||
/**
|
||||
* Where toast should be displayed - background
|
||||
*/
|
||||
backgroundpositionClass?: string;
|
||||
/**
|
||||
* Time in milliseconds that the toast should be displayed
|
||||
*/
|
||||
* Time in milliseconds that the toast should be displayed.
|
||||
* Set timeOut and extendedTimeOut to 0 to make it sticky.
|
||||
* @default 5000
|
||||
*/
|
||||
timeOut?: number;
|
||||
/**
|
||||
* CSS class the title element will be given
|
||||
*/
|
||||
* CSS class the title element will be given.
|
||||
* @default toast-title
|
||||
*/
|
||||
titleClass?: string;
|
||||
/**
|
||||
* CSS class the message element will be given
|
||||
*/
|
||||
* CSS class the message element will be given.
|
||||
* @default toast-message
|
||||
*/
|
||||
messageClass?: string;
|
||||
/**
|
||||
* Set newest toast to appear on top
|
||||
**/
|
||||
* Set newest toast to appear on top.
|
||||
* @default true
|
||||
*/
|
||||
newestOnTop?: boolean;
|
||||
/**
|
||||
* The element to put the toastr container
|
||||
**/
|
||||
* The element to put the toastr container
|
||||
* @default body
|
||||
*/
|
||||
target?: string;
|
||||
/**
|
||||
* Rather than having identical toasts stack, set the preventDuplicates property to true. Duplicates are matched to the previous toast based on their message content.
|
||||
*/
|
||||
* Rather than having identical toasts stack, set the preventDuplicates property to true.
|
||||
* Duplicates are matched to the previous toast based on their message content.
|
||||
* @default false
|
||||
*/
|
||||
preventDuplicates?: boolean;
|
||||
/**
|
||||
* Visually indicates how long before a toast expires.
|
||||
*/
|
||||
* Visually indicates how long before a toast expires.
|
||||
* @default false
|
||||
*/
|
||||
progressBar?: boolean;
|
||||
/**
|
||||
* Function to execute on toast click
|
||||
*/
|
||||
onclick?: () => void;
|
||||
* CSS class the progressbar element will be given.
|
||||
* @default toast-progress
|
||||
*/
|
||||
progressClass?: string;
|
||||
/**
|
||||
* Set if toastr should parse containing html
|
||||
**/
|
||||
allowHtml?: boolean;
|
||||
* Function to execute on toast click. Closing cannot be prevented by ev.stopPropagation() etc.
|
||||
* @default undefined
|
||||
*/
|
||||
onclick?: (ev: JQueryMouseEventObject) => void;
|
||||
/**
|
||||
* Set if toastr should escape html
|
||||
**/
|
||||
* Should the title and message text be escaped?
|
||||
* @default false
|
||||
*/
|
||||
escapeHtml?: boolean;
|
||||
/**
|
||||
* Flip the toastr to be displayed properly for right-to-left languages.
|
||||
* @default false
|
||||
*/
|
||||
rtl?: boolean;
|
||||
}
|
||||
|
||||
interface ToastrDisplayMethod {
|
||||
/**
|
||||
* Create a toast
|
||||
*
|
||||
* @param message Message to display in toast
|
||||
*/
|
||||
* Create a toast
|
||||
*
|
||||
* @param message Message to display in toast
|
||||
*/
|
||||
(message: string): JQuery;
|
||||
/**
|
||||
* Create a toast
|
||||
*
|
||||
* @param message Message to display in toast
|
||||
* @param title Title to display on toast
|
||||
*/
|
||||
* Create a toast
|
||||
*
|
||||
* @param message Message to display in toast
|
||||
* @param title Title to display on toast
|
||||
*/
|
||||
(message: string, title: string): JQuery;
|
||||
/**
|
||||
* Create a toast
|
||||
*
|
||||
* @param message Message to display in toast
|
||||
* @param title Title to display on toast
|
||||
* @param overrides Option values for toast
|
||||
*/
|
||||
* Create a toast
|
||||
*
|
||||
* @param message Message to display in toast
|
||||
* @param title Title to display on toast
|
||||
* @param overrides Option values for toast
|
||||
*/
|
||||
(message: string, title: string, overrides: ToastrOptions): JQuery;
|
||||
}
|
||||
|
||||
type ToastrType = 'error'|'info'|'success'|'warning';
|
||||
|
||||
interface ToastMap {
|
||||
/**
|
||||
* The toast type.
|
||||
*/
|
||||
type: ToastrType;
|
||||
/**
|
||||
* The toast message.
|
||||
*/
|
||||
message: string;
|
||||
/**
|
||||
* The toast icon class.
|
||||
*/
|
||||
iconClass: string;
|
||||
/**
|
||||
* The toast title.
|
||||
*/
|
||||
title?: string;
|
||||
/**
|
||||
* Any override options specified when the toast was created.
|
||||
*/
|
||||
optionsOverride?: ToastrOptions;
|
||||
}
|
||||
|
||||
interface ToastrResponse {
|
||||
/**
|
||||
* The internal toast id.
|
||||
*/
|
||||
toastId: number;
|
||||
/**
|
||||
* The current state of the toast.
|
||||
*/
|
||||
state: 'visible'|'hidden';
|
||||
/**
|
||||
* The datetime the toast was opened.
|
||||
*/
|
||||
startTime: Date;
|
||||
/**
|
||||
* The datetime the toast was closed, if the state is hidden.
|
||||
*/
|
||||
endTime?: Date;
|
||||
/**
|
||||
* The toastr options.
|
||||
*/
|
||||
options: ToastrOptions;
|
||||
/**
|
||||
* The event's toast details.
|
||||
*/
|
||||
map: ToastMap;
|
||||
}
|
||||
|
||||
interface Toastr {
|
||||
/**
|
||||
* Clear toasts
|
||||
*/
|
||||
* Clear toasts
|
||||
*/
|
||||
clear: {
|
||||
/**
|
||||
* Clear all toasts
|
||||
*/
|
||||
* Clear all toasts
|
||||
*/
|
||||
(): void;
|
||||
/**
|
||||
* Clear specific toast
|
||||
*
|
||||
* @param toast Toast to clear
|
||||
*/
|
||||
* Clear specific toast
|
||||
*
|
||||
* @param toast Toast to clear
|
||||
*/
|
||||
(toast: JQuery): void;
|
||||
/**
|
||||
* Clear specific toast
|
||||
*
|
||||
* @param toast Toast to clear
|
||||
* @param clearOptions force clearing a toast, ignoring focus
|
||||
*/
|
||||
(toast: JQuery, clearOptions: { force: boolean }): void;
|
||||
/**
|
||||
* Clear specific toast
|
||||
*
|
||||
* @param toast Toast to clear
|
||||
* @param clearOptions force clearing a toast, ignoring focus
|
||||
*/
|
||||
(toast: JQuery, clearOptions: {force: boolean}): void;
|
||||
};
|
||||
/**
|
||||
* Removes all toasts (without animation)
|
||||
*/
|
||||
* Removes all toasts (without animation)
|
||||
*/
|
||||
remove: {
|
||||
(): void;
|
||||
};
|
||||
/**
|
||||
* Create an error toast
|
||||
*/
|
||||
* Create an error toast
|
||||
*/
|
||||
error: ToastrDisplayMethod;
|
||||
/**
|
||||
* Create an info toast
|
||||
*/
|
||||
* Create an info toast
|
||||
*/
|
||||
info: ToastrDisplayMethod;
|
||||
/**
|
||||
* Create an options object
|
||||
*/
|
||||
* The toatsr options object
|
||||
*/
|
||||
options: ToastrOptions;
|
||||
/**
|
||||
* Create a success toast
|
||||
*/
|
||||
* Create a success toast
|
||||
*/
|
||||
success: ToastrDisplayMethod;
|
||||
/**
|
||||
* Create a warning toast
|
||||
*/
|
||||
* Create a warning toast
|
||||
*/
|
||||
warning: ToastrDisplayMethod;
|
||||
/**
|
||||
* Get toastr version
|
||||
*/
|
||||
* Get toastr version
|
||||
*/
|
||||
version: string;
|
||||
/**
|
||||
* Get or create a container.
|
||||
*/
|
||||
getContainer: {
|
||||
/**
|
||||
* Get the container by options.containerId.
|
||||
*
|
||||
* @param options Option values for the container
|
||||
*/
|
||||
(options?: ToastrOptions): JQuery,
|
||||
/**
|
||||
* Get the container by options.containerId.
|
||||
* If it doesn't exist, it will be created according to options.
|
||||
*
|
||||
* @param options Option values for the container
|
||||
* @param create Use true to create a container, if it doesn't exist
|
||||
*/
|
||||
(options: ToastrOptions, create: boolean): JQuery,
|
||||
};
|
||||
/**
|
||||
* Register a callback to be called when a toast gets created or hidden.
|
||||
*
|
||||
* @param callback The function which will be passed the event details.
|
||||
*/
|
||||
subscribe: (callback: (response: ToastrResponse) => any) => void;
|
||||
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user