47 lines
1.1 KiB
TypeScript
Executable File
47 lines
1.1 KiB
TypeScript
Executable File
/**
|
|
*
|
|
* [Live Demo](https://www.primevue.org/toast/)
|
|
*
|
|
* @module toastservice-usetoast
|
|
* @todo 'use' is not a valid name for a module. Next release will change.
|
|
*/
|
|
import { Plugin } from 'vue';
|
|
import { ToastMessageOptions } from '../toast';
|
|
|
|
declare const plugin: Plugin;
|
|
export default plugin;
|
|
|
|
/**
|
|
* Toast Service methods.
|
|
*
|
|
* @group Model
|
|
*
|
|
*/
|
|
export interface ToastServiceMethods {
|
|
/**
|
|
* Displays the message in a suitable Toast component.
|
|
* @param {ToastMessageOptions} message - Message instance.
|
|
*/
|
|
add(message: ToastMessageOptions): void;
|
|
/**
|
|
* Clears the message.
|
|
* @param {ToastMessageOptions} message - Message instance.
|
|
*/
|
|
remove(message: ToastMessageOptions): void;
|
|
/**
|
|
* Clears the messages that belongs to the group.
|
|
* @param {string} group - Name of the message group.
|
|
*/
|
|
removeGroup(group: string): void;
|
|
/**
|
|
* Clears all the messages.
|
|
*/
|
|
removeAllGroups(): void;
|
|
}
|
|
|
|
declare module 'vue' {
|
|
interface ComponentCustomProperties {
|
|
$toast: ToastServiceMethods;
|
|
}
|
|
}
|